upstream-man-pages/man4/xhtml/glDepthRangeArray.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   3 <!-- saved from url=(0013)about:internet -->
   4 <?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>glDepthRangeArray - 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="glDepthRangeArray"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glDepthRangeArray — specify mapping of depth values from normalized device coordinates to window coordinates for a specified set of viewports</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">glDepthRangeArrayv</b>(</code></td><td>GLuint  </td><td><var class="pdparam">first</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">count</var>, </td></tr><tr><td> </td><td>const GLdouble * </td><td><var class="pdparam">v</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>first</code></em></span></dt><dd><p>
   5                     Specifies the index of the first viewport whose depth range to update.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>count</code></em></span></dt><dd><p>
   7                     Specifies the number of viewports whose depth range to update.
   8                 </p></dd><dt><span class="term"><em class="parameter"><code>v</code></em></span></dt><dd><p>
   9                     Specifies the address of an array containing the near and far values for the
  10                     depth range of each modified viewport.
  11                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  12             After clipping and division by <span class="emphasis"><em>w</em></span>,
  13             depth coordinates range from
  14             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  15
  16                 <mml:mn>-1</mml:mn>
  17             </mml:math>
  18             to 1,
  19             corresponding to the near and far clipping planes.
  20             Each viewport has an independent depth range specified as a linear mapping of the normalized
  21             depth coordinates in this range to window depth coordinates.
  22             Regardless of the actual depth buffer implementation,
  23             window coordinate depth values are treated as though they range
  24             from 0 through 1 (like color components).
  25             <code class="function">glDepthRangeArray</code> specifies a linear mapping of the normalized depth coordinates
  26             in this range to window depth coordinates for each viewport in the range [<em class="parameter"><code>first</code></em>,
  27             <em class="parameter"><code>first</code></em> + <em class="parameter"><code>count</code></em>).
  28             Thus,
  29             the values accepted by <code class="function">glDepthRangeArray</code> are both clamped to this range
  30             before they are accepted.
  31         </p><p>
  32             The <em class="parameter"><code>first</code></em> parameter specifies the index of the first viewport whose depth
  33             range to modify and must be less than the value of <code class="constant">GL_MAX_VIEWPORTS</code>.
  34             <em class="parameter"><code>count</code></em> specifies the number of viewports whose depth range to modify.
  35             <em class="parameter"><code>first</code></em> + <em class="parameter"><code>count</code></em> must be less than or equal to
  36             the value of <code class="constant">GL_MAX_VIEWPORTS</code>. <em class="parameter"><code>v</code></em> specifies the address of an
  37             array of pairs of double precision floating point values representing the near and far values of the
  38             depth range for each viewport, in that order.
  39         </p><p>
  40             The setting of (0,1) maps the near plane to 0 and
  41             the far plane to 1.
  42             With this mapping,
  43             the depth buffer range is fully utilized.
  44         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  45             It is not necessary that the near plane distance be less than the far plane distance.
  46             Reverse mappings such as
  47             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  48
  49                 <mml:mrow>
  50                     <mml:mi mathvariant="italic">near</mml:mi>
  51                     <mml:mo>=</mml:mo>
  52                     <mml:mn>1</mml:mn>
  53                 </mml:mrow>
  54             </mml:math>,
  55             and
  56             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  57
  58                 <mml:mrow>
  59                     <mml:mi mathvariant="italic">far</mml:mi>
  60                     <mml:mo>=</mml:mo>
  61                     <mml:mn>0</mml:mn>
  62                 </mml:mrow>
  63             </mml:math>
  64             are acceptable.
  65         </p><p>
  66             The type of the <em class="parameter"><code>v</code></em> parameter was
  67             changed from GLclampd to GLdouble. This change is
  68             transparent to user code and is described in detail on the
  69             <a href="removedTypes.xml"><span class="citerefentry"><span class="refentrytitle">removedTypes</span></span></a>
  70             page.
  71         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  72             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>first</code></em> is greater than or equal to
  73             the value of <code class="constant">GL_MAX_VIEWPORTS</code>.
  74         </p><p>
  75             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>first</code></em> + <em class="parameter"><code>count</code></em>
  76             is greater than or equal to the value of <code class="constant">GL_MAX_VIEWPORTS</code>.
  77         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  78             <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_DEPTH_RANGE</code>
  79         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  80             <a href="glDepthFunc.xml"><span class="citerefentry"><span class="refentrytitle">glDepthFunc</span></span></a>,
  81             <a href="glDepthRange.xml"><span class="citerefentry"><span class="refentrytitle">glDepthRange</span></span></a>,
  82             <a href="glDepthRangeIndexed.xml"><span class="citerefentry"><span class="refentrytitle">glDepthRangeIndexed</span></span></a>,
  83             <a href="glPolygonOffset.xml"><span class="citerefentry"><span class="refentrytitle">glPolygonOffset</span></span></a>,
  84             <a href="glViewportArray.xml"><span class="citerefentry"><span class="refentrytitle">glViewportArray</span></span></a>,
  85             <a href="glViewport.xml"><span class="citerefentry"><span class="refentrytitle">glViewport</span></span></a>,
  86             <a href="removedTypes.xml"><span class="citerefentry"><span class="refentrytitle">removedTypes</span></span></a>
  87         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  88             Copyright <span class="trademark"></span>© 2010 Khronos Group.
  89             This material may be distributed subject to the terms and conditions set forth in
  90             the Open Publication License, v 1.0, 8 June 1999.
  91             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  92         </p></div></div></body></html>