Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> | |
3 | <!-- saved from url=(0013)about:internet --> | |
4 | <?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" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glIsEnabled - OpenGL 3.3 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glIsEnabled"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glIsEnabled, glIsEnabledi — test whether a capability is enabled</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><p><code class="funcdef">GLboolean <b class="fsfunc">glIsEnabled</b>(</code>GLenum <var class="pdparam">cap</var><code>)</code>;</p></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">GLboolean <b class="fsfunc">glIsEnabledi</b>(</code></td><td>GLenum </td><td><var class="pdparam">cap</var>, </td></tr><tr><td> </td><td>GLuint </td><td><var class="pdparam">index</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>cap</code></em></span></dt><dd><p> | |
5 | Specifies a symbolic constant indicating a GL capability. | |
6 | </p></dd><dt><span class="term"><em class="parameter"><code>index</code></em></span></dt><dd><p> | |
7 | Specifies the index of the capability. | |
8 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
9 | <code class="function">glIsEnabled</code> returns <code class="constant">GL_TRUE</code> if <em class="parameter"><code>cap</code></em> is an enabled capability | |
10 | and returns <code class="constant">GL_FALSE</code> otherwise. Boolean states that are indexed may be tested with <code class="function">glIsEnabledi</code>. | |
11 | For <code class="function">glIsEnabledi</code>, <em class="parameter"><code>index</code></em> specifies the index of the capability to test. <em class="parameter"><code>index</code></em> | |
12 | must be between zero and the count of indexed capabilities for <em class="parameter"><code>cap</code></em>. | |
13 | Initially all capabilities except <code class="constant">GL_DITHER</code> are disabled; | |
14 | <code class="constant">GL_DITHER</code> is initially enabled. | |
15 | </p><p> | |
16 | The following capabilities are accepted for <em class="parameter"><code>cap</code></em>: | |
17 | </p><p> | |
18 | </p><div class="informaltable"><table border="1"><colgroup><col align="left" /><col align="left" /></colgroup><thead><tr><th align="left"><span class="bold"><strong> | |
19 | Constant | |
20 | </strong></span></th><th align="left"><span class="bold"><strong> | |
21 | See | |
22 | </strong></span></th></tr></thead><tbody><tr><td align="left"> | |
23 | <code class="constant">GL_BLEND</code> | |
24 | </td><td align="left"> | |
25 | <a href="glBlendFunc.xml"><span class="citerefentry"><span class="refentrytitle">glBlendFunc</span></span></a>, <a href="glLogicOp.xml"><span class="citerefentry"><span class="refentrytitle">glLogicOp</span></span></a> | |
26 | </td></tr><tr><td align="left"> | |
27 | <code class="constant">GL_CLIP_DISTANCE</code><span class="emphasis"><em>i</em></span> | |
28 | </td><td align="left"> | |
29 | <a href="glEnable.xml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a> | |
30 | </td></tr><tr><td align="left"> | |
31 | <code class="constant">GL_COLOR_LOGIC_OP</code> | |
32 | </td><td align="left"> | |
33 | <a href="glLogicOp.xml"><span class="citerefentry"><span class="refentrytitle">glLogicOp</span></span></a> | |
34 | </td></tr><tr><td align="left"> | |
35 | <code class="constant">GL_CULL_FACE</code> | |
36 | </td><td align="left"> | |
37 | <a href="glCullFace.xml"><span class="citerefentry"><span class="refentrytitle">glCullFace</span></span></a> | |
38 | </td></tr><tr><td align="left"> | |
39 | <code class="constant">GL_DEPTH_CLAMP</code> | |
40 | </td><td align="left"> | |
41 | <a href="glEnable.xml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a> | |
42 | </td></tr><tr><td align="left"> | |
43 | <code class="constant">GL_DEPTH_TEST</code> | |
44 | </td><td align="left"> | |
45 | <a href="glDepthFunc.xml"><span class="citerefentry"><span class="refentrytitle">glDepthFunc</span></span></a>, <a href="glDepthRange.xml"><span class="citerefentry"><span class="refentrytitle">glDepthRange</span></span></a> | |
46 | </td></tr><tr><td align="left"> | |
47 | <code class="constant">GL_DITHER</code> | |
48 | </td><td align="left"> | |
49 | <a href="glEnable.xml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a> | |
50 | </td></tr><tr><td align="left"> | |
51 | <code class="constant">GL_FRAMEBUFFER_SRGB</code> | |
52 | </td><td align="left"> | |
53 | <a href="glEnable.xml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a> | |
54 | </td></tr><tr><td align="left"> | |
55 | <code class="constant">GL_LINE_SMOOTH</code> | |
56 | </td><td align="left"> | |
57 | <a href="glLineWidth.xml"><span class="citerefentry"><span class="refentrytitle">glLineWidth</span></span></a> | |
58 | </td></tr><tr><td align="left"> | |
59 | <code class="constant">GL_MULTISAMPLE</code> | |
60 | </td><td align="left"> | |
61 | <a href="glSampleCoverage.xml"><span class="citerefentry"><span class="refentrytitle">glSampleCoverage</span></span></a> | |
62 | </td></tr><tr><td align="left"> | |
63 | <code class="constant">GL_POLYGON_SMOOTH</code> | |
64 | </td><td align="left"> | |
65 | <a href="glPolygonMode.xml"><span class="citerefentry"><span class="refentrytitle">glPolygonMode</span></span></a> | |
66 | </td></tr><tr><td align="left"> | |
67 | <code class="constant">GL_POLYGON_OFFSET_FILL</code> | |
68 | </td><td align="left"> | |
69 | <a href="glPolygonOffset.xml"><span class="citerefentry"><span class="refentrytitle">glPolygonOffset</span></span></a> | |
70 | </td></tr><tr><td align="left"> | |
71 | <code class="constant">GL_POLYGON_OFFSET_LINE</code> | |
72 | </td><td align="left"> | |
73 | <a href="glPolygonOffset.xml"><span class="citerefentry"><span class="refentrytitle">glPolygonOffset</span></span></a> | |
74 | </td></tr><tr><td align="left"> | |
75 | <code class="constant">GL_POLYGON_OFFSET_POINT</code> | |
76 | </td><td align="left"> | |
77 | <a href="glPolygonOffset.xml"><span class="citerefentry"><span class="refentrytitle">glPolygonOffset</span></span></a> | |
78 | </td></tr><tr><td align="left"> | |
79 | <code class="constant">GL_PROGRAM_POINT_SIZE</code> | |
80 | </td><td align="left"> | |
81 | <a href="glEnable.xml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a> | |
82 | </td></tr><tr><td align="left"> | |
83 | <code class="constant">GL_PRIMITIVE_RESTART</code> | |
84 | </td><td align="left"> | |
85 | <a href="glEnable.xml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a>, <a href="glPrimitiveRestartIndex.xml"><span class="citerefentry"><span class="refentrytitle">glPrimitiveRestartIndex</span></span></a> | |
86 | </td></tr><tr><td align="left"> | |
87 | <code class="constant">GL_SAMPLE_ALPHA_TO_COVERAGE</code> | |
88 | </td><td align="left"> | |
89 | <a href="glSampleCoverage.xml"><span class="citerefentry"><span class="refentrytitle">glSampleCoverage</span></span></a> | |
90 | </td></tr><tr><td align="left"> | |
91 | <code class="constant">GL_SAMPLE_ALPHA_TO_ONE</code> | |
92 | </td><td align="left"> | |
93 | <a href="glSampleCoverage.xml"><span class="citerefentry"><span class="refentrytitle">glSampleCoverage</span></span></a> | |
94 | </td></tr><tr><td align="left"> | |
95 | <code class="constant">GL_SAMPLE_COVERAGE</code> | |
96 | </td><td align="left"> | |
97 | <a href="glSampleCoverage.xml"><span class="citerefentry"><span class="refentrytitle">glSampleCoverage</span></span></a> | |
98 | </td></tr><tr><td align="left"> | |
99 | <code class="constant">GL_SAMPLE_MASK</code> | |
100 | </td><td align="left"> | |
101 | <a href="glEnable.xml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a> | |
102 | </td></tr><tr><td align="left"> | |
103 | <code class="constant">GL_SCISSOR_TEST</code> | |
104 | </td><td align="left"> | |
105 | <a href="glScissor.xml"><span class="citerefentry"><span class="refentrytitle">glScissor</span></span></a> | |
106 | </td></tr><tr><td align="left"> | |
107 | <code class="constant">GL_STENCIL_TEST</code> | |
108 | </td><td align="left"> | |
109 | <a href="glStencilFunc.xml"><span class="citerefentry"><span class="refentrytitle">glStencilFunc</span></span></a>, <a href="glStencilOp.xml"><span class="citerefentry"><span class="refentrytitle">glStencilOp</span></span></a> | |
110 | </td></tr><tr><td align="left"> | |
111 | <code class="constant">GL_TEXTURE_CUBEMAP_SEAMLESS</code> | |
112 | </td><td align="left"> | |
113 | <a href="glEnable.xml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a> | |
114 | </td></tr></tbody></table></div><p> | |
115 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p> | |
116 | If an error is generated, | |
117 | <code class="function">glIsEnabled</code> and <code class="function">glIsEnabledi</code> return <code class="constant">GL_FALSE</code>. | |
118 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
119 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>cap</code></em> is not an accepted value. | |
120 | </p><p> | |
121 | <code class="constant">GL_INVALID_VALUE</code> is generated by <code class="function">glIsEnabledi</code> if <em class="parameter"><code>index</code></em> is outside the | |
122 | valid range for the indexed state <em class="parameter"><code>cap</code></em>. | |
123 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
124 | <a href="glEnable.xml"><span class="citerefentry"><span class="refentrytitle">glEnable</span></span></a>, | |
125 | <a href="glDisable.xml"><span class="citerefentry"><span class="refentrytitle">glDisable</span></span></a>, | |
126 | <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> | |
127 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
128 | Copyright <span class="trademark"></span>© 1991-2006 | |
129 | Silicon Graphics, Inc. Copyright <span class="trademark"></span>© 2010-2011 | |
130 | Khronos Group. This document is licensed under the SGI | |
131 | Free Software B License. For details, see | |
132 | <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>. | |
133 | </p></div></div></body></html> |