summaryrefslogtreecommitdiff
path: root/src/gallium/docs/source/cso/sampler.rst
diff options
context:
space:
mode:
authorCorbin Simpson <MostAwesomeDude@gmail.com>2010-01-05 08:37:49 -0800
committerCorbin Simpson <MostAwesomeDude@gmail.com>2010-01-05 08:37:49 -0800
commit3e18bad36d90255dca6cb519eb7ecfc540c292c1 (patch)
tree1d9d7dc8a24baf21d1758be65f5cf5dadf85e8f1 /src/gallium/docs/source/cso/sampler.rst
parent897cb8950ae14ffe7029b1daf16113ff62ce0dfe (diff)
parent467cccf0a77e225b886711db2b0b929ecf71e411 (diff)
Merge branch 'gallium-docs'
Diffstat (limited to 'src/gallium/docs/source/cso/sampler.rst')
-rw-r--r--src/gallium/docs/source/cso/sampler.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/src/gallium/docs/source/cso/sampler.rst b/src/gallium/docs/source/cso/sampler.rst
new file mode 100644
index 0000000000..e3f1757f57
--- /dev/null
+++ b/src/gallium/docs/source/cso/sampler.rst
@@ -0,0 +1,46 @@
+.. _sampler:
+
+Sampler
+=======
+
+Texture units have many options for selecting texels from loaded textures;
+this state controls an individual texture unit's texel-sampling settings.
+
+Texture coordinates are always treated as four-dimensional, and referred to
+with the traditional (S, T, R, Q) notation.
+
+Members
+-------
+
+XXX undocumented compare_mode, compare_func
+
+wrap_s
+ How to wrap the S coordinate. One of PIPE_TEX_WRAP.
+wrap_t
+ How to wrap the T coordinate. One of PIPE_TEX_WRAP.
+wrap_r
+ How to wrap the R coordinate. One of PIPE_TEX_WRAP.
+min_img_filter
+ The filter to use when minifying texels. One of PIPE_TEX_FILTER.
+min_mip_filter
+ The filter to use when minifying mipmapped textures. One of
+ PIPE_TEX_FILTER.
+mag_img_filter
+ The filter to use when magnifying texels. One of PIPE_TEX_FILTER.
+normalized_coords
+ Whether the texture coordinates are normalized. If normalized, they will
+ always be in [0, 1]. If not, they will be in the range of each dimension
+ of the loaded texture.
+prefilter
+ XXX From the Doxy, "weird sampling state exposed by some APIs." Refine.
+lod_bias
+ The bias to apply to the level of detail.
+min_lod
+ Minimum level of detail, used to clamp LoD after bias.
+max_lod
+ Maximum level of detail, used to clamp LoD after bias.
+border_color
+ RGBA color used for out-of-bounds coordinates.
+max_anisotropy
+ Maximum filtering to apply anisotropically to textures. Setting this to
+ 1.0 effectively disables anisotropic filtering.