GLAPI/glIsEnabled: Difference between revisions
4.0 API. |
m Renaming category: 'API Reference 4' to 'Core API Reference'. |
||
| Line 119: | Line 119: | ||
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 [http://oss.sgi.com/projects/FreeB/ http://oss.sgi.com/projects/FreeB/]. | ||
[[Category:API Reference | [[Category:Core API Reference|IsEnabled]] | ||
Revision as of 07:49, 26 February 2012
| 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_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_CUBEMAP_SEAMLESS | glEnable |
Notes
If an error is generated, glIsEnabled and glIsEnabledi return GL_FALSE.
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
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/.