Typedefs | |
typedef PixelDataFormat | oglplus::Format |
Alias for PixelDataFormat. | |
typedef PixelDataInternalFormat | oglplus::InternalFormat |
Alias for PixelDataInternalFormat. | |
typedef BufferSelectBit | oglplus::ClearBit |
Draw buffer clear bit enumeration. | |
Functions | |
StrCRef | oglplus::EnumValueName (Enum enum_value) |
Returns the name of the GL enumerated value for an OGLplus enum value. More... | |
template<typename Enumeration > | |
Range< Enum > | oglplus::EnumValueRange (void) |
Returns a Range of values in an Enumeration . More... | |
Variables | |
AccessSpecifier typedef AccessSpecifier | oglplus::Access |
Alternate name for AccessSpecifier. | |
These enumerations tie the OpenGL constants (defined as preprocessor symbols) into logical groups and are then used as parameter types in OpenGL function call wrappers instead of just plain GLenum
or GLbitfield
. This brings additional type safety and robustness to the application code and helps avoid subtle hard to track errors.
|
strong |
Enumeration of access type specifiers.
Enumerator | |
---|---|
ReadOnly |
READ_ONLY. |
WriteOnly |
WRITE_ONLY. |
ReadWrite |
READ_WRITE. |
|
strong |
Blend equation enumeration.
Enumerator | |
---|---|
Add |
FUNC_ADD. |
Subtract |
FUNC_SUBTRACT. |
ReverseSubtract |
FUNC_REVERSE_SUBTRACT. |
Min |
MIN. |
Max |
MAX. |
|
strong |
Advanced blend equation enumeration.
|
strong |
Blend function type enumeration.
|
strong |
Enumeration of blit operation filtering modes.
Enumerator | |
---|---|
Nearest |
NEAREST. |
Linear |
LINEAR. |
|
strong |
|
strong |
Buffer map access enumeration.
|
strong |
Buffer selection bit enumeration.
Enumerator | |
---|---|
ColorBuffer |
COLOR_BUFFER_BIT: Clear the color buffer. |
DepthBuffer |
DEPTH_BUFFER_BIT: Clear the depth buffer. |
StencilBuffer |
STENCIL_BUFFER_BIT: Clear the stencil buffer. |
|
strong |
|
strong |
Buffer bind target.
|
strong |
|
strong |
Capability enumeration.
This enumaration lists capabilities i.e. features that can be enabled, disabled or queried by the Enable, Disable and IsEnabled member functions of the Context class.
There are also some syntax-sugar operators defined for Capability so it can be used in the following ways:
|
strong |
Enumeration of color buffers for read/write operations.
Enumerator | |
---|---|
None |
NONE. |
FrontLeft |
FRONT_LEFT. |
FrontRight |
FRONT_RIGHT. |
BackLeft |
BACK_LEFT. |
BackRight |
BACK_RIGHT. |
Front |
FRONT. |
Back |
BACK. |
Left |
LEFT. |
Right |
RIGHT. |
FrontAndBack |
FRONT_AND_BACK. |
|
strong |
Color logic operation enumeration.
|
strong |
Comparison function type enumeration.
|
strong |
Compatibility server context attribute bits enumeration.
|
strong |
Compatibility client context attribute bits enumeration.
Enumerator | |
---|---|
VertexArray |
CLIENT_VERTEX_ARRAY_BIT. |
PixelStore |
CLIENT_PIXEL_STORE_BIT. |
AllAttribs |
CLIENT_ALL_ATTRIB_BITS. |
|
strong |
Compatibility matrix mode enumeration.
Enumerator | |
---|---|
Projection |
PROJECTION. |
Modelview |
MODELVIEW. |
Texture |
TEXTURE. |
Color |
COLOR. |
|
strong |
Compatibility primitive type enumeration.
|
strong |
Conditional render modes.
|
strong |
|
strong |
|
strong |
GL Context release behavior enumeration.
Enumerator | |
---|---|
None |
NONE. |
Flush |
CONTEXT_RELEASE_BEHAVIOR_FLUSH. |
|
strong |
OpenGL data type enumeration.
Enumerator | |
---|---|
Byte |
BYTE. |
Short |
SHORT. |
Int |
INT. |
Fixed |
FIXED. |
Float |
FLOAT. |
HalfFloat |
HALF_FLOAT. |
Double |
DOUBLE. |
UnsignedByte |
UNSIGNED_BYTE. |
UnsignedShort |
UNSIGNED_SHORT. |
UnsignedInt |
UNSIGNED_INT. |
|
strong |
Debug output severity enumeration.
Enumerator | |
---|---|
High |
DEBUG_SEVERITY_HIGH_ARB. |
Medium |
DEBUG_SEVERITY_MEDIUM_ARB. |
Low |
DEBUG_SEVERITY_LOW_ARB. |
DontCare |
DONT_CARE. |
|
strong |
Debug output source enumeration.
|
strong |
Debug output type enumeration.
|
strong |
Debug output severity enumeration.
Enumerator | |
---|---|
High |
DEBUG_SEVERITY_HIGH. |
Medium |
DEBUG_SEVERITY_MEDIUM. |
Low |
DEBUG_SEVERITY_LOW. |
Notification |
DEBUG_SEVERITY_NOTIFICATION. |
DontCare |
DONT_CARE. |
|
strong |
Debug output source enumeration.
|
strong |
Debug output type enumeration.
|
strong |
Debug output severity enumeration.
Enumerator | |
---|---|
High |
DEBUG_SEVERITY_HIGH. |
Medium |
DEBUG_SEVERITY_MEDIUM. |
Low |
DEBUG_SEVERITY_LOW. |
Notification |
DEBUG_SEVERITY_NOTIFICATION. |
DontCare |
DONT_CARE. |
|
strong |
Debug output source enumeration.
|
strong |
Debug output type enumeration.
|
strong |
Error code enumeration.
|
strong |
Polygon facing enumeration.
Enumerator | |
---|---|
Front |
FRONT. |
Back |
BACK. |
FrontAndBack |
FRONT_AND_BACK. |
|
strong |
Face orientation enumeration.
Enumerator | |
---|---|
CW |
CW: Clockwise. |
CCW |
CCW: Counter-clockwise. |
|
strong |
Framebuffer object attachment points.
|
strong |
|
strong |
Framebuffer color attachment points.
|
strong |
Framebuffer status enumeration.
|
strong |
|
strong |
Functionality enumeration.
Functionalities are similar to capabilities in that they can be enabled or disabled by the Enable, Disable and IsEnabled member functions of the Context class.
The difference between them is that functionalities have multiple 0-based-indexed 'slots' that can be enabled or disabled. One example of Functionality is ClipDistance where the i-th 'slot' enabled the i-th clipping plane.
There are also some syntax-sugar operators defined for Functionality so it can be used in the following ways:
Enumerator | |
---|---|
ClipDistance |
CLIP_DISTANCE0. |
|
strong |
|
strong |
Graphics reset status enumeration.
Enumerator | |
---|---|
NoError |
NO_ERROR. |
GuiltyContextReset |
GUILTY_CONTEXT_RESET_ARB. |
InnocentContextReset |
INNOCENT_CONTEXT_RESET_ARB. |
UnknownContextReset |
UNKNOWN_CONTEXT_RESET_ARB. |
|
strong |
Enumeration of hint options.
Enumerator | |
---|---|
Fastest |
FASTEST. |
Nicest |
NICEST. |
DontCare |
DONT_CARE. |
|
strong |
Enumeration of hint targets.
Enumerator | |
---|---|
LineSmooth |
LINE_SMOOTH_HINT. |
PolygonSmooth |
POLYGON_SMOOTH_HINT. |
TextureCompression |
TEXTURE_COMPRESSION_HINT. |
FragmentShaderDerivative |
FRAGMENT_SHADER_DERIVATIVE_HINT. |
|
strong |
OpenGL image unit format enumeration.
|
strong |
Enumeration of implementation-dependent limit queries.
|
strong |
Enumeration of memory barrier bits.
|
strong |
|
strong |
|
strong |
Enumeration of patch parameters.
Enumerator | |
---|---|
PatchVertices |
PATCH_VERTICES. |
PatchDefaultOuterLevel |
PATCH_DEFAULT_OUTER_LEVEL. |
PatchDefaultInnerLevel |
PATCH_DEFAULT_INNER_LEVEL. |
|
strong |
Path cap mode enumeration.
Enumerator | |
---|---|
Flat |
FLAT. |
Square |
SQUARE_NV. |
Round |
ROUND_NV. |
Triangular |
TRIANGULAR_NV. |
|
strong |
Path color mode enumeration.
Enumerator | |
---|---|
Primary |
PRIMARY_COLOR_NV. |
Secondary |
SECONDARY_COLOR_NV. |
|
strong |
Path color format enumeration.
Enumerator | |
---|---|
Luminance |
LUMINANCE. |
Alpha |
ALPHA. |
Intensity |
INTENSITY. |
LuminanceAlpha |
LUMINANCE_ALPHA. |
RGB |
RGB. |
RGBA |
RGBA. |
|
strong |
Path specification command enumeration.
|
strong |
Path dash offset reset mode enumeration.
Enumerator | |
---|---|
MoveToReset |
MOVE_TO_RESET_NV. |
MoveToContinues |
MOVE_TO_CONTINUES_NV. |
|
strong |
Path fill covering mode.
Enumerator | |
---|---|
ConvexHull |
CONVEX_HULL_NV. |
BoundingBox |
BOUNDING_BOX_NV. |
BoundingBoxOfBoundingBoxes |
BOUNDING_BOX_OF_BOUNDING_BOXES_NV. |
FillCover |
PATH_FILL_COVER_MODE_NV. |
|
strong |
Path fill mode.
Enumerator | |
---|---|
Invert |
INVERT. |
CountUp |
COUNT_UP_NV. |
CountDown |
COUNT_DOWN_NV. |
FillMode |
PATH_FILL_MODE_NV. |
|
strong |
Path font style bits enumeration.
Enumerator | |
---|---|
Bold |
BOLD_BIT_NV. |
Italic |
ITALIC_BIT_NV. |
|
strong |
Path font target enumeration.
Enumerator | |
---|---|
Standard |
STANDARD_FONT_NAME_NV. |
System |
SYSTEM_FONT_NAME_NV. |
FileName |
FILE_NAME_NV. |
|
strong |
Path specification string format enumeration.
Enumerator | |
---|---|
SVG |
PATH_FORMAT_SVG_NV. |
PS |
PATH_FORMAT_PS_NV. |
|
strong |
Path color and tex-coord generation mode enumeration.
Enumerator | |
---|---|
None |
NONE. |
EyeLinear |
EYE_LINEAR. |
ObjectLinear |
OBJECT_LINEAR. |
ObjectBoundingBox |
PATH_OBJECT_BOUNDING_BOX_NV. |
|
strong |
Stroke line join style enumeration.
Enumerator | |
---|---|
None |
NONE. |
Round |
ROUND_NV. |
Bevel |
BEVEL_NV. |
MiterRevert |
MITER_REVERT_NV. |
MiterTruncate |
MITER_TRUNCATE_NV. |
|
strong |
Path list mode enumeration.
Enumerator | |
---|---|
AccumAdjacentPairs |
ACCUM_ADJACENT_PAIRS_NV. |
AdjacentPairs |
ADJACENT_PAIRS_NV. |
FirstToRest |
FIRST_TO_REST_NV. |
|
strong |
Path metric query bits enumeration.
|
strong |
Path missing glyph action mode enumeration.
Enumerator | |
---|---|
Skip |
SKIP_MISSING_GLYPH_NV. |
Use |
USE_MISSING_GLYPH_NV. |
|
strong |
Path stroke covering move.
Enumerator | |
---|---|
ConvexHull |
CONVEX_HULL_NV. |
BoundingBox |
BOUNDING_BOX_NV. |
BoundingBoxOfBoundingBoxes |
BOUNDING_BOX_OF_BOUNDING_BOXES_NV. |
StrokeCover |
PATH_STROKE_COVER_MODE_NV. |
|
strong |
Text encoding type enumeration.
Enumerator | |
---|---|
UTF8 |
UTF8_NV. |
UTF16 |
UTF16_NV. |
|
strong |
Path transform type enumeration.
|
strong |
Performance counter type.
Enumerator | |
---|---|
UnsignedInt |
UNSIGNED_INT. |
Float |
FLOAT. |
UnsignedInt64 |
UNSIGNED_INT64_AMD. |
Percentage |
PERCENTAGE_AMD. |
|
strong |
OpenGL pixel data format enumeration.
|
strong |
OpenGL pixel data internal format enumeration.
|
strong |
OpenGL pixel data type enumeration.
|
strong |
Pixel storage mode parameter enumeration.
|
strong |
Polygon rasterization mode enumeration.
Enumerator | |
---|---|
Point |
POINT. |
Line |
LINE. |
Fill |
FILL. |
|
strong |
Precision type enumeration.
Enumerator | |
---|---|
LowFloat |
LOW_FLOAT. |
MediumFloat |
MEDIUM_FLOAT. |
HighFloat |
HIGH_FLOAT. |
LowInt |
LOW_INT. |
MediumInt |
MEDIUM_INT. |
HighInt |
HIGH_INT. |
|
strong |
Primitive type enumeration.
|
strong |
Program interface enumeration.
|
strong |
Program pipeline stage enumeration.
|
strong |
Program resource property enumeration.
|
strong |
Provoking vertex selection mode (for flatshading) enumeration.
Enumerator | |
---|---|
FirstVertexConvention |
FIRST_VERTEX_CONVENTION: First vertex convention. |
LastVertexConvention |
LAST_VERTEX_CONVENTION: Last vertex convention. |
|
strong |
Query bind target.
|
strong |
|
strong |
|
strong |
Graphics reset notification strategy enumeration.
Enumerator | |
---|---|
NoResetNotification |
NO_RESET_NOTIFICATION_ARB. |
LoseContextOnReset |
LOSE_CONTEXT_ON_RESET_ARB. |
|
strong |
The type of a Shader.
Enumerator | |
---|---|
Vertex |
VERTEX_SHADER. |
TessControl |
TESS_CONTROL_SHADER. |
TessEvaluation |
TESS_EVALUATION_SHADER. |
Geometry |
GEOMETRY_SHADER. |
Fragment |
FRAGMENT_SHADER. |
Compute |
COMPUTE_SHADER. |
|
strong |
OpenGL Shading Language data type enumeration.
|
strong |
Stencil operation type enumeration.
Enumerator | |
---|---|
Keep |
KEEP. |
Zero |
ZERO. |
Replace |
REPLACE. |
Incr |
INCR. |
Decr |
DECR. |
Invert |
INVERT. |
IncrWrap |
INCR_WRAP. |
DecrWrap |
DECR_WRAP. |
|
strong |
OpenGL string query enumeration.
Enumerator | |
---|---|
ClientAPIs | |
Extensions | |
Vendor | |
Version | |
ClientAPIs | |
Extensions | |
Vendor | |
Version | |
Renderer |
RENDERER. |
Vendor |
VENDOR. |
Version |
VERSION. |
ShadingLanguageVersion |
SHADING_LANGUAGE_VERSION. |
|
strong |
The synchronization condition enumeration.
Enumerator | |
---|---|
GPUCommandsComplete |
SYNC_GPU_COMMANDS_COMPLETE. |
|
strong |
The synchronization object status enumeration.
Enumerator | |
---|---|
Signaled |
SIGNALED. |
Unsignaled |
UNSIGNALED. |
|
strong |
|
strong |
The wait result enumeration.
Enumerator | |
---|---|
ConditionSatisfied |
CONDITION_SATISFIED. |
AlreadySignaled |
ALREADY_SIGNALED. |
TimeoutExpired |
TIMEOUT_EXPIRED. |
WaitFailed |
WAIT_FAILED. |
|
strong |
|
strong |
|
strong |
Texture compare mode enumeration.
GL_TEXTURE_COMPARE_MODE
Enumerator | |
---|---|
None |
NONE. |
CompareRefToTexture |
COMPARE_REF_TO_TEXTURE. |
|
strong |
Texture filter enumeration.
GL_TEXTURE_MAG_FILTER
GL_TEXTURE_MIN_FILTER
Enumerator | |
---|---|
Nearest |
NEAREST. |
Linear |
LINEAR. |
|
strong |
Texture magnification filter enumeration.
GL_TEXTURE_MAG_FILTER
Enumerator | |
---|---|
Nearest |
NEAREST. |
Linear |
LINEAR. |
|
strong |
Texture minification filter enumeration.
GL_TEXTURE_MIN_FILTER
|
strong |
Texture swizzle enumeration.
GL_TEXTURE_SWIZZLE_R
GL_TEXTURE_SWIZZLE_G
GL_TEXTURE_SWIZZLE_B
GL_TEXTURE_SWIZZLE_A
Enumerator | |
---|---|
Red |
RED. |
Green |
GREEN. |
Blue |
BLUE. |
Alpha |
ALPHA. |
Zero |
ZERO. |
One |
ONE. |
|
strong |
Texture swizzle parameter coordinate enumeration.
Enumerator | |
---|---|
R |
TEXTURE_SWIZZLE_R. |
G |
TEXTURE_SWIZZLE_G. |
B |
TEXTURE_SWIZZLE_B. |
A |
TEXTURE_SWIZZLE_A. |
RGBA |
TEXTURE_SWIZZLE_RGBA. |
|
strong |
Texture bind and image specification targets.
|
strong |
Texture wrap enumeration.
GL_TEXTURE_WRAP_S
GL_TEXTURE_WRAP_T
GL_TEXTURE_WRAP_R
Enumerator | |
---|---|
ClampToEdge |
CLAMP_TO_EDGE. |
Repeat |
REPEAT. |
ClampToBorder |
CLAMP_TO_BORDER. |
MirroredRepeat |
MIRRORED_REPEAT. |
MirrorClampToEdge |
MIRROR_CLAMP_TO_EDGE. |
|
strong |
Texture wrap parameter coordinate enumeration.
Enumerator | |
---|---|
S |
TEXTURE_WRAP_S. |
T |
TEXTURE_WRAP_T. |
R |
TEXTURE_WRAP_R. |
|
strong |
|
strong |
Transform feedback primitive modes.
Enumerator | |
---|---|
Triangles |
TRIANGLES. |
Lines |
LINES. |
Points |
POINTS. |
|
strong |
StrCRef oglplus::EnumValueName | ( | Enum | enum_value | ) |
Returns the name of the GL enumerated value for an OGLplus enum value.
This function is overloaded for the enumerated types defined by OGLplus and returns the GL constant name (without the 'GL_' prefix) as a c-string.
The result of this function is influenced by the #OGLPLUS_NO_ENUM_VALUE_NAMES preprocessor-symbol. If it is set to a nonzero value then EnumValueName(Enum) returns an empty string.
Range<Enum> oglplus::EnumValueRange | ( | void | ) |
Returns a Range
of values in an Enumeration
.
This template function is available for the enumerated types defined by OGLplus and returns a Range that allows to traverse all values of a particular Enumeration
type.
The result of this function is influenced by the #OGLPLUS_NO_ENUM_VALUE_RANGES preprocessor-symbol. If it is set to a nonzero value then EnumValueRange<E>() returns an empty range.