forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glIsEnabled.xhtml
67 lines (67 loc) · 5.96 KB
/
glIsEnabled.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
<div class="refentry"><a id="glIsEnabled"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glIsEnabled — test whether a capability is enabled</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table class="funcprototype-table" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">GLboolean <strong class="fsfunc">glIsEnabled</strong>(</code></td><td>GLenum <var class="pdparam">cap</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>cap</code></em></span></dt><dd><p>
Specifies a symbolic constant indicating a GL capability.
</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
<code class="function">glIsEnabled</code> returns <code class="constant">GL_TRUE</code> if <em class="parameter"><code>cap</code></em> is an enabled capability
and returns <code class="constant">GL_FALSE</code> otherwise.
Initially all capabilities except <code class="constant">GL_DITHER</code> are disabled;
<code class="constant">GL_DITHER</code> is initially enabled.
</p><p>
The following capabilities are accepted for <em class="parameter"><code>cap</code></em>:
</p><p>
</p><div class="informaltable"><table><colgroup><col /><col /></colgroup><thead><tr><th><span class="bold"><strong>
Constant
</strong></span></th><th><span class="bold"><strong>
See
</strong></span></th></tr></thead><tbody><tr><td>
<code class="constant">GL_BLEND</code>
</td><td>
<a class="citerefentry" href="glBlendFunc"><span class="citerefentry"><span class="refentrytitle">glBlendFunc</span></span></a>
</td></tr><tr><td>
<code class="constant">GL_CULL_FACE</code>
</td><td>
<a class="citerefentry" href="glCullFace"><span class="citerefentry"><span class="refentrytitle">glCullFace</span></span></a>
</td></tr><tr><td>
<code class="constant">GL_DEPTH_TEST</code>
</td><td>
<a class="citerefentry" href="glDepthFunc"><span class="citerefentry"><span class="refentrytitle">glDepthFunc</span></span></a>, <a class="citerefentry" href="glDepthRangef"><span class="citerefentry"><span class="refentrytitle">glDepthRangef</span></span></a>
</td></tr><tr><td>
<code class="constant">GL_DITHER</code>
</td><td>
<a class="citerefentry" href="glEnable"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a>
</td></tr><tr><td>
<code class="constant">GL_POLYGON_OFFSET_FILL</code>
</td><td>
<a class="citerefentry" href="glPolygonOffset"><span class="citerefentry"><span class="refentrytitle">glPolygonOffset</span></span></a>
</td></tr><tr><td>
<code class="constant">GL_SAMPLE_ALPHA_TO_COVERAGE</code>
</td><td>
<a class="citerefentry" href="glSampleCoverage"><span class="citerefentry"><span class="refentrytitle">glSampleCoverage</span></span></a>
</td></tr><tr><td>
<code class="constant">GL_SAMPLE_COVERAGE</code>
</td><td>
<a class="citerefentry" href="glSampleCoverage"><span class="citerefentry"><span class="refentrytitle">glSampleCoverage</span></span></a>
</td></tr><tr><td>
<code class="constant">GL_SCISSOR_TEST</code>
</td><td>
<a class="citerefentry" href="glScissor"><span class="citerefentry"><span class="refentrytitle">glScissor</span></span></a>
</td></tr><tr><td>
<code class="constant">GL_STENCIL_TEST</code>
</td><td>
<a class="citerefentry" href="glStencilFunc"><span class="citerefentry"><span class="refentrytitle">glStencilFunc</span></span></a>, <a class="citerefentry" href="glStencilOp"><span class="citerefentry"><span class="refentrytitle">glStencilOp</span></span></a>
</td></tr></tbody></table></div><p>
</p></div><div class="refsect1"><a id="notes"></a><h2>Notes</h2><p>
If an error is generated,
<code class="function">glIsEnabled</code> returns 0.
</p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p>
<code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>cap</code></em> is not an accepted value.
</p></div>
{$pipelinestall}{$examples}
<div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glEnable"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a>,
<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a>
</p></div><div class="refsect1"><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>