glbinding  3.3.0.0
A C++ binding for the OpenGL API, generated using the gl.xml specification.
Loading...
Searching...
No Matches

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

#include <glbinding-aux/Meta.h>

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

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

Constructor & Destructor Documentation

◆ Meta()

glbinding::aux::Meta::Meta ( )
delete

Deleted Constructor as all functions are static.

Member Function Documentation

◆ glRevision()

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

Returns the revision of the parsed gl.xml file.

Returns
The revision of the parsed gl.xml file

◆ getBitfield()

static gl::GLbitfield glbinding::aux::Meta::getBitfield ( const std::string &  bitfield)
static

Converts a string into a bitfield symbol.

Parameters
[in]bitfieldThe string representation of the bitfield
Returns
The symbol identified through the bitfield string, 0 if failed

◆ bitfields()

static std::vector< gl::GLbitfield > glbinding::aux::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

◆ getEnum()

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

Converts a GLenum to a string.

Parameters
[in]glenumThe enum to convert
Returns
A string representation of the GLenum symbol name
Remarks
Beware, that some enums in the OpenGL API have different symbol names but identical enum values and that this function cannot differentiate between them

Converts a string to an enum symbol

Parameters
[in]glenumThe string representation of the enum
Returns
The symbol identified through the enum string, 0 if failed

◆ enums()

static std::set< gl::GLenum > glbinding::aux::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

◆ getString() [1/25]

static const std::string & glbinding::aux::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
Remarks
Can either be GL_TRUE or GL_FALSE

◆ getBoolean()

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

Converts a string to a GLboolean symbol.

Parameters
[in]booleanThe string representation of the GLboolean
Returns
The symbol identified through the boolean string, GL_FALSE if failed

◆ getString() [2/25]

static const std::string & glbinding::aux::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

◆ getExtension()

static gl::GLextension glbinding::aux::Meta::getExtension ( const std::string &  extension)
static

Converts a string to an GLextension.

Parameters
[in]extensionThe string representation of the extension
Returns
The symbol identified through the extension string, 'UNKNOWN' if failed

◆ extensions() [1/3]

static std::set< gl::GLextension > glbinding::aux::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

◆ extensions() [2/3]

static const std::set< gl::GLextension > glbinding::aux::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

◆ extensions() [3/3]

static const std::set< gl::GLextension > glbinding::aux::Meta::extensions ( const std::string &  glfunction)
static

Returns the list of extensions that are requiring a function.

Parameters
[in]functionThe name of the function, including the 'gl' prefix
Returns
The set of extensions that are requiring a function

◆ versions() [1/2]

static const std::set< Version > glbinding::aux::Meta::versions ( const std::string &  glfunction)
static

Returns the list of features that are requiring a function.

Parameters
[in]functionThe name of the function, including the 'gl' prefix
Returns
The set of features that are requiring a function

◆ functions() [1/2]

static const std::set< AbstractFunction * > glbinding::aux::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
Remarks
This is exclusive (preceeding versions are ignored)

◆ functions() [2/2]

static const std::set< AbstractFunction * > glbinding::aux::Meta::functions ( gl::GLextension  extension)
static

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

Parameters
[in]extensionThe extension to return the required functions for
Returns
The set of functions that are required for the extension

◆ version()

static const Version & glbinding::aux::Meta::version ( gl::GLextension  glextension)
static

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

Parameters
[in]glextensionThe extension
Returns
The first Version (Feature) that required the extension

◆ versions() [2/2]

static const std::set< Version > & glbinding::aux::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

◆ getString() [3/25]

static const std::string & glbinding::aux::Meta::getString ( gl::AttribMask  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [4/25]

static const std::string & glbinding::aux::Meta::getString ( gl::BufferStorageMask  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [5/25]

static const std::string & glbinding::aux::Meta::getString ( gl::ClearBufferMask  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [6/25]

static const std::string & glbinding::aux::Meta::getString ( gl::ClientAttribMask  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [7/25]

static const std::string & glbinding::aux::Meta::getString ( gl::ContextFlagMask  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [8/25]

static const std::string & glbinding::aux::Meta::getString ( gl::ContextProfileMask  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [9/25]

static const std::string & glbinding::aux::Meta::getString ( gl::FfdMaskSGIX  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [10/25]

static const std::string & glbinding::aux::Meta::getString ( gl::FragmentShaderColorModMaskATI  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [11/25]

static const std::string & glbinding::aux::Meta::getString ( gl::FragmentShaderDestMaskATI  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [12/25]

static const std::string & glbinding::aux::Meta::getString ( gl::FragmentShaderDestModMaskATI  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [13/25]

static const std::string & glbinding::aux::Meta::getString ( gl::MapBufferAccessMask  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [14/25]

static const std::string & glbinding::aux::Meta::getString ( gl::MemoryBarrierMask  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [15/25]

static const std::string & glbinding::aux::Meta::getString ( gl::OcclusionQueryEventMaskAMD  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [16/25]

static const std::string & glbinding::aux::Meta::getString ( gl::PathFontStyle  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [17/25]

static const std::string & glbinding::aux::Meta::getString ( gl::PathMetricMask  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [18/25]

static const std::string & glbinding::aux::Meta::getString ( gl::PathRenderingMaskNV  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [19/25]

static const std::string & glbinding::aux::Meta::getString ( gl::PerformanceQueryCapsMaskINTEL  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [20/25]

static const std::string & glbinding::aux::Meta::getString ( gl::SyncObjectMask  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [21/25]

static const std::string & glbinding::aux::Meta::getString ( gl::TextureStorageMaskAMD  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [22/25]

static const std::string & glbinding::aux::Meta::getString ( gl::UnusedMask  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [23/25]

static const std::string & glbinding::aux::Meta::getString ( gl::UseProgramStageMask  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [24/25]

static const std::string & glbinding::aux::Meta::getString ( gl::VertexHintsMaskPGI  glbitfield)
static

Convert bitfield to symbol name string representation.

Parameters
[in]bitfieldThe bitfield value
Returns
The string representation of the value

◆ getString() [25/25]

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

Convert enum to symbol name string representation.

Parameters
[in]enumThe enum value
Returns
The shortest string representation of the value
Remarks
Beware, that some enums in the API have different symbol names but identical enum values and that this function cannot differentiate between them

◆ getStrings()

static std::vector< std::string > glbinding::aux::Meta::getStrings ( gl::GLenum  glenum)
static

Convert enum to symbol name string representation.

Parameters
[in]enumThe enum value
Returns
All string representations of the value

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