rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man2 / xhtml / glEdgeFlag.xml
CommitLineData
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>glEdgeFlag</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glEdgeFlag"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glEdgeFlag — flag edges as either boundary or nonboundary</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">glEdgeFlag</b>(</code></td><td>GLboolean  </td><td><var class="pdparam">flag</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>flag</code></em></span></dt><dd><p>
4 Specifies the current edge flag value,
5 either <code class="constant">GL_TRUE</code> or <code class="constant">GL_FALSE</code>. The initial value is <code class="constant">GL_TRUE</code>.
6 </p></dd></dl></div></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glEdgeFlagv</b>(</code></td><td>const GLboolean *  </td><td><var class="pdparam">flag</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters2"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>flag</code></em></span></dt><dd><p>
7 Specifies a pointer to an array that contains a single boolean element,
8 which replaces the current edge flag value.
9 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
10 Each vertex of a polygon,
11 separate triangle,
12 or separate quadrilateral specified between a <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a>/<a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a> pair
13 is marked as the start of either a boundary or nonboundary edge.
14 If the current edge flag is true when the vertex is specified,
15 the vertex is marked as the start of a boundary edge.
16 Otherwise, the vertex is marked as the start of a nonboundary edge.
17 <code class="function">glEdgeFlag</code> sets the edge flag bit to <code class="constant">GL_TRUE</code> if <em class="parameter"><code>flag</code></em> is <code class="constant">GL_TRUE</code>
18 and to <code class="constant">GL_FALSE</code> otherwise.
19 </p><p>
20 The vertices of connected triangles and connected quadrilaterals are always
21 marked as boundary,
22 regardless of the value of the edge flag.
23 </p><p>
24 Boundary and nonboundary edge flags on vertices are significant only if
25 <code class="constant">GL_POLYGON_MODE</code> is set to <code class="constant">GL_POINT</code> or <code class="constant">GL_LINE</code>.
26 See <a class="citerefentry" href="glPolygonMode.xml"><span class="citerefentry"><span class="refentrytitle">glPolygonMode</span></span></a>.
27 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
28 The current edge flag can be updated at any time.
29 In particular,
30 <code class="function">glEdgeFlag</code> can be called between a call to <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding
31 call to <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
32 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
33 <a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_EDGE_FLAG</code>
34 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
35 <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a>,
36 <code class="function">glEdgeFlagPointer</code>,
37 <a class="citerefentry" href="glPolygonMode.xml"><span class="citerefentry"><span class="refentrytitle">glPolygonMode</span></span></a>
38 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
39 Copyright <span class="trademark"></span>© 1991-2006
40 Silicon Graphics, Inc. This document is licensed under the SGI
41 Free Software B License. For details, see
42 <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
43 </p></div></div></body></html>