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 wrap_s
  16     How to wrap the S coordinate. One of PIPE_TEX_WRAP.
  17 wrap_t
  18     How to wrap the T coordinate. One of PIPE_TEX_WRAP.
  19 wrap_r
  20     How to wrap the R coordinate. One of PIPE_TEX_WRAP.
  21 min_img_filter
  22     The filter to use when minifying texels. One of PIPE_TEX_FILTER.
  23 min_mip_filter
  24     The filter to use when minifying mipmapped textures. One of
  25     PIPE_TEX_FILTER.
  26 mag_img_filter
  27     The filter to use when magnifying texels. One of PIPE_TEX_FILTER.
  28 compare_mode
  29     If set to PIPE_TEX_COMPARE_R_TO_TEXTURE, texture output is computed
  30     according to compare_func, using r coord and the texture value as operands.
  31     If set to PIPE_TEX_COMPARE_NONE, no comparison calculation is performed.
  32 compare_func
  33     How the comparison is computed. One of PIPE_FUNC.
  34 normalized_coords
  35     Whether the texture coordinates are normalized. If normalized, they will
  36     always be in [0, 1]. If not, they will be in the range of each dimension
  37     of the loaded texture.
  38 lod_bias
  39     The bias to apply to the level of detail.
  40 min_lod
  41     Minimum level of detail, used to clamp LoD after bias.
  42 max_lod
  43     Maximum level of detail, used to clamp LoD after bias.
  44 border_color
  45     RGBA color used for out-of-bounds coordinates.
  46 max_anisotropy
  47     Maximum filtering to apply anisotropically to textures. Setting this to
  48     1.0 effectively disables anisotropic filtering.