Fill out some of the CSO info.
[mesa.git] / src / gallium / docs / source / cso / sampler.rst
1 Sampler
2 =======
3
4 Texture units have many options for selecting texels from loaded textures;
5 this state controls an individual texture unit's texel-sampling settings.
6
7 Texture coordinates are always treated as four-dimensional, and referred to
8 with the traditional (S, T, R, Q) notation.
9
10 Members
11 -------
12
13 XXX undocumented compare_mode, compare_func
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 normalized_coords
29 Whether the texture coordinates are normalized. If normalized, they will
30 always be in [0, 1]. If not, they will be in the range of each dimension
31 of the loaded texture.
32 prefilter
33 XXX From the Doxy, "weird sampling state exposed by some APIs." Refine.
34 lod_bias
35 The bias to apply to the level of detail.
36 min_lod
37 Minimum level of detail, used to clamp LoD after bias.
38 max_lod
39 Maximum level of detail, used to clamp LoD after bias.
40 border_color
41 RGBA color used for out-of-bounds coordinates.
42 max_anisotropy
43 Maximum filtering to apply anisotropically to textures. Setting this to
44 1.0 effectively disables anisotropic filtering.