src/gallium/docs/source/cso/sampler.rst

   1 .. _sampler:
   2
   3 Sampler
   4 =======
   5
   6 Texture units have many options for selecting texels from loaded textures;
   7 this state controls an individual texture unit's texel-sampling settings.
   8
   9 Texture coordinates are always treated as four-dimensional, and referred to
  10 with the traditional (S, T, R, Q) notation.
  11
  12 Members
  13 -------
  14
  15 XXX undocumented compare_mode, compare_func
  16
  17 wrap_s
  18     How to wrap the S coordinate. One of PIPE_TEX_WRAP.
  19 wrap_t
  20     How to wrap the T coordinate. One of PIPE_TEX_WRAP.
  21 wrap_r
  22     How to wrap the R coordinate. One of PIPE_TEX_WRAP.
  23 min_img_filter
  24     The filter to use when minifying texels. One of PIPE_TEX_FILTER.
  25 min_mip_filter
  26     The filter to use when minifying mipmapped textures. One of
  27     PIPE_TEX_FILTER.
  28 mag_img_filter
  29     The filter to use when magnifying texels. One of PIPE_TEX_FILTER.
  30 normalized_coords
  31     Whether the texture coordinates are normalized. If normalized, they will
  32     always be in [0, 1]. If not, they will be in the range of each dimension
  33     of the loaded texture.
  34 prefilter
  35     XXX From the Doxy, "weird sampling state exposed by some APIs." Refine.
  36 lod_bias
  37     The bias to apply to the level of detail.
  38 min_lod
  39     Minimum level of detail, used to clamp LoD after bias.
  40 max_lod
  41     Maximum level of detail, used to clamp LoD after bias.
  42 border_color
  43     RGBA color used for out-of-bounds coordinates.
  44 max_anisotropy
  45     Maximum filtering to apply anisotropically to textures. Setting this to
  46     1.0 effectively disables anisotropic filtering.