update upstream sources
[clinton/guile-figl.git] / upstream-doc / man3 / xhtml / glGet.xml
CommitLineData
7faf1d71
AW
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>glGet - OpenGL 3.3 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="glGet"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGet — return the value or values of a selected parameter</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">glGetBooleanv</b>(</code></td><td>GLenum  </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLboolean *  </td><td><var class="pdparam">params</var><code>)</code>;</td></tr></table></div></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">glGetDoublev</b>(</code></td><td>GLenum  </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLdouble *  </td><td><var class="pdparam">params</var><code>)</code>;</td></tr></table></div></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">glGetFloatv</b>(</code></td><td>GLenum  </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLfloat *  </td><td><var class="pdparam">params</var><code>)</code>;</td></tr></table></div></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">glGetIntegerv</b>(</code></td><td>GLenum  </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLint *  </td><td><var class="pdparam">params</var><code>)</code>;</td></tr></table></div></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">glGetInteger64v</b>(</code></td><td>GLenum  </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLint64 *  </td><td><var class="pdparam">params</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>pname</code></em></span></dt><dd><p>
5 Specifies the parameter value to be returned.
6 The symbolic constants in the list below are accepted.
7 </p></dd><dt><span class="term"><em class="parameter"><code>params</code></em></span></dt><dd><p>
8 Returns the value or values of the specified parameter.
9 </p></dd></dl></div></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">glGetBooleani_v</b>(</code></td><td>GLenum  </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">index</var>, </td></tr><tr><td> </td><td>GLboolean *  </td><td><var class="pdparam">data</var><code>)</code>;</td></tr></table></div></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">glGetIntegeri_v</b>(</code></td><td>GLenum  </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">index</var>, </td></tr><tr><td> </td><td>GLint *  </td><td><var class="pdparam">data</var><code>)</code>;</td></tr></table></div></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">glGetInteger64i_v</b>(</code></td><td>GLenum  </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">index</var>, </td></tr><tr><td> </td><td>GLint64 *  </td><td><var class="pdparam">data</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters2"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p>
10 Specifies the parameter value to be returned.
11 The symbolic constants in the list below are accepted.
12 </p></dd><dt><span class="term"><em class="parameter"><code>index</code></em></span></dt><dd><p>
13 Specifies the index of the particular element being queried.
14 </p></dd><dt><span class="term"><em class="parameter"><code>data</code></em></span></dt><dd><p>
15 Returns the value or values of the specified parameter.
16 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
17 These four commands return values for simple state variables in GL.
18 <em class="parameter"><code>pname</code></em> is a symbolic constant indicating the state variable to be returned,
19 and <em class="parameter"><code>params</code></em> is a pointer to an array of the indicated type in
20 which to place the returned data.
21 </p><p>
22 Type conversion is performed if <em class="parameter"><code>params</code></em> has a different type than
23 the state variable value being requested.
24 If <code class="function">glGetBooleanv</code> is called,
25 a floating-point (or integer) value is converted to <code class="constant">GL_FALSE</code> if
26 and only if it is 0.0 (or 0).
27 Otherwise,
28 it is converted to <code class="constant">GL_TRUE</code>.
29 If <code class="function">glGetIntegerv</code> is called, boolean values are returned as
30 <code class="constant">GL_TRUE</code> or <code class="constant">GL_FALSE</code>, and most floating-point values are
31 rounded to the nearest integer value. Floating-point colors and
32 normals, however, are returned with a linear mapping that maps 1.0 to
33 the most positive representable integer value
34 and
35 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
36
37 <mml:mn>-1.0</mml:mn>
38 </mml:math>
39 to the most negative representable integer value.
40 If <code class="function">glGetFloatv</code> or <code class="function">glGetDoublev</code> is called,
41 boolean values are returned as <code class="constant">GL_TRUE</code> or <code class="constant">GL_FALSE</code>,
42 and integer values are converted to floating-point values.
43 </p><p>
44 The following symbolic constants are accepted by <em class="parameter"><code>pname</code></em>:
45 </p><div class="variablelist"><dl><dt><span class="term"><code class="constant">GL_ACTIVE_TEXTURE</code></span></dt><dd><p>
46 </p><p>
47 <em class="parameter"><code>params</code></em> returns a single value indicating the active multitexture unit.
48 The initial value is <code class="constant">GL_TEXTURE0</code>.
49 See <a href="glActiveTexture.xml"><span class="citerefentry"><span class="refentrytitle">glActiveTexture</span></span></a>.
50 </p></dd><dt><span class="term"><code class="constant">GL_ALIASED_LINE_WIDTH_RANGE</code></span></dt><dd><p>
51 </p><p>
52 <em class="parameter"><code>params</code></em> returns a pair of values indicating the range of
53 widths supported for aliased lines. See <a href="glLineWidth.xml"><span class="citerefentry"><span class="refentrytitle">glLineWidth</span></span></a>.
54 </p></dd><dt><span class="term"><code class="constant">GL_SMOOTH_LINE_WIDTH_RANGE</code></span></dt><dd><p>
55 </p><p>
56 <em class="parameter"><code>params</code></em> returns a pair of values indicating the range of
57 widths supported for smooth (antialiased) lines. See <a href="glLineWidth.xml"><span class="citerefentry"><span class="refentrytitle">glLineWidth</span></span></a>.
58 </p></dd><dt><span class="term"><code class="constant">GL_SMOOTH_LINE_WIDTH_GRANULARITY</code></span></dt><dd><p>
59 </p><p>
60 <em class="parameter"><code>params</code></em> returns a single value indicating the level of
61 quantization applied to smooth line width parameters.
62 </p></dd><dt><span class="term"><code class="constant">GL_ARRAY_BUFFER_BINDING</code></span></dt><dd><p>
63 </p><p>
64 <em class="parameter"><code>params</code></em> returns a single value, the name of the buffer object
65 currently bound to the target <code class="constant">GL_ARRAY_BUFFER</code>. If no buffer object
66 is bound to this target, 0 is returned. The initial value is 0.
67 See <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>.
68 </p></dd><dt><span class="term"><code class="constant">GL_BLEND</code></span></dt><dd><p>
69 </p><p>
70 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether blending is
71 enabled. The initial value is <code class="constant">GL_FALSE</code>.
72 See <a href="glBlendFunc.xml"><span class="citerefentry"><span class="refentrytitle">glBlendFunc</span></span></a>.
73 </p></dd><dt><span class="term"><code class="constant">GL_BLEND_COLOR</code></span></dt><dd><p>
74 </p><p>
75 <em class="parameter"><code>params</code></em> returns four values,
76 the red, green, blue, and alpha values which are the components of
77 the blend color.
78 See <a href="glBlendColor.xml"><span class="citerefentry"><span class="refentrytitle">glBlendColor</span></span></a>.
79 </p></dd><dt><span class="term"><code class="constant">GL_BLEND_DST_ALPHA</code></span></dt><dd><p>
80 </p><p>
81 <em class="parameter"><code>params</code></em> returns one value,
82 the symbolic constant identifying the alpha destination blend
83 function. The initial value is <code class="constant">GL_ZERO</code>.
84 See <a href="glBlendFunc.xml"><span class="citerefentry"><span class="refentrytitle">glBlendFunc</span></span></a> and <a href="glBlendFuncSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glBlendFuncSeparate</span></span></a>.
85 </p></dd><dt><span class="term"><code class="constant">GL_BLEND_DST_RGB</code></span></dt><dd><p>
86 </p><p>
87 <em class="parameter"><code>params</code></em> returns one value,
88 the symbolic constant identifying the RGB destination blend
89 function. The initial value is <code class="constant">GL_ZERO</code>.
90 See <a href="glBlendFunc.xml"><span class="citerefentry"><span class="refentrytitle">glBlendFunc</span></span></a> and <a href="glBlendFuncSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glBlendFuncSeparate</span></span></a>.
91 </p></dd><dt><span class="term"><code class="constant">GL_BLEND_EQUATION_RGB</code></span></dt><dd><p>
92 </p><p>
93 <em class="parameter"><code>params</code></em> returns one value, a symbolic constant indicating whether
94 the RGB blend equation is <code class="constant">GL_FUNC_ADD</code>, <code class="constant">GL_FUNC_SUBTRACT</code>,
95 <code class="constant">GL_FUNC_REVERSE_SUBTRACT</code>, <code class="constant">GL_MIN</code> or <code class="constant">GL_MAX</code>.
96 See <a href="glBlendEquationSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glBlendEquationSeparate</span></span></a>.
97 </p></dd><dt><span class="term"><code class="constant">GL_BLEND_EQUATION_ALPHA</code></span></dt><dd><p>
98 </p><p>
99 <em class="parameter"><code>params</code></em> returns one value, a symbolic constant indicating whether
100 the Alpha blend equation is <code class="constant">GL_FUNC_ADD</code>, <code class="constant">GL_FUNC_SUBTRACT</code>,
101 <code class="constant">GL_FUNC_REVERSE_SUBTRACT</code>, <code class="constant">GL_MIN</code> or <code class="constant">GL_MAX</code>.
102 See <a href="glBlendEquationSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glBlendEquationSeparate</span></span></a>.
103 </p></dd><dt><span class="term"><code class="constant">GL_BLEND_SRC_ALPHA</code></span></dt><dd><p>
104 </p><p>
105 <em class="parameter"><code>params</code></em> returns one value,
106 the symbolic constant identifying the alpha source blend function. The initial
107 value is <code class="constant">GL_ONE</code>.
108 See <a href="glBlendFunc.xml"><span class="citerefentry"><span class="refentrytitle">glBlendFunc</span></span></a> and <a href="glBlendFuncSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glBlendFuncSeparate</span></span></a>.
109 </p></dd><dt><span class="term"><code class="constant">GL_BLEND_SRC_RGB</code></span></dt><dd><p>
110 </p><p>
111 <em class="parameter"><code>params</code></em> returns one value,
112 the symbolic constant identifying the RGB source blend function. The initial
113 value is <code class="constant">GL_ONE</code>.
114 See <a href="glBlendFunc.xml"><span class="citerefentry"><span class="refentrytitle">glBlendFunc</span></span></a> and <a href="glBlendFuncSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glBlendFuncSeparate</span></span></a>.
115 </p></dd><dt><span class="term"><code class="constant">GL_COLOR_CLEAR_VALUE</code></span></dt><dd><p>
116 </p><p>
117 <em class="parameter"><code>params</code></em> returns four values:
118 the red, green, blue, and alpha values used to clear the color buffers.
119 Integer values,
120 if requested,
121 are linearly mapped from the internal floating-point representation such
122 that 1.0 returns the most positive representable integer value,
123 and
124 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
125
126 <mml:mn>-1.0</mml:mn>
127 </mml:math>
128 returns the most negative representable integer
129 value. The initial value is (0, 0, 0, 0).
130 See <a href="glClearColor.xml"><span class="citerefentry"><span class="refentrytitle">glClearColor</span></span></a>.
131 </p></dd><dt><span class="term"><code class="constant">GL_COLOR_LOGIC_OP</code></span></dt><dd><p>
132 </p><p>
133 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether a fragment's
134 RGBA color values are merged into the framebuffer using a logical
135 operation. The initial value is <code class="constant">GL_FALSE</code>.
136 See <a href="glLogicOp.xml"><span class="citerefentry"><span class="refentrytitle">glLogicOp</span></span></a>.
137 </p></dd><dt><span class="term"><code class="constant">GL_COLOR_WRITEMASK</code></span></dt><dd><p>
138 </p><p>
139 <em class="parameter"><code>params</code></em> returns four boolean values:
140 the red, green, blue, and alpha write enables for the color
141 buffers. The initial value is (<code class="constant">GL_TRUE</code>, <code class="constant">GL_TRUE</code>,
142 <code class="constant">GL_TRUE</code>, <code class="constant">GL_TRUE</code>).
143 See <a href="glColorMask.xml"><span class="citerefentry"><span class="refentrytitle">glColorMask</span></span></a>.
144 </p></dd><dt><span class="term"><code class="constant">GL_COMPRESSED_TEXTURE_FORMATS</code></span></dt><dd><p>
145 </p><p>
146 <em class="parameter"><code>params</code></em> returns a list of symbolic
147 constants of length <code class="constant">GL_NUM_COMPRESSED_TEXTURE_FORMATS</code>
148 indicating which compressed texture formats are available.
149 See <a href="glCompressedTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage2D</span></span></a>.
150 </p></dd><dt><span class="term"><code class="constant">GL_CULL_FACE</code></span></dt><dd><p>
151 </p><p>
152 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether polygon culling
153 is enabled. The initial value is <code class="constant">GL_FALSE</code>.
154 See <a href="glCullFace.xml"><span class="citerefentry"><span class="refentrytitle">glCullFace</span></span></a>.
155 </p></dd><dt><span class="term"><code class="constant">GL_CURRENT_PROGRAM</code></span></dt><dd><p>
156 </p><p>
157 <em class="parameter"><code>params</code></em> returns one value,
158 the name of the program object that is currently active, or 0 if no program object is active.
159 See <a href="glUseProgram.xml"><span class="citerefentry"><span class="refentrytitle">glUseProgram</span></span></a>.
160 </p></dd><dt><span class="term"><code class="constant">GL_DEPTH_CLEAR_VALUE</code></span></dt><dd><p>
161 </p><p>
162 <em class="parameter"><code>params</code></em> returns one value,
163 the value that is used to clear the depth buffer.
164 Integer values,
165 if requested,
166 are linearly mapped from the internal floating-point representation such
167 that 1.0 returns the most positive representable integer value,
168 and
169 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
170
171 <mml:mn>-1.0</mml:mn>
172 </mml:math>
173 returns the most negative representable integer
174 value. The initial value is 1.
175 See <a href="glClearDepth.xml"><span class="citerefentry"><span class="refentrytitle">glClearDepth</span></span></a>.
176 </p></dd><dt><span class="term"><code class="constant">GL_DEPTH_FUNC</code></span></dt><dd><p>
177 </p><p>
178 <em class="parameter"><code>params</code></em> returns one value,
179 the symbolic constant that indicates the depth comparison
180 function. The initial value is <code class="constant">GL_LESS</code>.
181 See <a href="glDepthFunc.xml"><span class="citerefentry"><span class="refentrytitle">glDepthFunc</span></span></a>.
182 </p></dd><dt><span class="term"><code class="constant">GL_DEPTH_RANGE</code></span></dt><dd><p>
183 </p><p>
184 <em class="parameter"><code>params</code></em> returns two values:
185 the near and far mapping limits for the depth buffer.
186 Integer values,
187 if requested,
188 are linearly mapped from the internal floating-point representation such
189 that 1.0 returns the most positive representable integer value,
190 and
191 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
192
193 <mml:mn>-1.0</mml:mn>
194 </mml:math>
195 returns the most negative representable integer
196 value. The initial value is (0, 1).
197 See <a href="glDepthRange.xml"><span class="citerefentry"><span class="refentrytitle">glDepthRange</span></span></a>.
198 </p></dd><dt><span class="term"><code class="constant">GL_DEPTH_TEST</code></span></dt><dd><p>
199 </p><p>
200 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether depth testing
201 of fragments is enabled. The initial value is <code class="constant">GL_FALSE</code>.
202 See <a href="glDepthFunc.xml"><span class="citerefentry"><span class="refentrytitle">glDepthFunc</span></span></a> and <a href="glDepthRange.xml"><span class="citerefentry"><span class="refentrytitle">glDepthRange</span></span></a>.
203 </p></dd><dt><span class="term"><code class="constant">GL_DEPTH_WRITEMASK</code></span></dt><dd><p>
204 </p><p>
205 <em class="parameter"><code>params</code></em> returns a single boolean value indicating if the depth buffer
206 is enabled for writing. The initial value is <code class="constant">GL_TRUE</code>.
207 See <a href="glDepthMask.xml"><span class="citerefentry"><span class="refentrytitle">glDepthMask</span></span></a>.
208 </p></dd><dt><span class="term"><code class="constant">GL_DITHER</code></span></dt><dd><p>
209 </p><p>
210 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether dithering of
211 fragment colors and indices is enabled. The initial value is <code class="constant">GL_TRUE</code>.
212 </p></dd><dt><span class="term"><code class="constant">GL_DOUBLEBUFFER</code></span></dt><dd><p>
213 </p><p>
214 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether double buffering
215 is supported.
216 </p></dd><dt><span class="term"><code class="constant">GL_DRAW_BUFFER</code></span></dt><dd><p>
217 </p><p>
218 <em class="parameter"><code>params</code></em> returns one value,
219 a symbolic constant indicating which buffers are being drawn to.
220 See <a href="glDrawBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glDrawBuffer</span></span></a>. The initial value is <code class="constant">GL_BACK</code> if there
221 are back buffers, otherwise it is <code class="constant">GL_FRONT</code>.
222 </p></dd><dt><span class="term"><code class="constant">GL_DRAW_BUFFER</code><span class="emphasis"><em>i</em></span></span></dt><dd><p>
223 </p><p>
224 <em class="parameter"><code>params</code></em> returns one value,
225 a symbolic constant indicating which buffers are being drawn to by the corresponding output color.
226 See <a href="glDrawBuffers.xml"><span class="citerefentry"><span class="refentrytitle">glDrawBuffers</span></span></a>.
227 The initial value of <code class="constant">GL_DRAW_BUFFER0</code> is <code class="constant">GL_BACK</code> if there
228 are back buffers, otherwise it is <code class="constant">GL_FRONT</code>. The
229 initial values of draw buffers for all other output colors is <code class="constant">GL_NONE</code>.
230 </p></dd><dt><span class="term"><code class="constant">GL_DRAW_FRAMEBUFFER_BINDING</code></span></dt><dd><p>
231 </p><p>
232 <em class="parameter"><code>params</code></em> returns one value,
233 the name of the framebuffer object currently bound to the <code class="constant">GL_DRAW_FRAMEBUFFER</code> target.
234 If the default framebuffer is bound, this value will be zero. The initial value is zero.
235 See <a href="glBindFramebuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindFramebuffer</span></span></a>.
236 </p></dd><dt><span class="term"><code class="constant">GL_READ_FRAMEBUFFER_BINDING</code></span></dt><dd><p>
237 </p><p>
238 <em class="parameter"><code>params</code></em> returns one value,
239 the name of the framebuffer object currently bound to the <code class="constant">GL_READ_FRAMEBUFFER</code> target.
240 If the default framebuffer is bound, this value will be zero. The initial value is zero.
241 See <a href="glBindFramebuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindFramebuffer</span></span></a>.
242 </p></dd><dt><span class="term"><code class="constant">GL_ELEMENT_ARRAY_BUFFER_BINDING</code></span></dt><dd><p>
243 </p><p>
244 <em class="parameter"><code>params</code></em> returns a single value, the name of the buffer object
245 currently bound to the target <code class="constant">GL_ELEMENT_ARRAY_BUFFER</code>. If no buffer object
246 is bound to this target, 0 is returned. The initial value is 0.
247 See <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>.
248 </p></dd><dt><span class="term"><code class="constant">GL_RENDERBUFFER_BINDING</code></span></dt><dd><p>
249 </p><p>
250 <em class="parameter"><code>params</code></em> returns a single value, the name of the renderbuffer object
251 currently bound to the target <code class="constant">GL_RENDERBUFFER</code>. If no renderbuffer object
252 is bound to this target, 0 is returned. The initial value is 0.
253 See <a href="glBindRenderbuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindRenderbuffer</span></span></a>.
254 </p></dd><dt><span class="term"><code class="constant">GL_FRAGMENT_SHADER_DERIVATIVE_HINT</code></span></dt><dd><p>
255 </p><p>
256 <em class="parameter"><code>params</code></em> returns one value,
257 a symbolic constant indicating the mode of the derivative accuracy hint
258 for fragment shaders. The initial value
259 is <code class="constant">GL_DONT_CARE</code>.
260 See <a href="glHint.xml"><span class="citerefentry"><span class="refentrytitle">glHint</span></span></a>.
261 </p></dd><dt><span class="term"><code class="constant">GL_LINE_SMOOTH</code></span></dt><dd><p>
262 </p><p>
263 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether antialiasing of
264 lines is enabled. The initial value is <code class="constant">GL_FALSE</code>.
265 See <a href="glLineWidth.xml"><span class="citerefentry"><span class="refentrytitle">glLineWidth</span></span></a>.
266 </p></dd><dt><span class="term"><code class="constant">GL_LINE_SMOOTH_HINT</code></span></dt><dd><p>
267 </p><p>
268 <em class="parameter"><code>params</code></em> returns one value,
269 a symbolic constant indicating the mode of the line antialiasing
270 hint. The initial value is <code class="constant">GL_DONT_CARE</code>.
271 See <a href="glHint.xml"><span class="citerefentry"><span class="refentrytitle">glHint</span></span></a>.
272 </p></dd><dt><span class="term"><code class="constant">GL_LINE_WIDTH</code></span></dt><dd><p>
273 </p><p>
274 <em class="parameter"><code>params</code></em> returns one value,
275 the line width as specified with <a href="glLineWidth.xml"><span class="citerefentry"><span class="refentrytitle">glLineWidth</span></span></a>. The initial value is
276 1.
7faf1d71
AW
277 </p></dd><dt><span class="term"><code class="constant">GL_LOGIC_OP_MODE</code></span></dt><dd><p>
278 </p><p>
279 <em class="parameter"><code>params</code></em> returns one value,
280 a symbolic constant indicating the selected logic operation
281 mode. The initial value is <code class="constant">GL_COPY</code>.
282 See <a href="glLogicOp.xml"><span class="citerefentry"><span class="refentrytitle">glLogicOp</span></span></a>.
283 </p></dd><dt><span class="term"><code class="constant">GL_MAX_3D_TEXTURE_SIZE</code></span></dt><dd><p>
284 </p><p>
285 <em class="parameter"><code>params</code></em> returns one value,
286 a rough estimate of the largest 3D texture that the GL can handle.
287 The value must be at least 64.
288 Use <code class="constant">GL_PROXY_TEXTURE_3D</code> to determine if a texture is too large.
289 See <a href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>.
290 </p></dd><dt><span class="term"><code class="constant">GL_MAX_CLIP_DISTANCES</code></span></dt><dd><p>
291 </p><p>
292 <em class="parameter"><code>params</code></em> returns one value,
293 the maximum number of application-defined clipping distances. The value must be at least 8.
294 </p></dd><dt><span class="term"><code class="constant">GL_MAX_COMBINED_FRAGMENT_UNIFORM_COMPONENTS</code></span></dt><dd><p>
295 </p><p>
296 <em class="parameter"><code>params</code></em> returns one value,
297 the number of words for fragment shader uniform variables in all uniform
298 blocks (including default). The value must be at least 1.
299 See <a href="glUniform.xml"><span class="citerefentry"><span class="refentrytitle">glUniform</span></span></a>.
300 </p></dd><dt><span class="term"><code class="constant">GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS</code></span></dt><dd><p>
301 </p><p>
302 <em class="parameter"><code>params</code></em> returns one value, the maximum supported texture image units that
303 can be used to access texture maps from the vertex shader and the fragment processor combined.
304 If both the vertex shader and the fragment processing stage access the same texture image
305 unit, then that counts as using two texture image units against this limit.
306 The value must be at least 48.
307 See <a href="glActiveTexture.xml"><span class="citerefentry"><span class="refentrytitle">glActiveTexture</span></span></a>.
308 </p></dd><dt><span class="term"><code class="constant">GL_MAX_COMBINED_VERTEX_UNIFORM_COMPONENTS</code></span></dt><dd><p>
309 </p><p>
310 <em class="parameter"><code>params</code></em> returns one value,
311 the number of words for vertex shader uniform variables in all uniform
312 blocks (including default). The value must be at least 1.
313 See <a href="glUniform.xml"><span class="citerefentry"><span class="refentrytitle">glUniform</span></span></a>.
314 </p></dd><dt><span class="term"><code class="constant">GL_MAX_COMBINED_GEOMETRY_UNIFORM_COMPONENTS</code></span></dt><dd><p>
315 </p><p>
316 <em class="parameter"><code>params</code></em> returns one value,
317 the number of words for geometry shader uniform variables in all uniform
318 blocks (including default). The value must be at least 1.
319 See <a href="glUniform.xml"><span class="citerefentry"><span class="refentrytitle">glUniform</span></span></a>.
320 </p></dd><dt><span class="term"><code class="constant">GL_MAX_VARYING_COMPONENTS</code></span></dt><dd><p>
321 </p><p>
322 <em class="parameter"><code>params</code></em> returns one value,
323 the number components for varying variables, which must be at least 60.
324 </p></dd><dt><span class="term"><code class="constant">GL_MAX_COMBINED_UNIFORM_BLOCKS</code></span></dt><dd><p>
325 </p><p>
326 <em class="parameter"><code>params</code></em> returns one value,
327 the maximum number of uniform blocks per program. The value must be at least 36.
328 See <a href="glUniformBlockBinding.xml"><span class="citerefentry"><span class="refentrytitle">glUniformBlockBinding</span></span></a>.
329 </p></dd><dt><span class="term"><code class="constant">GL_MAX_CUBE_MAP_TEXTURE_SIZE</code></span></dt><dd><p>
330 </p><p>
331 <em class="parameter"><code>params</code></em> returns one value.
332 The value gives a rough estimate of the largest cube-map texture that
333 the GL can handle. The value must be at least 1024.
334 Use <code class="constant">GL_PROXY_TEXTURE_CUBE_MAP</code>
335 to determine if a texture is too large.
336 See <a href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>.
337 </p></dd><dt><span class="term"><code class="constant">GL_MAX_DRAW_BUFFERS</code></span></dt><dd><p>
338 </p><p>
339 <em class="parameter"><code>params</code></em> returns one value, the maximum number
340 of simultaneous outputs that may be written in a fragment shader.
341 The value must be at least 8.
342 See <a href="glDrawBuffers.xml"><span class="citerefentry"><span class="refentrytitle">glDrawBuffers</span></span></a>.
c7b31271 343 </p></dd><dt><span class="term"><code class="constant">GL_MAX_DUAL_SOURCE_DRAW_BUFFERS</code></span></dt><dd><p>
7faf1d71
AW
344 </p><p>
345 <em class="parameter"><code>params</code></em> returns one value, the maximum number
346 of active draw buffers when using dual-source blending. The value must be at least 1.
347 See <a href="glBlendFunc.xml"><span class="citerefentry"><span class="refentrytitle">glBlendFunc</span></span></a> and
348 <a href="glBlendFuncSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glBlendFuncSeparate</span></span></a>.
349 </p></dd><dt><span class="term"><code class="constant">GL_MAX_ELEMENTS_INDICES</code></span></dt><dd><p>
350 </p><p>
351 <em class="parameter"><code>params</code></em> returns one value,
352 the recommended maximum number of vertex array indices.
353 See <a href="glDrawRangeElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>.
354 </p></dd><dt><span class="term"><code class="constant">GL_MAX_ELEMENTS_VERTICES</code></span></dt><dd><p>
355 </p><p>
356 <em class="parameter"><code>params</code></em> returns one value,
357 the recommended maximum number of vertex array vertices.
358 See <a href="glDrawRangeElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>.
359 </p></dd><dt><span class="term"><code class="constant">GL_MAX_FRAGMENT_UNIFORM_COMPONENTS</code></span></dt><dd><p>
360 </p><p>
361 <em class="parameter"><code>params</code></em> returns one value,
362 the maximum number of individual floating-point, integer, or boolean values that can be held
363 in uniform variable storage for a fragment shader. The value must be at least 1024.
364 See <a href="glUniform.xml"><span class="citerefentry"><span class="refentrytitle">glUniform</span></span></a>.
365 </p></dd><dt><span class="term"><code class="constant">GL_MAX_FRAGMENT_UNIFORM_BLOCKS</code></span></dt><dd><p>
366 </p><p>
367 <em class="parameter"><code>params</code></em> returns one value,
368 the maximum number of uniform blocks per fragment shader. The value must be at least 12.
369 See <a href="glUniformBlockBinding.xml"><span class="citerefentry"><span class="refentrytitle">glUniformBlockBinding</span></span></a>.
370 </p></dd><dt><span class="term"><code class="constant">GL_MAX_FRAGMENT_INPUT_COMPONENTS</code></span></dt><dd><p>
371 </p><p>
372 <em class="parameter"><code>params</code></em> returns one value,
373 the maximum number of components of the inputs read by the fragment shader, which must be at least 128.
374 </p></dd><dt><span class="term"><code class="constant">GL_MIN_PROGRAM_TEXEL_OFFSET</code></span></dt><dd><p>
375 </p><p>
376 <em class="parameter"><code>params</code></em> returns one value,
377 the minimum texel offset allowed in a texture lookup, which must be at most -8.
378 </p></dd><dt><span class="term"><code class="constant">GL_MAX_PROGRAM_TEXEL_OFFSET</code></span></dt><dd><p>
379 </p><p>
380 <em class="parameter"><code>params</code></em> returns one value,
381 the maximum texel offset allowed in a texture lookup, which must be at least 7.
382 </p></dd><dt><span class="term"><code class="constant">GL_MAX_RECTANGLE_TEXTURE_SIZE</code></span></dt><dd><p>
383 </p><p>
384 <em class="parameter"><code>params</code></em> returns one value.
385 The value gives a rough estimate of the largest rectangular texture that
386 the GL can handle. The value must be at least 1024.
c7b31271 387 Use <code class="constant">GL_PROXY_TEXTURE_RECTANGLE</code>
7faf1d71
AW
388 to determine if a texture is too large.
389 See <a href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>.
390 </p></dd><dt><span class="term"><code class="constant">GL_MAX_TEXTURE_IMAGE_UNITS</code></span></dt><dd><p>
391 </p><p>
392 <em class="parameter"><code>params</code></em> returns one value, the maximum supported texture image units that
393 can be used to access texture maps from the fragment shader.
394 The value must be at least 16.
395 See <a href="glActiveTexture.xml"><span class="citerefentry"><span class="refentrytitle">glActiveTexture</span></span></a>.
396 </p></dd><dt><span class="term"><code class="constant">GL_MAX_TEXTURE_LOD_BIAS</code></span></dt><dd><p>
397 </p><p>
398 <em class="parameter"><code>params</code></em> returns one value,
399 the maximum, absolute value of the texture level-of-detail bias. The
400 value must be at least 2.0.
401 </p></dd><dt><span class="term"><code class="constant">GL_MAX_TEXTURE_SIZE</code></span></dt><dd><p>
402 </p><p>
403 <em class="parameter"><code>params</code></em> returns one value.
404 The value gives a rough estimate of the largest texture that
405 the GL can handle. The value must be at least 1024.
406 Use a proxy texture target such as <code class="constant">GL_PROXY_TEXTURE_1D</code> or <code class="constant">GL_PROXY_TEXTURE_2D</code>
407 to determine if a texture is too large.
408 See <a href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a> and <a href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>.
409 </p></dd><dt><span class="term"><code class="constant">GL_MAX_RENDERBUFFER_SIZE</code></span></dt><dd><p>
410 </p><p>
411 <em class="parameter"><code>params</code></em> returns one value.
412 The value indicates the maximum supported size for renderbuffers.
413 See <a href="glFramebufferRenderbuffer.xml"><span class="citerefentry"><span class="refentrytitle">glFramebufferRenderbuffer</span></span></a>.
414 </p></dd><dt><span class="term"><code class="constant">GL_MAX_ARRAY_TEXTURE_LAYERS</code></span></dt><dd><p>
415 </p><p>
416 <em class="parameter"><code>params</code></em> returns one value.
417 The value indicates the maximum number of layers allowed in an array texture, and must be at least 256.
418 See <a href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>.
419 </p></dd><dt><span class="term"><code class="constant">GL_MAX_TEXTURE_BUFFER_SIZE</code></span></dt><dd><p>
420 </p><p>
421 <em class="parameter"><code>params</code></em> returns one value.
422 The value gives the maximum number of texels allowed in the texel array of a texture buffer object.
423 Value must be at least 65536.
424 </p></dd><dt><span class="term"><code class="constant">GL_MAX_UNIFORM_BLOCK_SIZE</code></span></dt><dd><p>
425 </p><p>
426 <em class="parameter"><code>params</code></em> returns one value,
427 the maximum size in basic machine units of a uniform block.
428 The value must be at least 16384.
429 See <a href="glUniformBlockBinding.xml"><span class="citerefentry"><span class="refentrytitle">glUniformBlockBinding</span></span></a>.
430 </p></dd><dt><span class="term"><code class="constant">GL_MAX_VARYING_FLOATS</code></span></dt><dd><p>
431 </p><p>
432 <em class="parameter"><code>params</code></em> returns one value,
433 the maximum number of interpolators available for processing varying variables used by
434 vertex and fragment shaders. This value represents the number of individual floating-point
435 values that can be interpolated; varying variables declared as vectors, matrices, and arrays
436 will all consume multiple interpolators. The value must be at least 32.
437 </p></dd><dt><span class="term"><code class="constant">GL_MAX_VERTEX_ATTRIBS</code></span></dt><dd><p>
438 </p><p>
439 <em class="parameter"><code>params</code></em> returns one value,
440 the maximum number of 4-component generic vertex attributes accessible to a vertex shader.
441 The value must be at least 16.
442 See <a href="glVertexAttrib.xml"><span class="citerefentry"><span class="refentrytitle">glVertexAttrib</span></span></a>.
443 </p></dd><dt><span class="term"><code class="constant">GL_MAX_VERTEX_TEXTURE_IMAGE_UNITS</code></span></dt><dd><p>
444 </p><p>
445 <em class="parameter"><code>params</code></em> returns one value, the maximum supported texture image units that
446 can be used to access texture maps from the vertex shader. The value may be at least 16.
447 See <a href="glActiveTexture.xml"><span class="citerefentry"><span class="refentrytitle">glActiveTexture</span></span></a>.
448 </p></dd><dt><span class="term"><code class="constant">GL_MAX_GEOMETRY_TEXTURE_IMAGE_UNITS</code></span></dt><dd><p>
449 </p><p>
450 <em class="parameter"><code>params</code></em> returns one value, the maximum supported texture image units that
451 can be used to access texture maps from the geometry shader. The value must be at least 16.
452 See <a href="glActiveTexture.xml"><span class="citerefentry"><span class="refentrytitle">glActiveTexture</span></span></a>.
453 </p></dd><dt><span class="term"><code class="constant">GL_MAX_VERTEX_UNIFORM_COMPONENTS</code></span></dt><dd><p>
454 </p><p>
455 <em class="parameter"><code>params</code></em> returns one value,
456 the maximum number of individual floating-point, integer, or boolean values that can be held
457 in uniform variable storage for a vertex shader. The value must be at least 1024.
458 See <a href="glUniform.xml"><span class="citerefentry"><span class="refentrytitle">glUniform</span></span></a>.
459 </p></dd><dt><span class="term"><code class="constant">GL_MAX_VERTEX_OUTPUT_COMPONENTS</code></span></dt><dd><p>
460 </p><p>
461 <em class="parameter"><code>params</code></em> returns one value,
462 the maximum number of components of output written by a vertex shader, which must be at least 64.
463 </p></dd><dt><span class="term"><code class="constant">GL_MAX_GEOMETRY_UNIFORM_COMPONENTS</code></span></dt><dd><p>
464 </p><p>
465 <em class="parameter"><code>params</code></em> returns one value,
466 the maximum number of individual floating-point, integer, or boolean values that can be held
467 in uniform variable storage for a geometry shader. The value must be at least 1024.
468 See <a href="glUniform.xml"><span class="citerefentry"><span class="refentrytitle">glUniform</span></span></a>.
469 </p></dd><dt><span class="term"><code class="constant">GL_MAX_SAMPLE_MASK_WORDS</code></span></dt><dd><p>
470 </p><p>
471 <em class="parameter"><code>params</code></em> returns one value,
472 the maximum number of sample mask words.
473 </p></dd><dt><span class="term"><code class="constant">GL_MAX_COLOR_TEXTURE_SAMPLES</code></span></dt><dd><p>
474 </p><p>
475 <em class="parameter"><code>params</code></em> returns one value,
476 the maximum number of samples in a color multisample texture.
477 </p></dd><dt><span class="term"><code class="constant">GL_MAX_DEPTH_TEXTURE_SAMPLES</code></span></dt><dd><p>
478 </p><p>
479 <em class="parameter"><code>params</code></em> returns one value,
480 the maximum number of samples in a multisample depth or depth-stencil texture.
481 </p></dd><dt><span class="term"><code class="constant">GL_MAX_DEPTH_TEXTURE_SAMPLES</code></span></dt><dd><p>
482 </p><p>
483 <em class="parameter"><code>params</code></em> returns one value,
484 the maximum number of samples in a multisample depth or depth-stencil texture.
485 </p></dd><dt><span class="term"><code class="constant">GL_MAX_INTEGER_SAMPLES</code></span></dt><dd><p>
486 </p><p>
487 <em class="parameter"><code>params</code></em> returns one value,
488 the maximum number of samples supported in integer format multisample buffers.
489 </p></dd><dt><span class="term"><code class="constant">GL_MAX_SERVER_WAIT_TIMEOUT</code></span></dt><dd><p>
490 </p><p>
491 <em class="parameter"><code>params</code></em> returns one value,
492 the maximum <a href="glWaitSync.xml"><span class="citerefentry"><span class="refentrytitle">glWaitSync</span></span></a> timeout interval.
493 </p></dd><dt><span class="term"><code class="constant">GL_MAX_UNIFORM_BUFFER_BINDINGS</code></span></dt><dd><p>
494 </p><p>
495 <em class="parameter"><code>params</code></em> returns one value,
496 the maximum number of uniform buffer binding points on the context, which must be at least 36.
497 </p></dd><dt><span class="term"><code class="constant">GL_MAX_UNIFORM_BLOCK_SIZE</code></span></dt><dd><p>
498 </p><p>
499 <em class="parameter"><code>params</code></em> returns one value,
500 the maximum size in basic machine units of a uniform block, which must be at least 16384.
501 </p></dd><dt><span class="term"><code class="constant">GL_UNIFORM_BUFFER_OFFSET_ALIGNMENT</code></span></dt><dd><p>
502 </p><p>
503 <em class="parameter"><code>params</code></em> returns one value,
504 the minimum required alignment for uniform buffer sizes and offsets.
505 </p></dd><dt><span class="term"><code class="constant">GL_MAX_VERTEX_UNIFORM_BLOCKS</code></span></dt><dd><p>
506 </p><p>
507 <em class="parameter"><code>params</code></em> returns one value,
508 the maximum number of uniform blocks per vertex shader. The value must be at least 12.
509 See <a href="glUniformBlockBinding.xml"><span class="citerefentry"><span class="refentrytitle">glUniformBlockBinding</span></span></a>.
510 </p></dd><dt><span class="term"><code class="constant">GL_MAX_GEOMETRY_UNIFORM_BLOCKS</code></span></dt><dd><p>
511 </p><p>
512 <em class="parameter"><code>params</code></em> returns one value,
513 the maximum number of uniform blocks per geometry shader. The value must be at least 12.
514 See <a href="glUniformBlockBinding.xml"><span class="citerefentry"><span class="refentrytitle">glUniformBlockBinding</span></span></a>.
515 </p></dd><dt><span class="term"><code class="constant">GL_MAX_GEOMETRY_INPUT_COMPONENTS</code></span></dt><dd><p>
516 </p><p>
517 <em class="parameter"><code>params</code></em> returns one value,
518 the maximum number of components of inputs read by a geometry shader, which must be at least 64.
519 </p></dd><dt><span class="term"><code class="constant">GL_MAX_GEOMETRY_OUTPUT_COMPONENTS</code></span></dt><dd><p>
520 </p><p>
521 <em class="parameter"><code>params</code></em> returns one value,
522 the maximum number of components of outputs written by a geometry shader, which must be at least 128.
523 </p></dd><dt><span class="term"><code class="constant">GL_MAX_VIEWPORT_DIMS</code></span></dt><dd><p>
524 </p><p>
525 <em class="parameter"><code>params</code></em> returns two values:
526 the maximum supported width and height of the viewport.
527 These must be at least as large as the visible dimensions of the display
528 being rendered to.
529 See <a href="glViewport.xml"><span class="citerefentry"><span class="refentrytitle">glViewport</span></span></a>.
530 </p></dd><dt><span class="term"><code class="constant">GL_NUM_COMPRESSED_TEXTURE_FORMATS</code></span></dt><dd><p>
531 </p><p>
532 <em class="parameter"><code>params</code></em> returns a single integer value indicating the number of available
533 compressed texture formats. The minimum value is 4.
534 See <a href="glCompressedTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage2D</span></span></a>.
535 </p></dd><dt><span class="term"><code class="constant">GL_PACK_ALIGNMENT</code></span></dt><dd><p>
536 </p><p>
537 <em class="parameter"><code>params</code></em> returns one value,
538 the byte alignment used for writing pixel data to memory. The initial
539 value is 4.
540 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
541 </p></dd><dt><span class="term"><code class="constant">GL_PACK_IMAGE_HEIGHT</code></span></dt><dd><p>
542 </p><p>
543 <em class="parameter"><code>params</code></em> returns one value,
544 the image height used for writing pixel data to memory. The initial
545 value is 0.
546 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
547 </p></dd><dt><span class="term"><code class="constant">GL_PACK_LSB_FIRST</code></span></dt><dd><p>
548 </p><p>
549 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether single-bit
550 pixels being written to memory are written first to the least significant
551 bit of each unsigned byte. The initial value is <code class="constant">GL_FALSE</code>.
552 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
553 </p></dd><dt><span class="term"><code class="constant">GL_PACK_ROW_LENGTH</code></span></dt><dd><p>
554 </p><p>
555 <em class="parameter"><code>params</code></em> returns one value,
556 the row length used for writing pixel data to memory. The initial value is
557 0.
558 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
559 </p></dd><dt><span class="term"><code class="constant">GL_PACK_SKIP_IMAGES</code></span></dt><dd><p>
560 </p><p>
561 <em class="parameter"><code>params</code></em> returns one value,
562 the number of pixel images skipped before the first pixel is written
563 into memory. The initial value is 0.
564 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
565 </p></dd><dt><span class="term"><code class="constant">GL_PACK_SKIP_PIXELS</code></span></dt><dd><p>
566 </p><p>
567 <em class="parameter"><code>params</code></em> returns one value,
568 the number of pixel locations skipped before the first pixel is written
569 into memory. The initial value is 0.
570 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
571 </p></dd><dt><span class="term"><code class="constant">GL_PACK_SKIP_ROWS</code></span></dt><dd><p>
572 </p><p>
573 <em class="parameter"><code>params</code></em> returns one value,
574 the number of rows of pixel locations skipped before the first pixel is written
575 into memory. The initial value is 0.
576 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
577 </p></dd><dt><span class="term"><code class="constant">GL_PACK_SWAP_BYTES</code></span></dt><dd><p>
578 </p><p>
579 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether the bytes of
580 two-byte and four-byte pixel indices and components are swapped before being
581 written to memory. The initial value is <code class="constant">GL_FALSE</code>.
582 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
583 </p></dd><dt><span class="term"><code class="constant">GL_PIXEL_PACK_BUFFER_BINDING</code></span></dt><dd><p>
584 </p><p>
585 <em class="parameter"><code>params</code></em> returns a single value, the name of the buffer object
586 currently bound to the target <code class="constant">GL_PIXEL_PACK_BUFFER</code>. If no buffer object
587 is bound to this target, 0 is returned. The initial value is 0.
588 See <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>.
589 </p></dd><dt><span class="term"><code class="constant">GL_PIXEL_UNPACK_BUFFER_BINDING</code></span></dt><dd><p>
590 </p><p>
591 <em class="parameter"><code>params</code></em> returns a single value, the name of the buffer object
592 currently bound to the target <code class="constant">GL_PIXEL_UNPACK_BUFFER</code>. If no buffer object
593 is bound to this target, 0 is returned. The initial value is 0.
594 See <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>.
595 </p></dd><dt><span class="term"><code class="constant">GL_POINT_FADE_THRESHOLD_SIZE</code></span></dt><dd><p>
596 </p><p>
597 <em class="parameter"><code>params</code></em> returns one value,
598 the point size threshold for determining the point size.
599 See <a href="glPointParameter.xml"><span class="citerefentry"><span class="refentrytitle">glPointParameter</span></span></a>.
600 </p></dd><dt><span class="term"><code class="constant">GL_PRIMITIVE_RESTART_INDEX</code></span></dt><dd><p>
601 </p><p>
602 <em class="parameter"><code>params</code></em> returns one value,
603 the current primitive restart index. The initial value is 0.
604 See <a href="glPrimitiveRestartIndex.xml"><span class="citerefentry"><span class="refentrytitle">glPrimitiveRestartIndex</span></span></a>.
c7b31271
DH
605 </p></dd><dt><span class="term"><code class="constant">GL_PROGRAM_POINT_SIZE</code></span></dt><dd><p>
606 </p><p>
607 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether vertex
608 program point size mode is enabled. If enabled, then the
609 point size is taken from the shader built-in <code class="code">gl_PointSize</code>. If disabled,
610 then the point size is taken from the point state as specified
611 by <a href="glPointSize.xml"><span class="citerefentry"><span class="refentrytitle">glPointSize</span></span></a>.
612 The initial value is <code class="constant">GL_FALSE</code>.
7faf1d71
AW
613 </p></dd><dt><span class="term"><code class="constant">GL_PROVOKING_VERTEX</code></span></dt><dd><p>
614 </p><p>
615 <em class="parameter"><code>params</code></em> returns one value,
616 the currently selected provoking vertex convention. The initial value is <code class="constant">GL_LAST_VERTEX_CONVENTION</code>.
617 See <a href="glProvokingVertex.xml"><span class="citerefentry"><span class="refentrytitle">glProvokingVertex</span></span></a>.
618 </p></dd><dt><span class="term"><code class="constant">GL_POINT_SIZE</code></span></dt><dd><p>
619 </p><p>
620 <em class="parameter"><code>params</code></em> returns one value,
621 the point size as specified by <a href="glPointSize.xml"><span class="citerefentry"><span class="refentrytitle">glPointSize</span></span></a>.
622 The initial value is 1.
623 </p></dd><dt><span class="term"><code class="constant">GL_POINT_SIZE_GRANULARITY</code></span></dt><dd><p>
624 </p><p>
625 <em class="parameter"><code>params</code></em> returns one value,
626 the size difference between adjacent supported sizes for antialiased points.
627 See <a href="glPointSize.xml"><span class="citerefentry"><span class="refentrytitle">glPointSize</span></span></a>.
628 </p></dd><dt><span class="term"><code class="constant">GL_POINT_SIZE_RANGE</code></span></dt><dd><p>
629 </p><p>
630 <em class="parameter"><code>params</code></em> returns two values:
631 the smallest and largest supported sizes for antialiased
632 points. The smallest size must be at most 1, and the largest size must
633 be at least 1.
634 See <a href="glPointSize.xml"><span class="citerefentry"><span class="refentrytitle">glPointSize</span></span></a>.
635 </p></dd><dt><span class="term"><code class="constant">GL_POLYGON_OFFSET_FACTOR</code></span></dt><dd><p>
636 </p><p>
637 <em class="parameter"><code>params</code></em> returns one value,
638 the scaling factor used to determine the variable offset that is added
639 to the depth value of each fragment generated when a polygon is
640 rasterized. The initial value is 0.
641 See <a href="glPolygonOffset.xml"><span class="citerefentry"><span class="refentrytitle">glPolygonOffset</span></span></a>.
642 </p></dd><dt><span class="term"><code class="constant">GL_POLYGON_OFFSET_UNITS</code></span></dt><dd><p>
643 </p><p>
644 <em class="parameter"><code>params</code></em> returns one value.
645 This value is multiplied by an implementation-specific value and then
646 added to the depth value of each fragment
647 generated when a polygon is rasterized. The initial value is 0.
648 See <a href="glPolygonOffset.xml"><span class="citerefentry"><span class="refentrytitle">glPolygonOffset</span></span></a>.
649 </p></dd><dt><span class="term"><code class="constant">GL_POLYGON_OFFSET_FILL</code></span></dt><dd><p>
650 </p><p>
651 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether polygon offset
652 is enabled for polygons in fill mode. The initial value is <code class="constant">GL_FALSE</code>.
653 See <a href="glPolygonOffset.xml"><span class="citerefentry"><span class="refentrytitle">glPolygonOffset</span></span></a>.
654 </p></dd><dt><span class="term"><code class="constant">GL_POLYGON_OFFSET_LINE</code></span></dt><dd><p>
655 </p><p>
656 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether polygon offset
657 is enabled for polygons in line mode. The initial value is <code class="constant">GL_FALSE</code>.
658 See <a href="glPolygonOffset.xml"><span class="citerefentry"><span class="refentrytitle">glPolygonOffset</span></span></a>.
659 </p></dd><dt><span class="term"><code class="constant">GL_POLYGON_OFFSET_POINT</code></span></dt><dd><p>
660 </p><p>
661 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether polygon offset
662 is enabled for polygons in point mode. The initial value is <code class="constant">GL_FALSE</code>.
663 See <a href="glPolygonOffset.xml"><span class="citerefentry"><span class="refentrytitle">glPolygonOffset</span></span></a>.
664 </p></dd><dt><span class="term"><code class="constant">GL_POLYGON_SMOOTH</code></span></dt><dd><p>
665 </p><p>
666 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether antialiasing of
667 polygons is enabled. The initial value is <code class="constant">GL_FALSE</code>.
668 See <a href="glPolygonMode.xml"><span class="citerefentry"><span class="refentrytitle">glPolygonMode</span></span></a>.
669 </p></dd><dt><span class="term"><code class="constant">GL_POLYGON_SMOOTH_HINT</code></span></dt><dd><p>
670 </p><p>
671 <em class="parameter"><code>params</code></em> returns one value,
672 a symbolic constant indicating the mode of the polygon antialiasing
673 hint. The initial value is <code class="constant">GL_DONT_CARE</code>.
674 See <a href="glHint.xml"><span class="citerefentry"><span class="refentrytitle">glHint</span></span></a>.
675 </p></dd><dt><span class="term"><code class="constant">GL_READ_BUFFER</code></span></dt><dd><p>
676 </p><p>
677 <em class="parameter"><code>params</code></em> returns one value,
678 a symbolic constant indicating which color buffer is selected for
679 reading. The initial value is <code class="constant">GL_BACK</code> if there is a back buffer,
680 otherwise it is <code class="constant">GL_FRONT</code>.
681 See
682 <a href="glReadPixels.xml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a>.
683 </p></dd><dt><span class="term"><code class="constant">GL_SAMPLE_BUFFERS</code></span></dt><dd><p>
684 </p><p>
685 <em class="parameter"><code>params</code></em> returns a single integer value indicating the number of sample buffers
686 associated with the framebuffer.
687 See <a href="glSampleCoverage.xml"><span class="citerefentry"><span class="refentrytitle">glSampleCoverage</span></span></a>.
688 </p></dd><dt><span class="term"><code class="constant">GL_SAMPLE_COVERAGE_VALUE</code></span></dt><dd><p>
689 </p><p>
690 <em class="parameter"><code>params</code></em> returns a single positive floating-point value indicating the
691 current sample coverage value.
692 See <a href="glSampleCoverage.xml"><span class="citerefentry"><span class="refentrytitle">glSampleCoverage</span></span></a>.
693 </p></dd><dt><span class="term"><code class="constant">GL_SAMPLE_COVERAGE_INVERT</code></span></dt><dd><p>
694 </p><p>
695 <em class="parameter"><code>params</code></em> returns a single boolean value indicating if the temporary
696 coverage value should be inverted.
697 See <a href="glSampleCoverage.xml"><span class="citerefentry"><span class="refentrytitle">glSampleCoverage</span></span></a>.
698 </p></dd><dt><span class="term"><code class="constant">GL_SAMPLER_BINDING</code></span></dt><dd><p>
699 </p><p>
700 <em class="parameter"><code>params</code></em> returns a single value, the name of the sampler object
701 currently bound to the active texture unit. The initial value is 0.
702 See <a href="glBindSampler.xml"><span class="citerefentry"><span class="refentrytitle">glBindSampler</span></span></a>.
703 </p></dd><dt><span class="term"><code class="constant">GL_SAMPLES</code></span></dt><dd><p>
704 </p><p>
705 <em class="parameter"><code>params</code></em> returns a single integer value indicating the coverage mask size.
706 See <a href="glSampleCoverage.xml"><span class="citerefentry"><span class="refentrytitle">glSampleCoverage</span></span></a>.
707 </p></dd><dt><span class="term"><code class="constant">GL_SCISSOR_BOX</code></span></dt><dd><p>
708 </p><p>
709 <em class="parameter"><code>params</code></em> returns four values:
710 the
711 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">x</mml:mi></mml:math>
712 and
713 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">y</mml:mi></mml:math>
714 window coordinates of the scissor box,
715 followed by its width and height.
716 Initially the
717 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">x</mml:mi></mml:math>
718 and
719 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">y</mml:mi></mml:math>
720 window coordinates are both 0 and the
721 width and height are set to the size of the window.
722 See <a href="glScissor.xml"><span class="citerefentry"><span class="refentrytitle">glScissor</span></span></a>.
723 </p></dd><dt><span class="term"><code class="constant">GL_SCISSOR_TEST</code></span></dt><dd><p>
724 </p><p>
725 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether scissoring is
726 enabled. The initial value is <code class="constant">GL_FALSE</code>.
727 See <a href="glScissor.xml"><span class="citerefentry"><span class="refentrytitle">glScissor</span></span></a>.
728 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_BACK_FAIL</code></span></dt><dd><p>
729 </p><p>
730 <em class="parameter"><code>params</code></em> returns one value,
731 a symbolic constant indicating what action is taken for back-facing polygons when the stencil
732 test fails. The initial value is <code class="constant">GL_KEEP</code>.
733 See <a href="glStencilOpSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOpSeparate</span></span></a>.
734 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_BACK_FUNC</code></span></dt><dd><p>
735 </p><p>
736 <em class="parameter"><code>params</code></em> returns one value,
737 a symbolic constant indicating what function is used for back-facing polygons to compare the
738 stencil reference value with the stencil buffer value. The initial value
739 is <code class="constant">GL_ALWAYS</code>.
740 See <a href="glStencilFuncSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFuncSeparate</span></span></a>.
741 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_BACK_PASS_DEPTH_FAIL</code></span></dt><dd><p>
742 </p><p>
743 <em class="parameter"><code>params</code></em> returns one value,
744 a symbolic constant indicating what action is taken for back-facing polygons when the stencil
745 test passes,
746 but the depth test fails. The initial value is <code class="constant">GL_KEEP</code>.
747 See <a href="glStencilOpSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOpSeparate</span></span></a>.
748 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_BACK_PASS_DEPTH_PASS</code></span></dt><dd><p>
749 </p><p>
750 <em class="parameter"><code>params</code></em> returns one value,
751 a symbolic constant indicating what action is taken for back-facing polygons when the stencil
752 test passes and the depth test passes. The initial value is <code class="constant">GL_KEEP</code>.
753 See <a href="glStencilOpSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOpSeparate</span></span></a>.
754 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_BACK_REF</code></span></dt><dd><p>
755 </p><p>
756 <em class="parameter"><code>params</code></em> returns one value,
757 the reference value that is compared with the contents of the stencil
758 buffer for back-facing polygons. The initial value is 0.
759 See <a href="glStencilFuncSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFuncSeparate</span></span></a>.
760 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_BACK_VALUE_MASK</code></span></dt><dd><p>
761 </p><p>
762 <em class="parameter"><code>params</code></em> returns one value,
763 the mask that is used for back-facing polygons to mask both the stencil reference value and the
764 stencil buffer value before they are compared. The initial value is all 1's.
765 See <a href="glStencilFuncSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFuncSeparate</span></span></a>.
766 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_BACK_WRITEMASK</code></span></dt><dd><p>
767 </p><p>
768 <em class="parameter"><code>params</code></em> returns one value,
769 the mask that controls writing of the stencil bitplanes for back-facing polygons. The initial value
770 is all 1's.
771 See <a href="glStencilMaskSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilMaskSeparate</span></span></a>.
772 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_CLEAR_VALUE</code></span></dt><dd><p>
773 </p><p>
774 <em class="parameter"><code>params</code></em> returns one value,
775 the index to which the stencil bitplanes are cleared. The initial value is
776 0.
777 See <a href="glClearStencil.xml"><span class="citerefentry"><span class="refentrytitle">glClearStencil</span></span></a>.
778 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_FAIL</code></span></dt><dd><p>
779 </p><p>
780 <em class="parameter"><code>params</code></em> returns one value,
781 a symbolic constant indicating what action is taken when the stencil
782 test fails. The initial value is <code class="constant">GL_KEEP</code>.
783 See <a href="glStencilOp.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOp</span></span></a>.
784 This stencil state only affects non-polygons
785 and front-facing polygons. Back-facing polygons use separate stencil state.
786 See <a href="glStencilOpSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOpSeparate</span></span></a>.
787 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_FUNC</code></span></dt><dd><p>
788 </p><p>
789 <em class="parameter"><code>params</code></em> returns one value,
790 a symbolic constant indicating what function is used to compare the
791 stencil reference value with the stencil buffer value. The initial value
792 is <code class="constant">GL_ALWAYS</code>.
793 See <a href="glStencilFunc.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFunc</span></span></a>.
794 This stencil state only affects non-polygons
795 and front-facing polygons. Back-facing polygons use separate stencil state.
796 See <a href="glStencilFuncSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFuncSeparate</span></span></a>.
797 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_PASS_DEPTH_FAIL</code></span></dt><dd><p>
798 </p><p>
799 <em class="parameter"><code>params</code></em> returns one value,
800 a symbolic constant indicating what action is taken when the stencil
801 test passes,
802 but the depth test fails. The initial value is <code class="constant">GL_KEEP</code>.
803 See <a href="glStencilOp.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOp</span></span></a>.
804 This stencil state only affects non-polygons
805 and front-facing polygons. Back-facing polygons use separate stencil state.
806 See <a href="glStencilOpSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOpSeparate</span></span></a>.
807 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_PASS_DEPTH_PASS</code></span></dt><dd><p>
808 </p><p>
809 <em class="parameter"><code>params</code></em> returns one value,
810 a symbolic constant indicating what action is taken when the stencil
811 test passes and the depth test passes. The initial value is <code class="constant">GL_KEEP</code>.
812 See <a href="glStencilOp.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOp</span></span></a>.
813 This stencil state only affects non-polygons
814 and front-facing polygons. Back-facing polygons use separate stencil state.
815 See <a href="glStencilOpSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOpSeparate</span></span></a>.
816 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_REF</code></span></dt><dd><p>
817 </p><p>
818 <em class="parameter"><code>params</code></em> returns one value,
819 the reference value that is compared with the contents of the stencil
820 buffer. The initial value is 0.
821 See <a href="glStencilFunc.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFunc</span></span></a>.
822 This stencil state only affects non-polygons
823 and front-facing polygons. Back-facing polygons use separate stencil state.
824 See <a href="glStencilFuncSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFuncSeparate</span></span></a>.
825 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_TEST</code></span></dt><dd><p>
826 </p><p>
827 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether stencil testing
828 of fragments is enabled. The initial value is <code class="constant">GL_FALSE</code>.
829 See <a href="glStencilFunc.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFunc</span></span></a> and <a href="glStencilOp.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOp</span></span></a>.
830 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_VALUE_MASK</code></span></dt><dd><p>
831 </p><p>
832 <em class="parameter"><code>params</code></em> returns one value,
833 the mask that is used to mask both the stencil reference value and the
834 stencil buffer value before they are compared. The initial value is all 1's.
835 See <a href="glStencilFunc.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFunc</span></span></a>.
836 This stencil state only affects non-polygons
837 and front-facing polygons. Back-facing polygons use separate stencil state.
838 See <a href="glStencilFuncSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFuncSeparate</span></span></a>.
839 </p></dd><dt><span class="term"><code class="constant">GL_STENCIL_WRITEMASK</code></span></dt><dd><p>
840 </p><p>
841 <em class="parameter"><code>params</code></em> returns one value,
842 the mask that controls writing of the stencil bitplanes. The initial value
843 is all 1's.
844 See <a href="glStencilMask.xml"><span class="citerefentry"><span class="refentrytitle">glStencilMask</span></span></a>.
845 This stencil state only affects non-polygons
846 and front-facing polygons. Back-facing polygons use separate stencil state.
847 See <a href="glStencilMaskSeparate.xml"><span class="citerefentry"><span class="refentrytitle">glStencilMaskSeparate</span></span></a>.
848 </p></dd><dt><span class="term"><code class="constant">GL_STEREO</code></span></dt><dd><p>
849 </p><p>
850 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether stereo buffers
851 (left and right) are supported.
852 </p></dd><dt><span class="term"><code class="constant">GL_SUBPIXEL_BITS</code></span></dt><dd><p>
853 </p><p>
854 <em class="parameter"><code>params</code></em> returns one value,
855 an estimate of the number of bits of subpixel resolution that are used to
856 position rasterized geometry in window coordinates. The value must be at least 4.
857 </p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_BINDING_1D</code></span></dt><dd><p>
858 </p><p>
859 <em class="parameter"><code>params</code></em> returns a single value, the name of the texture
860 currently bound to the target <code class="constant">GL_TEXTURE_1D</code>. The initial value is 0.
861 See <a href="glBindTexture.xml"><span class="citerefentry"><span class="refentrytitle">glBindTexture</span></span></a>.
862 </p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_BINDING_1D_ARRAY</code></span></dt><dd><p>
863 </p><p>
864 <em class="parameter"><code>params</code></em> returns a single value, the name of the texture
865 currently bound to the target <code class="constant">GL_TEXTURE_1D_ARRAY</code>. The initial value is 0.
866 See <a href="glBindTexture.xml"><span class="citerefentry"><span class="refentrytitle">glBindTexture</span></span></a>.
867 </p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_BINDING_2D</code></span></dt><dd><p>
868 </p><p>
869 <em class="parameter"><code>params</code></em> returns a single value, the name of the texture
870 currently bound to the target <code class="constant">GL_TEXTURE_2D</code>. The initial value is 0.
871 See <a href="glBindTexture.xml"><span class="citerefentry"><span class="refentrytitle">glBindTexture</span></span></a>.
872 </p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_BINDING_2D_ARRAY</code></span></dt><dd><p>
873 </p><p>
874 <em class="parameter"><code>params</code></em> returns a single value, the name of the texture
875 currently bound to the target <code class="constant">GL_TEXTURE_2D_ARRAY</code>. The initial value is 0.
876 See <a href="glBindTexture.xml"><span class="citerefentry"><span class="refentrytitle">glBindTexture</span></span></a>.
877 </p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_BINDING_2D_MULTISAMPLE</code></span></dt><dd><p>
878 </p><p>
879 <em class="parameter"><code>params</code></em> returns a single value, the name of the texture
880 currently bound to the target <code class="constant">GL_TEXTURE_2D_MULTISAMPLE</code>. The initial value is 0.
881 See <a href="glBindTexture.xml"><span class="citerefentry"><span class="refentrytitle">glBindTexture</span></span></a>.
882 </p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_BINDING_2D_MULTISAMPLE_ARRAY</code></span></dt><dd><p>
883 </p><p>
884 <em class="parameter"><code>params</code></em> returns a single value, the name of the texture
885 currently bound to the target <code class="constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY</code>. The initial value is 0.
886 See <a href="glBindTexture.xml"><span class="citerefentry"><span class="refentrytitle">glBindTexture</span></span></a>.
887 </p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_BINDING_3D</code></span></dt><dd><p>
888 </p><p>
889 <em class="parameter"><code>params</code></em> returns a single value, the name of the texture
890 currently bound to the target <code class="constant">GL_TEXTURE_3D</code>. The initial value is 0.
891 See <a href="glBindTexture.xml"><span class="citerefentry"><span class="refentrytitle">glBindTexture</span></span></a>.
892 </p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_BINDING_BUFFER</code></span></dt><dd><p>
893 </p><p>
894 <em class="parameter"><code>params</code></em> returns a single value, the name of the texture
895 currently bound to the target <code class="constant">GL_TEXTURE_BUFFER</code>. The initial value is 0.
896 See <a href="glBindTexture.xml"><span class="citerefentry"><span class="refentrytitle">glBindTexture</span></span></a>.
897 </p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_BINDING_CUBE_MAP</code></span></dt><dd><p>
898 </p><p>
899 <em class="parameter"><code>params</code></em> returns a single value, the name of the texture
900 currently bound to the target <code class="constant">GL_TEXTURE_CUBE_MAP</code>. The initial value is 0.
901 See <a href="glBindTexture.xml"><span class="citerefentry"><span class="refentrytitle">glBindTexture</span></span></a>.
902 </p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_BINDING_RECTANGLE</code></span></dt><dd><p>
903 </p><p>
904 <em class="parameter"><code>params</code></em> returns a single value, the name of the texture
905 currently bound to the target <code class="constant">GL_TEXTURE_RECTANGLE</code>. The initial value is 0.
906 See <a href="glBindTexture.xml"><span class="citerefentry"><span class="refentrytitle">glBindTexture</span></span></a>.
907 </p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_COMPRESSION_HINT</code></span></dt><dd><p>
908 </p><p>
909 <em class="parameter"><code>params</code></em> returns a single value indicating the mode of the texture
910 compression hint. The initial value is <code class="constant">GL_DONT_CARE</code>.
c7b31271 911 </p></dd><dt><span class="term"><code class="constant">GL_TEXTURE_BINDING_BUFFER</code></span></dt><dd><p>
7faf1d71
AW
912 </p><p>
913 <em class="parameter"><code>params</code></em> returns a single value, the name of the texture buffer object
914 currently bound. The initial value is 0.
915 See <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>.
916 </p></dd><dt><span class="term"><code class="constant">GL_TIMESTAMP</code></span></dt><dd><p>
917 </p><p>
918 <em class="parameter"><code>params</code></em> returns a single value, the 64-bit value of the current
919 GL time.
920 See <a href="glQueryCounter.xml"><span class="citerefentry"><span class="refentrytitle">glQueryCounter</span></span></a>.
921 </p></dd><dt><span class="term"><code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER_BINDING</code></span></dt><dd><p>
922 </p><p>
923 When used with non-indexed variants of <code class="function">glGet</code> (such as <code class="function">glGetIntegerv</code>),
924 <em class="parameter"><code>params</code></em> returns a single value, the name of the buffer object
925 currently bound to the target <code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER</code>. If no buffer object
926 is bound to this target, 0 is returned.
927 When used with indexed variants of <code class="function">glGet</code> (such as <code class="function">glGetIntegeri_v</code>),
928 <em class="parameter"><code>params</code></em> returns a single value, the name of the buffer object
929 bound to the indexed transform feedback attribute stream. The initial value is 0 for all targets.
930 See <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>, <a href="glBindBufferBase.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferBase</span></span></a>, and
931 <a href="glBindBufferRange.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferRange</span></span></a>.
932 </p></dd><dt><span class="term"><code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER_START</code></span></dt><dd><p>
933 </p><p>
934 When used with indexed variants of <code class="function">glGet</code> (such as <code class="function">glGetInteger64i_v</code>),
935 <em class="parameter"><code>params</code></em> returns a single value, the start offset of the binding range for each
936 transform feedback attribute stream. The initial value is 0 for all streams.
937 See <a href="glBindBufferRange.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferRange</span></span></a>.
938 </p></dd><dt><span class="term"><code class="constant">GL_TRANSFORM_FEEDBACK_BUFFER_SIZE</code></span></dt><dd><p>
939 </p><p>
940 When used with indexed variants of <code class="function">glGet</code> (such as <code class="function">glGetInteger64i_v</code>),
941 <em class="parameter"><code>params</code></em> returns a single value, the size of the binding range for each
942 transform feedback attribute stream. The initial value is 0 for all streams.
943 See <a href="glBindBufferRange.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferRange</span></span></a>.
944 </p></dd><dt><span class="term"><code class="constant">GL_UNIFORM_BUFFER_BINDING</code></span></dt><dd><p>
945 </p><p>
946 When used with non-indexed variants of <code class="function">glGet</code> (such as <code class="function">glGetIntegerv</code>),
947 <em class="parameter"><code>params</code></em> returns a single value, the name of the buffer object
948 currently bound to the target <code class="constant">GL_UNIFORM_BUFFER</code>. If no buffer object
949 is bound to this target, 0 is returned.
950 When used with indexed variants of <code class="function">glGet</code> (such as <code class="function">glGetIntegeri_v</code>),
951 <em class="parameter"><code>params</code></em> returns a single value, the name of the buffer object
952 bound to the indexed uniform buffer binding point. The initial value is 0 for all targets.
953 See <a href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>, <a href="glBindBufferBase.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferBase</span></span></a>, and
954 <a href="glBindBufferRange.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferRange</span></span></a>.
955 </p></dd><dt><span class="term"><code class="constant">GL_UNIFORM_BUFFER_START</code></span></dt><dd><p>
956 </p><p>
957 When used with indexed variants of <code class="function">glGet</code> (such as <code class="function">glGetInteger64i_v</code>),
958 <em class="parameter"><code>params</code></em> returns a single value, the start offset of the binding range for each
959 indexed uniform buffer binding. The initial value is 0 for all bindings.
960 See <a href="glBindBufferRange.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferRange</span></span></a>.
961 </p></dd><dt><span class="term"><code class="constant">GL_UNIFORM_BUFFER_SIZE</code></span></dt><dd><p>
962 </p><p>
963 When used with indexed variants of <code class="function">glGet</code> (such as <code class="function">glGetInteger64i_v</code>),
964 <em class="parameter"><code>params</code></em> returns a single value, the size of the binding range for each
965 indexed uniform buffer binding. The initial value is 0 for all bindings.
966 See <a href="glBindBufferRange.xml"><span class="citerefentry"><span class="refentrytitle">glBindBufferRange</span></span></a>.
967 </p></dd><dt><span class="term"><code class="constant">GL_UNIFORM_BUFFER_OFFSET_ALIGNMENT</code></span></dt><dd><p>
968 </p><p>
969 <em class="parameter"><code>params</code></em> returns a single value, the minimum required alignment
970 for uniform buffer sizes and offset. The initial value is 1.
971 See <a href="glUniformBlockBinding.xml"><span class="citerefentry"><span class="refentrytitle">glUniformBlockBinding</span></span></a>.
972 </p></dd><dt><span class="term"><code class="constant">GL_UNPACK_ALIGNMENT</code></span></dt><dd><p>
973 </p><p>
974 <em class="parameter"><code>params</code></em> returns one value,
975 the byte alignment used for reading pixel data from memory. The initial
976 value is 4.
977 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
978 </p></dd><dt><span class="term"><code class="constant">GL_UNPACK_IMAGE_HEIGHT</code></span></dt><dd><p>
979 </p><p>
980 <em class="parameter"><code>params</code></em> returns one value,
981 the image height used for reading pixel data from memory. The initial
982 is 0.
983 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
984 </p></dd><dt><span class="term"><code class="constant">GL_UNPACK_LSB_FIRST</code></span></dt><dd><p>
985 </p><p>
986 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether single-bit
987 pixels being read from memory are read first from the least significant
988 bit of each unsigned byte. The initial value is <code class="constant">GL_FALSE</code>.
989 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
990 </p></dd><dt><span class="term"><code class="constant">GL_UNPACK_ROW_LENGTH</code></span></dt><dd><p>
991 </p><p>
992 <em class="parameter"><code>params</code></em> returns one value,
993 the row length used for reading pixel data from memory. The initial value
994 is 0.
995 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
996 </p></dd><dt><span class="term"><code class="constant">GL_UNPACK_SKIP_IMAGES</code></span></dt><dd><p>
997 </p><p>
998 <em class="parameter"><code>params</code></em> returns one value,
999 the number of pixel images skipped before the first pixel is read
1000 from memory. The initial value is 0.
1001 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
1002 </p></dd><dt><span class="term"><code class="constant">GL_UNPACK_SKIP_PIXELS</code></span></dt><dd><p>
1003 </p><p>
1004 <em class="parameter"><code>params</code></em> returns one value,
1005 the number of pixel locations skipped before the first pixel is read
1006 from memory. The initial value is 0.
1007 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
1008 </p></dd><dt><span class="term"><code class="constant">GL_UNPACK_SKIP_ROWS</code></span></dt><dd><p>
1009 </p><p>
1010 <em class="parameter"><code>params</code></em> returns one value,
1011 the number of rows of pixel locations skipped before the first pixel is read
1012 from memory. The initial value is 0.
1013 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
1014 </p></dd><dt><span class="term"><code class="constant">GL_UNPACK_SWAP_BYTES</code></span></dt><dd><p>
1015 </p><p>
1016 <em class="parameter"><code>params</code></em> returns a single boolean value indicating whether the bytes of
1017 two-byte and four-byte pixel indices and components are swapped after being
1018 read from memory. The initial value is <code class="constant">GL_FALSE</code>.
1019 See <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>.
1020 </p></dd><dt><span class="term"><code class="constant">GL_NUM_EXTENSIONS</code></span></dt><dd><p>
1021 </p><p>
1022 <em class="parameter"><code>params</code></em> returns one value,
1023 the number of extensions supported by the GL implementation for the current context.
1024 See <a href="glGetString.xml"><span class="citerefentry"><span class="refentrytitle">glGetString</span></span></a>.
1025 </p></dd><dt><span class="term"><code class="constant">GL_MAJOR_VERSION</code></span></dt><dd><p>
1026 </p><p>
1027 <em class="parameter"><code>params</code></em> returns one value,
1028 the major version number of the OpenGL API supported by the current context.
1029 </p></dd><dt><span class="term"><code class="constant">GL_MINOR_VERSION</code></span></dt><dd><p>
1030 </p><p>
1031 <em class="parameter"><code>params</code></em> returns one value,
1032 the minor version number of the OpenGL API supported by the current context.
1033 </p></dd><dt><span class="term"><code class="constant">GL_CONTEXT_FLAGS</code></span></dt><dd><p>
1034 </p><p>
1035 <em class="parameter"><code>params</code></em> returns one value,
1036 the flags with which the context was created (such as debugging functionality).
7faf1d71
AW
1037 </p></dd><dt><span class="term"><code class="constant">GL_VIEWPORT</code></span></dt><dd><p>
1038 </p><p>
1039 <em class="parameter"><code>params</code></em> returns four values:
1040 the
1041 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">x</mml:mi></mml:math>
1042 and
1043 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">y</mml:mi></mml:math>
1044 window coordinates of the viewport,
1045 followed by its width and height.
1046 Initially the
1047 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">x</mml:mi></mml:math>
1048 and
1049 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">y</mml:mi></mml:math>
1050 window coordinates are both set to 0,
1051 and the width and height are set to the width and height of the window into
1052 which the GL will do its rendering.
1053 See <a href="glViewport.xml"><span class="citerefentry"><span class="refentrytitle">glViewport</span></span></a>.
1054 </p></dd></dl></div><p>
1055 Many of the boolean parameters can also be queried more easily using
1056 <a href="glIsEnabled.xml"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a>.
1057 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
1058 The following parameters return the associated value for the active texture unit:
1059 <code class="constant">GL_TEXTURE_1D</code>, <code class="constant">GL_TEXTURE_BINDING_1D</code>,
1060 <code class="constant">GL_TEXTURE_2D</code>, <code class="constant">GL_TEXTURE_BINDING_2D</code>,
1061 <code class="constant">GL_TEXTURE_3D</code> and <code class="constant">GL_TEXTURE_BINDING_3D</code>.
1062 </p><p>
1063 <code class="constant">GL_MAX_RECTANGLE_TEXTURE_SIZE</code>, <code class="constant">GL_MAX_TEXTURE_BUFFER_SIZE</code>,
c7b31271 1064 <code class="constant">GL_UNIFORM_BUFFER_BINDING</code>, <code class="constant">GL_TEXTURE_BINDING_BUFFER</code>,
7faf1d71
AW
1065 <code class="constant">GL_MAX_VERTEX_UNIFORM_BLOCKS</code>, <code class="constant">GL_MAX_FRAGMENT_UNIFORM_BLOCKS</code>,
1066 <code class="constant">GL_MAX_COMBINED_FRAGMENT_UNIFORM_COMPONENTS</code>, <code class="constant">GL_MAX_COMBINED_VERTEX_UNIFORM_COMPONENTS</code>
1067 <code class="constant">GL_MAX_COMBINED_UNIFORM_BLOCKS</code>, <code class="constant">GL_MAX_UNIFORM_BLOCK_SIZE</code>,
1068 and <code class="constant">GL_UNIFORM_BUFFER_OFFSET_ALIGNMENT</code>
1069 are available only if the GL version is 3.1 or greater.
1070 </p><p>
1071 <code class="constant">GL_MAX_COMBINED_GEOMETRY_UNIFORM_COMPONENTS</code>, <code class="constant">GL_MAX_GEOMETRY_UNIFORM_BLOCKS</code>,
1072 <code class="constant">GL_MAX_GEOMETRY_INPUT_COMPONENTS</code>, <code class="constant">GL_MAX_GEOMETRY_OUTPUT_COMPONENTS</code>,
1073 <code class="constant">GL_MAX_GEOMETRY_OUTPUT_VERTICES</code>, <code class="constant">GL_MAX_GEOMETRY_TOTAL_OUTPUT_COMPONENTS</code> and
1074 <code class="constant">GL_MAX_GEOMETRY_TEXTURE_IMAGE_UNITS</code> are available only if the GL version is 3.2 or greater.
1075 </p><p>
1076 <code class="function">glGetInteger64v</code> and <code class="function">glGetInteger64i_v</code> are available only if
1077 the GL version is 3.2 or greater.
1078 </p><p>
c7b31271 1079 <code class="constant">GL_MAX_DUAL_SOURCE_DRAW_BUFFERS</code>, <code class="constant">GL_SAMPLER_BINDING</code>, and
7faf1d71
AW
1080 <code class="constant">GL_TIMESTAMP</code> are available only if the GL version is 3.3 or greater.
1081 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
1082 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>pname</code></em> is not an accepted value.
1083 </p><p>
1084 <code class="constant">GL_INVALID_VALUE</code> is generated on any of <code class="function">glGetBooleani_v</code>,
1085 <code class="function">glGetIntegeri_v</code>, or <code class="function">glGetInteger64i_v</code> if
1086 <em class="parameter"><code>index</code></em> is outside of the valid range for the indexed state <em class="parameter"><code>target</code></em>.
1087 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
1088 <a href="glGetActiveUniform.xml"><span class="citerefentry"><span class="refentrytitle">glGetActiveUniform</span></span></a>,
1089 <a href="glGetAttachedShaders.xml"><span class="citerefentry"><span class="refentrytitle">glGetAttachedShaders</span></span></a>,
1090 <a href="glGetAttribLocation.xml"><span class="citerefentry"><span class="refentrytitle">glGetAttribLocation</span></span></a>,
1091 <a href="glGetBufferParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetBufferParameter</span></span></a>,
1092 <a href="glGetBufferPointerv.xml"><span class="citerefentry"><span class="refentrytitle">glGetBufferPointerv</span></span></a>,
1093 <a href="glGetBufferSubData.xml"><span class="citerefentry"><span class="refentrytitle">glGetBufferSubData</span></span></a>,
1094 <a href="glGetCompressedTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glGetCompressedTexImage</span></span></a>,
1095 <a href="glGetError.xml"><span class="citerefentry"><span class="refentrytitle">glGetError</span></span></a>,
1096 <a href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>,
1097 <a href="glGetProgramInfoLog.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgramInfoLog</span></span></a>,
1098 <a href="glGetQueryiv.xml"><span class="citerefentry"><span class="refentrytitle">glGetQueryiv</span></span></a>,
1099 <a href="glGetQueryObject.xml"><span class="citerefentry"><span class="refentrytitle">glGetQueryObject</span></span></a>,
1100 <a href="glGetShader.xml"><span class="citerefentry"><span class="refentrytitle">glGetShader</span></span></a>,
1101 <a href="glGetShaderInfoLog.xml"><span class="citerefentry"><span class="refentrytitle">glGetShaderInfoLog</span></span></a>,
1102 <a href="glGetShaderSource.xml"><span class="citerefentry"><span class="refentrytitle">glGetShaderSource</span></span></a>,
1103 <a href="glGetString.xml"><span class="citerefentry"><span class="refentrytitle">glGetString</span></span></a>,
1104 <a href="glGetTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexImage</span></span></a>,
1105 <a href="glGetTexLevelParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexLevelParameter</span></span></a>,
1106 <a href="glGetTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexParameter</span></span></a>,
1107 <a href="glGetUniform.xml"><span class="citerefentry"><span class="refentrytitle">glGetUniform</span></span></a>,
1108 <a href="glGetUniformLocation.xml"><span class="citerefentry"><span class="refentrytitle">glGetUniformLocation</span></span></a>,
1109 <a href="glGetVertexAttrib.xml"><span class="citerefentry"><span class="refentrytitle">glGetVertexAttrib</span></span></a>,
1110 <a href="glGetVertexAttribPointerv.xml"><span class="citerefentry"><span class="refentrytitle">glGetVertexAttribPointerv</span></span></a>,
1111 <a href="glIsEnabled.xml"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a>
1112 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
1113 Copyright <span class="trademark"></span>© 1991-2006
1114 Silicon Graphics, Inc. This document is licensed under the SGI
1115 Free Software B License. For details, see
1116 <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
1117 </p></div></div></body></html>