forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glEdgeFlagPointer.xhtml
94 lines (94 loc) · 12 KB
/
glEdgeFlagPointer.xhtml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<div class="refentry" lang="en" xml:lang="en"><a id="glEdgeFlagPointer"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glEdgeFlagPointer — define an array of edge flags</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table><tr><td><code class="funcdef">void <b class="fsfunc">glEdgeFlagPointer</b>(</code></td><td>GLsizei </td><td><var class="pdparam">stride</var>, </td></tr><tr><td> </td><td>const 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>stride</code></em></span></dt><dd><p>
Specifies the byte offset between consecutive edge flags.
If <em class="parameter"><code>stride</code></em> is 0, the edge flags are understood
to be tightly packed in the array. The initial value is 0.
</p></dd><dt><span class="term"><em class="parameter"><code>pointer</code></em></span></dt><dd><p>
Specifies a pointer to the first edge flag in the array. The initial
value is 0.
</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
<code class="function">glEdgeFlagPointer</code> specifies the location and data format of an array of boolean edge
flags to use when rendering. <em class="parameter"><code>stride</code></em> specifies the byte stride from one
edge flag to the next, allowing vertices and attributes
to be packed into a single array or stored in separate arrays.
</p><p>
If a non-zero named buffer object is bound to the <code class="constant">GL_ARRAY_BUFFER</code> target
(see <a class="citerefentry" href="glBindBuffer"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>) while an edge flag array is
specified, <em class="parameter"><code>pointer</code></em> is treated as a byte offset into the buffer object's data store.
Also, the buffer object binding (<code class="constant">GL_ARRAY_BUFFER_BINDING</code>) is saved as edge flag vertex array
client-side state (<code class="constant">GL_EDGE_FLAG_ARRAY_BUFFER_BINDING</code>).
</p><p>
When an edge flag array is
specified, <em class="parameter"><code>stride</code></em> and <em class="parameter"><code>pointer</code></em> are saved as client-side
state, in addition to the current vertex array buffer object binding.
</p><p>
To enable and disable the edge flag array, call
<a class="citerefentry" href="glEnableClientState"><span class="citerefentry"><span class="refentrytitle">glEnableClientState</span></span></a> and <a class="citerefentry" href="glDisableClientState"><span class="citerefentry"><span class="refentrytitle">glDisableClientState</span></span></a> with the argument
<code class="constant">GL_EDGE_FLAG_ARRAY</code>. If
enabled, the edge flag array is used
when <a class="citerefentry" href="glDrawArrays"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>, <a class="citerefentry" href="glMultiDrawArrays"><span class="citerefentry"><span class="refentrytitle">glMultiDrawArrays</span></span></a>, <a class="citerefentry" href="glDrawElements"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>,
<a class="citerefentry" href="glMultiDrawElements"><span class="citerefentry"><span class="refentrytitle">glMultiDrawElements</span></span></a>, <a class="citerefentry" href="glDrawRangeElements"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>, or
<a class="citerefentry" href="glArrayElement"><span class="citerefentry"><span class="refentrytitle">glArrayElement</span></span></a> is called.
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
<code class="function">glEdgeFlagPointer</code> is available only if the GL version is 1.1 or greater.
</p><p>
Edge flags are not supported for interleaved vertex array formats
(see <a class="citerefentry" href="glInterleavedArrays"><span class="citerefentry"><span class="refentrytitle">glInterleavedArrays</span></span></a>).
</p><p>
The edge flag array is initially disabled and isn't accessed when
<a class="citerefentry" href="glArrayElement"><span class="citerefentry"><span class="refentrytitle">glArrayElement</span></span></a>, <a class="citerefentry" href="glDrawElements"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>, <a class="citerefentry" href="glDrawRangeElements"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>,
<a class="citerefentry" href="glDrawArrays"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>, <a class="citerefentry" href="glMultiDrawArrays"><span class="citerefentry"><span class="refentrytitle">glMultiDrawArrays</span></span></a>, or <a class="citerefentry" href="glMultiDrawElements"><span class="citerefentry"><span class="refentrytitle">glMultiDrawElements</span></span></a>
is called.
</p><p>
Execution of <code class="function">glEdgeFlagPointer</code> is not allowed between the execution of
<a class="citerefentry" href="glBegin"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding execution of <a class="citerefentry" href="glEnd"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>,
but an error may or may not be generated. If no error is generated,
the operation is undefined.
</p><p>
<code class="function">glEdgeFlagPointer</code> is typically implemented on the client side.
</p><p>
Edge flag array parameters are client-side state and are therefore
not saved or restored by <a class="citerefentry" href="glPushAttrib"><span class="citerefentry"><span class="refentrytitle">glPushAttrib</span></span></a> and <a class="citerefentry" href="glPopAttrib"><span class="citerefentry"><span class="refentrytitle">glPopAttrib</span></span></a>.
Use <a class="citerefentry" href="glPushClientAttrib"><span class="citerefentry"><span class="refentrytitle">glPushClientAttrib</span></span></a> and
<a class="citerefentry" href="glPopClientAttrib"><span class="citerefentry"><span class="refentrytitle">glPopClientAttrib</span></span></a> instead.
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>stride</code></em> is negative.
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
<a class="citerefentry" href="glIsEnabled"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a> with argument <code class="constant">GL_EDGE_FLAG_ARRAY</code>
</p><p>
<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_EDGE_FLAG_ARRAY_STRIDE</code>
</p><p>
<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_EDGE_FLAG_ARRAY_BUFFER_BINDING</code>
</p><p>
<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_ARRAY_BUFFER_BINDING</code>
</p><p>
<a class="citerefentry" href="glGetPointerv"><span class="citerefentry"><span class="refentrytitle">glGetPointerv</span></span></a> with argument <code class="constant">GL_EDGE_FLAG_ARRAY_POINTER</code>
</p></div>
{$pipelinestall}{$examples}
<div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glArrayElement"><span class="citerefentry"><span class="refentrytitle">glArrayElement</span></span></a>,
<a class="citerefentry" href="glBindBuffer"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>,
<a class="citerefentry" href="glColorPointer"><span class="citerefentry"><span class="refentrytitle">glColorPointer</span></span></a>,
<a class="citerefentry" href="glDisableClientState"><span class="citerefentry"><span class="refentrytitle">glDisableClientState</span></span></a>,
<a class="citerefentry" href="glDrawArrays"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>,
<a class="citerefentry" href="glDrawElements"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>,
<a class="citerefentry" href="glDrawRangeElements"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>,
<a class="citerefentry" href="glEdgeFlag"><span class="citerefentry"><span class="refentrytitle">glEdgeFlag</span></span></a>,
<a class="citerefentry" href="glEnableClientState"><span class="citerefentry"><span class="refentrytitle">glEnableClientState</span></span></a>,
<a class="citerefentry" href="glFogCoordPointer"><span class="citerefentry"><span class="refentrytitle">glFogCoordPointer</span></span></a>,
<a class="citerefentry" href="glIndexPointer"><span class="citerefentry"><span class="refentrytitle">glIndexPointer</span></span></a>,
<a class="citerefentry" href="glInterleavedArrays"><span class="citerefentry"><span class="refentrytitle">glInterleavedArrays</span></span></a>,
<a class="citerefentry" href="glMultiDrawArrays"><span class="citerefentry"><span class="refentrytitle">glMultiDrawArrays</span></span></a>,
<a class="citerefentry" href="glMultiDrawElements"><span class="citerefentry"><span class="refentrytitle">glMultiDrawElements</span></span></a>,
<a class="citerefentry" href="glNormalPointer"><span class="citerefentry"><span class="refentrytitle">glNormalPointer</span></span></a>,
<a class="citerefentry" href="glPopClientAttrib"><span class="citerefentry"><span class="refentrytitle">glPopClientAttrib</span></span></a>,
<a class="citerefentry" href="glPushClientAttrib"><span class="citerefentry"><span class="refentrytitle">glPushClientAttrib</span></span></a>,
<a class="citerefentry" href="glSecondaryColorPointer"><span class="citerefentry"><span class="refentrytitle">glSecondaryColorPointer</span></span></a>,
<a class="citerefentry" href="glTexCoordPointer"><span class="citerefentry"><span class="refentrytitle">glTexCoordPointer</span></span></a>,
<a class="citerefentry" href="glVertexAttribPointer"><span class="citerefentry"><span class="refentrytitle">glVertexAttribPointer</span></span></a>,
<a class="citerefentry" href="glVertexPointer"><span class="citerefentry"><span class="refentrytitle">glVertexPointer</span></span></a>
</p></div><div class="refsect1" lang="en" xml:lang="en"><div id="Copyright"><h2>Copyright</h2><p>
Copyright © 1991-2006
Silicon Graphics, Inc. This document is licensed under the SGI
Free Software B License. For details, see
<a class="ulink" href="https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/" target="_top">https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/</a>.
</p></div></div></div>