forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glDepthRangeIndexed.xhtml
269 lines (265 loc) · 12.5 KB
/
glDepthRangeIndexed.xhtml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<div class="refentry" id="glDepthRangeIndexed">
<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 style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<tr>
<td>
<code class="funcdef">void <strong class="fsfunc">glDepthRangeIndexed</strong>(</code>
</td>
<td>GLuint <var class="pdparam">index</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLdouble <var class="pdparam">nearVal</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLdouble <var class="pdparam">farVal</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer"> </div>
</div>
</div>
<div class="refsect1" id="parameters">
<h2>Parameters</h2>
<div class="variablelist">
<dl class="variablelist">
<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" id="description">
<h2>Description</h2>
<p>
After clipping and division by <span class="emphasis"><em>w</em></span>,
depth coordinates range from
<math overflow="scroll">
<mn>-1</mn>
</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" id="notes">
<h2>Notes</h2>
<p>
It is not necessary that the near plane distance be less than the far plane distance.
Reverse mappings such as
<math overflow="scroll">
<mrow>
<mi mathvariant="italic">nearVal</mi>
<mo>=</mo>
<mn>1</mn>
</mrow>
</math>,
and
<math overflow="scroll">
<mrow>
<mi mathvariant="italic">farVal</mi>
<mo>=</mo>
<mn>0</mn>
</mrow>
</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 class="citerefentry" href="removedTypes"><span class="citerefentry"><span class="refentrytitle">removedTypes</span></span></a>
page.
</p>
</div>
<div class="refsect1" id="errors">
<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" id="associatedgets">
<h2>Associated Gets</h2>
<p>
<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_DEPTH_RANGE</code>
</p>
</div>
{$pipelinestall}{$examples}
<div class="refsect1" id="versions">
<h2>Version Support</h2>
<div class="informaltable">
<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
<colgroup>
<col style="text-align: left; "/>
<col style="text-align: center; " class="firstvers"/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; " class="lastvers"/>
</colgroup>
<thead>
<tr>
<th style="text-align: left; border-right: 2px solid ; ">
</th>
<th style="text-align: center; border-bottom: 2px solid ; " colspan="12">
<span class="bold"><strong>OpenGL Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function / Feature Name</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.4</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.5</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">
<code class="function">glDepthRangeIndexed</code>
</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; ">✔</td>
<td style="text-align: center; ">✔</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1" id="seealso">
<h2>See Also</h2>
<p>
<a class="citerefentry" href="glDepthFunc"><span class="citerefentry"><span class="refentrytitle">glDepthFunc</span></span></a>,
<a class="citerefentry" href="glDepthRange"><span class="citerefentry"><span class="refentrytitle">glDepthRange</span></span></a>,
<a class="citerefentry" href="glDepthRangeArray"><span class="citerefentry"><span class="refentrytitle">glDepthRangeArray</span></span></a>,
<a class="citerefentry" href="glPolygonOffset"><span class="citerefentry"><span class="refentrytitle">glPolygonOffset</span></span></a>,
<a class="citerefentry" href="glViewportArray"><span class="citerefentry"><span class="refentrytitle">glViewportArray</span></span></a>,
<a class="citerefentry" href="glViewport"><span class="citerefentry"><span class="refentrytitle">glViewport</span></span></a>,
<a class="citerefentry" href="removedTypes"><span class="citerefentry"><span class="refentrytitle">removedTypes</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright © 2010-2014 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 class="link" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.
</p>
</div>
</div>