More docs. Glossary.

This commit is contained in:
Corbin Simpson
2009-12-20 20:37:40 -08:00
parent f3347fe397
commit 9ddeab48c8
13 changed files with 174 additions and 26 deletions

View File

@@ -29,7 +29,7 @@ point_sprite
point_size_per_vertex point_size_per_vertex
Whether vertices have a point size element. Whether vertices have a point size element.
multisample multisample
Whether MSAA is enabled. Whether :ref:`MSAA` is enabled.
line_smooth line_smooth
Whether lines should be smoothed. Line smoothing is simply anti-aliasing. Whether lines should be smoothed. Line smoothing is simply anti-aliasing.
line_stipple_enable line_stipple_enable
@@ -77,10 +77,11 @@ flatshade_first
There are several important exceptions to the specification of this rule. There are several important exceptions to the specification of this rule.
* PIPE_PRIMITIVE_POLYGON: The provoking vertex is always the first vertex. * ``PIPE_PRIMITIVE_POLYGON``: The provoking vertex is always the first
If the caller wishes to change the provoking vertex, they merely need to vertex. If the caller wishes to change the provoking vertex, they merely
rotate the vertices themselves. need to rotate the vertices themselves.
* PIPE_PRIMITIVE_QUAD, PIPE_PRIMITIVE_QUAD_STRIP: This option has no effect. * ``PIPE_PRIMITIVE_QUAD``, ``PIPE_PRIMITIVE_QUAD_STRIP``: This option has no
* PIPE_PRIMITIVE_TRIANGLE_FAN: When set, the provoking vertex is the second effect; the provoking vertex is always the last vertex.
vertex, not the first. This permits each segment of the fan to have a * ``PIPE_PRIMITIVE_TRIANGLE_FAN``: When set, the provoking vertex is the
different color. second vertex, not the first. This permits each segment of the fan to have
a different color.

View File

@@ -0,0 +1,10 @@
Glossary
========
.. glossary::
:sorted:
MSAA
Multi-Sampled Anti-Aliasing. A basic anti-aliasing technique that takes
multiple samples of the depth buffer, and uses this information to
smooth the edges of polygons.

View File

@@ -16,6 +16,7 @@ Contents:
screen screen
context context
cso cso
glossary
Indices and tables Indices and tables
================== ==================

View File

@@ -73,7 +73,7 @@ points into circles or ovals.</dd>
<dt>point_size_per_vertex</dt> <dt>point_size_per_vertex</dt>
<dd>Whether vertices have a point size element.</dd> <dd>Whether vertices have a point size element.</dd>
<dt>multisample</dt> <dt>multisample</dt>
<dd>Whether MSAA is enabled.</dd> <dd>Whether <em class="xref">MSAA</em> is enabled.</dd>
<dt>line_smooth</dt> <dt>line_smooth</dt>
<dd>Whether lines should be smoothed. Line smoothing is simply anti-aliasing.</dd> <dd>Whether lines should be smoothed. Line smoothing is simply anti-aliasing.</dd>
<dt>line_stipple_enable</dt> <dt>line_stipple_enable</dt>
@@ -118,13 +118,14 @@ clip away vertices that are not visible.</p>
<h3>flatshade_first<a class="headerlink" href="#flatshade-first" title="Permalink to this headline"></a></h3> <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> <p>There are several important exceptions to the specification of this rule.</p>
<ul class="simple"> <ul class="simple">
<li>PIPE_PRIMITIVE_POLYGON: The provoking vertex is always the first vertex. <li><tt class="docutils literal"><span class="pre">PIPE_PRIMITIVE_POLYGON</span></tt>: The provoking vertex is always the first
If the caller wishes to change the provoking vertex, they merely need to vertex. If the caller wishes to change the provoking vertex, they merely
rotate the vertices themselves.</li> need to rotate the vertices themselves.</li>
<li>PIPE_PRIMITIVE_QUAD, PIPE_PRIMITIVE_QUAD_STRIP: This option has no effect.</li> <li><tt class="docutils literal"><span class="pre">PIPE_PRIMITIVE_QUAD</span></tt>, <tt class="docutils literal"><span class="pre">PIPE_PRIMITIVE_QUAD_STRIP</span></tt>: This option has no
<li>PIPE_PRIMITIVE_TRIANGLE_FAN: When set, the provoking vertex is the second effect; the provoking vertex is always the last vertex.</li>
vertex, not the first. This permits each segment of the fan to have a <li><tt class="docutils literal"><span class="pre">PIPE_PRIMITIVE_TRIANGLE_FAN</span></tt>: When set, the provoking vertex is the
different color.</li> second vertex, not the first. This permits each segment of the fan to have
a different color.</li>
</ul> </ul>
</div> </div>
</div> </div>

View File

@@ -21,6 +21,7 @@
<script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="Gallium v0.3 documentation" href="../index.html" /> <link rel="top" title="Gallium v0.3 documentation" href="../index.html" />
<link rel="up" title="CSO" href="../cso.html" /> <link rel="up" title="CSO" href="../cso.html" />
<link rel="next" title="Glossary" href="../glossary.html" />
<link rel="prev" title="Sampler" href="sampler.html" /> <link rel="prev" title="Sampler" href="sampler.html" />
</head> </head>
<body> <body>
@@ -30,6 +31,9 @@
<li class="right" style="margin-right: 10px"> <li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index" <a href="../genindex.html" title="General Index"
accesskey="I">index</a></li> accesskey="I">index</a></li>
<li class="right" >
<a href="../glossary.html" title="Glossary"
accesskey="N">next</a> |</li>
<li class="right" > <li class="right" >
<a href="sampler.html" title="Sampler" <a href="sampler.html" title="Sampler"
accesskey="P">previous</a> |</li> accesskey="P">previous</a> |</li>
@@ -72,6 +76,9 @@
<h4>Previous topic</h4> <h4>Previous topic</h4>
<p class="topless"><a href="sampler.html" <p class="topless"><a href="sampler.html"
title="previous chapter">Sampler</a></p> title="previous chapter">Sampler</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../glossary.html"
title="next chapter">Glossary</a></p>
<h3>This Page</h3> <h3>This Page</h3>
<ul class="this-page-menu"> <ul class="this-page-menu">
<li><a href="../_sources/cso/shader.txt" <li><a href="../_sources/cso/shader.txt"
@@ -100,6 +107,9 @@
<li class="right" style="margin-right: 10px"> <li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index" <a href="../genindex.html" title="General Index"
>index</a></li> >index</a></li>
<li class="right" >
<a href="../glossary.html" title="Glossary"
>next</a> |</li>
<li class="right" > <li class="right" >
<a href="sampler.html" title="Sampler" <a href="sampler.html" title="Sampler"
>previous</a> |</li> >previous</a> |</li>

View File

@@ -40,11 +40,18 @@
<h1 id="index">Index</h1> <h1 id="index">Index</h1>
<a href="#M"><strong>M</strong></a>
<hr /> <hr />
<h2 id="M">M</h2>
<table width="100%" class="indextable"><tr><td width="33%" valign="top">
<dl>
<dt><a href="glossary.html#term-msaa">MSAA</a></dt></dl></td><td width="33%" valign="top"><dl>
</dl></td></tr></table>
</div> </div>

View File

@@ -0,0 +1,102 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Glossary &mdash; Gallium v0.3 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.3',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Gallium v0.3 documentation" href="index.html" />
<link rel="prev" title="Shader" href="cso/shader.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="cso/shader.html" title="Shader"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Gallium v0.3 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="glossary">
<h1>Glossary<a class="headerlink" href="#glossary" title="Permalink to this headline"></a></h1>
<dl class="glossary docutils">
<dt id="term-msaa">MSAA</dt>
<dd>Multi-Sampled Anti-Aliasing. A basic anti-aliasing technique that takes
multiple samples of the depth buffer, and uses this information to
smooth the edges of polygons.</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="cso/shader.html"
title="previous chapter">Shader</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/glossary.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="cso/shader.html" title="Shader"
>previous</a> |</li>
<li><a href="index.html">Gallium v0.3 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2009, VMWare, X.org, Nouveau.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.3.
</div>
</body>
</html>

View File

@@ -66,6 +66,7 @@
<li class="toctree-l2"><a class="reference external" href="cso/shader.html">Shader</a></li> <li class="toctree-l2"><a class="reference external" href="cso/shader.html">Shader</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference external" href="glossary.html">Glossary</a></li>
</ul> </ul>
</div> </div>
<div class="section" id="indices-and-tables"> <div class="section" id="indices-and-tables">

File diff suppressed because one or more lines are too long

View File

@@ -83,6 +83,9 @@ exclude_trees = []
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'sphinx'
# The language for highlighting source code.
highlight_language = 'c'
# A list of ignored prefixes for module index sorting. # A list of ignored prefixes for module index sorting.
#modindex_common_prefix = [] #modindex_common_prefix = []

View File

@@ -29,7 +29,7 @@ point_sprite
point_size_per_vertex point_size_per_vertex
Whether vertices have a point size element. Whether vertices have a point size element.
multisample multisample
Whether MSAA is enabled. Whether :ref:`MSAA` is enabled.
line_smooth line_smooth
Whether lines should be smoothed. Line smoothing is simply anti-aliasing. Whether lines should be smoothed. Line smoothing is simply anti-aliasing.
line_stipple_enable line_stipple_enable
@@ -77,10 +77,11 @@ flatshade_first
There are several important exceptions to the specification of this rule. There are several important exceptions to the specification of this rule.
* PIPE_PRIMITIVE_POLYGON: The provoking vertex is always the first vertex. * ``PIPE_PRIMITIVE_POLYGON``: The provoking vertex is always the first
If the caller wishes to change the provoking vertex, they merely need to vertex. If the caller wishes to change the provoking vertex, they merely
rotate the vertices themselves. need to rotate the vertices themselves.
* PIPE_PRIMITIVE_QUAD, PIPE_PRIMITIVE_QUAD_STRIP: This option has no effect. * ``PIPE_PRIMITIVE_QUAD``, ``PIPE_PRIMITIVE_QUAD_STRIP``: This option has no
* PIPE_PRIMITIVE_TRIANGLE_FAN: When set, the provoking vertex is the second effect; the provoking vertex is always the last vertex.
vertex, not the first. This permits each segment of the fan to have a * ``PIPE_PRIMITIVE_TRIANGLE_FAN``: When set, the provoking vertex is the
different color. second vertex, not the first. This permits each segment of the fan to have
a different color.

View File

@@ -0,0 +1,10 @@
Glossary
========
.. glossary::
:sorted:
MSAA
Multi-Sampled Anti-Aliasing. A basic anti-aliasing technique that takes
multiple samples of the depth buffer, and uses this information to
smooth the edges of polygons.

View File

@@ -16,6 +16,7 @@ Contents:
screen screen
context context
cso cso
glossary
Indices and tables Indices and tables
================== ==================