summaryrefslogtreecommitdiff
path: root/src/gallium/docs/build/html/_sources
diff options
context:
space:
mode:
authorCorbin Simpson <MostAwesomeDude@gmail.com>2009-12-20 17:25:44 -0800
committerCorbin Simpson <MostAwesomeDude@gmail.com>2009-12-20 17:25:44 -0800
commit9f936f2001116d75b1bc5b086b9ff6d5d415bb60 (patch)
tree53a449522f546827a17dd5c0b8bfcabb42c56033 /src/gallium/docs/build/html/_sources
parentfa33812d47bde327ca69dc3f849404fb22b6f34f (diff)
Regenerate docs.
Diffstat (limited to 'src/gallium/docs/build/html/_sources')
-rw-r--r--src/gallium/docs/build/html/_sources/cso.txt7
-rw-r--r--src/gallium/docs/build/html/_sources/cso/blend.txt2
-rw-r--r--src/gallium/docs/build/html/_sources/cso/dsa.txt39
-rw-r--r--src/gallium/docs/build/html/_sources/cso/rasterizer.txt76
-rw-r--r--src/gallium/docs/build/html/_sources/cso/sampler.txt36
5 files changed, 154 insertions, 6 deletions
diff --git a/src/gallium/docs/build/html/_sources/cso.txt b/src/gallium/docs/build/html/_sources/cso.txt
index f00cc51d4b..dab1ee50f3 100644
--- a/src/gallium/docs/build/html/_sources/cso.txt
+++ b/src/gallium/docs/build/html/_sources/cso.txt
@@ -1,6 +1,13 @@
CSO
===
+CSO, Constant State Objects, are a core part of Gallium's API.
+
+CSO work on the principle of reusable state; they are created by filling
+out a state object with the desired properties, then passing that object
+to a context. The context returns an opaque context-specific handle which
+can be bound at any time for the desired effect.
+
.. toctree::
:glob:
diff --git a/src/gallium/docs/build/html/_sources/cso/blend.txt b/src/gallium/docs/build/html/_sources/cso/blend.txt
index e32d324854..608f36999b 100644
--- a/src/gallium/docs/build/html/_sources/cso/blend.txt
+++ b/src/gallium/docs/build/html/_sources/cso/blend.txt
@@ -9,4 +9,4 @@ XXX it is unresolved what behavior should result if blend_enable is off.
Members
-------
-XXX
+XXX undocumented members
diff --git a/src/gallium/docs/build/html/_sources/cso/dsa.txt b/src/gallium/docs/build/html/_sources/cso/dsa.txt
index 5f23896f6e..0be7af5029 100644
--- a/src/gallium/docs/build/html/_sources/cso/dsa.txt
+++ b/src/gallium/docs/build/html/_sources/cso/dsa.txt
@@ -7,17 +7,50 @@ discard fragments that have passed through the fragment shader.
Traditionally, these three tests have been clumped together in hardware, so
they are all stored in one structure.
+During actual execution, the order of operations done on fragments is always:
+
+* Stencil
+* Depth
+* Alpha
+
Depth Members
-------------
-XXX
+enabled
+ Whether the depth test is enabled.
+writemask
+ Whether the depth buffer receives depth writes.
+func
+ The depth test function. One of PIPE_FUNC.
Stencil Members
---------------
-XXX
+XXX document valuemask, writemask
+
+enabled
+ Whether the stencil test is enabled. For the second stencil, whether the
+ two-sided stencil is enabled.
+func
+ The stencil test function. One of PIPE_FUNC.
+ref_value
+ Stencil test reference value; used for certain functions.
+fail_op
+ The operation to carry out if the stencil test fails. One of
+ PIPE_STENCIL_OP.
+zfail_op
+ The operation to carry out if the stencil test passes but the depth test
+ fails. One of PIPE_STENCIL_OP.
+zpass_op
+ The operation to carry out if the stencil test and depth test both pass.
+ One of PIPE_STENCIL_OP.
Alpha Members
-------------
-XXX
+enabled
+ Whether the alpha test is enabled.
+func
+ The alpha test function. One of PIPE_FUNC.
+ref_value
+ Alpha test reference value; used for certain functions.
diff --git a/src/gallium/docs/build/html/_sources/cso/rasterizer.txt b/src/gallium/docs/build/html/_sources/cso/rasterizer.txt
index 145ce259bb..b87d121db3 100644
--- a/src/gallium/docs/build/html/_sources/cso/rasterizer.txt
+++ b/src/gallium/docs/build/html/_sources/cso/rasterizer.txt
@@ -7,4 +7,78 @@ interpolated into fragments.
Members
-------
-XXX
+XXX undocumented light_twoside, front_winding, cull_mode, fill_cw, fill_ccw, offset_cw, offset_ccw
+XXX moar undocumented poly_smooth, line_stipple_factor, line_last_pixel, offset_units, offset_scale
+XXX sprite_coord_mode
+
+flatshade
+ If set, the provoking vertex of each polygon is used to determine the
+ color of the entire polygon. If not set, the color fragments will be
+ interpolated from each vertex's color.
+scissor
+ Whether the scissor test is enabled.
+poly_stipple_enable
+ Whether polygon stippling is enabled.
+point_smooth
+ Whether points should be smoothed. Point smoothing turns rectangular
+ points into circles or ovals.
+point_sprite
+ Whether point sprites are enabled.
+point_size_per_vertex
+ Whether vertices have a point size element.
+multisample
+ Whether MSAA is enabled.
+line_smooth
+ Whether lines should be smoothed. Line smoothing is simply anti-aliasing.
+line_stipple_enable
+ Whether line stippling is enabled.
+line_stipple_pattern
+ 16-bit bitfield of on/off flags, used to pattern the line stipple.
+bypass_vs_clip_and_viewport
+ Whether the entire TCL pipeline should be bypassed. This implies that
+ vertices are pre-transformed for the viewport, and will not be run
+ through the vertex shader. Note that implementations may still clip away
+ vertices that are not in the viewport.
+flatshade_first
+ Whether the first vertex should be the provoking vertex, for most
+ primitives. If not set, the last vertex is the provoking vertex.
+gl_rasterization_rules
+ Whether the rasterizer should use (0.5, 0.5) pixel centers. When not set,
+ the rasterizer will use (0, 0) for pixel centers.
+line_width
+ The width of lines.
+point_size
+ The size of points, if not specified per-vertex.
+point_size_min
+ The minimum size of points.
+point_size_max
+ The maximum size of points.
+
+Notes
+-----
+
+flatshade
+^^^^^^^^^
+
+The actual interpolated shading algorithm is obviously
+implementation-dependent, but will usually be Gourard for most hardware.
+
+bypass_vs_clip_and_viewport
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When set, this implies that vertices are pre-transformed for the viewport, and
+will not be run through the vertex shader. Note that implementations may still
+clip away vertices that are not visible.
+
+flatshade_first
+^^^^^^^^^^^^^^^
+
+There are several important exceptions to the specification of this rule.
+
+* PIPE_PRIMITIVE_POLYGON: The provoking vertex is always the first vertex.
+ If the caller wishes to change the provoking vertex, they merely need to
+ rotate the vertices themselves.
+* PIPE_PRIMITIVE_QUAD, PIPE_PRIMITIVE_QUAD_STRIP: This option has no effect.
+* PIPE_PRIMITIVE_TRIANGLE_FAN: When set, the provoking vertex is the second
+ vertex, not the first. This permits each segment of the fan to have a
+ different color.
diff --git a/src/gallium/docs/build/html/_sources/cso/sampler.txt b/src/gallium/docs/build/html/_sources/cso/sampler.txt
index 09b959ffff..3a63ac637b 100644
--- a/src/gallium/docs/build/html/_sources/cso/sampler.txt
+++ b/src/gallium/docs/build/html/_sources/cso/sampler.txt
@@ -4,7 +4,41 @@ 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
+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.