HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> |
| 2 | <!-- saved from url=(0013)about:internet --> | |
| 3 | <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>glFogCoordPointer</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glFogCoordPointer"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glFogCoordPointer — define an array of fog coordinates</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glFogCoordPointer</b>(</code></td><td>GLenum </td><td><var class="pdparam">type</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">stride</var>, </td></tr><tr><td> </td><td>GLvoid * </td><td><var class="pdparam">pointer</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>type</code></em></span></dt><dd><p> | |
| 4 | Specifies the data type of each fog coordinate. | |
| 5 | Symbolic constants | |
| 6 | <code class="constant">GL_FLOAT</code>, | |
| 7 | or <code class="constant">GL_DOUBLE</code> | |
| 8 | are accepted. The initial value is <code class="constant">GL_FLOAT</code>. | |
| 9 | </p></dd><dt><span class="term"><em class="parameter"><code>stride</code></em></span></dt><dd><p> | |
| 10 | Specifies the byte offset between consecutive fog coordinates. | |
| 11 | If <em class="parameter"><code>stride</code></em> is 0, the array elements are understood | |
| 12 | to be tightly packed. The initial value is 0. | |
| 13 | </p></dd><dt><span class="term"><em class="parameter"><code>pointer</code></em></span></dt><dd><p> | |
| 14 | Specifies a pointer to the first coordinate of the first fog coordinate in the | |
| 15 | array. The initial value is 0. | |
| 16 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
| 17 | <code class="function">glFogCoordPointer</code> specifies the location and data format of an array of fog coordinates | |
| 18 | to use when rendering. <em class="parameter"><code>type</code></em> specifies the data type of each fog | |
| 19 | coordinate, and <em class="parameter"><code>stride</code></em> specifies the byte stride from one fog coordinate to | |
| 20 | the next, allowing vertices and attributes to be packed into a single array | |
| 21 | or stored in separate arrays. | |
| 22 | </p><p> | |
| 23 | If a non-zero named buffer object is bound to the <code class="constant">GL_ARRAY_BUFFER</code> target | |
| 24 | (see <a class="citerefentry" href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>) while a fog coordinate array is | |
| 25 | specified, <em class="parameter"><code>pointer</code></em> is treated as a byte offset into the buffer object's data store. | |
| 26 | Also, the buffer object binding (<code class="constant">GL_ARRAY_BUFFER_BINDING</code>) is saved as fog coordinate vertex array | |
| 27 | client-side state (<code class="constant">GL_FOG_COORD_ARRAY_BUFFER_BINDING</code>). | |
| 28 | </p><p> | |
| 29 | When a fog coordinate array is specified, | |
| 30 | <em class="parameter"><code>type</code></em>, <em class="parameter"><code>stride</code></em>, and <em class="parameter"><code>pointer</code></em> are saved as client-side | |
| 31 | state, in addition to the current vertex array buffer object binding. | |
| 32 | </p><p> | |
| 33 | To enable and disable the fog coordinate array, call | |
| 34 | <a class="citerefentry" href="glEnableClientState.xml"><span class="citerefentry"><span class="refentrytitle">glEnableClientState</span></span></a> and <a class="citerefentry" href="glDisableClientState.xml"><span class="citerefentry"><span class="refentrytitle">glDisableClientState</span></span></a> with the argument | |
| 35 | <code class="constant">GL_FOG_COORD_ARRAY</code>. If | |
| 36 | enabled, the fog coordinate array is used | |
| 37 | when <a class="citerefentry" href="glDrawArrays.xml"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>, <a class="citerefentry" href="glMultiDrawArrays.xml"><span class="citerefentry"><span class="refentrytitle">glMultiDrawArrays</span></span></a>, <a class="citerefentry" href="glDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>, | |
| 38 | <a class="citerefentry" href="glMultiDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glMultiDrawElements</span></span></a>, <a class="citerefentry" href="glDrawRangeElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>, or | |
| 39 | <a class="citerefentry" href="glArrayElement.xml"><span class="citerefentry"><span class="refentrytitle">glArrayElement</span></span></a> is called. | |
| 40 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p> | |
| 41 | <code class="function">glFogCoordPointer</code> is available only if the GL version is 1.4 or greater. | |
| 42 | </p><p> | |
| 43 | Fog coordinates are not supported for interleaved vertex array formats | |
| 44 | (see <a class="citerefentry" href="glInterleavedArrays.xml"><span class="citerefentry"><span class="refentrytitle">glInterleavedArrays</span></span></a>). | |
| 45 | </p><p> | |
| 46 | The fog coordinate array is initially disabled and isn't accessed when | |
| 47 | <a class="citerefentry" href="glArrayElement.xml"><span class="citerefentry"><span class="refentrytitle">glArrayElement</span></span></a>, <a class="citerefentry" href="glDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>, <a class="citerefentry" href="glDrawRangeElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>, | |
| 48 | <a class="citerefentry" href="glDrawArrays.xml"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>, <a class="citerefentry" href="glMultiDrawArrays.xml"><span class="citerefentry"><span class="refentrytitle">glMultiDrawArrays</span></span></a>, or <a class="citerefentry" href="glMultiDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glMultiDrawElements</span></span></a> | |
| 49 | is called. | |
| 50 | </p><p> | |
| 51 | Execution of <code class="function">glFogCoordPointer</code> is not allowed between the execution of | |
| 52 | <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>, | |
| 53 | but an error may or may not be generated. If no error is generated, | |
| 54 | the operation is undefined. | |
| 55 | </p><p> | |
| 56 | <code class="function">glFogCoordPointer</code> is typically implemented on the client side with no protocol. | |
| 57 | </p><p> | |
| 58 | Fog coordinate array parameters are client-side state and are | |
| 59 | therefore not saved or restored by <a class="citerefentry" href="glPushAttrib.xml"><span class="citerefentry"><span class="refentrytitle">glPushAttrib</span></span></a> and <a class="citerefentry" href="glPopAttrib.xml"><span class="citerefentry"><span class="refentrytitle">glPopAttrib</span></span></a>. | |
| 60 | Use <a class="citerefentry" href="glPushClientAttrib.xml"><span class="citerefentry"><span class="refentrytitle">glPushClientAttrib</span></span></a> and | |
| 61 | <a class="citerefentry" href="glPopClientAttrib.xml"><span class="citerefentry"><span class="refentrytitle">glPopClientAttrib</span></span></a> instead. | |
| 62 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
| 63 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>type</code></em> is not either <code class="constant">GL_FLOAT</code> | |
| 64 | or <code class="constant">GL_DOUBLE</code>. | |
| 65 | </p><p> | |
| 66 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>stride</code></em> is negative. | |
| 67 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> | |
| 68 | <a class="citerefentry" href="glIsEnabled.xml"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a> with argument <code class="constant">GL_FOG_COORD_ARRAY</code> | |
| 69 | </p><p> | |
| 70 | <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_FOG_COORD_ARRAY_STRIDE</code> | |
| 71 | </p><p> | |
| 72 | <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_FOG_COORD_ARRAY_TYPE</code> | |
| 73 | </p><p> | |
| 74 | <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_FOG_COORD_ARRAY_BUFFER_BINDING</code> | |
| 75 | </p><p> | |
| 76 | <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_ARRAY_BUFFER_BINDING</code> | |
| 77 | </p><p> | |
| 78 | <a class="citerefentry" href="glGetPointerv.xml"><span class="citerefentry"><span class="refentrytitle">glGetPointerv</span></span></a> with argument <code class="constant">GL_FOG_COORD_ARRAY_POINTER</code> | |
| 79 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
| 80 | <a class="citerefentry" href="glArrayElement.xml"><span class="citerefentry"><span class="refentrytitle">glArrayElement</span></span></a>, | |
| 81 | <a class="citerefentry" href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>, | |
| 82 | <a class="citerefentry" href="glColorPointer.xml"><span class="citerefentry"><span class="refentrytitle">glColorPointer</span></span></a>, | |
| 83 | <a class="citerefentry" href="glDisableClientState.xml"><span class="citerefentry"><span class="refentrytitle">glDisableClientState</span></span></a>, | |
| 84 | <a class="citerefentry" href="glDrawArrays.xml"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>, | |
| 85 | <a class="citerefentry" href="glDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>, | |
| 86 | <a class="citerefentry" href="glDrawRangeElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>, | |
| 87 | <a class="citerefentry" href="glEdgeFlagPointer.xml"><span class="citerefentry"><span class="refentrytitle">glEdgeFlagPointer</span></span></a>, | |
| 88 | <a class="citerefentry" href="glEnableClientState.xml"><span class="citerefentry"><span class="refentrytitle">glEnableClientState</span></span></a>, | |
| 89 | <a class="citerefentry" href="glFogCoord.xml"><span class="citerefentry"><span class="refentrytitle">glFogCoord</span></span></a>, | |
| 90 | <a class="citerefentry" href="glIndexPointer.xml"><span class="citerefentry"><span class="refentrytitle">glIndexPointer</span></span></a>, | |
| 91 | <a class="citerefentry" href="glInterleavedArrays.xml"><span class="citerefentry"><span class="refentrytitle">glInterleavedArrays</span></span></a>, | |
| 92 | <a class="citerefentry" href="glMultiDrawArrays.xml"><span class="citerefentry"><span class="refentrytitle">glMultiDrawArrays</span></span></a>, | |
| 93 | <a class="citerefentry" href="glMultiDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glMultiDrawElements</span></span></a>, | |
| 94 | <a class="citerefentry" href="glNormalPointer.xml"><span class="citerefentry"><span class="refentrytitle">glNormalPointer</span></span></a>, | |
| 95 | <a class="citerefentry" href="glPopClientAttrib.xml"><span class="citerefentry"><span class="refentrytitle">glPopClientAttrib</span></span></a>, | |
| 96 | <a class="citerefentry" href="glPushClientAttrib.xml"><span class="citerefentry"><span class="refentrytitle">glPushClientAttrib</span></span></a>, | |
| 97 | <a class="citerefentry" href="glSecondaryColorPointer.xml"><span class="citerefentry"><span class="refentrytitle">glSecondaryColorPointer</span></span></a>, | |
| 98 | <a class="citerefentry" href="glTexCoordPointer.xml"><span class="citerefentry"><span class="refentrytitle">glTexCoordPointer</span></span></a>, | |
| 99 | <a class="citerefentry" href="glVertexAttribPointer.xml"><span class="citerefentry"><span class="refentrytitle">glVertexAttribPointer</span></span></a>, | |
| 100 | <a class="citerefentry" href="glVertexPointer.xml"><span class="citerefentry"><span class="refentrytitle">glVertexPointer</span></span></a> | |
| 101 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
| 102 | Copyright <span class="trademark"></span>© 1991-2006 | |
| 103 | Silicon Graphics, Inc. This document is licensed under the SGI | |
| 104 | Free Software B License. For details, see | |
| 105 | <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>. | |
| 106 | </p></div></div></body></html> |