glbinding  2.1.1.96dbfd46d679
A C++ binding for the OpenGL API, generated using the gl.xml specification.

Provisioning of meta information about OpenGL extensions, functions and conversion of strings and symbols of the OpenGL API. More...

#include <glbinding/include/glbinding/Meta.h>

Public Member Functions

 Meta ()=delete
 Deleted Constructor as all functions are static. More...
 

Static Public Member Functions

static int glRevision ()
 Returns the revision of the parsed gl.xml file. More...
 
static gl::GLbitfield getBitfield (const std::string &glbitfield)
 Converts a string into a bitfield symbol. More...
 
static std::vector< gl::GLbitfield > bitfields ()
 Returns the list of all bitfields known by the gl.xml. More...
 
static const std::string & getString (gl::GLenum glenum)
 Converts a GLenum to a string. More...
 
static gl::GLenum getEnum (const std::string &glenum)
 Converts a string to a GLenum symbol. More...
 
static std::vector< gl::GLenum > enums ()
 Returns the list of all enums known by the gl.xml. More...
 
static const std::string & getString (const gl::GLboolean &glboolean)
 Converts a GLboolean to a string. More...
 
static gl::GLboolean getBoolean (const std::string &glboolean)
 Converts a string to a GLboolean symbol. More...
 
static const std::string & getString (gl::GLextension glextension)
 Converts a GLextension to its string representation. More...
 
static gl::GLextension getExtension (const std::string &glextension)
 Converts a string to an extension. More...
 
static std::set< gl::GLextension > extensions ()
 Returns the set of all extensions known by the gl.xml. More...
 
static const std::set< gl::GLextension > extensions (const Version &version)
 Returns the set of extensions that are required for by the given version. More...
 
static const std::set< gl::GLextension > extensions (const std::string &glfunction)
 Returns the list of extensions that are requiring an OpenGL function. More...
 
static const std::set< AbstractFunction * > functions (const Version &version)
 Returns the set of functions that are required for the version. More...
 
static const std::set< AbstractFunction * > functions (gl::GLextension glextension)
 Returns the set of functions that are required for the extension. More...
 
static const Versionversion (gl::GLextension glextension)
 Returns the first OpenGL Version (Feature) that required the extension. More...
 
static const VersiongetRequiringVersion (gl::GLextension glextension)
 Returns the first OpenGL Version (Feature) that required the extension. More...
 
static const std::set< Version > & versions ()
 Returns the list of all Versions (Features) known by the gl.xml. More...
 
static const std::string & getString (gl::AttribMask glbitfield)
 
static const std::string & getString (gl::BufferAccessMask glbitfield)
 
static const std::string & getString (gl::BufferStorageMask glbitfield)
 
static const std::string & getString (gl::ClearBufferMask glbitfield)
 
static const std::string & getString (gl::ClientAttribMask glbitfield)
 
static const std::string & getString (gl::ContextFlagMask glbitfield)
 
static const std::string & getString (gl::ContextProfileMask glbitfield)
 
static const std::string & getString (gl::FfdMaskSGIX glbitfield)
 
static const std::string & getString (gl::FragmentShaderColorModMaskATI glbitfield)
 
static const std::string & getString (gl::FragmentShaderDestMaskATI glbitfield)
 
static const std::string & getString (gl::FragmentShaderDestModMaskATI glbitfield)
 
static const std::string & getString (gl::MapBufferUsageMask glbitfield)
 
static const std::string & getString (gl::MemoryBarrierMask glbitfield)
 
static const std::string & getString (gl::PathFontStyle glbitfield)
 
static const std::string & getString (gl::PathRenderingMaskNV glbitfield)
 
static const std::string & getString (gl::PerformanceQueryCapsMaskINTEL glbitfield)
 
static const std::string & getString (gl::SyncObjectMask glbitfield)
 
static const std::string & getString (gl::TextureStorageMaskAMD glbitfield)
 
static const std::string & getString (gl::UnusedMask glbitfield)
 
static const std::string & getString (gl::UseProgramStageMask glbitfield)
 
static const std::string & getString (gl::VertexHintsMaskPGI glbitfield)
 

Detailed Description

Provisioning of meta information about OpenGL extensions, functions and conversion of strings and symbols of the OpenGL API.

Constructor & Destructor Documentation

glbinding::Meta::Meta ( )
delete

Deleted Constructor as all functions are static.

Member Function Documentation

static int glbinding::Meta::glRevision ( )
static

Returns the revision of the parsed gl.xml file.

Returns
The revision of the parsed gl.xml file.
static gl::GLbitfield glbinding::Meta::getBitfield ( const std::string &  glbitfield)
static

Converts a string into a bitfield symbol.

Parameters
[in]glbitfieldThe string representation of the bitfield.
Returns
The symbol identified through the bitfield string, 0 if failed.
static std::vector<gl::GLbitfield> glbinding::Meta::bitfields ( )
static

Returns the list of all bitfields known by the gl.xml.

Returns
The list of all bitfields known by the gl.xml.
static const std::string& glbinding::Meta::getString ( gl::GLenum  glenum)
static

Converts a GLenum to a string.

Parameters
[in]glenumThe enum to convert.
Returns
A string representation of the GLenum symbol name.

Beware, that some enums in the OpenGL API have different symbol names but identical enum values and that this function cannot differentiate between them.

static gl::GLenum glbinding::Meta::getEnum ( const std::string &  glenum)
static

Converts a string to a GLenum symbol.

Parameters
[in]glenumThe string representation of the enum.
Returns
The symbol identified through the enum string, 0 if failed.
static std::vector<gl::GLenum> glbinding::Meta::enums ( )
static

Returns the list of all enums known by the gl.xml.

Returns
The list of all enums known by the gl.xml.
static const std::string& glbinding::Meta::getString ( const gl::GLboolean &  glboolean)
static

Converts a GLboolean to a string.

Parameters
[in]glbooleanThe boolean to convert.
Returns
A string representation of the GLboolean symbol name.

Can either be 'GL_TRUE' or 'GL_FALSE'.

static gl::GLboolean glbinding::Meta::getBoolean ( const std::string &  glboolean)
static

Converts a string to a GLboolean symbol.

Parameters
[in]glbooleanThe string representation of the GLboolean.
Returns
The symbol identified through the boolean string, 'GL_FALSE' if failed.
static const std::string& glbinding::Meta::getString ( gl::GLextension  glextension)
static

Converts a GLextension to its string representation.

Parameters
[in]glextensionThe extension to convert.
Returns
The string representation of the extension.
static gl::GLextension glbinding::Meta::getExtension ( const std::string &  glextension)
static

Converts a string to an extension.

Parameters
[in]glextensionThe string representation of the extension.
Returns
The symbol identified through the extension string, 'UNKNOWN' if failed.
static std::set<gl::GLextension> glbinding::Meta::extensions ( )
static

Returns the set of all extensions known by the gl.xml.

Returns
The set of all extensions known by the gl.xml.
static const std::set<gl::GLextension> glbinding::Meta::extensions ( const Version version)
static

Returns the set of extensions that are required for by the given version.

Parameters
[in]versionThe version/feature to return the required extensions for. If an null version is given, all extensions that have no version/feature associated are returned instead.
Returns
The set of extensions that should be supported for the given version. All non versioned extensions can be queried by providing the null version.
static const std::set<gl::GLextension> glbinding::Meta::extensions ( const std::string &  glfunction)
static

Returns the list of extensions that are requiring an OpenGL function.

Parameters
[in]glfunctionThe name of the function, including the 'gl' prefix.
Returns
The set of extensions that are requiring an OpenGL function.
static const std::set<AbstractFunction *> glbinding::Meta::functions ( const Version version)
static

Returns the set of functions that are required for the version.

Parameters
[in]versionThe version to return the required functions for.
Returns
The set of functions that are required for the version. Note: this is exclusive (preceeding versions are ignored).
static const std::set<AbstractFunction *> glbinding::Meta::functions ( gl::GLextension  glextension)
static

Returns the set of functions that are required for the extension.

Parameters
[in]glextensionThe extension to return the required functions for.
Returns
The set of functions that are required for the extension.
static const Version& glbinding::Meta::version ( gl::GLextension  glextension)
static

Returns the first OpenGL Version (Feature) that required the extension.

Parameters
[in]glextensionThe extension.
Returns
The first OpenGL Version (Feature) that required the extension.
static const Version& glbinding::Meta::getRequiringVersion ( gl::GLextension  glextension)
static

Returns the first OpenGL Version (Feature) that required the extension.

Parameters
[in]glextensionThe extension.
Returns
The first OpenGL Version (Feature) that required the extension.
Deprecated:
This method will be removed in future major releases.
static const std::set<Version>& glbinding::Meta::versions ( )
static

Returns the list of all Versions (Features) known by the gl.xml.

Returns
The list of all Versions (Features) known by the gl.xml.
static const std::string& glbinding::Meta::getString ( gl::AttribMask  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::BufferAccessMask  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::BufferStorageMask  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::ClearBufferMask  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::ClientAttribMask  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::ContextFlagMask  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::ContextProfileMask  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::FfdMaskSGIX  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::FragmentShaderColorModMaskATI  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::FragmentShaderDestMaskATI  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::FragmentShaderDestModMaskATI  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::MapBufferUsageMask  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::MemoryBarrierMask  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::PathFontStyle  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::PathRenderingMaskNV  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::PerformanceQueryCapsMaskINTEL  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::SyncObjectMask  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::TextureStorageMaskAMD  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::UnusedMask  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::UseProgramStageMask  glbitfield)
static
static const std::string& glbinding::Meta::getString ( gl::VertexHintsMaskPGI  glbitfield)
static

The documentation for this class was generated from the following file: