HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" | |
| 3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> | |
| 4 | <refentry id="glGet"> | |
| 5 | <refmeta> | |
| 6 | <refmetainfo> | |
| 7 | <copyright> | |
| 8 | <year>1991-2006</year> | |
| 9 | <holder>Silicon Graphics, Inc.</holder> | |
| 10 | </copyright> | |
| 11 | </refmetainfo> | |
| 12 | <refentrytitle>glGet</refentrytitle> | |
| 13 | <manvolnum>3G</manvolnum> | |
| 14 | </refmeta> | |
| 15 | <refnamediv> | |
| 16 | <refname>glGet</refname> | |
| 17 | <refpurpose>return the value or values of a selected parameter</refpurpose> | |
| 18 | </refnamediv> | |
| 19 | <refsynopsisdiv><title>C Specification</title> | |
| 20 | <funcsynopsis> | |
| 21 | <funcprototype> | |
| 22 | <funcdef>void <function>glGetBooleanv</function></funcdef> | |
| 23 | <paramdef>GLenum <parameter>pname</parameter></paramdef> | |
| 24 | <paramdef>GLboolean * <parameter>params</parameter></paramdef> | |
| 25 | </funcprototype> | |
| 26 | </funcsynopsis> | |
| 27 | </refsynopsisdiv> | |
| 28 | <refsynopsisdiv><title>C Specification</title> | |
| 29 | <funcsynopsis> | |
| 30 | <funcprototype> | |
| 31 | <funcdef>void <function>glGetDoublev</function></funcdef> | |
| 32 | <paramdef>GLenum <parameter>pname</parameter></paramdef> | |
| 33 | <paramdef>GLdouble * <parameter>params</parameter></paramdef> | |
| 34 | </funcprototype> | |
| 35 | </funcsynopsis> | |
| 36 | </refsynopsisdiv> | |
| 37 | <refsynopsisdiv><title>C Specification</title> | |
| 38 | <funcsynopsis> | |
| 39 | <funcprototype> | |
| 40 | <funcdef>void <function>glGetFloatv</function></funcdef> | |
| 41 | <paramdef>GLenum <parameter>pname</parameter></paramdef> | |
| 42 | <paramdef>GLfloat * <parameter>params</parameter></paramdef> | |
| 43 | </funcprototype> | |
| 44 | </funcsynopsis> | |
| 45 | </refsynopsisdiv> | |
| 46 | <refsynopsisdiv><title>C Specification</title> | |
| 47 | <funcsynopsis> | |
| 48 | <funcprototype> | |
| 49 | <funcdef>void <function>glGetIntegerv</function></funcdef> | |
| 50 | <paramdef>GLenum <parameter>pname</parameter></paramdef> | |
| 51 | <paramdef>GLint * <parameter>params</parameter></paramdef> | |
| 52 | </funcprototype> | |
| 53 | </funcsynopsis> | |
| 54 | </refsynopsisdiv> | |
| 55 | <refsynopsisdiv><title>C Specification</title> | |
| 56 | <funcsynopsis> | |
| 57 | <funcprototype> | |
| 58 | <funcdef>void <function>glGetInteger64v</function></funcdef> | |
| 59 | <paramdef>GLenum <parameter>pname</parameter></paramdef> | |
| 60 | <paramdef>GLint64 * <parameter>params</parameter></paramdef> | |
| 61 | </funcprototype> | |
| 62 | </funcsynopsis> | |
| 63 | </refsynopsisdiv> | |
| 64 | <!-- eqn: ignoring delim $$ --> | |
| 65 | <refsect1 id="parameters"><title>Parameters</title> | |
| 66 | <variablelist> | |
| 67 | <varlistentry> | |
| 68 | <term><parameter>pname</parameter></term> | |
| 69 | <listitem> | |
| 70 | <para> | |
| 71 | Specifies the parameter value to be returned. | |
| 72 | The symbolic constants in the list below are accepted. | |
| 73 | </para> | |
| 74 | </listitem> | |
| 75 | </varlistentry> | |
| 76 | <varlistentry> | |
| 77 | <term><parameter>params</parameter></term> | |
| 78 | <listitem> | |
| 79 | <para> | |
| 80 | Returns the value or values of the specified parameter. | |
| 81 | </para> | |
| 82 | </listitem> | |
| 83 | </varlistentry> | |
| 84 | </variablelist> | |
| 85 | </refsect1> | |
| 86 | <refsynopsisdiv><title>C Specification</title> | |
| 87 | <funcsynopsis> | |
| 88 | <funcprototype> | |
| 89 | <funcdef>void <function>glGetBooleani_v</function></funcdef> | |
| 90 | <paramdef>GLenum <parameter>pname</parameter></paramdef> | |
| 91 | <paramdef>GLuint <parameter>index</parameter></paramdef> | |
| 92 | <paramdef>GLboolean * <parameter>data</parameter></paramdef> | |
| 93 | </funcprototype> | |
| 94 | </funcsynopsis> | |
| 95 | </refsynopsisdiv> | |
| 96 | <refsynopsisdiv><title>C Specification</title> | |
| 97 | <funcsynopsis> | |
| 98 | <funcprototype> | |
| 99 | <funcdef>void <function>glGetIntegeri_v</function></funcdef> | |
| 100 | <paramdef>GLenum <parameter>pname</parameter></paramdef> | |
| 101 | <paramdef>GLuint <parameter>index</parameter></paramdef> | |
| 102 | <paramdef>GLint * <parameter>data</parameter></paramdef> | |
| 103 | </funcprototype> | |
| 104 | </funcsynopsis> | |
| 105 | </refsynopsisdiv> | |
| 106 | <refsynopsisdiv><title>C Specification</title> | |
| 107 | <funcsynopsis> | |
| 108 | <funcprototype> | |
| 109 | <funcdef>void <function>glGetInteger64i_v</function></funcdef> | |
| 110 | <paramdef>GLenum <parameter>pname</parameter></paramdef> | |
| 111 | <paramdef>GLuint <parameter>index</parameter></paramdef> | |
| 112 | <paramdef>GLint64 * <parameter>data</parameter></paramdef> | |
| 113 | </funcprototype> | |
| 114 | </funcsynopsis> | |
| 115 | </refsynopsisdiv> | |
| 116 | <!-- eqn: ignoring delim $$ --> | |
| 117 | <refsect1 id="parameters2"><title>Parameters</title> | |
| 118 | <variablelist> | |
| 119 | <varlistentry> | |
| 120 | <term><parameter>pname</parameter></term> | |
| 121 | <listitem> | |
| 122 | <para> | |
| 123 | Specifies the parameter value to be returned. | |
| 124 | The symbolic constants in the list below are accepted. | |
| 125 | </para> | |
| 126 | </listitem> | |
| 127 | </varlistentry> | |
| 128 | <varlistentry> | |
| 129 | <term><parameter>index</parameter></term> | |
| 130 | <listitem> | |
| 131 | <para> | |
| 132 | Specifies the index of the particular element being queried. | |
| 133 | </para> | |
| 134 | </listitem> | |
| 135 | </varlistentry> | |
| 136 | <varlistentry> | |
| 137 | <term><parameter>data</parameter></term> | |
| 138 | <listitem> | |
| 139 | <para> | |
| 140 | Returns the value or values of the specified parameter. | |
| 141 | </para> | |
| 142 | </listitem> | |
| 143 | </varlistentry> | |
| 144 | </variablelist> | |
| 145 | </refsect1> | |
| 146 | <refsect1 id="description"><title>Description</title> | |
| 147 | <para> | |
| 148 | These four commands return values for simple state variables in GL. | |
| 149 | <parameter>pname</parameter> is a symbolic constant indicating the state variable to be returned, | |
| 150 | and <parameter>params</parameter> is a pointer to an array of the indicated type in | |
| 151 | which to place the returned data. | |
| 152 | </para> | |
| 153 | <para> | |
| 154 | Type conversion is performed if <parameter>params</parameter> has a different type than | |
| 155 | the state variable value being requested. | |
| 156 | If <function>glGetBooleanv</function> is called, | |
| 157 | a floating-point (or integer) value is converted to <constant>GL_FALSE</constant> if | |
| 158 | and only if it is 0.0 (or 0). | |
| 159 | Otherwise, | |
| 160 | it is converted to <constant>GL_TRUE</constant>. | |
| 161 | If <function>glGetIntegerv</function> is called, boolean values are returned as | |
| 162 | <constant>GL_TRUE</constant> or <constant>GL_FALSE</constant>, and most floating-point values are | |
| 163 | rounded to the nearest integer value. Floating-point colors and | |
| 164 | normals, however, are returned with a linear mapping that maps 1.0 to | |
| 165 | the most positive representable integer value | |
| 166 | and | |
| 167 | <inlineequation><mml:math> | |
| 168 | <!-- eqn: -1.0: --> | |
| 169 | <mml:mn>-1.0</mml:mn> | |
| 170 | </mml:math></inlineequation> | |
| 171 | to the most negative representable integer value. | |
| 172 | If <function>glGetFloatv</function> or <function>glGetDoublev</function> is called, | |
| 173 | boolean values are returned as <constant>GL_TRUE</constant> or <constant>GL_FALSE</constant>, | |
| 174 | and integer values are converted to floating-point values. | |
| 175 | </para> | |
| 176 | <para> | |
| 177 | The following symbolic constants are accepted by <parameter>pname</parameter>: | |
| 178 | </para> | |
| 179 | <variablelist> | |
| 180 | <varlistentry> | |
| 181 | <term><constant>GL_ACTIVE_TEXTURE</constant></term> | |
| 182 | <listitem> | |
| 183 | <para> | |
| 184 | </para> | |
| 185 | <para> | |
| 186 | <parameter>params</parameter> returns a single value indicating the active multitexture unit. | |
| 187 | The initial value is <constant>GL_TEXTURE0</constant>. | |
| 188 | See <citerefentry><refentrytitle>glActiveTexture</refentrytitle></citerefentry>. | |
| 189 | </para> | |
| 190 | </listitem> | |
| 191 | </varlistentry> | |
| 192 | <varlistentry> | |
| 193 | <term><constant>GL_ALIASED_LINE_WIDTH_RANGE</constant></term> | |
| 194 | <listitem> | |
| 195 | <para> | |
| 196 | </para> | |
| 197 | <para> | |
| 198 | <parameter>params</parameter> returns a pair of values indicating the range of | |
| 199 | widths supported for aliased lines. See <citerefentry><refentrytitle>glLineWidth</refentrytitle></citerefentry>. | |
| 200 | </para> | |
| 201 | </listitem> | |
| 202 | </varlistentry> | |
| 203 | <varlistentry> | |
| 204 | <term><constant>GL_SMOOTH_LINE_WIDTH_RANGE</constant></term> | |
| 205 | <listitem> | |
| 206 | <para> | |
| 207 | </para> | |
| 208 | <para> | |
| 209 | <parameter>params</parameter> returns a pair of values indicating the range of | |
| 210 | widths supported for smooth (antialiased) lines. See <citerefentry><refentrytitle>glLineWidth</refentrytitle></citerefentry>. | |
| 211 | </para> | |
| 212 | </listitem> | |
| 213 | </varlistentry> | |
| 214 | <varlistentry> | |
| 215 | <term><constant>GL_SMOOTH_LINE_WIDTH_GRANULARITY</constant></term> | |
| 216 | <listitem> | |
| 217 | <para> | |
| 218 | </para> | |
| 219 | <para> | |
| 220 | <parameter>params</parameter> returns a single value indicating the level of | |
| 221 | quantization applied to smooth line width parameters. | |
| 222 | </para> | |
| 223 | </listitem> | |
| 224 | </varlistentry> | |
| 225 | <varlistentry> | |
| 226 | <term><constant>GL_ARRAY_BUFFER_BINDING</constant></term> | |
| 227 | <listitem> | |
| 228 | <para> | |
| 229 | </para> | |
| 230 | <para> | |
| 231 | <parameter>params</parameter> returns a single value, the name of the buffer object | |
| 232 | currently bound to the target <constant>GL_ARRAY_BUFFER</constant>. If no buffer object | |
| 233 | is bound to this target, 0 is returned. The initial value is 0. | |
| 234 | See <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>. | |
| 235 | </para> | |
| 236 | </listitem> | |
| 237 | </varlistentry> | |
| 238 | <varlistentry> | |
| 239 | <term><constant>GL_BLEND</constant></term> | |
| 240 | <listitem> | |
| 241 | <para> | |
| 242 | </para> | |
| 243 | <para> | |
| 244 | <parameter>params</parameter> returns a single boolean value indicating whether blending is | |
| 245 | enabled. The initial value is <constant>GL_FALSE</constant>. | |
| 246 | See <citerefentry><refentrytitle>glBlendFunc</refentrytitle></citerefentry>. | |
| 247 | </para> | |
| 248 | </listitem> | |
| 249 | </varlistentry> | |
| 250 | <varlistentry> | |
| 251 | <term><constant>GL_BLEND_COLOR</constant></term> | |
| 252 | <listitem> | |
| 253 | <para> | |
| 254 | </para> | |
| 255 | <para> | |
| 256 | <parameter>params</parameter> returns four values, | |
| 257 | the red, green, blue, and alpha values which are the components of | |
| 258 | the blend color. | |
| 259 | See <citerefentry><refentrytitle>glBlendColor</refentrytitle></citerefentry>. | |
| 260 | </para> | |
| 261 | </listitem> | |
| 262 | </varlistentry> | |
| 263 | <varlistentry> | |
| 264 | <term><constant>GL_BLEND_DST_ALPHA</constant></term> | |
| 265 | <listitem> | |
| 266 | <para> | |
| 267 | </para> | |
| 268 | <para> | |
| 269 | <parameter>params</parameter> returns one value, | |
| 270 | the symbolic constant identifying the alpha destination blend | |
| 271 | function. The initial value is <constant>GL_ZERO</constant>. | |
| 272 | See <citerefentry><refentrytitle>glBlendFunc</refentrytitle></citerefentry> and <citerefentry><refentrytitle>glBlendFuncSeparate</refentrytitle></citerefentry>. | |
| 273 | </para> | |
| 274 | </listitem> | |
| 275 | </varlistentry> | |
| 276 | <varlistentry> | |
| 277 | <term><constant>GL_BLEND_DST_RGB</constant></term> | |
| 278 | <listitem> | |
| 279 | <para> | |
| 280 | </para> | |
| 281 | <para> | |
| 282 | <parameter>params</parameter> returns one value, | |
| 283 | the symbolic constant identifying the RGB destination blend | |
| 284 | function. The initial value is <constant>GL_ZERO</constant>. | |
| 285 | See <citerefentry><refentrytitle>glBlendFunc</refentrytitle></citerefentry> and <citerefentry><refentrytitle>glBlendFuncSeparate</refentrytitle></citerefentry>. | |
| 286 | </para> | |
| 287 | </listitem> | |
| 288 | </varlistentry> | |
| 289 | <varlistentry> | |
| 290 | <term><constant>GL_BLEND_EQUATION_RGB</constant></term> | |
| 291 | <listitem> | |
| 292 | <para> | |
| 293 | </para> | |
| 294 | <para> | |
| 295 | <parameter>params</parameter> returns one value, a symbolic constant indicating whether | |
| 296 | the RGB blend equation is <constant>GL_FUNC_ADD</constant>, <constant>GL_FUNC_SUBTRACT</constant>, | |
| 297 | <constant>GL_FUNC_REVERSE_SUBTRACT</constant>, <constant>GL_MIN</constant> or <constant>GL_MAX</constant>. | |
| 298 | See <citerefentry><refentrytitle>glBlendEquationSeparate</refentrytitle></citerefentry>. | |
| 299 | </para> | |
| 300 | </listitem> | |
| 301 | </varlistentry> | |
| 302 | <varlistentry> | |
| 303 | <term><constant>GL_BLEND_EQUATION_ALPHA</constant></term> | |
| 304 | <listitem> | |
| 305 | <para> | |
| 306 | </para> | |
| 307 | <para> | |
| 308 | <parameter>params</parameter> returns one value, a symbolic constant indicating whether | |
| 309 | the Alpha blend equation is <constant>GL_FUNC_ADD</constant>, <constant>GL_FUNC_SUBTRACT</constant>, | |
| 310 | <constant>GL_FUNC_REVERSE_SUBTRACT</constant>, <constant>GL_MIN</constant> or <constant>GL_MAX</constant>. | |
| 311 | See <citerefentry><refentrytitle>glBlendEquationSeparate</refentrytitle></citerefentry>. | |
| 312 | </para> | |
| 313 | </listitem> | |
| 314 | </varlistentry> | |
| 315 | <varlistentry> | |
| 316 | <term><constant>GL_BLEND_SRC_ALPHA</constant></term> | |
| 317 | <listitem> | |
| 318 | <para> | |
| 319 | </para> | |
| 320 | <para> | |
| 321 | <parameter>params</parameter> returns one value, | |
| 322 | the symbolic constant identifying the alpha source blend function. The initial | |
| 323 | value is <constant>GL_ONE</constant>. | |
| 324 | See <citerefentry><refentrytitle>glBlendFunc</refentrytitle></citerefentry> and <citerefentry><refentrytitle>glBlendFuncSeparate</refentrytitle></citerefentry>. | |
| 325 | </para> | |
| 326 | </listitem> | |
| 327 | </varlistentry> | |
| 328 | <varlistentry> | |
| 329 | <term><constant>GL_BLEND_SRC_RGB</constant></term> | |
| 330 | <listitem> | |
| 331 | <para> | |
| 332 | </para> | |
| 333 | <para> | |
| 334 | <parameter>params</parameter> returns one value, | |
| 335 | the symbolic constant identifying the RGB source blend function. The initial | |
| 336 | value is <constant>GL_ONE</constant>. | |
| 337 | See <citerefentry><refentrytitle>glBlendFunc</refentrytitle></citerefentry> and <citerefentry><refentrytitle>glBlendFuncSeparate</refentrytitle></citerefentry>. | |
| 338 | </para> | |
| 339 | </listitem> | |
| 340 | </varlistentry> | |
| 341 | <varlistentry> | |
| 342 | <term><constant>GL_COLOR_CLEAR_VALUE</constant></term> | |
| 343 | <listitem> | |
| 344 | <para> | |
| 345 | </para> | |
| 346 | <para> | |
| 347 | <parameter>params</parameter> returns four values: | |
| 348 | the red, green, blue, and alpha values used to clear the color buffers. | |
| 349 | Integer values, | |
| 350 | if requested, | |
| 351 | are linearly mapped from the internal floating-point representation such | |
| 352 | that 1.0 returns the most positive representable integer value, | |
| 353 | and | |
| 354 | <inlineequation><mml:math> | |
| 355 | <!-- eqn: -1.0: --> | |
| 356 | <mml:mn>-1.0</mml:mn> | |
| 357 | </mml:math></inlineequation> | |
| 358 | returns the most negative representable integer | |
| 359 | value. The initial value is (0, 0, 0, 0). | |
| 360 | See <citerefentry><refentrytitle>glClearColor</refentrytitle></citerefentry>. | |
| 361 | </para> | |
| 362 | </listitem> | |
| 363 | </varlistentry> | |
| 364 | <varlistentry> | |
| 365 | <term><constant>GL_COLOR_LOGIC_OP</constant></term> | |
| 366 | <listitem> | |
| 367 | <para> | |
| 368 | </para> | |
| 369 | <para> | |
| 370 | <parameter>params</parameter> returns a single boolean value indicating whether a fragment's | |
| 371 | RGBA color values are merged into the framebuffer using a logical | |
| 372 | operation. The initial value is <constant>GL_FALSE</constant>. | |
| 373 | See <citerefentry><refentrytitle>glLogicOp</refentrytitle></citerefentry>. | |
| 374 | </para> | |
| 375 | </listitem> | |
| 376 | </varlistentry> | |
| 377 | <varlistentry> | |
| 378 | <term><constant>GL_COLOR_WRITEMASK</constant></term> | |
| 379 | <listitem> | |
| 380 | <para> | |
| 381 | </para> | |
| 382 | <para> | |
| 383 | <parameter>params</parameter> returns four boolean values: | |
| 384 | the red, green, blue, and alpha write enables for the color | |
| 385 | buffers. The initial value is (<constant>GL_TRUE</constant>, <constant>GL_TRUE</constant>, | |
| 386 | <constant>GL_TRUE</constant>, <constant>GL_TRUE</constant>). | |
| 387 | See <citerefentry><refentrytitle>glColorMask</refentrytitle></citerefentry>. | |
| 388 | </para> | |
| 389 | </listitem> | |
| 390 | </varlistentry> | |
| 391 | <varlistentry> | |
| 392 | <term><constant>GL_COMPRESSED_TEXTURE_FORMATS</constant></term> | |
| 393 | <listitem> | |
| 394 | <para> | |
| 395 | </para> | |
| 396 | <para> | |
| 397 | <parameter>params</parameter> returns a list of symbolic | |
| 398 | constants of length <constant>GL_NUM_COMPRESSED_TEXTURE_FORMATS</constant> | |
| 399 | indicating which compressed texture formats are available. | |
| 400 | See <citerefentry><refentrytitle>glCompressedTexImage2D</refentrytitle></citerefentry>. | |
| 401 | </para> | |
| 402 | </listitem> | |
| 403 | </varlistentry> | |
| 404 | <varlistentry> | |
| 405 | <term><constant>GL_CULL_FACE</constant></term> | |
| 406 | <listitem> | |
| 407 | <para> | |
| 408 | </para> | |
| 409 | <para> | |
| 410 | <parameter>params</parameter> returns a single boolean value indicating whether polygon culling | |
| 411 | is enabled. The initial value is <constant>GL_FALSE</constant>. | |
| 412 | See <citerefentry><refentrytitle>glCullFace</refentrytitle></citerefentry>. | |
| 413 | </para> | |
| 414 | </listitem> | |
| 415 | </varlistentry> | |
| 416 | <varlistentry> | |
| 417 | <term><constant>GL_CURRENT_PROGRAM</constant></term> | |
| 418 | <listitem> | |
| 419 | <para> | |
| 420 | </para> | |
| 421 | <para> | |
| 422 | <parameter>params</parameter> returns one value, | |
| 423 | the name of the program object that is currently active, or 0 if no program object is active. | |
| 424 | See <citerefentry><refentrytitle>glUseProgram</refentrytitle></citerefentry>. | |
| 425 | </para> | |
| 426 | </listitem> | |
| 427 | </varlistentry> | |
| 428 | <varlistentry> | |
| 429 | <term><constant>GL_DEPTH_CLEAR_VALUE</constant></term> | |
| 430 | <listitem> | |
| 431 | <para> | |
| 432 | </para> | |
| 433 | <para> | |
| 434 | <parameter>params</parameter> returns one value, | |
| 435 | the value that is used to clear the depth buffer. | |
| 436 | Integer values, | |
| 437 | if requested, | |
| 438 | are linearly mapped from the internal floating-point representation such | |
| 439 | that 1.0 returns the most positive representable integer value, | |
| 440 | and | |
| 441 | <inlineequation><mml:math> | |
| 442 | <!-- eqn: -1.0: --> | |
| 443 | <mml:mn>-1.0</mml:mn> | |
| 444 | </mml:math></inlineequation> | |
| 445 | returns the most negative representable integer | |
| 446 | value. The initial value is 1. | |
| 447 | See <citerefentry><refentrytitle>glClearDepth</refentrytitle></citerefentry>. | |
| 448 | </para> | |
| 449 | </listitem> | |
| 450 | </varlistentry> | |
| 451 | <varlistentry> | |
| 452 | <term><constant>GL_DEPTH_FUNC</constant></term> | |
| 453 | <listitem> | |
| 454 | <para> | |
| 455 | </para> | |
| 456 | <para> | |
| 457 | <parameter>params</parameter> returns one value, | |
| 458 | the symbolic constant that indicates the depth comparison | |
| 459 | function. The initial value is <constant>GL_LESS</constant>. | |
| 460 | See <citerefentry><refentrytitle>glDepthFunc</refentrytitle></citerefentry>. | |
| 461 | </para> | |
| 462 | </listitem> | |
| 463 | </varlistentry> | |
| 464 | <varlistentry> | |
| 465 | <term><constant>GL_DEPTH_RANGE</constant></term> | |
| 466 | <listitem> | |
| 467 | <para> | |
| 468 | </para> | |
| 469 | <para> | |
| 470 | <parameter>params</parameter> returns two values: | |
| 471 | the near and far mapping limits for the depth buffer. | |
| 472 | Integer values, | |
| 473 | if requested, | |
| 474 | are linearly mapped from the internal floating-point representation such | |
| 475 | that 1.0 returns the most positive representable integer value, | |
| 476 | and | |
| 477 | <inlineequation><mml:math> | |
| 478 | <!-- eqn: -1.0: --> | |
| 479 | <mml:mn>-1.0</mml:mn> | |
| 480 | </mml:math></inlineequation> | |
| 481 | returns the most negative representable integer | |
| 482 | value. The initial value is (0, 1). | |
| 483 | See <citerefentry><refentrytitle>glDepthRange</refentrytitle></citerefentry>. | |
| 484 | </para> | |
| 485 | </listitem> | |
| 486 | </varlistentry> | |
| 487 | <varlistentry> | |
| 488 | <term><constant>GL_DEPTH_TEST</constant></term> | |
| 489 | <listitem> | |
| 490 | <para> | |
| 491 | </para> | |
| 492 | <para> | |
| 493 | <parameter>params</parameter> returns a single boolean value indicating whether depth testing | |
| 494 | of fragments is enabled. The initial value is <constant>GL_FALSE</constant>. | |
| 495 | See <citerefentry><refentrytitle>glDepthFunc</refentrytitle></citerefentry> and <citerefentry><refentrytitle>glDepthRange</refentrytitle></citerefentry>. | |
| 496 | </para> | |
| 497 | </listitem> | |
| 498 | </varlistentry> | |
| 499 | <varlistentry> | |
| 500 | <term><constant>GL_DEPTH_WRITEMASK</constant></term> | |
| 501 | <listitem> | |
| 502 | <para> | |
| 503 | </para> | |
| 504 | <para> | |
| 505 | <parameter>params</parameter> returns a single boolean value indicating if the depth buffer | |
| 506 | is enabled for writing. The initial value is <constant>GL_TRUE</constant>. | |
| 507 | See <citerefentry><refentrytitle>glDepthMask</refentrytitle></citerefentry>. | |
| 508 | </para> | |
| 509 | </listitem> | |
| 510 | </varlistentry> | |
| 511 | <varlistentry> | |
| 512 | <term><constant>GL_DITHER</constant></term> | |
| 513 | <listitem> | |
| 514 | <para> | |
| 515 | </para> | |
| 516 | <para> | |
| 517 | <parameter>params</parameter> returns a single boolean value indicating whether dithering of | |
| 518 | fragment colors and indices is enabled. The initial value is <constant>GL_TRUE</constant>. | |
| 519 | </para> | |
| 520 | </listitem> | |
| 521 | </varlistentry> | |
| 522 | <varlistentry> | |
| 523 | <term><constant>GL_DOUBLEBUFFER</constant></term> | |
| 524 | <listitem> | |
| 525 | <para> | |
| 526 | </para> | |
| 527 | <para> | |
| 528 | <parameter>params</parameter> returns a single boolean value indicating whether double buffering | |
| 529 | is supported. | |
| 530 | </para> | |
| 531 | </listitem> | |
| 532 | </varlistentry> | |
| 533 | <varlistentry> | |
| 534 | <term><constant>GL_DRAW_BUFFER</constant></term> | |
| 535 | <listitem> | |
| 536 | <para> | |
| 537 | </para> | |
| 538 | <para> | |
| 539 | <parameter>params</parameter> returns one value, | |
| 540 | a symbolic constant indicating which buffers are being drawn to. | |
| 541 | See <citerefentry><refentrytitle>glDrawBuffer</refentrytitle></citerefentry>. The initial value is <constant>GL_BACK</constant> if there | |
| 542 | are back buffers, otherwise it is <constant>GL_FRONT</constant>. | |
| 543 | </para> | |
| 544 | </listitem> | |
| 545 | </varlistentry> | |
| 546 | <varlistentry> | |
| 547 | <term><constant>GL_DRAW_BUFFER</constant><emphasis>i</emphasis></term> | |
| 548 | <listitem> | |
| 549 | <para> | |
| 550 | </para> | |
| 551 | <para> | |
| 552 | <parameter>params</parameter> returns one value, | |
| 553 | a symbolic constant indicating which buffers are being drawn to by the corresponding output color. | |
| 554 | See <citerefentry><refentrytitle>glDrawBuffers</refentrytitle></citerefentry>. | |
| 555 | The initial value of <constant>GL_DRAW_BUFFER0</constant> is <constant>GL_BACK</constant> if there | |
| 556 | are back buffers, otherwise it is <constant>GL_FRONT</constant>. The | |
| 557 | initial values of draw buffers for all other output colors is <constant>GL_NONE</constant>. | |
| 558 | </para> | |
| 559 | </listitem> | |
| 560 | </varlistentry> | |
| 561 | <varlistentry> | |
| 562 | <term><constant>GL_DRAW_FRAMEBUFFER_BINDING</constant></term> | |
| 563 | <listitem> | |
| 564 | <para> | |
| 565 | </para> | |
| 566 | <para> | |
| 567 | <parameter>params</parameter> returns one value, | |
| 568 | the name of the framebuffer object currently bound to the <constant>GL_DRAW_FRAMEBUFFER</constant> target. | |
| 569 | If the default framebuffer is bound, this value will be zero. The initial value is zero. | |
| 570 | See <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>. | |
| 571 | </para> | |
| 572 | </listitem> | |
| 573 | </varlistentry> | |
| 574 | <varlistentry> | |
| 575 | <term><constant>GL_READ_FRAMEBUFFER_BINDING</constant></term> | |
| 576 | <listitem> | |
| 577 | <para> | |
| 578 | </para> | |
| 579 | <para> | |
| 580 | <parameter>params</parameter> returns one value, | |
| 581 | the name of the framebuffer object currently bound to the <constant>GL_READ_FRAMEBUFFER</constant> target. | |
| 582 | If the default framebuffer is bound, this value will be zero. The initial value is zero. | |
| 583 | See <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>. | |
| 584 | </para> | |
| 585 | </listitem> | |
| 586 | </varlistentry> | |
| 587 | <varlistentry> | |
| 588 | <term><constant>GL_ELEMENT_ARRAY_BUFFER_BINDING</constant></term> | |
| 589 | <listitem> | |
| 590 | <para> | |
| 591 | </para> | |
| 592 | <para> | |
| 593 | <parameter>params</parameter> returns a single value, the name of the buffer object | |
| 594 | currently bound to the target <constant>GL_ELEMENT_ARRAY_BUFFER</constant>. If no buffer object | |
| 595 | is bound to this target, 0 is returned. The initial value is 0. | |
| 596 | See <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>. | |
| 597 | </para> | |
| 598 | </listitem> | |
| 599 | </varlistentry> | |
| 600 | <varlistentry> | |
| 601 | <term><constant>GL_RENDERBUFFER_BINDING</constant></term> | |
| 602 | <listitem> | |
| 603 | <para> | |
| 604 | </para> | |
| 605 | <para> | |
| 606 | <parameter>params</parameter> returns a single value, the name of the renderbuffer object | |
| 607 | currently bound to the target <constant>GL_RENDERBUFFER</constant>. If no renderbuffer object | |
| 608 | is bound to this target, 0 is returned. The initial value is 0. | |
| 609 | See <citerefentry><refentrytitle>glBindRenderbuffer</refentrytitle></citerefentry>. | |
| 610 | </para> | |
| 611 | </listitem> | |
| 612 | </varlistentry> | |
| 613 | <varlistentry> | |
| 614 | <term><constant>GL_FRAGMENT_SHADER_DERIVATIVE_HINT</constant></term> | |
| 615 | <listitem> | |
| 616 | <para> | |
| 617 | </para> | |
| 618 | <para> | |
| 619 | <parameter>params</parameter> returns one value, | |
| 620 | a symbolic constant indicating the mode of the derivative accuracy hint | |
| 621 | for fragment shaders. The initial value | |
| 622 | is <constant>GL_DONT_CARE</constant>. | |
| 623 | See <citerefentry><refentrytitle>glHint</refentrytitle></citerefentry>. | |
| 624 | </para> | |
| 625 | </listitem> | |
| 626 | </varlistentry> | |
| 627 | <varlistentry> | |
| 628 | <term><constant>GL_LINE_SMOOTH</constant></term> | |
| 629 | <listitem> | |
| 630 | <para> | |
| 631 | </para> | |
| 632 | <para> | |
| 633 | <parameter>params</parameter> returns a single boolean value indicating whether antialiasing of | |
| 634 | lines is enabled. The initial value is <constant>GL_FALSE</constant>. | |
| 635 | See <citerefentry><refentrytitle>glLineWidth</refentrytitle></citerefentry>. | |
| 636 | </para> | |
| 637 | </listitem> | |
| 638 | </varlistentry> | |
| 639 | <varlistentry> | |
| 640 | <term><constant>GL_LINE_SMOOTH_HINT</constant></term> | |
| 641 | <listitem> | |
| 642 | <para> | |
| 643 | </para> | |
| 644 | <para> | |
| 645 | <parameter>params</parameter> returns one value, | |
| 646 | a symbolic constant indicating the mode of the line antialiasing | |
| 647 | hint. The initial value is <constant>GL_DONT_CARE</constant>. | |
| 648 | See <citerefentry><refentrytitle>glHint</refentrytitle></citerefentry>. | |
| 649 | </para> | |
| 650 | </listitem> | |
| 651 | </varlistentry> | |
| 652 | <varlistentry> | |
| 653 | <term><constant>GL_LINE_WIDTH</constant></term> | |
| 654 | <listitem> | |
| 655 | <para> | |
| 656 | </para> | |
| 657 | <para> | |
| 658 | <parameter>params</parameter> returns one value, | |
| 659 | the line width as specified with <citerefentry><refentrytitle>glLineWidth</refentrytitle></citerefentry>. The initial value is | |
| 660 | 1. | |
| 661 | </para> | |
| 662 | </listitem> | |
| 663 | </varlistentry> | |
| 664 | <varlistentry> | |
| 665 | <term><constant>GL_LINE_WIDTH_GRANULARITY</constant></term> | |
| 666 | <listitem> | |
| 667 | <para> | |
| 668 | </para> | |
| 669 | <para> | |
| 670 | <parameter>params</parameter> returns one value, | |
| 671 | the width difference between adjacent supported widths for antialiased lines. | |
| 672 | See <citerefentry><refentrytitle>glLineWidth</refentrytitle></citerefentry>. | |
| 673 | </para> | |
| 674 | </listitem> | |
| 675 | </varlistentry> | |
| 676 | <varlistentry> | |
| 677 | <term><constant>GL_LINE_WIDTH_RANGE</constant></term> | |
| 678 | <listitem> | |
| 679 | <para> | |
| 680 | </para> | |
| 681 | <para> | |
| 682 | <parameter>params</parameter> returns two values: | |
| 683 | the smallest and largest supported widths for antialiased | |
| 684 | lines. | |
| 685 | See <citerefentry><refentrytitle>glLineWidth</refentrytitle></citerefentry>. | |
| 686 | </para> | |
| 687 | </listitem> | |
| 688 | </varlistentry> | |
| 689 | <varlistentry> | |
| 690 | <term><constant>GL_LOGIC_OP_MODE</constant></term> | |
| 691 | <listitem> | |
| 692 | <para> | |
| 693 | </para> | |
| 694 | <para> | |
| 695 | <parameter>params</parameter> returns one value, | |
| 696 | a symbolic constant indicating the selected logic operation | |
| 697 | mode. The initial value is <constant>GL_COPY</constant>. | |
| 698 | See <citerefentry><refentrytitle>glLogicOp</refentrytitle></citerefentry>. | |
| 699 | </para> | |
| 700 | </listitem> | |
| 701 | </varlistentry> | |
| 702 | <varlistentry> | |
| 703 | <term><constant>GL_MAX_3D_TEXTURE_SIZE</constant></term> | |
| 704 | <listitem> | |
| 705 | <para> | |
| 706 | </para> | |
| 707 | <para> | |
| 708 | <parameter>params</parameter> returns one value, | |
| 709 | a rough estimate of the largest 3D texture that the GL can handle. | |
| 710 | The value must be at least 64. | |
| 711 | Use <constant>GL_PROXY_TEXTURE_3D</constant> to determine if a texture is too large. | |
| 712 | See <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>. | |
| 713 | </para> | |
| 714 | </listitem> | |
| 715 | </varlistentry> | |
| 716 | <varlistentry> | |
| 717 | <term><constant>GL_MAX_CLIP_DISTANCES</constant></term> | |
| 718 | <listitem> | |
| 719 | <para> | |
| 720 | </para> | |
| 721 | <para> | |
| 722 | <parameter>params</parameter> returns one value, | |
| 723 | the maximum number of application-defined clipping distances. The value must be at least 8. | |
| 724 | </para> | |
| 725 | </listitem> | |
| 726 | </varlistentry> | |
| 727 | <varlistentry> | |
| 728 | <term><constant>GL_MAX_COMBINED_FRAGMENT_UNIFORM_COMPONENTS</constant></term> | |
| 729 | <listitem> | |
| 730 | <para> | |
| 731 | </para> | |
| 732 | <para> | |
| 733 | <parameter>params</parameter> returns one value, | |
| 734 | the number of words for fragment shader uniform variables in all uniform | |
| 735 | blocks (including default). The value must be at least 1. | |
| 736 | See <citerefentry><refentrytitle>glUniform</refentrytitle></citerefentry>. | |
| 737 | </para> | |
| 738 | </listitem> | |
| 739 | </varlistentry> | |
| 740 | <varlistentry> | |
| 741 | <term><constant>GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS</constant></term> | |
| 742 | <listitem> | |
| 743 | <para> | |
| 744 | </para> | |
| 745 | <para> | |
| 746 | <parameter>params</parameter> returns one value, the maximum supported texture image units that | |
| 747 | can be used to access texture maps from the vertex shader and the fragment processor combined. | |
| 748 | If both the vertex shader and the fragment processing stage access the same texture image | |
| 749 | unit, then that counts as using two texture image units against this limit. | |
| 750 | The value must be at least 48. | |
| 751 | See <citerefentry><refentrytitle>glActiveTexture</refentrytitle></citerefentry>. | |
| 752 | </para> | |
| 753 | </listitem> | |
| 754 | </varlistentry> | |
| 755 | <varlistentry> | |
| 756 | <term><constant>GL_MAX_COMBINED_VERTEX_UNIFORM_COMPONENTS</constant></term> | |
| 757 | <listitem> | |
| 758 | <para> | |
| 759 | </para> | |
| 760 | <para> | |
| 761 | <parameter>params</parameter> returns one value, | |
| 762 | the number of words for vertex shader uniform variables in all uniform | |
| 763 | blocks (including default). The value must be at least 1. | |
| 764 | See <citerefentry><refentrytitle>glUniform</refentrytitle></citerefentry>. | |
| 765 | </para> | |
| 766 | </listitem> | |
| 767 | </varlistentry> | |
| 768 | <varlistentry> | |
| 769 | <term><constant>GL_MAX_COMBINED_GEOMETRY_UNIFORM_COMPONENTS</constant></term> | |
| 770 | <listitem> | |
| 771 | <para> | |
| 772 | </para> | |
| 773 | <para> | |
| 774 | <parameter>params</parameter> returns one value, | |
| 775 | the number of words for geometry shader uniform variables in all uniform | |
| 776 | blocks (including default). The value must be at least 1. | |
| 777 | See <citerefentry><refentrytitle>glUniform</refentrytitle></citerefentry>. | |
| 778 | </para> | |
| 779 | </listitem> | |
| 780 | </varlistentry> | |
| 781 | <varlistentry> | |
| 782 | <term><constant>GL_MAX_VARYING_COMPONENTS</constant></term> | |
| 783 | <listitem> | |
| 784 | <para> | |
| 785 | </para> | |
| 786 | <para> | |
| 787 | <parameter>params</parameter> returns one value, | |
| 788 | the number components for varying variables, which must be at least 60. | |
| 789 | </para> | |
| 790 | </listitem> | |
| 791 | </varlistentry> | |
| 792 | <varlistentry> | |
| 793 | <term><constant>GL_MAX_COMBINED_UNIFORM_BLOCKS</constant></term> | |
| 794 | <listitem> | |
| 795 | <para> | |
| 796 | </para> | |
| 797 | <para> | |
| 798 | <parameter>params</parameter> returns one value, | |
| 799 | the maximum number of uniform blocks per program. The value must be at least 36. | |
| 800 | See <citerefentry><refentrytitle>glUniformBlockBinding</refentrytitle></citerefentry>. | |
| 801 | </para> | |
| 802 | </listitem> | |
| 803 | </varlistentry> | |
| 804 | <varlistentry> | |
| 805 | <term><constant>GL_MAX_CUBE_MAP_TEXTURE_SIZE</constant></term> | |
| 806 | <listitem> | |
| 807 | <para> | |
| 808 | </para> | |
| 809 | <para> | |
| 810 | <parameter>params</parameter> returns one value. | |
| 811 | The value gives a rough estimate of the largest cube-map texture that | |
| 812 | the GL can handle. The value must be at least 1024. | |
| 813 | Use <constant>GL_PROXY_TEXTURE_CUBE_MAP</constant> | |
| 814 | to determine if a texture is too large. | |
| 815 | See <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>. | |
| 816 | </para> | |
| 817 | </listitem> | |
| 818 | </varlistentry> | |
| 819 | <varlistentry> | |
| 820 | <term><constant>GL_MAX_DRAW_BUFFERS</constant></term> | |
| 821 | <listitem> | |
| 822 | <para> | |
| 823 | </para> | |
| 824 | <para> | |
| 825 | <parameter>params</parameter> returns one value, the maximum number | |
| 826 | of simultaneous outputs that may be written in a fragment shader. | |
| 827 | The value must be at least 8. | |
| 828 | See <citerefentry><refentrytitle>glDrawBuffers</refentrytitle></citerefentry>. | |
| 829 | </para> | |
| 830 | </listitem> | |
| 831 | </varlistentry> | |
| 832 | <varlistentry> | |
| 833 | <term><constant>GL_MAX_DUALSOURCE_DRAW_BUFFERS</constant></term> | |
| 834 | <listitem> | |
| 835 | <para> | |
| 836 | </para> | |
| 837 | <para> | |
| 838 | <parameter>params</parameter> returns one value, the maximum number | |
| 839 | of active draw buffers when using dual-source blending. The value must be at least 1. | |
| 840 | See <citerefentry><refentrytitle>glBlendFunc</refentrytitle></citerefentry> and | |
| 841 | <citerefentry><refentrytitle>glBlendFuncSeparate</refentrytitle></citerefentry>. | |
| 842 | </para> | |
| 843 | </listitem> | |
| 844 | </varlistentry> | |
| 845 | <varlistentry> | |
| 846 | <term><constant>GL_MAX_ELEMENTS_INDICES</constant></term> | |
| 847 | <listitem> | |
| 848 | <para> | |
| 849 | </para> | |
| 850 | <para> | |
| 851 | <parameter>params</parameter> returns one value, | |
| 852 | the recommended maximum number of vertex array indices. | |
| 853 | See <citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry>. | |
| 854 | </para> | |
| 855 | </listitem> | |
| 856 | </varlistentry> | |
| 857 | <varlistentry> | |
| 858 | <term><constant>GL_MAX_ELEMENTS_VERTICES</constant></term> | |
| 859 | <listitem> | |
| 860 | <para> | |
| 861 | </para> | |
| 862 | <para> | |
| 863 | <parameter>params</parameter> returns one value, | |
| 864 | the recommended maximum number of vertex array vertices. | |
| 865 | See <citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry>. | |
| 866 | </para> | |
| 867 | </listitem> | |
| 868 | </varlistentry> | |
| 869 | <varlistentry> | |
| 870 | <term><constant>GL_MAX_FRAGMENT_UNIFORM_COMPONENTS</constant></term> | |
| 871 | <listitem> | |
| 872 | <para> | |
| 873 | </para> | |
| 874 | <para> | |
| 875 | <parameter>params</parameter> returns one value, | |
| 876 | the maximum number of individual floating-point, integer, or boolean values that can be held | |
| 877 | in uniform variable storage for a fragment shader. The value must be at least 1024. | |
| 878 | See <citerefentry><refentrytitle>glUniform</refentrytitle></citerefentry>. | |
| 879 | </para> | |
| 880 | </listitem> | |
| 881 | </varlistentry> | |
| 882 | <varlistentry> | |
| 883 | <term><constant>GL_MAX_FRAGMENT_UNIFORM_BLOCKS</constant></term> | |
| 884 | <listitem> | |
| 885 | <para> | |
| 886 | </para> | |
| 887 | <para> | |
| 888 | <parameter>params</parameter> returns one value, | |
| 889 | the maximum number of uniform blocks per fragment shader. The value must be at least 12. | |
| 890 | See <citerefentry><refentrytitle>glUniformBlockBinding</refentrytitle></citerefentry>. | |
| 891 | </para> | |
| 892 | </listitem> | |
| 893 | </varlistentry> | |
| 894 | <varlistentry> | |
| 895 | <term><constant>GL_MAX_FRAGMENT_INPUT_COMPONENTS</constant></term> | |
| 896 | <listitem> | |
| 897 | <para> | |
| 898 | </para> | |
| 899 | <para> | |
| 900 | <parameter>params</parameter> returns one value, | |
| 901 | the maximum number of components of the inputs read by the fragment shader, which must be at least 128. | |
| 902 | </para> | |
| 903 | </listitem> | |
| 904 | </varlistentry> | |
| 905 | <varlistentry> | |
| 906 | <term><constant>GL_MIN_PROGRAM_TEXEL_OFFSET</constant></term> | |
| 907 | <listitem> | |
| 908 | <para> | |
| 909 | </para> | |
| 910 | <para> | |
| 911 | <parameter>params</parameter> returns one value, | |
| 912 | the minimum texel offset allowed in a texture lookup, which must be at most -8. | |
| 913 | </para> | |
| 914 | </listitem> | |
| 915 | </varlistentry> | |
| 916 | <varlistentry> | |
| 917 | <term><constant>GL_MAX_PROGRAM_TEXEL_OFFSET</constant></term> | |
| 918 | <listitem> | |
| 919 | <para> | |
| 920 | </para> | |
| 921 | <para> | |
| 922 | <parameter>params</parameter> returns one value, | |
| 923 | the maximum texel offset allowed in a texture lookup, which must be at least 7. | |
| 924 | </para> | |
| 925 | </listitem> | |
| 926 | </varlistentry> | |
| 927 | <varlistentry> | |
| 928 | <term><constant>GL_MAX_RECTANGLE_TEXTURE_SIZE</constant></term> | |
| 929 | <listitem> | |
| 930 | <para> | |
| 931 | </para> | |
| 932 | <para> | |
| 933 | <parameter>params</parameter> returns one value. | |
| 934 | The value gives a rough estimate of the largest rectangular texture that | |
| 935 | the GL can handle. The value must be at least 1024. | |
| 936 | Use <constant>GL_PROXY_RECTANGLE_TEXTURE</constant> | |
| 937 | to determine if a texture is too large. | |
| 938 | See <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>. | |
| 939 | </para> | |
| 940 | </listitem> | |
| 941 | </varlistentry> | |
| 942 | <varlistentry> | |
| 943 | <term><constant>GL_MAX_TEXTURE_IMAGE_UNITS</constant></term> | |
| 944 | <listitem> | |
| 945 | <para> | |
| 946 | </para> | |
| 947 | <para> | |
| 948 | <parameter>params</parameter> returns one value, the maximum supported texture image units that | |
| 949 | can be used to access texture maps from the fragment shader. | |
| 950 | The value must be at least 16. | |
| 951 | See <citerefentry><refentrytitle>glActiveTexture</refentrytitle></citerefentry>. | |
| 952 | </para> | |
| 953 | </listitem> | |
| 954 | </varlistentry> | |
| 955 | <varlistentry> | |
| 956 | <term><constant>GL_MAX_TEXTURE_LOD_BIAS</constant></term> | |
| 957 | <listitem> | |
| 958 | <para> | |
| 959 | </para> | |
| 960 | <para> | |
| 961 | <parameter>params</parameter> returns one value, | |
| 962 | the maximum, absolute value of the texture level-of-detail bias. The | |
| 963 | value must be at least 2.0. | |
| 964 | </para> | |
| 965 | </listitem> | |
| 966 | </varlistentry> | |
| 967 | <varlistentry> | |
| 968 | <term><constant>GL_MAX_TEXTURE_SIZE</constant></term> | |
| 969 | <listitem> | |
| 970 | <para> | |
| 971 | </para> | |
| 972 | <para> | |
| 973 | <parameter>params</parameter> returns one value. | |
| 974 | The value gives a rough estimate of the largest texture that | |
| 975 | the GL can handle. The value must be at least 1024. | |
| 976 | Use a proxy texture target such as <constant>GL_PROXY_TEXTURE_1D</constant> or <constant>GL_PROXY_TEXTURE_2D</constant> | |
| 977 | to determine if a texture is too large. | |
| 978 | See <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry> and <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>. | |
| 979 | </para> | |
| 980 | </listitem> | |
| 981 | </varlistentry> | |
| 982 | <varlistentry> | |
| 983 | <term><constant>GL_MAX_RENDERBUFFER_SIZE</constant></term> | |
| 984 | <listitem> | |
| 985 | <para> | |
| 986 | </para> | |
| 987 | <para> | |
| 988 | <parameter>params</parameter> returns one value. | |
| 989 | The value indicates the maximum supported size for renderbuffers. | |
| 990 | See <citerefentry><refentrytitle>glFramebufferRenderbuffer</refentrytitle></citerefentry>. | |
| 991 | </para> | |
| 992 | </listitem> | |
| 993 | </varlistentry> | |
| 994 | <varlistentry> | |
| 995 | <term><constant>GL_MAX_ARRAY_TEXTURE_LAYERS</constant></term> | |
| 996 | <listitem> | |
| 997 | <para> | |
| 998 | </para> | |
| 999 | <para> | |
| 1000 | <parameter>params</parameter> returns one value. | |
| 1001 | The value indicates the maximum number of layers allowed in an array texture, and must be at least 256. | |
| 1002 | See <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>. | |
| 1003 | </para> | |
| 1004 | </listitem> | |
| 1005 | </varlistentry> | |
| 1006 | <varlistentry> | |
| 1007 | <term><constant>GL_MAX_TEXTURE_BUFFER_SIZE</constant></term> | |
| 1008 | <listitem> | |
| 1009 | <para> | |
| 1010 | </para> | |
| 1011 | <para> | |
| 1012 | <parameter>params</parameter> returns one value. | |
| 1013 | The value gives the maximum number of texels allowed in the texel array of a texture buffer object. | |
| 1014 | Value must be at least 65536. | |
| 1015 | </para> | |
| 1016 | </listitem> | |
| 1017 | </varlistentry> | |
| 1018 | <varlistentry> | |
| 1019 | <term><constant>GL_MAX_UNIFORM_BLOCK_SIZE</constant></term> | |
| 1020 | <listitem> | |
| 1021 | <para> | |
| 1022 | </para> | |
| 1023 | <para> | |
| 1024 | <parameter>params</parameter> returns one value, | |
| 1025 | the maximum size in basic machine units of a uniform block. | |
| 1026 | The value must be at least 16384. | |
| 1027 | See <citerefentry><refentrytitle>glUniformBlockBinding</refentrytitle></citerefentry>. | |
| 1028 | </para> | |
| 1029 | </listitem> | |
| 1030 | </varlistentry> | |
| 1031 | <varlistentry> | |
| 1032 | <term><constant>GL_MAX_VARYING_FLOATS</constant></term> | |
| 1033 | <listitem> | |
| 1034 | <para> | |
| 1035 | </para> | |
| 1036 | <para> | |
| 1037 | <parameter>params</parameter> returns one value, | |
| 1038 | the maximum number of interpolators available for processing varying variables used by | |
| 1039 | vertex and fragment shaders. This value represents the number of individual floating-point | |
| 1040 | values that can be interpolated; varying variables declared as vectors, matrices, and arrays | |
| 1041 | will all consume multiple interpolators. The value must be at least 32. | |
| 1042 | </para> | |
| 1043 | </listitem> | |
| 1044 | </varlistentry> | |
| 1045 | <varlistentry> | |
| 1046 | <term><constant>GL_MAX_VERTEX_ATTRIBS</constant></term> | |
| 1047 | <listitem> | |
| 1048 | <para> | |
| 1049 | </para> | |
| 1050 | <para> | |
| 1051 | <parameter>params</parameter> returns one value, | |
| 1052 | the maximum number of 4-component generic vertex attributes accessible to a vertex shader. | |
| 1053 | The value must be at least 16. | |
| 1054 | See <citerefentry><refentrytitle>glVertexAttrib</refentrytitle></citerefentry>. | |
| 1055 | </para> | |
| 1056 | </listitem> | |
| 1057 | </varlistentry> | |
| 1058 | <varlistentry> | |
| 1059 | <term><constant>GL_MAX_VERTEX_TEXTURE_IMAGE_UNITS</constant></term> | |
| 1060 | <listitem> | |
| 1061 | <para> | |
| 1062 | </para> | |
| 1063 | <para> | |
| 1064 | <parameter>params</parameter> returns one value, the maximum supported texture image units that | |
| 1065 | can be used to access texture maps from the vertex shader. The value may be at least 16. | |
| 1066 | See <citerefentry><refentrytitle>glActiveTexture</refentrytitle></citerefentry>. | |
| 1067 | </para> | |
| 1068 | </listitem> | |
| 1069 | </varlistentry> | |
| 1070 | <varlistentry> | |
| 1071 | <term><constant>GL_MAX_GEOMETRY_TEXTURE_IMAGE_UNITS</constant></term> | |
| 1072 | <listitem> | |
| 1073 | <para> | |
| 1074 | </para> | |
| 1075 | <para> | |
| 1076 | <parameter>params</parameter> returns one value, the maximum supported texture image units that | |
| 1077 | can be used to access texture maps from the geometry shader. The value must be at least 16. | |
| 1078 | See <citerefentry><refentrytitle>glActiveTexture</refentrytitle></citerefentry>. | |
| 1079 | </para> | |
| 1080 | </listitem> | |
| 1081 | </varlistentry> | |
| 1082 | <varlistentry> | |
| 1083 | <term><constant>GL_MAX_VERTEX_UNIFORM_COMPONENTS</constant></term> | |
| 1084 | <listitem> | |
| 1085 | <para> | |
| 1086 | </para> | |
| 1087 | <para> | |
| 1088 | <parameter>params</parameter> returns one value, | |
| 1089 | the maximum number of individual floating-point, integer, or boolean values that can be held | |
| 1090 | in uniform variable storage for a vertex shader. The value must be at least 1024. | |
| 1091 | See <citerefentry><refentrytitle>glUniform</refentrytitle></citerefentry>. | |
| 1092 | </para> | |
| 1093 | </listitem> | |
| 1094 | </varlistentry> | |
| 1095 | <varlistentry> | |
| 1096 | <term><constant>GL_MAX_VERTEX_OUTPUT_COMPONENTS</constant></term> | |
| 1097 | <listitem> | |
| 1098 | <para> | |
| 1099 | </para> | |
| 1100 | <para> | |
| 1101 | <parameter>params</parameter> returns one value, | |
| 1102 | the maximum number of components of output written by a vertex shader, which must be at least 64. | |
| 1103 | </para> | |
| 1104 | </listitem> | |
| 1105 | </varlistentry> | |
| 1106 | <varlistentry> | |
| 1107 | <term><constant>GL_MAX_GEOMETRY_UNIFORM_COMPONENTS</constant></term> | |
| 1108 | <listitem> | |
| 1109 | <para> | |
| 1110 | </para> | |
| 1111 | <para> | |
| 1112 | <parameter>params</parameter> returns one value, | |
| 1113 | the maximum number of individual floating-point, integer, or boolean values that can be held | |
| 1114 | in uniform variable storage for a geometry shader. The value must be at least 1024. | |
| 1115 | See <citerefentry><refentrytitle>glUniform</refentrytitle></citerefentry>. | |
| 1116 | </para> | |
| 1117 | </listitem> | |
| 1118 | </varlistentry> | |
| 1119 | <varlistentry> | |
| 1120 | <term><constant>GL_MAX_SAMPLE_MASK_WORDS</constant></term> | |
| 1121 | <listitem> | |
| 1122 | <para> | |
| 1123 | </para> | |
| 1124 | <para> | |
| 1125 | <parameter>params</parameter> returns one value, | |
| 1126 | the maximum number of sample mask words. | |
| 1127 | </para> | |
| 1128 | </listitem> | |
| 1129 | </varlistentry> | |
| 1130 | <varlistentry> | |
| 1131 | <term><constant>GL_MAX_COLOR_TEXTURE_SAMPLES</constant></term> | |
| 1132 | <listitem> | |
| 1133 | <para> | |
| 1134 | </para> | |
| 1135 | <para> | |
| 1136 | <parameter>params</parameter> returns one value, | |
| 1137 | the maximum number of samples in a color multisample texture. | |
| 1138 | </para> | |
| 1139 | </listitem> | |
| 1140 | </varlistentry> | |
| 1141 | <varlistentry> | |
| 1142 | <term><constant>GL_MAX_DEPTH_TEXTURE_SAMPLES</constant></term> | |
| 1143 | <listitem> | |
| 1144 | <para> | |
| 1145 | </para> | |
| 1146 | <para> | |
| 1147 | <parameter>params</parameter> returns one value, | |
| 1148 | the maximum number of samples in a multisample depth or depth-stencil texture. | |
| 1149 | </para> | |
| 1150 | </listitem> | |
| 1151 | </varlistentry> | |
| 1152 | <varlistentry> | |
| 1153 | <term><constant>GL_MAX_DEPTH_TEXTURE_SAMPLES</constant></term> | |
| 1154 | <listitem> | |
| 1155 | <para> | |
| 1156 | </para> | |
| 1157 | <para> | |
| 1158 | <parameter>params</parameter> returns one value, | |
| 1159 | the maximum number of samples in a multisample depth or depth-stencil texture. | |
| 1160 | </para> | |
| 1161 | </listitem> | |
| 1162 | </varlistentry> | |
| 1163 | <varlistentry> | |
| 1164 | <term><constant>GL_MAX_INTEGER_SAMPLES</constant></term> | |
| 1165 | <listitem> | |
| 1166 | <para> | |
| 1167 | </para> | |
| 1168 | <para> | |
| 1169 | <parameter>params</parameter> returns one value, | |
| 1170 | the maximum number of samples supported in integer format multisample buffers. | |
| 1171 | </para> | |
| 1172 | </listitem> | |
| 1173 | </varlistentry> | |
| 1174 | <varlistentry> | |
| 1175 | <term><constant>GL_MAX_SERVER_WAIT_TIMEOUT</constant></term> | |
| 1176 | <listitem> | |
| 1177 | <para> | |
| 1178 | </para> | |
| 1179 | <para> | |
| 1180 | <parameter>params</parameter> returns one value, | |
| 1181 | the maximum <citerefentry><refentrytitle>glWaitSync</refentrytitle></citerefentry> timeout interval. | |
| 1182 | </para> | |
| 1183 | </listitem> | |
| 1184 | </varlistentry> | |
| 1185 | <varlistentry> | |
| 1186 | <term><constant>GL_MAX_UNIFORM_BUFFER_BINDINGS</constant></term> | |
| 1187 | <listitem> | |
| 1188 | <para> | |
| 1189 | </para> | |
| 1190 | <para> | |
| 1191 | <parameter>params</parameter> returns one value, | |
| 1192 | the maximum number of uniform buffer binding points on the context, which must be at least 36. | |
| 1193 | </para> | |
| 1194 | </listitem> | |
| 1195 | </varlistentry> | |
| 1196 | <varlistentry> | |
| 1197 | <term><constant>GL_MAX_UNIFORM_BLOCK_SIZE</constant></term> | |
| 1198 | <listitem> | |
| 1199 | <para> | |
| 1200 | </para> | |
| 1201 | <para> | |
| 1202 | <parameter>params</parameter> returns one value, | |
| 1203 | the maximum size in basic machine units of a uniform block, which must be at least 16384. | |
| 1204 | </para> | |
| 1205 | </listitem> | |
| 1206 | </varlistentry> | |
| 1207 | <varlistentry> | |
| 1208 | <term><constant>GL_UNIFORM_BUFFER_OFFSET_ALIGNMENT</constant></term> | |
| 1209 | <listitem> | |
| 1210 | <para> | |
| 1211 | </para> | |
| 1212 | <para> | |
| 1213 | <parameter>params</parameter> returns one value, | |
| 1214 | the minimum required alignment for uniform buffer sizes and offsets. | |
| 1215 | </para> | |
| 1216 | </listitem> | |
| 1217 | </varlistentry> | |
| 1218 | <varlistentry> | |
| 1219 | <term><constant>GL_MAX_VERTEX_UNIFORM_BLOCKS</constant></term> | |
| 1220 | <listitem> | |
| 1221 | <para> | |
| 1222 | </para> | |
| 1223 | <para> | |
| 1224 | <parameter>params</parameter> returns one value, | |
| 1225 | the maximum number of uniform blocks per vertex shader. The value must be at least 12. | |
| 1226 | See <citerefentry><refentrytitle>glUniformBlockBinding</refentrytitle></citerefentry>. | |
| 1227 | </para> | |
| 1228 | </listitem> | |
| 1229 | </varlistentry> | |
| 1230 | <varlistentry> | |
| 1231 | <term><constant>GL_MAX_GEOMETRY_UNIFORM_BLOCKS</constant></term> | |
| 1232 | <listitem> | |
| 1233 | <para> | |
| 1234 | </para> | |
| 1235 | <para> | |
| 1236 | <parameter>params</parameter> returns one value, | |
| 1237 | the maximum number of uniform blocks per geometry shader. The value must be at least 12. | |
| 1238 | See <citerefentry><refentrytitle>glUniformBlockBinding</refentrytitle></citerefentry>. | |
| 1239 | </para> | |
| 1240 | </listitem> | |
| 1241 | </varlistentry> | |
| 1242 | <varlistentry> | |
| 1243 | <term><constant>GL_MAX_GEOMETRY_INPUT_COMPONENTS</constant></term> | |
| 1244 | <listitem> | |
| 1245 | <para> | |
| 1246 | </para> | |
| 1247 | <para> | |
| 1248 | <parameter>params</parameter> returns one value, | |
| 1249 | the maximum number of components of inputs read by a geometry shader, which must be at least 64. | |
| 1250 | </para> | |
| 1251 | </listitem> | |
| 1252 | </varlistentry> | |
| 1253 | <varlistentry> | |
| 1254 | <term><constant>GL_MAX_GEOMETRY_OUTPUT_COMPONENTS</constant></term> | |
| 1255 | <listitem> | |
| 1256 | <para> | |
| 1257 | </para> | |
| 1258 | <para> | |
| 1259 | <parameter>params</parameter> returns one value, | |
| 1260 | the maximum number of components of outputs written by a geometry shader, which must be at least 128. | |
| 1261 | </para> | |
| 1262 | </listitem> | |
| 1263 | </varlistentry> | |
| 1264 | <varlistentry> | |
| 1265 | <term><constant>GL_MAX_VIEWPORT_DIMS</constant></term> | |
| 1266 | <listitem> | |
| 1267 | <para> | |
| 1268 | </para> | |
| 1269 | <para> | |
| 1270 | <parameter>params</parameter> returns two values: | |
| 1271 | the maximum supported width and height of the viewport. | |
| 1272 | These must be at least as large as the visible dimensions of the display | |
| 1273 | being rendered to. | |
| 1274 | See <citerefentry><refentrytitle>glViewport</refentrytitle></citerefentry>. | |
| 1275 | </para> | |
| 1276 | </listitem> | |
| 1277 | </varlistentry> | |
| 1278 | <varlistentry> | |
| 1279 | <term><constant>GL_NUM_COMPRESSED_TEXTURE_FORMATS</constant></term> | |
| 1280 | <listitem> | |
| 1281 | <para> | |
| 1282 | </para> | |
| 1283 | <para> | |
| 1284 | <parameter>params</parameter> returns a single integer value indicating the number of available | |
| 1285 | compressed texture formats. The minimum value is 4. | |
| 1286 | See <citerefentry><refentrytitle>glCompressedTexImage2D</refentrytitle></citerefentry>. | |
| 1287 | </para> | |
| 1288 | </listitem> | |
| 1289 | </varlistentry> | |
| 1290 | <varlistentry> | |
| 1291 | <term><constant>GL_PACK_ALIGNMENT</constant></term> | |
| 1292 | <listitem> | |
| 1293 | <para> | |
| 1294 | </para> | |
| 1295 | <para> | |
| 1296 | <parameter>params</parameter> returns one value, | |
| 1297 | the byte alignment used for writing pixel data to memory. The initial | |
| 1298 | value is 4. | |
| 1299 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 1300 | </para> | |
| 1301 | </listitem> | |
| 1302 | </varlistentry> | |
| 1303 | <varlistentry> | |
| 1304 | <term><constant>GL_PACK_IMAGE_HEIGHT</constant></term> | |
| 1305 | <listitem> | |
| 1306 | <para> | |
| 1307 | </para> | |
| 1308 | <para> | |
| 1309 | <parameter>params</parameter> returns one value, | |
| 1310 | the image height used for writing pixel data to memory. The initial | |
| 1311 | value is 0. | |
| 1312 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 1313 | </para> | |
| 1314 | </listitem> | |
| 1315 | </varlistentry> | |
| 1316 | <varlistentry> | |
| 1317 | <term><constant>GL_PACK_LSB_FIRST</constant></term> | |
| 1318 | <listitem> | |
| 1319 | <para> | |
| 1320 | </para> | |
| 1321 | <para> | |
| 1322 | <parameter>params</parameter> returns a single boolean value indicating whether single-bit | |
| 1323 | pixels being written to memory are written first to the least significant | |
| 1324 | bit of each unsigned byte. The initial value is <constant>GL_FALSE</constant>. | |
| 1325 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 1326 | </para> | |
| 1327 | </listitem> | |
| 1328 | </varlistentry> | |
| 1329 | <varlistentry> | |
| 1330 | <term><constant>GL_PACK_ROW_LENGTH</constant></term> | |
| 1331 | <listitem> | |
| 1332 | <para> | |
| 1333 | </para> | |
| 1334 | <para> | |
| 1335 | <parameter>params</parameter> returns one value, | |
| 1336 | the row length used for writing pixel data to memory. The initial value is | |
| 1337 | 0. | |
| 1338 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 1339 | </para> | |
| 1340 | </listitem> | |
| 1341 | </varlistentry> | |
| 1342 | <varlistentry> | |
| 1343 | <term><constant>GL_PACK_SKIP_IMAGES</constant></term> | |
| 1344 | <listitem> | |
| 1345 | <para> | |
| 1346 | </para> | |
| 1347 | <para> | |
| 1348 | <parameter>params</parameter> returns one value, | |
| 1349 | the number of pixel images skipped before the first pixel is written | |
| 1350 | into memory. The initial value is 0. | |
| 1351 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 1352 | </para> | |
| 1353 | </listitem> | |
| 1354 | </varlistentry> | |
| 1355 | <varlistentry> | |
| 1356 | <term><constant>GL_PACK_SKIP_PIXELS</constant></term> | |
| 1357 | <listitem> | |
| 1358 | <para> | |
| 1359 | </para> | |
| 1360 | <para> | |
| 1361 | <parameter>params</parameter> returns one value, | |
| 1362 | the number of pixel locations skipped before the first pixel is written | |
| 1363 | into memory. The initial value is 0. | |
| 1364 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 1365 | </para> | |
| 1366 | </listitem> | |
| 1367 | </varlistentry> | |
| 1368 | <varlistentry> | |
| 1369 | <term><constant>GL_PACK_SKIP_ROWS</constant></term> | |
| 1370 | <listitem> | |
| 1371 | <para> | |
| 1372 | </para> | |
| 1373 | <para> | |
| 1374 | <parameter>params</parameter> returns one value, | |
| 1375 | the number of rows of pixel locations skipped before the first pixel is written | |
| 1376 | into memory. The initial value is 0. | |
| 1377 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 1378 | </para> | |
| 1379 | </listitem> | |
| 1380 | </varlistentry> | |
| 1381 | <varlistentry> | |
| 1382 | <term><constant>GL_PACK_SWAP_BYTES</constant></term> | |
| 1383 | <listitem> | |
| 1384 | <para> | |
| 1385 | </para> | |
| 1386 | <para> | |
| 1387 | <parameter>params</parameter> returns a single boolean value indicating whether the bytes of | |
| 1388 | two-byte and four-byte pixel indices and components are swapped before being | |
| 1389 | written to memory. The initial value is <constant>GL_FALSE</constant>. | |
| 1390 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 1391 | </para> | |
| 1392 | </listitem> | |
| 1393 | </varlistentry> | |
| 1394 | <varlistentry> | |
| 1395 | <term><constant>GL_PIXEL_PACK_BUFFER_BINDING</constant></term> | |
| 1396 | <listitem> | |
| 1397 | <para> | |
| 1398 | </para> | |
| 1399 | <para> | |
| 1400 | <parameter>params</parameter> returns a single value, the name of the buffer object | |
| 1401 | currently bound to the target <constant>GL_PIXEL_PACK_BUFFER</constant>. If no buffer object | |
| 1402 | is bound to this target, 0 is returned. The initial value is 0. | |
| 1403 | See <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>. | |
| 1404 | </para> | |
| 1405 | </listitem> | |
| 1406 | </varlistentry> | |
| 1407 | <varlistentry> | |
| 1408 | <term><constant>GL_PIXEL_UNPACK_BUFFER_BINDING</constant></term> | |
| 1409 | <listitem> | |
| 1410 | <para> | |
| 1411 | </para> | |
| 1412 | <para> | |
| 1413 | <parameter>params</parameter> returns a single value, the name of the buffer object | |
| 1414 | currently bound to the target <constant>GL_PIXEL_UNPACK_BUFFER</constant>. If no buffer object | |
| 1415 | is bound to this target, 0 is returned. The initial value is 0. | |
| 1416 | See <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>. | |
| 1417 | </para> | |
| 1418 | </listitem> | |
| 1419 | </varlistentry> | |
| 1420 | <varlistentry> | |
| 1421 | <term><constant>GL_POINT_FADE_THRESHOLD_SIZE</constant></term> | |
| 1422 | <listitem> | |
| 1423 | <para> | |
| 1424 | </para> | |
| 1425 | <para> | |
| 1426 | <parameter>params</parameter> returns one value, | |
| 1427 | the point size threshold for determining the point size. | |
| 1428 | See <citerefentry><refentrytitle>glPointParameter</refentrytitle></citerefentry>. | |
| 1429 | </para> | |
| 1430 | </listitem> | |
| 1431 | </varlistentry> | |
| 1432 | <varlistentry> | |
| 1433 | <term><constant>GL_PRIMITIVE_RESTART_INDEX</constant></term> | |
| 1434 | <listitem> | |
| 1435 | <para> | |
| 1436 | </para> | |
| 1437 | <para> | |
| 1438 | <parameter>params</parameter> returns one value, | |
| 1439 | the current primitive restart index. The initial value is 0. | |
| 1440 | See <citerefentry><refentrytitle>glPrimitiveRestartIndex</refentrytitle></citerefentry>. | |
| 1441 | </para> | |
| 1442 | </listitem> | |
| 1443 | </varlistentry> | |
| 1444 | <varlistentry> | |
| 1445 | <term><constant>GL_PROVOKING_VERTEX</constant></term> | |
| 1446 | <listitem> | |
| 1447 | <para> | |
| 1448 | </para> | |
| 1449 | <para> | |
| 1450 | <parameter>params</parameter> returns one value, | |
| 1451 | the currently selected provoking vertex convention. The initial value is <constant>GL_LAST_VERTEX_CONVENTION</constant>. | |
| 1452 | See <citerefentry><refentrytitle>glProvokingVertex</refentrytitle></citerefentry>. | |
| 1453 | </para> | |
| 1454 | </listitem> | |
| 1455 | </varlistentry> | |
| 1456 | <varlistentry> | |
| 1457 | <term><constant>GL_POINT_SIZE</constant></term> | |
| 1458 | <listitem> | |
| 1459 | <para> | |
| 1460 | </para> | |
| 1461 | <para> | |
| 1462 | <parameter>params</parameter> returns one value, | |
| 1463 | the point size as specified by <citerefentry><refentrytitle>glPointSize</refentrytitle></citerefentry>. | |
| 1464 | The initial value is 1. | |
| 1465 | </para> | |
| 1466 | </listitem> | |
| 1467 | </varlistentry> | |
| 1468 | <varlistentry> | |
| 1469 | <term><constant>GL_POINT_SIZE_GRANULARITY</constant></term> | |
| 1470 | <listitem> | |
| 1471 | <para> | |
| 1472 | </para> | |
| 1473 | <para> | |
| 1474 | <parameter>params</parameter> returns one value, | |
| 1475 | the size difference between adjacent supported sizes for antialiased points. | |
| 1476 | See <citerefentry><refentrytitle>glPointSize</refentrytitle></citerefentry>. | |
| 1477 | </para> | |
| 1478 | </listitem> | |
| 1479 | </varlistentry> | |
| 1480 | <varlistentry> | |
| 1481 | <term><constant>GL_POINT_SIZE_RANGE</constant></term> | |
| 1482 | <listitem> | |
| 1483 | <para> | |
| 1484 | </para> | |
| 1485 | <para> | |
| 1486 | <parameter>params</parameter> returns two values: | |
| 1487 | the smallest and largest supported sizes for antialiased | |
| 1488 | points. The smallest size must be at most 1, and the largest size must | |
| 1489 | be at least 1. | |
| 1490 | See <citerefentry><refentrytitle>glPointSize</refentrytitle></citerefentry>. | |
| 1491 | </para> | |
| 1492 | </listitem> | |
| 1493 | </varlistentry> | |
| 1494 | <varlistentry> | |
| 1495 | <term><constant>GL_POLYGON_OFFSET_FACTOR</constant></term> | |
| 1496 | <listitem> | |
| 1497 | <para> | |
| 1498 | </para> | |
| 1499 | <para> | |
| 1500 | <parameter>params</parameter> returns one value, | |
| 1501 | the scaling factor used to determine the variable offset that is added | |
| 1502 | to the depth value of each fragment generated when a polygon is | |
| 1503 | rasterized. The initial value is 0. | |
| 1504 | See <citerefentry><refentrytitle>glPolygonOffset</refentrytitle></citerefentry>. | |
| 1505 | </para> | |
| 1506 | </listitem> | |
| 1507 | </varlistentry> | |
| 1508 | <varlistentry> | |
| 1509 | <term><constant>GL_POLYGON_OFFSET_UNITS</constant></term> | |
| 1510 | <listitem> | |
| 1511 | <para> | |
| 1512 | </para> | |
| 1513 | <para> | |
| 1514 | <parameter>params</parameter> returns one value. | |
| 1515 | This value is multiplied by an implementation-specific value and then | |
| 1516 | added to the depth value of each fragment | |
| 1517 | generated when a polygon is rasterized. The initial value is 0. | |
| 1518 | See <citerefentry><refentrytitle>glPolygonOffset</refentrytitle></citerefentry>. | |
| 1519 | </para> | |
| 1520 | </listitem> | |
| 1521 | </varlistentry> | |
| 1522 | <varlistentry> | |
| 1523 | <term><constant>GL_POLYGON_OFFSET_FILL</constant></term> | |
| 1524 | <listitem> | |
| 1525 | <para> | |
| 1526 | </para> | |
| 1527 | <para> | |
| 1528 | <parameter>params</parameter> returns a single boolean value indicating whether polygon offset | |
| 1529 | is enabled for polygons in fill mode. The initial value is <constant>GL_FALSE</constant>. | |
| 1530 | See <citerefentry><refentrytitle>glPolygonOffset</refentrytitle></citerefentry>. | |
| 1531 | </para> | |
| 1532 | </listitem> | |
| 1533 | </varlistentry> | |
| 1534 | <varlistentry> | |
| 1535 | <term><constant>GL_POLYGON_OFFSET_LINE</constant></term> | |
| 1536 | <listitem> | |
| 1537 | <para> | |
| 1538 | </para> | |
| 1539 | <para> | |
| 1540 | <parameter>params</parameter> returns a single boolean value indicating whether polygon offset | |
| 1541 | is enabled for polygons in line mode. The initial value is <constant>GL_FALSE</constant>. | |
| 1542 | See <citerefentry><refentrytitle>glPolygonOffset</refentrytitle></citerefentry>. | |
| 1543 | </para> | |
| 1544 | </listitem> | |
| 1545 | </varlistentry> | |
| 1546 | <varlistentry> | |
| 1547 | <term><constant>GL_POLYGON_OFFSET_POINT</constant></term> | |
| 1548 | <listitem> | |
| 1549 | <para> | |
| 1550 | </para> | |
| 1551 | <para> | |
| 1552 | <parameter>params</parameter> returns a single boolean value indicating whether polygon offset | |
| 1553 | is enabled for polygons in point mode. The initial value is <constant>GL_FALSE</constant>. | |
| 1554 | See <citerefentry><refentrytitle>glPolygonOffset</refentrytitle></citerefentry>. | |
| 1555 | </para> | |
| 1556 | </listitem> | |
| 1557 | </varlistentry> | |
| 1558 | <varlistentry> | |
| 1559 | <term><constant>GL_POLYGON_SMOOTH</constant></term> | |
| 1560 | <listitem> | |
| 1561 | <para> | |
| 1562 | </para> | |
| 1563 | <para> | |
| 1564 | <parameter>params</parameter> returns a single boolean value indicating whether antialiasing of | |
| 1565 | polygons is enabled. The initial value is <constant>GL_FALSE</constant>. | |
| 1566 | See <citerefentry><refentrytitle>glPolygonMode</refentrytitle></citerefentry>. | |
| 1567 | </para> | |
| 1568 | </listitem> | |
| 1569 | </varlistentry> | |
| 1570 | <varlistentry> | |
| 1571 | <term><constant>GL_POLYGON_SMOOTH_HINT</constant></term> | |
| 1572 | <listitem> | |
| 1573 | <para> | |
| 1574 | </para> | |
| 1575 | <para> | |
| 1576 | <parameter>params</parameter> returns one value, | |
| 1577 | a symbolic constant indicating the mode of the polygon antialiasing | |
| 1578 | hint. The initial value is <constant>GL_DONT_CARE</constant>. | |
| 1579 | See <citerefentry><refentrytitle>glHint</refentrytitle></citerefentry>. | |
| 1580 | </para> | |
| 1581 | </listitem> | |
| 1582 | </varlistentry> | |
| 1583 | <varlistentry> | |
| 1584 | <term><constant>GL_READ_BUFFER</constant></term> | |
| 1585 | <listitem> | |
| 1586 | <para> | |
| 1587 | </para> | |
| 1588 | <para> | |
| 1589 | <parameter>params</parameter> returns one value, | |
| 1590 | a symbolic constant indicating which color buffer is selected for | |
| 1591 | reading. The initial value is <constant>GL_BACK</constant> if there is a back buffer, | |
| 1592 | otherwise it is <constant>GL_FRONT</constant>. | |
| 1593 | See | |
| 1594 | <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry>. | |
| 1595 | </para> | |
| 1596 | </listitem> | |
| 1597 | </varlistentry> | |
| 1598 | <varlistentry> | |
| 1599 | <term><constant>GL_SAMPLE_BUFFERS</constant></term> | |
| 1600 | <listitem> | |
| 1601 | <para> | |
| 1602 | </para> | |
| 1603 | <para> | |
| 1604 | <parameter>params</parameter> returns a single integer value indicating the number of sample buffers | |
| 1605 | associated with the framebuffer. | |
| 1606 | See <citerefentry><refentrytitle>glSampleCoverage</refentrytitle></citerefentry>. | |
| 1607 | </para> | |
| 1608 | </listitem> | |
| 1609 | </varlistentry> | |
| 1610 | <varlistentry> | |
| 1611 | <term><constant>GL_SAMPLE_COVERAGE_VALUE</constant></term> | |
| 1612 | <listitem> | |
| 1613 | <para> | |
| 1614 | </para> | |
| 1615 | <para> | |
| 1616 | <parameter>params</parameter> returns a single positive floating-point value indicating the | |
| 1617 | current sample coverage value. | |
| 1618 | See <citerefentry><refentrytitle>glSampleCoverage</refentrytitle></citerefentry>. | |
| 1619 | </para> | |
| 1620 | </listitem> | |
| 1621 | </varlistentry> | |
| 1622 | <varlistentry> | |
| 1623 | <term><constant>GL_SAMPLE_COVERAGE_INVERT</constant></term> | |
| 1624 | <listitem> | |
| 1625 | <para> | |
| 1626 | </para> | |
| 1627 | <para> | |
| 1628 | <parameter>params</parameter> returns a single boolean value indicating if the temporary | |
| 1629 | coverage value should be inverted. | |
| 1630 | See <citerefentry><refentrytitle>glSampleCoverage</refentrytitle></citerefentry>. | |
| 1631 | </para> | |
| 1632 | </listitem> | |
| 1633 | </varlistentry> | |
| 1634 | <varlistentry> | |
| 1635 | <term><constant>GL_SAMPLER_BINDING</constant></term> | |
| 1636 | <listitem> | |
| 1637 | <para> | |
| 1638 | </para> | |
| 1639 | <para> | |
| 1640 | <parameter>params</parameter> returns a single value, the name of the sampler object | |
| 1641 | currently bound to the active texture unit. The initial value is 0. | |
| 1642 | See <citerefentry><refentrytitle>glBindSampler</refentrytitle></citerefentry>. | |
| 1643 | </para> | |
| 1644 | </listitem> | |
| 1645 | </varlistentry> | |
| 1646 | <varlistentry> | |
| 1647 | <term><constant>GL_SAMPLES</constant></term> | |
| 1648 | <listitem> | |
| 1649 | <para> | |
| 1650 | </para> | |
| 1651 | <para> | |
| 1652 | <parameter>params</parameter> returns a single integer value indicating the coverage mask size. | |
| 1653 | See <citerefentry><refentrytitle>glSampleCoverage</refentrytitle></citerefentry>. | |
| 1654 | </para> | |
| 1655 | </listitem> | |
| 1656 | </varlistentry> | |
| 1657 | <varlistentry> | |
| 1658 | <term><constant>GL_SCISSOR_BOX</constant></term> | |
| 1659 | <listitem> | |
| 1660 | <para> | |
| 1661 | </para> | |
| 1662 | <para> | |
| 1663 | <parameter>params</parameter> returns four values: | |
| 1664 | the | |
| 1665 | <inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation> | |
| 1666 | and | |
| 1667 | <inlineequation><mml:math><mml:mi mathvariant="italic">y</mml:mi></mml:math></inlineequation> | |
| 1668 | window coordinates of the scissor box, | |
| 1669 | followed by its width and height. | |
| 1670 | Initially the | |
| 1671 | <inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation> | |
| 1672 | and | |
| 1673 | <inlineequation><mml:math><mml:mi mathvariant="italic">y</mml:mi></mml:math></inlineequation> | |
| 1674 | window coordinates are both 0 and the | |
| 1675 | width and height are set to the size of the window. | |
| 1676 | See <citerefentry><refentrytitle>glScissor</refentrytitle></citerefentry>. | |
| 1677 | </para> | |
| 1678 | </listitem> | |
| 1679 | </varlistentry> | |
| 1680 | <varlistentry> | |
| 1681 | <term><constant>GL_SCISSOR_TEST</constant></term> | |
| 1682 | <listitem> | |
| 1683 | <para> | |
| 1684 | </para> | |
| 1685 | <para> | |
| 1686 | <parameter>params</parameter> returns a single boolean value indicating whether scissoring is | |
| 1687 | enabled. The initial value is <constant>GL_FALSE</constant>. | |
| 1688 | See <citerefentry><refentrytitle>glScissor</refentrytitle></citerefentry>. | |
| 1689 | </para> | |
| 1690 | </listitem> | |
| 1691 | </varlistentry> | |
| 1692 | <varlistentry> | |
| 1693 | <term><constant>GL_STENCIL_BACK_FAIL</constant></term> | |
| 1694 | <listitem> | |
| 1695 | <para> | |
| 1696 | </para> | |
| 1697 | <para> | |
| 1698 | <parameter>params</parameter> returns one value, | |
| 1699 | a symbolic constant indicating what action is taken for back-facing polygons when the stencil | |
| 1700 | test fails. The initial value is <constant>GL_KEEP</constant>. | |
| 1701 | See <citerefentry><refentrytitle>glStencilOpSeparate</refentrytitle></citerefentry>. | |
| 1702 | </para> | |
| 1703 | </listitem> | |
| 1704 | </varlistentry> | |
| 1705 | <varlistentry> | |
| 1706 | <term><constant>GL_STENCIL_BACK_FUNC</constant></term> | |
| 1707 | <listitem> | |
| 1708 | <para> | |
| 1709 | </para> | |
| 1710 | <para> | |
| 1711 | <parameter>params</parameter> returns one value, | |
| 1712 | a symbolic constant indicating what function is used for back-facing polygons to compare the | |
| 1713 | stencil reference value with the stencil buffer value. The initial value | |
| 1714 | is <constant>GL_ALWAYS</constant>. | |
| 1715 | See <citerefentry><refentrytitle>glStencilFuncSeparate</refentrytitle></citerefentry>. | |
| 1716 | </para> | |
| 1717 | </listitem> | |
| 1718 | </varlistentry> | |
| 1719 | <varlistentry> | |
| 1720 | <term><constant>GL_STENCIL_BACK_PASS_DEPTH_FAIL</constant></term> | |
| 1721 | <listitem> | |
| 1722 | <para> | |
| 1723 | </para> | |
| 1724 | <para> | |
| 1725 | <parameter>params</parameter> returns one value, | |
| 1726 | a symbolic constant indicating what action is taken for back-facing polygons when the stencil | |
| 1727 | test passes, | |
| 1728 | but the depth test fails. The initial value is <constant>GL_KEEP</constant>. | |
| 1729 | See <citerefentry><refentrytitle>glStencilOpSeparate</refentrytitle></citerefentry>. | |
| 1730 | </para> | |
| 1731 | </listitem> | |
| 1732 | </varlistentry> | |
| 1733 | <varlistentry> | |
| 1734 | <term><constant>GL_STENCIL_BACK_PASS_DEPTH_PASS</constant></term> | |
| 1735 | <listitem> | |
| 1736 | <para> | |
| 1737 | </para> | |
| 1738 | <para> | |
| 1739 | <parameter>params</parameter> returns one value, | |
| 1740 | a symbolic constant indicating what action is taken for back-facing polygons when the stencil | |
| 1741 | test passes and the depth test passes. The initial value is <constant>GL_KEEP</constant>. | |
| 1742 | See <citerefentry><refentrytitle>glStencilOpSeparate</refentrytitle></citerefentry>. | |
| 1743 | </para> | |
| 1744 | </listitem> | |
| 1745 | </varlistentry> | |
| 1746 | <varlistentry> | |
| 1747 | <term><constant>GL_STENCIL_BACK_REF</constant></term> | |
| 1748 | <listitem> | |
| 1749 | <para> | |
| 1750 | </para> | |
| 1751 | <para> | |
| 1752 | <parameter>params</parameter> returns one value, | |
| 1753 | the reference value that is compared with the contents of the stencil | |
| 1754 | buffer for back-facing polygons. The initial value is 0. | |
| 1755 | See <citerefentry><refentrytitle>glStencilFuncSeparate</refentrytitle></citerefentry>. | |
| 1756 | </para> | |
| 1757 | </listitem> | |
| 1758 | </varlistentry> | |
| 1759 | <varlistentry> | |
| 1760 | <term><constant>GL_STENCIL_BACK_VALUE_MASK</constant></term> | |
| 1761 | <listitem> | |
| 1762 | <para> | |
| 1763 | </para> | |
| 1764 | <para> | |
| 1765 | <parameter>params</parameter> returns one value, | |
| 1766 | the mask that is used for back-facing polygons to mask both the stencil reference value and the | |
| 1767 | stencil buffer value before they are compared. The initial value is all 1's. | |
| 1768 | See <citerefentry><refentrytitle>glStencilFuncSeparate</refentrytitle></citerefentry>. | |
| 1769 | </para> | |
| 1770 | </listitem> | |
| 1771 | </varlistentry> | |
| 1772 | <varlistentry> | |
| 1773 | <term><constant>GL_STENCIL_BACK_WRITEMASK</constant></term> | |
| 1774 | <listitem> | |
| 1775 | <para> | |
| 1776 | </para> | |
| 1777 | <para> | |
| 1778 | <parameter>params</parameter> returns one value, | |
| 1779 | the mask that controls writing of the stencil bitplanes for back-facing polygons. The initial value | |
| 1780 | is all 1's. | |
| 1781 | See <citerefentry><refentrytitle>glStencilMaskSeparate</refentrytitle></citerefentry>. | |
| 1782 | </para> | |
| 1783 | </listitem> | |
| 1784 | </varlistentry> | |
| 1785 | <varlistentry> | |
| 1786 | <term><constant>GL_STENCIL_CLEAR_VALUE</constant></term> | |
| 1787 | <listitem> | |
| 1788 | <para> | |
| 1789 | </para> | |
| 1790 | <para> | |
| 1791 | <parameter>params</parameter> returns one value, | |
| 1792 | the index to which the stencil bitplanes are cleared. The initial value is | |
| 1793 | 0. | |
| 1794 | See <citerefentry><refentrytitle>glClearStencil</refentrytitle></citerefentry>. | |
| 1795 | </para> | |
| 1796 | </listitem> | |
| 1797 | </varlistentry> | |
| 1798 | <varlistentry> | |
| 1799 | <term><constant>GL_STENCIL_FAIL</constant></term> | |
| 1800 | <listitem> | |
| 1801 | <para> | |
| 1802 | </para> | |
| 1803 | <para> | |
| 1804 | <parameter>params</parameter> returns one value, | |
| 1805 | a symbolic constant indicating what action is taken when the stencil | |
| 1806 | test fails. The initial value is <constant>GL_KEEP</constant>. | |
| 1807 | See <citerefentry><refentrytitle>glStencilOp</refentrytitle></citerefentry>. | |
| 1808 | This stencil state only affects non-polygons | |
| 1809 | and front-facing polygons. Back-facing polygons use separate stencil state. | |
| 1810 | See <citerefentry><refentrytitle>glStencilOpSeparate</refentrytitle></citerefentry>. | |
| 1811 | </para> | |
| 1812 | </listitem> | |
| 1813 | </varlistentry> | |
| 1814 | <varlistentry> | |
| 1815 | <term><constant>GL_STENCIL_FUNC</constant></term> | |
| 1816 | <listitem> | |
| 1817 | <para> | |
| 1818 | </para> | |
| 1819 | <para> | |
| 1820 | <parameter>params</parameter> returns one value, | |
| 1821 | a symbolic constant indicating what function is used to compare the | |
| 1822 | stencil reference value with the stencil buffer value. The initial value | |
| 1823 | is <constant>GL_ALWAYS</constant>. | |
| 1824 | See <citerefentry><refentrytitle>glStencilFunc</refentrytitle></citerefentry>. | |
| 1825 | This stencil state only affects non-polygons | |
| 1826 | and front-facing polygons. Back-facing polygons use separate stencil state. | |
| 1827 | See <citerefentry><refentrytitle>glStencilFuncSeparate</refentrytitle></citerefentry>. | |
| 1828 | </para> | |
| 1829 | </listitem> | |
| 1830 | </varlistentry> | |
| 1831 | <varlistentry> | |
| 1832 | <term><constant>GL_STENCIL_PASS_DEPTH_FAIL</constant></term> | |
| 1833 | <listitem> | |
| 1834 | <para> | |
| 1835 | </para> | |
| 1836 | <para> | |
| 1837 | <parameter>params</parameter> returns one value, | |
| 1838 | a symbolic constant indicating what action is taken when the stencil | |
| 1839 | test passes, | |
| 1840 | but the depth test fails. The initial value is <constant>GL_KEEP</constant>. | |
| 1841 | See <citerefentry><refentrytitle>glStencilOp</refentrytitle></citerefentry>. | |
| 1842 | This stencil state only affects non-polygons | |
| 1843 | and front-facing polygons. Back-facing polygons use separate stencil state. | |
| 1844 | See <citerefentry><refentrytitle>glStencilOpSeparate</refentrytitle></citerefentry>. | |
| 1845 | </para> | |
| 1846 | </listitem> | |
| 1847 | </varlistentry> | |
| 1848 | <varlistentry> | |
| 1849 | <term><constant>GL_STENCIL_PASS_DEPTH_PASS</constant></term> | |
| 1850 | <listitem> | |
| 1851 | <para> | |
| 1852 | </para> | |
| 1853 | <para> | |
| 1854 | <parameter>params</parameter> returns one value, | |
| 1855 | a symbolic constant indicating what action is taken when the stencil | |
| 1856 | test passes and the depth test passes. The initial value is <constant>GL_KEEP</constant>. | |
| 1857 | See <citerefentry><refentrytitle>glStencilOp</refentrytitle></citerefentry>. | |
| 1858 | This stencil state only affects non-polygons | |
| 1859 | and front-facing polygons. Back-facing polygons use separate stencil state. | |
| 1860 | See <citerefentry><refentrytitle>glStencilOpSeparate</refentrytitle></citerefentry>. | |
| 1861 | </para> | |
| 1862 | </listitem> | |
| 1863 | </varlistentry> | |
| 1864 | <varlistentry> | |
| 1865 | <term><constant>GL_STENCIL_REF</constant></term> | |
| 1866 | <listitem> | |
| 1867 | <para> | |
| 1868 | </para> | |
| 1869 | <para> | |
| 1870 | <parameter>params</parameter> returns one value, | |
| 1871 | the reference value that is compared with the contents of the stencil | |
| 1872 | buffer. The initial value is 0. | |
| 1873 | See <citerefentry><refentrytitle>glStencilFunc</refentrytitle></citerefentry>. | |
| 1874 | This stencil state only affects non-polygons | |
| 1875 | and front-facing polygons. Back-facing polygons use separate stencil state. | |
| 1876 | See <citerefentry><refentrytitle>glStencilFuncSeparate</refentrytitle></citerefentry>. | |
| 1877 | </para> | |
| 1878 | </listitem> | |
| 1879 | </varlistentry> | |
| 1880 | <varlistentry> | |
| 1881 | <term><constant>GL_STENCIL_TEST</constant></term> | |
| 1882 | <listitem> | |
| 1883 | <para> | |
| 1884 | </para> | |
| 1885 | <para> | |
| 1886 | <parameter>params</parameter> returns a single boolean value indicating whether stencil testing | |
| 1887 | of fragments is enabled. The initial value is <constant>GL_FALSE</constant>. | |
| 1888 | See <citerefentry><refentrytitle>glStencilFunc</refentrytitle></citerefentry> and <citerefentry><refentrytitle>glStencilOp</refentrytitle></citerefentry>. | |
| 1889 | </para> | |
| 1890 | </listitem> | |
| 1891 | </varlistentry> | |
| 1892 | <varlistentry> | |
| 1893 | <term><constant>GL_STENCIL_VALUE_MASK</constant></term> | |
| 1894 | <listitem> | |
| 1895 | <para> | |
| 1896 | </para> | |
| 1897 | <para> | |
| 1898 | <parameter>params</parameter> returns one value, | |
| 1899 | the mask that is used to mask both the stencil reference value and the | |
| 1900 | stencil buffer value before they are compared. The initial value is all 1's. | |
| 1901 | See <citerefentry><refentrytitle>glStencilFunc</refentrytitle></citerefentry>. | |
| 1902 | This stencil state only affects non-polygons | |
| 1903 | and front-facing polygons. Back-facing polygons use separate stencil state. | |
| 1904 | See <citerefentry><refentrytitle>glStencilFuncSeparate</refentrytitle></citerefentry>. | |
| 1905 | </para> | |
| 1906 | </listitem> | |
| 1907 | </varlistentry> | |
| 1908 | <varlistentry> | |
| 1909 | <term><constant>GL_STENCIL_WRITEMASK</constant></term> | |
| 1910 | <listitem> | |
| 1911 | <para> | |
| 1912 | </para> | |
| 1913 | <para> | |
| 1914 | <parameter>params</parameter> returns one value, | |
| 1915 | the mask that controls writing of the stencil bitplanes. The initial value | |
| 1916 | is all 1's. | |
| 1917 | See <citerefentry><refentrytitle>glStencilMask</refentrytitle></citerefentry>. | |
| 1918 | This stencil state only affects non-polygons | |
| 1919 | and front-facing polygons. Back-facing polygons use separate stencil state. | |
| 1920 | See <citerefentry><refentrytitle>glStencilMaskSeparate</refentrytitle></citerefentry>. | |
| 1921 | </para> | |
| 1922 | </listitem> | |
| 1923 | </varlistentry> | |
| 1924 | <varlistentry> | |
| 1925 | <term><constant>GL_STEREO</constant></term> | |
| 1926 | <listitem> | |
| 1927 | <para> | |
| 1928 | </para> | |
| 1929 | <para> | |
| 1930 | <parameter>params</parameter> returns a single boolean value indicating whether stereo buffers | |
| 1931 | (left and right) are supported. | |
| 1932 | </para> | |
| 1933 | </listitem> | |
| 1934 | </varlistentry> | |
| 1935 | <varlistentry> | |
| 1936 | <term><constant>GL_SUBPIXEL_BITS</constant></term> | |
| 1937 | <listitem> | |
| 1938 | <para> | |
| 1939 | </para> | |
| 1940 | <para> | |
| 1941 | <parameter>params</parameter> returns one value, | |
| 1942 | an estimate of the number of bits of subpixel resolution that are used to | |
| 1943 | position rasterized geometry in window coordinates. The value must be at least 4. | |
| 1944 | </para> | |
| 1945 | </listitem> | |
| 1946 | </varlistentry> | |
| 1947 | <varlistentry> | |
| 1948 | <term><constant>GL_TEXTURE_BINDING_1D</constant></term> | |
| 1949 | <listitem> | |
| 1950 | <para> | |
| 1951 | </para> | |
| 1952 | <para> | |
| 1953 | <parameter>params</parameter> returns a single value, the name of the texture | |
| 1954 | currently bound to the target <constant>GL_TEXTURE_1D</constant>. The initial value is 0. | |
| 1955 | See <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>. | |
| 1956 | </para> | |
| 1957 | </listitem> | |
| 1958 | </varlistentry> | |
| 1959 | <varlistentry> | |
| 1960 | <term><constant>GL_TEXTURE_BINDING_1D_ARRAY</constant></term> | |
| 1961 | <listitem> | |
| 1962 | <para> | |
| 1963 | </para> | |
| 1964 | <para> | |
| 1965 | <parameter>params</parameter> returns a single value, the name of the texture | |
| 1966 | currently bound to the target <constant>GL_TEXTURE_1D_ARRAY</constant>. The initial value is 0. | |
| 1967 | See <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>. | |
| 1968 | </para> | |
| 1969 | </listitem> | |
| 1970 | </varlistentry> | |
| 1971 | <varlistentry> | |
| 1972 | <term><constant>GL_TEXTURE_BINDING_2D</constant></term> | |
| 1973 | <listitem> | |
| 1974 | <para> | |
| 1975 | </para> | |
| 1976 | <para> | |
| 1977 | <parameter>params</parameter> returns a single value, the name of the texture | |
| 1978 | currently bound to the target <constant>GL_TEXTURE_2D</constant>. The initial value is 0. | |
| 1979 | See <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>. | |
| 1980 | </para> | |
| 1981 | </listitem> | |
| 1982 | </varlistentry> | |
| 1983 | <varlistentry> | |
| 1984 | <term><constant>GL_TEXTURE_BINDING_2D_ARRAY</constant></term> | |
| 1985 | <listitem> | |
| 1986 | <para> | |
| 1987 | </para> | |
| 1988 | <para> | |
| 1989 | <parameter>params</parameter> returns a single value, the name of the texture | |
| 1990 | currently bound to the target <constant>GL_TEXTURE_2D_ARRAY</constant>. The initial value is 0. | |
| 1991 | See <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>. | |
| 1992 | </para> | |
| 1993 | </listitem> | |
| 1994 | </varlistentry> | |
| 1995 | <varlistentry> | |
| 1996 | <term><constant>GL_TEXTURE_BINDING_2D_MULTISAMPLE</constant></term> | |
| 1997 | <listitem> | |
| 1998 | <para> | |
| 1999 | </para> | |
| 2000 | <para> | |
| 2001 | <parameter>params</parameter> returns a single value, the name of the texture | |
| 2002 | currently bound to the target <constant>GL_TEXTURE_2D_MULTISAMPLE</constant>. The initial value is 0. | |
| 2003 | See <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>. | |
| 2004 | </para> | |
| 2005 | </listitem> | |
| 2006 | </varlistentry> | |
| 2007 | <varlistentry> | |
| 2008 | <term><constant>GL_TEXTURE_BINDING_2D_MULTISAMPLE_ARRAY</constant></term> | |
| 2009 | <listitem> | |
| 2010 | <para> | |
| 2011 | </para> | |
| 2012 | <para> | |
| 2013 | <parameter>params</parameter> returns a single value, the name of the texture | |
| 2014 | currently bound to the target <constant>GL_TEXTURE_2D_MULTISAMPLE_ARRAY</constant>. The initial value is 0. | |
| 2015 | See <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>. | |
| 2016 | </para> | |
| 2017 | </listitem> | |
| 2018 | </varlistentry> | |
| 2019 | <varlistentry> | |
| 2020 | <term><constant>GL_TEXTURE_BINDING_3D</constant></term> | |
| 2021 | <listitem> | |
| 2022 | <para> | |
| 2023 | </para> | |
| 2024 | <para> | |
| 2025 | <parameter>params</parameter> returns a single value, the name of the texture | |
| 2026 | currently bound to the target <constant>GL_TEXTURE_3D</constant>. The initial value is 0. | |
| 2027 | See <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>. | |
| 2028 | </para> | |
| 2029 | </listitem> | |
| 2030 | </varlistentry> | |
| 2031 | <varlistentry> | |
| 2032 | <term><constant>GL_TEXTURE_BINDING_BUFFER</constant></term> | |
| 2033 | <listitem> | |
| 2034 | <para> | |
| 2035 | </para> | |
| 2036 | <para> | |
| 2037 | <parameter>params</parameter> returns a single value, the name of the texture | |
| 2038 | currently bound to the target <constant>GL_TEXTURE_BUFFER</constant>. The initial value is 0. | |
| 2039 | See <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>. | |
| 2040 | </para> | |
| 2041 | </listitem> | |
| 2042 | </varlistentry> | |
| 2043 | <varlistentry> | |
| 2044 | <term><constant>GL_TEXTURE_BINDING_CUBE_MAP</constant></term> | |
| 2045 | <listitem> | |
| 2046 | <para> | |
| 2047 | </para> | |
| 2048 | <para> | |
| 2049 | <parameter>params</parameter> returns a single value, the name of the texture | |
| 2050 | currently bound to the target <constant>GL_TEXTURE_CUBE_MAP</constant>. The initial value is 0. | |
| 2051 | See <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>. | |
| 2052 | </para> | |
| 2053 | </listitem> | |
| 2054 | </varlistentry> | |
| 2055 | <varlistentry> | |
| 2056 | <term><constant>GL_TEXTURE_BINDING_RECTANGLE</constant></term> | |
| 2057 | <listitem> | |
| 2058 | <para> | |
| 2059 | </para> | |
| 2060 | <para> | |
| 2061 | <parameter>params</parameter> returns a single value, the name of the texture | |
| 2062 | currently bound to the target <constant>GL_TEXTURE_RECTANGLE</constant>. The initial value is 0. | |
| 2063 | See <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>. | |
| 2064 | </para> | |
| 2065 | </listitem> | |
| 2066 | </varlistentry> | |
| 2067 | <varlistentry> | |
| 2068 | <term><constant>GL_TEXTURE_COMPRESSION_HINT</constant></term> | |
| 2069 | <listitem> | |
| 2070 | <para> | |
| 2071 | </para> | |
| 2072 | <para> | |
| 2073 | <parameter>params</parameter> returns a single value indicating the mode of the texture | |
| 2074 | compression hint. The initial value is <constant>GL_DONT_CARE</constant>. | |
| 2075 | </para> | |
| 2076 | </listitem> | |
| 2077 | </varlistentry> | |
| 2078 | <varlistentry> | |
| 2079 | <term><constant>GL_TEXTURE_BUFFER_BINDING</constant></term> | |
| 2080 | <listitem> | |
| 2081 | <para> | |
| 2082 | </para> | |
| 2083 | <para> | |
| 2084 | <parameter>params</parameter> returns a single value, the name of the texture buffer object | |
| 2085 | currently bound. The initial value is 0. | |
| 2086 | See <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>. | |
| 2087 | </para> | |
| 2088 | </listitem> | |
| 2089 | </varlistentry> | |
| 2090 | <varlistentry> | |
| 2091 | <term><constant>GL_TIMESTAMP</constant></term> | |
| 2092 | <listitem> | |
| 2093 | <para> | |
| 2094 | </para> | |
| 2095 | <para> | |
| 2096 | <parameter>params</parameter> returns a single value, the 64-bit value of the current | |
| 2097 | GL time. | |
| 2098 | See <citerefentry><refentrytitle>glQueryCounter</refentrytitle></citerefentry>. | |
| 2099 | </para> | |
| 2100 | </listitem> | |
| 2101 | </varlistentry> | |
| 2102 | <varlistentry> | |
| 2103 | <term><constant>GL_TRANSFORM_FEEDBACK_BUFFER_BINDING</constant></term> | |
| 2104 | <listitem> | |
| 2105 | <para> | |
| 2106 | </para> | |
| 2107 | <para> | |
| 2108 | When used with non-indexed variants of <function>glGet</function> (such as <function>glGetIntegerv</function>), | |
| 2109 | <parameter>params</parameter> returns a single value, the name of the buffer object | |
| 2110 | currently bound to the target <constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant>. If no buffer object | |
| 2111 | is bound to this target, 0 is returned. | |
| 2112 | When used with indexed variants of <function>glGet</function> (such as <function>glGetIntegeri_v</function>), | |
| 2113 | <parameter>params</parameter> returns a single value, the name of the buffer object | |
| 2114 | bound to the indexed transform feedback attribute stream. The initial value is 0 for all targets. | |
| 2115 | See <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glBindBufferBase</refentrytitle></citerefentry>, and | |
| 2116 | <citerefentry><refentrytitle>glBindBufferRange</refentrytitle></citerefentry>. | |
| 2117 | </para> | |
| 2118 | </listitem> | |
| 2119 | </varlistentry> | |
| 2120 | <varlistentry> | |
| 2121 | <term><constant>GL_TRANSFORM_FEEDBACK_BUFFER_START</constant></term> | |
| 2122 | <listitem> | |
| 2123 | <para> | |
| 2124 | </para> | |
| 2125 | <para> | |
| 2126 | When used with indexed variants of <function>glGet</function> (such as <function>glGetInteger64i_v</function>), | |
| 2127 | <parameter>params</parameter> returns a single value, the start offset of the binding range for each | |
| 2128 | transform feedback attribute stream. The initial value is 0 for all streams. | |
| 2129 | See <citerefentry><refentrytitle>glBindBufferRange</refentrytitle></citerefentry>. | |
| 2130 | </para> | |
| 2131 | </listitem> | |
| 2132 | </varlistentry> | |
| 2133 | <varlistentry> | |
| 2134 | <term><constant>GL_TRANSFORM_FEEDBACK_BUFFER_SIZE</constant></term> | |
| 2135 | <listitem> | |
| 2136 | <para> | |
| 2137 | </para> | |
| 2138 | <para> | |
| 2139 | When used with indexed variants of <function>glGet</function> (such as <function>glGetInteger64i_v</function>), | |
| 2140 | <parameter>params</parameter> returns a single value, the size of the binding range for each | |
| 2141 | transform feedback attribute stream. The initial value is 0 for all streams. | |
| 2142 | See <citerefentry><refentrytitle>glBindBufferRange</refentrytitle></citerefentry>. | |
| 2143 | </para> | |
| 2144 | </listitem> | |
| 2145 | </varlistentry> | |
| 2146 | <varlistentry> | |
| 2147 | <term><constant>GL_UNIFORM_BUFFER_BINDING</constant></term> | |
| 2148 | <listitem> | |
| 2149 | <para> | |
| 2150 | </para> | |
| 2151 | <para> | |
| 2152 | When used with non-indexed variants of <function>glGet</function> (such as <function>glGetIntegerv</function>), | |
| 2153 | <parameter>params</parameter> returns a single value, the name of the buffer object | |
| 2154 | currently bound to the target <constant>GL_UNIFORM_BUFFER</constant>. If no buffer object | |
| 2155 | is bound to this target, 0 is returned. | |
| 2156 | When used with indexed variants of <function>glGet</function> (such as <function>glGetIntegeri_v</function>), | |
| 2157 | <parameter>params</parameter> returns a single value, the name of the buffer object | |
| 2158 | bound to the indexed uniform buffer binding point. The initial value is 0 for all targets. | |
| 2159 | See <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glBindBufferBase</refentrytitle></citerefentry>, and | |
| 2160 | <citerefentry><refentrytitle>glBindBufferRange</refentrytitle></citerefentry>. | |
| 2161 | </para> | |
| 2162 | </listitem> | |
| 2163 | </varlistentry> | |
| 2164 | <varlistentry> | |
| 2165 | <term><constant>GL_UNIFORM_BUFFER_START</constant></term> | |
| 2166 | <listitem> | |
| 2167 | <para> | |
| 2168 | </para> | |
| 2169 | <para> | |
| 2170 | When used with indexed variants of <function>glGet</function> (such as <function>glGetInteger64i_v</function>), | |
| 2171 | <parameter>params</parameter> returns a single value, the start offset of the binding range for each | |
| 2172 | indexed uniform buffer binding. The initial value is 0 for all bindings. | |
| 2173 | See <citerefentry><refentrytitle>glBindBufferRange</refentrytitle></citerefentry>. | |
| 2174 | </para> | |
| 2175 | </listitem> | |
| 2176 | </varlistentry> | |
| 2177 | <varlistentry> | |
| 2178 | <term><constant>GL_UNIFORM_BUFFER_SIZE</constant></term> | |
| 2179 | <listitem> | |
| 2180 | <para> | |
| 2181 | </para> | |
| 2182 | <para> | |
| 2183 | When used with indexed variants of <function>glGet</function> (such as <function>glGetInteger64i_v</function>), | |
| 2184 | <parameter>params</parameter> returns a single value, the size of the binding range for each | |
| 2185 | indexed uniform buffer binding. The initial value is 0 for all bindings. | |
| 2186 | See <citerefentry><refentrytitle>glBindBufferRange</refentrytitle></citerefentry>. | |
| 2187 | </para> | |
| 2188 | </listitem> | |
| 2189 | </varlistentry> | |
| 2190 | <varlistentry> | |
| 2191 | <term><constant>GL_UNIFORM_BUFFER_OFFSET_ALIGNMENT</constant></term> | |
| 2192 | <listitem> | |
| 2193 | <para> | |
| 2194 | </para> | |
| 2195 | <para> | |
| 2196 | <parameter>params</parameter> returns a single value, the minimum required alignment | |
| 2197 | for uniform buffer sizes and offset. The initial value is 1. | |
| 2198 | See <citerefentry><refentrytitle>glUniformBlockBinding</refentrytitle></citerefentry>. | |
| 2199 | </para> | |
| 2200 | </listitem> | |
| 2201 | </varlistentry> | |
| 2202 | <varlistentry> | |
| 2203 | <term><constant>GL_UNPACK_ALIGNMENT</constant></term> | |
| 2204 | <listitem> | |
| 2205 | <para> | |
| 2206 | </para> | |
| 2207 | <para> | |
| 2208 | <parameter>params</parameter> returns one value, | |
| 2209 | the byte alignment used for reading pixel data from memory. The initial | |
| 2210 | value is 4. | |
| 2211 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 2212 | </para> | |
| 2213 | </listitem> | |
| 2214 | </varlistentry> | |
| 2215 | <varlistentry> | |
| 2216 | <term><constant>GL_UNPACK_IMAGE_HEIGHT</constant></term> | |
| 2217 | <listitem> | |
| 2218 | <para> | |
| 2219 | </para> | |
| 2220 | <para> | |
| 2221 | <parameter>params</parameter> returns one value, | |
| 2222 | the image height used for reading pixel data from memory. The initial | |
| 2223 | is 0. | |
| 2224 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 2225 | </para> | |
| 2226 | </listitem> | |
| 2227 | </varlistentry> | |
| 2228 | <varlistentry> | |
| 2229 | <term><constant>GL_UNPACK_LSB_FIRST</constant></term> | |
| 2230 | <listitem> | |
| 2231 | <para> | |
| 2232 | </para> | |
| 2233 | <para> | |
| 2234 | <parameter>params</parameter> returns a single boolean value indicating whether single-bit | |
| 2235 | pixels being read from memory are read first from the least significant | |
| 2236 | bit of each unsigned byte. The initial value is <constant>GL_FALSE</constant>. | |
| 2237 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 2238 | </para> | |
| 2239 | </listitem> | |
| 2240 | </varlistentry> | |
| 2241 | <varlistentry> | |
| 2242 | <term><constant>GL_UNPACK_ROW_LENGTH</constant></term> | |
| 2243 | <listitem> | |
| 2244 | <para> | |
| 2245 | </para> | |
| 2246 | <para> | |
| 2247 | <parameter>params</parameter> returns one value, | |
| 2248 | the row length used for reading pixel data from memory. The initial value | |
| 2249 | is 0. | |
| 2250 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 2251 | </para> | |
| 2252 | </listitem> | |
| 2253 | </varlistentry> | |
| 2254 | <varlistentry> | |
| 2255 | <term><constant>GL_UNPACK_SKIP_IMAGES</constant></term> | |
| 2256 | <listitem> | |
| 2257 | <para> | |
| 2258 | </para> | |
| 2259 | <para> | |
| 2260 | <parameter>params</parameter> returns one value, | |
| 2261 | the number of pixel images skipped before the first pixel is read | |
| 2262 | from memory. The initial value is 0. | |
| 2263 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 2264 | </para> | |
| 2265 | </listitem> | |
| 2266 | </varlistentry> | |
| 2267 | <varlistentry> | |
| 2268 | <term><constant>GL_UNPACK_SKIP_PIXELS</constant></term> | |
| 2269 | <listitem> | |
| 2270 | <para> | |
| 2271 | </para> | |
| 2272 | <para> | |
| 2273 | <parameter>params</parameter> returns one value, | |
| 2274 | the number of pixel locations skipped before the first pixel is read | |
| 2275 | from memory. The initial value is 0. | |
| 2276 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 2277 | </para> | |
| 2278 | </listitem> | |
| 2279 | </varlistentry> | |
| 2280 | <varlistentry> | |
| 2281 | <term><constant>GL_UNPACK_SKIP_ROWS</constant></term> | |
| 2282 | <listitem> | |
| 2283 | <para> | |
| 2284 | </para> | |
| 2285 | <para> | |
| 2286 | <parameter>params</parameter> returns one value, | |
| 2287 | the number of rows of pixel locations skipped before the first pixel is read | |
| 2288 | from memory. The initial value is 0. | |
| 2289 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 2290 | </para> | |
| 2291 | </listitem> | |
| 2292 | </varlistentry> | |
| 2293 | <varlistentry> | |
| 2294 | <term><constant>GL_UNPACK_SWAP_BYTES</constant></term> | |
| 2295 | <listitem> | |
| 2296 | <para> | |
| 2297 | </para> | |
| 2298 | <para> | |
| 2299 | <parameter>params</parameter> returns a single boolean value indicating whether the bytes of | |
| 2300 | two-byte and four-byte pixel indices and components are swapped after being | |
| 2301 | read from memory. The initial value is <constant>GL_FALSE</constant>. | |
| 2302 | See <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>. | |
| 2303 | </para> | |
| 2304 | </listitem> | |
| 2305 | </varlistentry> | |
| 2306 | <varlistentry> | |
| 2307 | <term><constant>GL_NUM_EXTENSIONS</constant></term> | |
| 2308 | <listitem> | |
| 2309 | <para> | |
| 2310 | </para> | |
| 2311 | <para> | |
| 2312 | <parameter>params</parameter> returns one value, | |
| 2313 | the number of extensions supported by the GL implementation for the current context. | |
| 2314 | See <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry>. | |
| 2315 | </para> | |
| 2316 | </listitem> | |
| 2317 | </varlistentry> | |
| 2318 | <varlistentry> | |
| 2319 | <term><constant>GL_MAJOR_VERSION</constant></term> | |
| 2320 | <listitem> | |
| 2321 | <para> | |
| 2322 | </para> | |
| 2323 | <para> | |
| 2324 | <parameter>params</parameter> returns one value, | |
| 2325 | the major version number of the OpenGL API supported by the current context. | |
| 2326 | </para> | |
| 2327 | </listitem> | |
| 2328 | </varlistentry> | |
| 2329 | <varlistentry> | |
| 2330 | <term><constant>GL_MINOR_VERSION</constant></term> | |
| 2331 | <listitem> | |
| 2332 | <para> | |
| 2333 | </para> | |
| 2334 | <para> | |
| 2335 | <parameter>params</parameter> returns one value, | |
| 2336 | the minor version number of the OpenGL API supported by the current context. | |
| 2337 | </para> | |
| 2338 | </listitem> | |
| 2339 | </varlistentry> | |
| 2340 | <varlistentry> | |
| 2341 | <term><constant>GL_CONTEXT_FLAGS</constant></term> | |
| 2342 | <listitem> | |
| 2343 | <para> | |
| 2344 | </para> | |
| 2345 | <para> | |
| 2346 | <parameter>params</parameter> returns one value, | |
| 2347 | the flags with which the context was created (such as debugging functionality). | |
| 2348 | </para> | |
| 2349 | </listitem> | |
| 2350 | </varlistentry> | |
| 2351 | <varlistentry> | |
| 2352 | <term><constant>GL_VERTEX_PROGRAM_POINT_SIZE</constant></term> | |
| 2353 | <listitem> | |
| 2354 | <para> | |
| 2355 | </para> | |
| 2356 | <para> | |
| 2357 | <parameter>params</parameter> returns a single boolean value indicating whether vertex | |
| 2358 | program point size mode is enabled. If enabled, and a vertex shader is active, then the | |
| 2359 | point size is taken from the shader built-in <code>gl_PointSize</code>. If disabled, | |
| 2360 | and a vertex shader is active, then the point size is taken from the point state as specified | |
| 2361 | by <citerefentry><refentrytitle>glPointSize</refentrytitle></citerefentry>. | |
| 2362 | The initial value is <constant>GL_FALSE</constant>. | |
| 2363 | </para> | |
| 2364 | </listitem> | |
| 2365 | </varlistentry> | |
| 2366 | <varlistentry> | |
| 2367 | <term><constant>GL_VIEWPORT</constant></term> | |
| 2368 | <listitem> | |
| 2369 | <para> | |
| 2370 | </para> | |
| 2371 | <para> | |
| 2372 | <parameter>params</parameter> returns four values: | |
| 2373 | the | |
| 2374 | <inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation> | |
| 2375 | and | |
| 2376 | <inlineequation><mml:math><mml:mi mathvariant="italic">y</mml:mi></mml:math></inlineequation> | |
| 2377 | window coordinates of the viewport, | |
| 2378 | followed by its width and height. | |
| 2379 | Initially the | |
| 2380 | <inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation> | |
| 2381 | and | |
| 2382 | <inlineequation><mml:math><mml:mi mathvariant="italic">y</mml:mi></mml:math></inlineequation> | |
| 2383 | window coordinates are both set to 0, | |
| 2384 | and the width and height are set to the width and height of the window into | |
| 2385 | which the GL will do its rendering. | |
| 2386 | See <citerefentry><refentrytitle>glViewport</refentrytitle></citerefentry>. | |
| 2387 | </para> | |
| 2388 | </listitem> | |
| 2389 | </varlistentry> | |
| 2390 | </variablelist> | |
| 2391 | <para> | |
| 2392 | Many of the boolean parameters can also be queried more easily using | |
| 2393 | <citerefentry><refentrytitle>glIsEnabled</refentrytitle></citerefentry>. | |
| 2394 | </para> | |
| 2395 | </refsect1> | |
| 2396 | <refsect1 id="notes"><title>Notes</title> | |
| 2397 | <para> | |
| 2398 | The following parameters return the associated value for the active texture unit: | |
| 2399 | <constant>GL_TEXTURE_1D</constant>, <constant>GL_TEXTURE_BINDING_1D</constant>, | |
| 2400 | <constant>GL_TEXTURE_2D</constant>, <constant>GL_TEXTURE_BINDING_2D</constant>, | |
| 2401 | <constant>GL_TEXTURE_3D</constant> and <constant>GL_TEXTURE_BINDING_3D</constant>. | |
| 2402 | </para> | |
| 2403 | <para> | |
| 2404 | <constant>GL_MAX_RECTANGLE_TEXTURE_SIZE</constant>, <constant>GL_MAX_TEXTURE_BUFFER_SIZE</constant>, | |
| 2405 | <constant>GL_UNIFORM_BUFFER_BINDING</constant>, <constant>GL_TEXTURE_BUFFER_BINDING</constant>, | |
| 2406 | <constant>GL_MAX_VERTEX_UNIFORM_BLOCKS</constant>, <constant>GL_MAX_FRAGMENT_UNIFORM_BLOCKS</constant>, | |
| 2407 | <constant>GL_MAX_COMBINED_FRAGMENT_UNIFORM_COMPONENTS</constant>, <constant>GL_MAX_COMBINED_VERTEX_UNIFORM_COMPONENTS</constant> | |
| 2408 | <constant>GL_MAX_COMBINED_UNIFORM_BLOCKS</constant>, <constant>GL_MAX_UNIFORM_BLOCK_SIZE</constant>, | |
| 2409 | and <constant>GL_UNIFORM_BUFFER_OFFSET_ALIGNMENT</constant> | |
| 2410 | are available only if the GL version is 3.1 or greater. | |
| 2411 | </para> | |
| 2412 | <para> | |
| 2413 | <constant>GL_MAX_COMBINED_GEOMETRY_UNIFORM_COMPONENTS</constant>, <constant>GL_MAX_GEOMETRY_UNIFORM_BLOCKS</constant>, | |
| 2414 | <constant>GL_MAX_GEOMETRY_INPUT_COMPONENTS</constant>, <constant>GL_MAX_GEOMETRY_OUTPUT_COMPONENTS</constant>, | |
| 2415 | <constant>GL_MAX_GEOMETRY_OUTPUT_VERTICES</constant>, <constant>GL_MAX_GEOMETRY_TOTAL_OUTPUT_COMPONENTS</constant> and | |
| 2416 | <constant>GL_MAX_GEOMETRY_TEXTURE_IMAGE_UNITS</constant> are available only if the GL version is 3.2 or greater. | |
| 2417 | </para> | |
| 2418 | <para> | |
| 2419 | <function>glGetInteger64v</function> and <function>glGetInteger64i_v</function> are available only if | |
| 2420 | the GL version is 3.2 or greater. | |
| 2421 | </para> | |
| 2422 | <para> | |
| 2423 | <constant>GL_MAX_DUALSOURCE_DRAW_BUFFERS</constant>, <constant>GL_SAMPLER_BINDING</constant>, and | |
| 2424 | <constant>GL_TIMESTAMP</constant> are available only if the GL version is 3.3 or greater. | |
| 2425 | </para> | |
| 2426 | </refsect1> | |
| 2427 | <refsect1 id="errors"><title>Errors</title> | |
| 2428 | <para> | |
| 2429 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>pname</parameter> is not an accepted value. | |
| 2430 | </para> | |
| 2431 | <para> | |
| 2432 | <constant>GL_INVALID_VALUE</constant> is generated on any of <function>glGetBooleani_v</function>, | |
| 2433 | <function>glGetIntegeri_v</function>, or <function>glGetInteger64i_v</function> if | |
| 2434 | <parameter>index</parameter> is outside of the valid range for the indexed state <parameter>target</parameter>. | |
| 2435 | </para> | |
| 2436 | </refsect1> | |
| 2437 | <refsect1 id="seealso"><title>See Also</title> | |
| 2438 | <para> | |
| 2439 | <citerefentry><refentrytitle>glGetActiveUniform</refentrytitle></citerefentry>, | |
| 2440 | <citerefentry><refentrytitle>glGetAttachedShaders</refentrytitle></citerefentry>, | |
| 2441 | <citerefentry><refentrytitle>glGetAttribLocation</refentrytitle></citerefentry>, | |
| 2442 | <citerefentry><refentrytitle>glGetBufferParameter</refentrytitle></citerefentry>, | |
| 2443 | <citerefentry><refentrytitle>glGetBufferPointerv</refentrytitle></citerefentry>, | |
| 2444 | <citerefentry><refentrytitle>glGetBufferSubData</refentrytitle></citerefentry>, | |
| 2445 | <citerefentry><refentrytitle>glGetCompressedTexImage</refentrytitle></citerefentry>, | |
| 2446 | <citerefentry><refentrytitle>glGetError</refentrytitle></citerefentry>, | |
| 2447 | <citerefentry><refentrytitle>glGetProgram</refentrytitle></citerefentry>, | |
| 2448 | <citerefentry><refentrytitle>glGetProgramInfoLog</refentrytitle></citerefentry>, | |
| 2449 | <citerefentry><refentrytitle>glGetQueryiv</refentrytitle></citerefentry>, | |
| 2450 | <citerefentry><refentrytitle>glGetQueryObject</refentrytitle></citerefentry>, | |
| 2451 | <citerefentry><refentrytitle>glGetShader</refentrytitle></citerefentry>, | |
| 2452 | <citerefentry><refentrytitle>glGetShaderInfoLog</refentrytitle></citerefentry>, | |
| 2453 | <citerefentry><refentrytitle>glGetShaderSource</refentrytitle></citerefentry>, | |
| 2454 | <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry>, | |
| 2455 | <citerefentry><refentrytitle>glGetTexImage</refentrytitle></citerefentry>, | |
| 2456 | <citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry>, | |
| 2457 | <citerefentry><refentrytitle>glGetTexParameter</refentrytitle></citerefentry>, | |
| 2458 | <citerefentry><refentrytitle>glGetUniform</refentrytitle></citerefentry>, | |
| 2459 | <citerefentry><refentrytitle>glGetUniformLocation</refentrytitle></citerefentry>, | |
| 2460 | <citerefentry><refentrytitle>glGetVertexAttrib</refentrytitle></citerefentry>, | |
| 2461 | <citerefentry><refentrytitle>glGetVertexAttribPointerv</refentrytitle></citerefentry>, | |
| 2462 | <citerefentry><refentrytitle>glIsEnabled</refentrytitle></citerefentry> | |
| 2463 | </para> | |
| 2464 | </refsect1> | |
| 2465 | <refsect1 id="Copyright"><title>Copyright</title> | |
| 2466 | <para> | |
| 2467 | Copyright <trademark class="copyright"></trademark> 1991-2006 | |
| 2468 | Silicon Graphics, Inc. This document is licensed under the SGI | |
| 2469 | Free Software B License. For details, see | |
| 2470 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>. | |
| 2471 | </para> | |
| 2472 | </refsect1> | |
| 2473 | </refentry> |