GLAPI/glIsEnabled: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
← Older edit
m Bot: Adding better formatting.
 
(4 intermediate revisions by one other user not shown)
Line 18: Line 18:
== Description ==
== Description ==


'''glIsEnabled''' returns {{code|GL_TRUE}} if {{param|cap}} is an enabled capability and returns {{code|GL_FALSE}} otherwise. Boolean states that are indexed may be tested with '''glIsEnabledi'''. For '''glIsEnabledi''', {{param|index}} specifies the index of the capability to test. {{param|index}} must be between zero and the count of indexed capabilities for {{param|cap}}. Initially all capabilities except {{code|GL_DITHER}} are disabled; {{code|GL_DITHER}} is initially enabled.
'''glIsEnabled''' returns {{enum|GL_TRUE}} if {{param|cap}} is an enabled capability and returns {{enum|GL_FALSE}} otherwise. Boolean states that are indexed may be tested with '''glIsEnabledi'''. For '''glIsEnabledi''', {{param|index}} specifies the index of the capability to test. {{param|index}} must be between zero and the count of indexed capabilities for {{param|cap}}. Initially all capabilities except {{enum|GL_DITHER}} are disabled; {{enum|GL_DITHER}} is initially enabled.


The following capabilities are accepted for {{param|cap}}:
The following capabilities are accepted for {{param|cap}}:
Line 25: Line 25:


{|
{|
|+
|-
! '''Constant'''
! '''Constant'''
! '''See'''
! '''See'''
|+
|-
| {{code|GL_BLEND}}
| {{enum|GL_BLEND}}
| {{apifunc|glBlendFunc}}, {{apifunc|glLogicOp}}
| {{apifunc|glBlendFunc}}, {{apifunc|glLogicOp}}
|+
|-
| {{code|GL_CLIP_DISTANCE}}''i''
| {{enum|GL_CLIP_DISTANCE}}''i''
| {{apifunc|glEnable}}
| {{apifunc|glEnable}}
|+
|-
| {{code|GL_COLOR_LOGIC_OP}}
| {{enum|GL_COLOR_LOGIC_OP}}
| {{apifunc|glLogicOp}}
| {{apifunc|glLogicOp}}
|+
|-
| {{code|GL_CULL_FACE}}
| {{enum|GL_CULL_FACE}}
| {{apifunc|glCullFace}}
| {{apifunc|glCullFace}}
|+
|-
| {{code|GL_DEPTH_CLAMP}}
| {{enum|GL_DEPTH_CLAMP}}
| {{apifunc|glEnable}}
| {{apifunc|glEnable}}
|+
|-
| {{code|GL_DEPTH_TEST}}
| {{enum|GL_DEBUG_OUTPUT}}
| {{apifunc|glEnable}}
|-
| {{enum|GL_DEBUG_OUTPUT_SYNCHRONOUS}}
| {{apifunc|glEnable}}
|-
| {{enum|GL_DEPTH_TEST}}
| {{apifunc|glDepthFunc}}, {{apifunc|glDepthRange}}
| {{apifunc|glDepthFunc}}, {{apifunc|glDepthRange}}
|+
|-
| {{code|GL_DITHER}}
| {{enum|GL_DITHER}}
| {{apifunc|glEnable}}
| {{apifunc|glEnable}}
|+
|-
| {{code|GL_FRAMEBUFFER_SRGB}}
| {{enum|GL_FRAMEBUFFER_SRGB}}
| {{apifunc|glEnable}}
| {{apifunc|glEnable}}
|+
|-
| {{code|GL_LINE_SMOOTH}}
| {{enum|GL_LINE_SMOOTH}}
| {{apifunc|glLineWidth}}
| {{apifunc|glLineWidth}}
|+
|-
| {{code|GL_MULTISAMPLE}}
| {{enum|GL_MULTISAMPLE}}
| {{apifunc|glSampleCoverage}}
| {{apifunc|glSampleCoverage}}
|+
|-
| {{code|GL_POLYGON_SMOOTH}}
| {{enum|GL_POLYGON_SMOOTH}}
| {{apifunc|glPolygonMode}}
| {{apifunc|glPolygonMode}}
|+
|-
| {{code|GL_POLYGON_OFFSET_FILL}}
| {{enum|GL_POLYGON_OFFSET_FILL}}
| {{apifunc|glPolygonOffset}}
| {{apifunc|glPolygonOffset}}
|+
|-
| {{code|GL_POLYGON_OFFSET_LINE}}
| {{enum|GL_POLYGON_OFFSET_LINE}}
| {{apifunc|glPolygonOffset}}
| {{apifunc|glPolygonOffset}}
|+
|-
| {{code|GL_POLYGON_OFFSET_POINT}}
| {{enum|GL_POLYGON_OFFSET_POINT}}
| {{apifunc|glPolygonOffset}}
| {{apifunc|glPolygonOffset}}
|+
|-
| {{code|GL_PROGRAM_POINT_SIZE}}
| {{enum|GL_PROGRAM_POINT_SIZE}}
| {{apifunc|glEnable}}
| {{apifunc|glEnable}}
|+
|-
| {{code|GL_PRIMITIVE_RESTART}}
| {{enum|GL_PRIMITIVE_RESTART}}
| {{apifunc|glEnable}}, {{apifunc|glPrimitiveRestartIndex}}
| {{apifunc|glEnable}}, {{apifunc|glPrimitiveRestartIndex}}
|+
|-
| {{code|GL_SAMPLE_ALPHA_TO_COVERAGE}}
| {{enum|GL_SAMPLE_ALPHA_TO_COVERAGE}}
| {{apifunc|glSampleCoverage}}
| {{apifunc|glSampleCoverage}}
|+
|-
| {{code|GL_SAMPLE_ALPHA_TO_ONE}}
| {{enum|GL_SAMPLE_ALPHA_TO_ONE}}
| {{apifunc|glSampleCoverage}}
| {{apifunc|glSampleCoverage}}
|+
|-
| {{code|GL_SAMPLE_COVERAGE}}
| {{enum|GL_SAMPLE_COVERAGE}}
| {{apifunc|glSampleCoverage}}
| {{apifunc|glSampleCoverage}}
|+
|-
| {{code|GL_SAMPLE_MASK}}
| {{enum|GL_SAMPLE_MASK}}
| {{apifunc|glEnable}}
| {{apifunc|glEnable}}
|+
|-
| {{code|GL_SCISSOR_TEST}}
| {{enum|GL_SCISSOR_TEST}}
| {{apifunc|glScissor}}
| {{apifunc|glScissor}}
|+
|-
| {{code|GL_STENCIL_TEST}}
| {{enum|GL_STENCIL_TEST}}
| {{apifunc|glStencilFunc}}, {{apifunc|glStencilOp}}
| {{apifunc|glStencilFunc}}, {{apifunc|glStencilOp}}
|+
|-
| {{code|GL_TEXTURE_CUBEMAP_SEAMLESS}}
| {{enum|GL_TEXTURE_CUBE_MAP_SEAMLESS}}
| {{apifunc|glEnable}}
| {{apifunc|glEnable}}
|}
|}
Line 103: Line 109:
== Notes ==
== Notes ==


If an error is generated, '''glIsEnabled''' and '''glIsEnabledi''' return {{code|GL_FALSE}}.
If an error is generated, '''glIsEnabled''' and '''glIsEnabledi''' return {{enum|GL_FALSE}}.
 
{{enum|GL_DEBUG_OUTPUT}} and {{enum|GL_DEBUG_OUTPUT_SYNCHRONOUS}} are available only if the GL version is 4.3 or greater.


== Errors ==
== Errors ==


{{code|GL_INVALID_ENUM}} is generated if {{param|cap}} is not an accepted value.
{{enum|GL_INVALID_ENUM}} is generated if {{param|cap}} is not an accepted value.


{{code|GL_INVALID_VALUE}} is generated by '''glIsEnabledi''' if {{param|index}} is outside the valid range for the indexed state {{param|cap}}.
{{enum|GL_INVALID_VALUE}} is generated by '''glIsEnabledi''' if {{param|index}} is outside the valid range for the indexed state {{param|cap}}.


== See Also ==
== See Also ==
Line 117: Line 125:
== Copyright ==
== Copyright ==


Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2011 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/].
Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2011 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see [https://khronos.org/registry/OpenGL-Refpages/LICENSES/LicenseRef-FreeB.txt LicenseRef-FreeB].


[[Category:Core API Reference|IsEnabled]]
[[Category:Core API Reference|IsEnabled]]

Latest revision as of 22:07, 5 February 2021

glIsEnabled, glIsEnabledi
Core in version 4.6
Core since version 1.0

glIsEnabled, glIsEnabledi: test whether a capability is enabled

Function Definition

 GLboolean glIsEnabled(GLenum cap​);
 GLboolean glIsEnabledi(GLenum cap​, GLuint index​);
cap
Specifies a symbolic constant indicating a GL capability.
index
Specifies the index of the capability.

Description

glIsEnabled returns GL_TRUE if cap​ is an enabled capability and returns GL_FALSE otherwise. Boolean states that are indexed may be tested with glIsEnabledi. For glIsEnabledi, index​ specifies the index of the capability to test. index​ must be between zero and the count of indexed capabilities for cap​. Initially all capabilities except GL_DITHER are disabled; GL_DITHER is initially enabled.

The following capabilities are accepted for cap​:


Constant See
GL_BLEND glBlendFunc, glLogicOp
GL_CLIP_DISTANCEi glEnable
GL_COLOR_LOGIC_OP glLogicOp
GL_CULL_FACE glCullFace
GL_DEPTH_CLAMP glEnable
GL_DEBUG_OUTPUT glEnable
GL_DEBUG_OUTPUT_SYNCHRONOUS glEnable
GL_DEPTH_TEST glDepthFunc, glDepthRange
GL_DITHER glEnable
GL_FRAMEBUFFER_SRGB glEnable
GL_LINE_SMOOTH glLineWidth
GL_MULTISAMPLE glSampleCoverage
GL_POLYGON_SMOOTH glPolygonMode
GL_POLYGON_OFFSET_FILL glPolygonOffset
GL_POLYGON_OFFSET_LINE glPolygonOffset
GL_POLYGON_OFFSET_POINT glPolygonOffset
GL_PROGRAM_POINT_SIZE glEnable
GL_PRIMITIVE_RESTART glEnable, glPrimitiveRestartIndex
GL_SAMPLE_ALPHA_TO_COVERAGE glSampleCoverage
GL_SAMPLE_ALPHA_TO_ONE glSampleCoverage
GL_SAMPLE_COVERAGE glSampleCoverage
GL_SAMPLE_MASK glEnable
GL_SCISSOR_TEST glScissor
GL_STENCIL_TEST glStencilFunc, glStencilOp
GL_TEXTURE_CUBE_MAP_SEAMLESS glEnable


Notes

If an error is generated, glIsEnabled and glIsEnabledi return GL_FALSE.

GL_DEBUG_OUTPUT and GL_DEBUG_OUTPUT_SYNCHRONOUS are available only if the GL version is 4.3 or greater.

Errors

GL_INVALID_ENUM is generated if cap​ is not an accepted value.

GL_INVALID_VALUE is generated by glIsEnabledi if index​ is outside the valid range for the indexed state cap​.

See Also

glEnable, glDisable, glGet

Copyright

Copyright © 1991-2006 Silicon Graphics, Inc. Copyright © 2010-2011 Khronos Group. This document is licensed under the SGI Free Software B License. For details, see LicenseRef-FreeB.

Retrieved from "https://wikis.khronos.org/opengl/index.php?title=GLAPI/glIsEnabled&oldid=14801"