PrevUpHomeNext

Chapter 2. Quick reference

Table of Contents

Introduction
Concepts
Ranges
Metafunctions
Strings
String container
String constant reference
Error reporting and handling
Error code enumeration
Basic exception class
Missing function errors
Limit errors
Object errors
Program variable errors
Program build errors
Framebuffer errors
Deferred error handlers
Function outcome
Object creation methods
Operation kinds
OGLplus objects
Tags
Object type
Name
Textual descriptions
Gen/Delete operations
Type specific operations
Object subtype
Object
Currently bound objects
Optional
Reference
Sequence
Array
Group
Buffers
Buffer maps
Currently bound buffers
DSA Buffers
DSA buffer maps
Vertex arrays
DSA vertex arrays
Textures
Currently bound textures
DSA textures
Samplers
Framebuffers
Currently bound framebuffers
DSA framebuffers
Renderbuffers
Currently bound renderbuffers
DSA renderbuffers
Shaders
Programs
Program pipelines
Queries
Transform feedback
DSA transform feedback
Sync objects
Vertex attrib slot
Fragment data slot
Texture handle
OGLplus program variables
Tags
Location
Wrapper
Typechecking modifier
Optional modifier
Lazy modifier
Uniforms
Program uniforms
Uniform blocks
Shader storage blocks
Uniform subroutines
Vertex attributes
DSA vertex attributes
Fragment output data
Draw buffer index
Viewport index
Current GL context
Errors
Capabilities
Clip control
Viewport operations
Buffer selection
Buffer masking
Buffer clearing
Rasterization
Drawing
Computing
Depth test
Stencil test
Scissor test
Logic operations
Pixel operations
Blending operations
Synchronization
Hints
Limit queries
Numeric queries
String queries
Object binding
Object DSA
Helper classes
Client-side wrapper of the GL context
Client context settings
Blending
Buffer clearing
Buffer masking
Capabilities
Clip control
Computing
Depth test
Stencil test
Scissor test
Viewport
Drawing
Hints
Limit queries
Numeric queries
String queries
Logic operations
Pixel operations
Synchronization
Rasterization
Object binding
Capabilities
Hint
Limit queries
String queries
Compare function
Stencil operation
Access specifier
Data types
Face orientation and mode
Clip control
Blend function and equation
Color buffer
Buffer selection bits
Shader type
Pixel data type and format
Pixel storage mode
Blit filter
Color logic operation
Polygon mode
Precision type
Primitive type
Provoke mode
Patch parameter
Program interface
Memory barrier bits
Context profile bits
Context flags
Context release behavior
Reset notification strategy
Graphics reset status
Compile-time configuration
Site-configuration
Compiler capabilities
General configuration
GL-related
Strings
Error-related
Enumerations
Object-related
Math utilities
Constants
Angles
Vectors
Matrices
Planes
Boolean
SizeType
Bitfield
Enumerations
Limited values
GLSL Source code
GLSL Strings
Output data wrapper
Attribute list
Misc utilities
Nothing
Ranges
Image generators and loaders
Image specification
Image

This quick reference describes the public API of the OGLplus library. The implementation details, i.e. parts of of OGLplus not listed in this reference should not be used by the library users and are subject to change without any prior notice.

Note, that several classes or types described here (for example function parameter types or return value types), are just concepts - named lists of type constraints not concrete types. The actual types conforming to these concepts are implementation details and usually instantiation of templates. If values of such types are returned from a function and need to be stored in variables, then the auto type specifier (or the decltype operator) should be used to determine the actual type. Whenever this is the case, it is clearly noted in the section describing the concept.

Unless stated otherwise, all OGLplus definitions are made inside of the top-level oglplus namespace or in namespaces nested inside of namespace oglplus.

The namespace-definition opening,

namespace oglplus {

and closing,

} // namespace oglplus

statements are assumed, but omitted for the sake of brevity from this reference.


PrevUpHomeNext