rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man4 / xhtml / glDepthRangeIndexed.xml
diff --git a/upstream-doc/man4/xhtml/glDepthRangeIndexed.xml b/upstream-doc/man4/xhtml/glDepthRangeIndexed.xml
new file mode 100644 (file)
index 0000000..552e8c9
--- /dev/null
@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
+<!-- saved from url=(0013)about:internet -->
+<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glDepthRangeIndexed - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glDepthRangeIndexed"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glDepthRangeIndexed — specify mapping of depth values from normalized device coordinates to window coordinates for a specified viewport</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glDepthRangeIndexed</b>(</code></td><td>GLuint  </td><td><var class="pdparam">index</var>, </td></tr><tr><td> </td><td>GLdouble  </td><td><var class="pdparam">nearVal</var>, </td></tr><tr><td> </td><td>GLdouble  </td><td><var class="pdparam">farVal</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>index</code></em></span></dt><dd><p>
+                    Specifies the index of the viewport whose depth range to update.
+                </p></dd><dt><span class="term"><em class="parameter"><code>nearVal</code></em></span></dt><dd><p>
+                    Specifies the mapping of the near clipping plane to window coordinates.
+                    The initial value is 0.
+                </p></dd><dt><span class="term"><em class="parameter"><code>farVal</code></em></span></dt><dd><p>
+                    Specifies the mapping of the far clipping plane to window coordinates.
+                    The initial value is 1.
+                </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
+            After clipping and division by <span class="emphasis"><em>w</em></span>,
+            depth coordinates range from 
+            <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+                
+                <mml:mn>-1</mml:mn>
+            </mml:math>
+            to 1,
+            corresponding to the near and far clipping planes.
+            Each viewport has an independent depth range specified as a linear mapping of the normalized
+            depth coordinates in this range to window depth coordinates.
+            Regardless of the actual depth buffer implementation,
+            window coordinate depth values are treated as though they range
+            from 0 through 1 (like color components).
+            <code class="function">glDepthRangeIndexed</code> specifies a linear mapping of the normalized depth coordinates
+            in this range to window depth coordinates for a specified viewport.
+            Thus,
+            the values accepted by <code class="function">glDepthRangeIndexed</code> are both clamped to this range
+            before they are accepted.
+        </p><p>
+            The <em class="parameter"><code>index</code></em> parameter specifies the index of first viewport whose depth
+            range to modify and must be less than the value of <code class="constant">GL_MAX_VIEWPORTS</code>.
+            <em class="parameter"><code>nearVal</code></em> and <em class="parameter"><code>farVal</code></em> specify near and far values of the
+            depth range for the specified viewport, respectively.
+        </p><p>
+            The setting of (0,1) maps the near plane to 0 and
+            the far plane to 1.
+            With this mapping,
+            the depth buffer range is fully utilized.
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
+            It is not necessary that the near plane distance be less than the far plane distance.
+            Reverse mappings such as 
+            <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+                
+                <mml:mrow>
+                    <mml:mi mathvariant="italic">nearVal</mml:mi>
+                    <mml:mo>=</mml:mo>
+                    <mml:mn>1</mml:mn>
+                </mml:mrow>
+            </mml:math>,
+            and 
+            <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
+                
+                <mml:mrow>
+                    <mml:mi mathvariant="italic">farVal</mml:mi>
+                    <mml:mo>=</mml:mo>
+                    <mml:mn>0</mml:mn>
+                </mml:mrow>
+            </mml:math>
+            are acceptable.
+        </p><p>
+            The type of the <em class="parameter"><code>nearVal</code></em> and
+            <em class="parameter"><code>farVal</code></em> parameters was changed from
+            GLclampd to GLdouble. This change is transparent to user
+            code and is described in detail on the
+            <a href="removedTypes.xml"><span class="citerefentry"><span class="refentrytitle">removedTypes</span></span></a>
+            page.
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
+            <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>index</code></em> is greater than or equal to
+            the value of <code class="constant">GL_MAX_VIEWPORTS</code>.
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
+            <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_DEPTH_RANGE</code>
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
+            <a href="glDepthFunc.xml"><span class="citerefentry"><span class="refentrytitle">glDepthFunc</span></span></a>,
+            <a href="glDepthRange.xml"><span class="citerefentry"><span class="refentrytitle">glDepthRange</span></span></a>,
+            <a href="glDepthRangeArray.xml"><span class="citerefentry"><span class="refentrytitle">glDepthRangeArray</span></span></a>,
+            <a href="glPolygonOffset.xml"><span class="citerefentry"><span class="refentrytitle">glPolygonOffset</span></span></a>,
+            <a href="glViewportArray.xml"><span class="citerefentry"><span class="refentrytitle">glViewportArray</span></span></a>,
+            <a href="glViewport.xml"><span class="citerefentry"><span class="refentrytitle">glViewport</span></span></a>,
+            <a href="removedTypes.xml"><span class="citerefentry"><span class="refentrytitle">removedTypes</span></span></a>
+        </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
+            Copyright <span class="trademark"></span>© 2010 Khronos Group. 
+            This material may be distributed subject to the terms and conditions set forth in 
+            the Open Publication License, v 1.0, 8 June 1999.
+            <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
+        </p></div></div></body></html>