summaryrefslogtreecommitdiff
path: root/src/gallium/docs/build/html/cso
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/cso
parentfa33812d47bde327ca69dc3f849404fb22b6f34f (diff)
Regenerate docs.
Diffstat (limited to 'src/gallium/docs/build/html/cso')
-rw-r--r--src/gallium/docs/build/html/cso/blend.html2
-rw-r--r--src/gallium/docs/build/html/cso/dsa.html44
-rw-r--r--src/gallium/docs/build/html/cso/rasterizer.html81
-rw-r--r--src/gallium/docs/build/html/cso/sampler.html36
4 files changed, 157 insertions, 6 deletions
diff --git a/src/gallium/docs/build/html/cso/blend.html b/src/gallium/docs/build/html/cso/blend.html
index 360a0f2c03..5863cd4fba 100644
--- a/src/gallium/docs/build/html/cso/blend.html
+++ b/src/gallium/docs/build/html/cso/blend.html
@@ -54,7 +54,7 @@ buffers.</p>
<p>XXX it is unresolved what behavior should result if blend_enable is off.</p>
<div class="section" id="members">
<h2>Members<a class="headerlink" href="#members" title="Permalink to this headline">¶</a></h2>
-<p>XXX</p>
+<p>XXX undocumented members</p>
</div>
</div>
diff --git a/src/gallium/docs/build/html/cso/dsa.html b/src/gallium/docs/build/html/cso/dsa.html
index c35b946369..ec73a03e38 100644
--- a/src/gallium/docs/build/html/cso/dsa.html
+++ b/src/gallium/docs/build/html/cso/dsa.html
@@ -53,17 +53,55 @@
discard fragments that have passed through the fragment shader.</p>
<p>Traditionally, these three tests have been clumped together in hardware, so
they are all stored in one structure.</p>
+<p>During actual execution, the order of operations done on fragments is always:</p>
+<ul class="simple">
+<li>Stencil</li>
+<li>Depth</li>
+<li>Alpha</li>
+</ul>
<div class="section" id="depth-members">
<h2>Depth Members<a class="headerlink" href="#depth-members" title="Permalink to this headline">¶</a></h2>
-<p>XXX</p>
+<dl class="docutils">
+<dt>enabled</dt>
+<dd>Whether the depth test is enabled.</dd>
+<dt>writemask</dt>
+<dd>Whether the depth buffer receives depth writes.</dd>
+<dt>func</dt>
+<dd>The depth test function. One of PIPE_FUNC.</dd>
+</dl>
</div>
<div class="section" id="stencil-members">
<h2>Stencil Members<a class="headerlink" href="#stencil-members" title="Permalink to this headline">¶</a></h2>
-<p>XXX</p>
+<p>XXX document valuemask, writemask</p>
+<dl class="docutils">
+<dt>enabled</dt>
+<dd>Whether the stencil test is enabled. For the second stencil, whether the
+two-sided stencil is enabled.</dd>
+<dt>func</dt>
+<dd>The stencil test function. One of PIPE_FUNC.</dd>
+<dt>ref_value</dt>
+<dd>Stencil test reference value; used for certain functions.</dd>
+<dt>fail_op</dt>
+<dd>The operation to carry out if the stencil test fails. One of
+PIPE_STENCIL_OP.</dd>
+<dt>zfail_op</dt>
+<dd>The operation to carry out if the stencil test passes but the depth test
+fails. One of PIPE_STENCIL_OP.</dd>
+<dt>zpass_op</dt>
+<dd>The operation to carry out if the stencil test and depth test both pass.
+One of PIPE_STENCIL_OP.</dd>
+</dl>
</div>
<div class="section" id="alpha-members">
<h2>Alpha Members<a class="headerlink" href="#alpha-members" title="Permalink to this headline">¶</a></h2>
-<p>XXX</p>
+<dl class="docutils">
+<dt>enabled</dt>
+<dd>Whether the alpha test is enabled.</dd>
+<dt>func</dt>
+<dd>The alpha test function. One of PIPE_FUNC.</dd>
+<dt>ref_value</dt>
+<dd>Alpha test reference value; used for certain functions.</dd>
+</dl>
</div>
</div>
diff --git a/src/gallium/docs/build/html/cso/rasterizer.html b/src/gallium/docs/build/html/cso/rasterizer.html
index 12d9060e62..b8309247cc 100644
--- a/src/gallium/docs/build/html/cso/rasterizer.html
+++ b/src/gallium/docs/build/html/cso/rasterizer.html
@@ -53,7 +53,80 @@
interpolated into fragments.</p>
<div class="section" id="members">
<h2>Members<a class="headerlink" href="#members" title="Permalink to this headline">¶</a></h2>
-<p>XXX</p>
+<p>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</p>
+<dl class="docutils">
+<dt>flatshade</dt>
+<dd>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&#8217;s color.</dd>
+<dt>scissor</dt>
+<dd>Whether the scissor test is enabled.</dd>
+<dt>poly_stipple_enable</dt>
+<dd>Whether polygon stippling is enabled.</dd>
+<dt>point_smooth</dt>
+<dd>Whether points should be smoothed. Point smoothing turns rectangular
+points into circles or ovals.</dd>
+<dt>point_sprite</dt>
+<dd>Whether point sprites are enabled.</dd>
+<dt>point_size_per_vertex</dt>
+<dd>Whether vertices have a point size element.</dd>
+<dt>multisample</dt>
+<dd>Whether MSAA is enabled.</dd>
+<dt>line_smooth</dt>
+<dd>Whether lines should be smoothed. Line smoothing is simply anti-aliasing.</dd>
+<dt>line_stipple_enable</dt>
+<dd>Whether line stippling is enabled.</dd>
+<dt>line_stipple_pattern</dt>
+<dd>16-bit bitfield of on/off flags, used to pattern the line stipple.</dd>
+<dt>bypass_vs_clip_and_viewport</dt>
+<dd>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.</dd>
+<dt>flatshade_first</dt>
+<dd>Whether the first vertex should be the provoking vertex, for most
+primitives. If not set, the last vertex is the provoking vertex.</dd>
+<dt>gl_rasterization_rules</dt>
+<dd>Whether the rasterizer should use (0.5, 0.5) pixel centers. When not set,
+the rasterizer will use (0, 0) for pixel centers.</dd>
+<dt>line_width</dt>
+<dd>The width of lines.</dd>
+<dt>point_size</dt>
+<dd>The size of points, if not specified per-vertex.</dd>
+<dt>point_size_min</dt>
+<dd>The minimum size of points.</dd>
+<dt>point_size_max</dt>
+<dd>The maximum size of points.</dd>
+</dl>
+</div>
+<div class="section" id="notes">
+<h2>Notes<a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="flatshade">
+<h3>flatshade<a class="headerlink" href="#flatshade" title="Permalink to this headline">¶</a></h3>
+<p>The actual interpolated shading algorithm is obviously
+implementation-dependent, but will usually be Gourard for most hardware.</p>
+</div>
+<div class="section" id="bypass-vs-clip-and-viewport">
+<h3>bypass_vs_clip_and_viewport<a class="headerlink" href="#bypass-vs-clip-and-viewport" title="Permalink to this headline">¶</a></h3>
+<p>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.</p>
+</div>
+<div class="section" id="flatshade-first">
+<h3>flatshade_first<a class="headerlink" href="#flatshade-first" title="Permalink to this headline">¶</a></h3>
+<p>There are several important exceptions to the specification of this rule.</p>
+<ul class="simple">
+<li>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.</li>
+<li>PIPE_PRIMITIVE_QUAD, PIPE_PRIMITIVE_QUAD_STRIP: This option has no effect.</li>
+<li>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.</li>
+</ul>
+</div>
</div>
</div>
@@ -67,6 +140,12 @@ interpolated into fragments.</p>
<ul>
<li><a class="reference external" href="">Rasterizer</a><ul>
<li><a class="reference external" href="#members">Members</a></li>
+<li><a class="reference external" href="#notes">Notes</a><ul>
+<li><a class="reference external" href="#flatshade">flatshade</a></li>
+<li><a class="reference external" href="#bypass-vs-clip-and-viewport">bypass_vs_clip_and_viewport</a></li>
+<li><a class="reference external" href="#flatshade-first">flatshade_first</a></li>
+</ul>
+</li>
</ul>
</li>
</ul>
diff --git a/src/gallium/docs/build/html/cso/sampler.html b/src/gallium/docs/build/html/cso/sampler.html
index 57300a9ff1..79c1998e48 100644
--- a/src/gallium/docs/build/html/cso/sampler.html
+++ b/src/gallium/docs/build/html/cso/sampler.html
@@ -51,9 +51,43 @@
<h1>Sampler<a class="headerlink" href="#sampler" title="Permalink to this headline">¶</a></h1>
<p>Texture units have many options for selecting texels from loaded textures;
this state controls an individual texture unit&#8217;s texel-sampling settings.</p>
+<p>Texture coordinates are always treated as four-dimensional, and referred to
+with the traditional (S, T, R, Q) notation.</p>
<div class="section" id="members">
<h2>Members<a class="headerlink" href="#members" title="Permalink to this headline">¶</a></h2>
-<p>XXX</p>
+<p>XXX undocumented compare_mode, compare_func</p>
+<dl class="docutils">
+<dt>wrap_s</dt>
+<dd>How to wrap the S coordinate. One of PIPE_TEX_WRAP.</dd>
+<dt>wrap_t</dt>
+<dd>How to wrap the T coordinate. One of PIPE_TEX_WRAP.</dd>
+<dt>wrap_r</dt>
+<dd>How to wrap the R coordinate. One of PIPE_TEX_WRAP.</dd>
+<dt>min_img_filter</dt>
+<dd>The filter to use when minifying texels. One of PIPE_TEX_FILTER.</dd>
+<dt>min_mip_filter</dt>
+<dd>The filter to use when minifying mipmapped textures. One of
+PIPE_TEX_FILTER.</dd>
+<dt>mag_img_filter</dt>
+<dd>The filter to use when magnifying texels. One of PIPE_TEX_FILTER.</dd>
+<dt>normalized_coords</dt>
+<dd>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.</dd>
+<dt>prefilter</dt>
+<dd>XXX From the Doxy, &#8220;weird sampling state exposed by some APIs.&#8221; Refine.</dd>
+<dt>lod_bias</dt>
+<dd>The bias to apply to the level of detail.</dd>
+<dt>min_lod</dt>
+<dd>Minimum level of detail, used to clamp LoD after bias.</dd>
+<dt>max_lod</dt>
+<dd>Maximum level of detail, used to clamp LoD after bias.</dd>
+<dt>border_color</dt>
+<dd>RGBA color used for out-of-bounds coordinates.</dd>
+<dt>max_anisotropy</dt>
+<dd>Maximum filtering to apply anisotropically to textures. Setting this to
+1.0 effectively disables anisotropic filtering.</dd>
+</dl>
</div>
</div>