![]() |
glbinding
3.3.0.0
A C++ binding for the OpenGL API, generated using the gl.xml specification.
|
The Function represents an OpenGL API function with additional features. More...
#include <glbinding/Function.h>
Public Types | |
| using | Signature = ReturnType(*)(Arguments...) |
| The c pointer type for a function call. | |
| using | BeforeCallback = typename CallbackType< void, Arguments... >::type |
| The callback type for the before callback. | |
| using | AfterCallback = typename CallbackType< ReturnType, Arguments... >::type |
| The callback type for the after callback. | |
Public Member Functions | |
| Function (const char *name) | |
| Constructor. | |
| ReturnType | operator() (Arguments &... arguments) const |
| Executes a function call on the resolved function pointer and passes the arguments. | |
| ReturnType | call (Arguments &... arguments) const |
| Executes a function call on the resolved function pointer and passes the arguments. | |
| ReturnType | directCall (Arguments... arguments) const |
| Executes a function call on the resolved function pointer and passes the arguments. | |
| void | setBeforeCallback (BeforeCallback callback) |
| Register a callback that is triggered before a function call to the OpenGL driver. | |
| void | clearBeforeCallback () |
| Clears any previously registered before callback. | |
| void | setAfterCallback (AfterCallback callback) |
| Register a callback that is triggered after a function call to the OpenGL driver. | |
| void | clearAfterCallback () |
| Clears any previously registered after callback. | |
| BeforeCallback | beforeCallback () const |
| The accessor for the beforeCallback. | |
| AfterCallback | afterCallback () const |
| The accessor for the afterCallback. | |
| virtual bool | hasState () const override |
| Checks for existence of the current configured state. | |
| virtual bool | hasState (int pos) const override |
| Checks for existence of a state. | |
| virtual AbstractState & | state () const override |
| Get current state. | |
| virtual AbstractState & | state (int pos) const override |
| Get state. | |
| virtual void | resizeStates (int count) override |
| Resize internal cache of states. | |
Public Member Functions inherited from glbinding::AbstractFunction | |
| AbstractFunction (const char *name) | |
| Constructor. | |
| virtual | ~AbstractFunction () |
| Destructor to guarantee correct memory deallocation of subclasses. | |
| const char * | name () const |
| Get function name. | |
| void | resolveAddress () |
| Lookup the function pointer and stores it in the current state. | |
| bool | isResolved () const |
| Check for a valid function pointer in the current state. | |
| ProcAddress | address () const |
| Get function pointer. | |
| CallbackMask | callbackMask () const |
| Get callback mask. | |
| void | setCallbackMask (CallbackMask mask) |
| Reconfigures the callback mask for the current state. | |
| void | addCallbackMask (CallbackMask mask) |
| Reconfigures the callback mask for the current state in means of a bit-wise 'or' operation with the current callback mask. | |
| void | removeCallbackMask (CallbackMask mask) |
| Reconfigures the callback mask for the current state in means of a bit-wise 'clear' operation of the current callback mask. | |
| bool | isEnabled (CallbackMask mask) const |
| Check if all bits of the parameter are set in the currently configured callback mask of the current state. | |
| bool | isAnyEnabled (CallbackMask mask) const |
| Check if any bit of the parameter is set in the currently configured callback mask of the current state. | |
Protected Attributes | |
| std::vector< State > | m_states |
| List of States the function is registered in. | |
| BeforeCallback | m_beforeCallback |
| The currently registered before callback. | |
| AfterCallback | m_afterCallback |
| The currently registered after callback. | |
Protected Attributes inherited from glbinding::AbstractFunction | |
| const char * | m_name |
| The function name, including the 'gl' prefix. | |
Friends | |
| struct | FunctionHelper< ReturnType, Arguments... > |
Additional Inherited Members | |
Static Public Member Functions inherited from glbinding::AbstractFunction | |
| static void | unresolved (const AbstractFunction *function) |
| Call unresolved callback. | |
| static void | before (const FunctionCall &call) |
| Call before callback. | |
| static void | after (const FunctionCall &call) |
| Call after callback. | |
| static void | log (FunctionCall &&call) |
| Call log callback. | |
| static int | currentPos () |
| Get index of current state. | |
| static int | maxPos () |
| Get highest state index currently used. | |
The Function represents an OpenGL API function with additional features.
These features include:
| ReturnType | The return type of the function |
| Arguments | The types of the arguments |
| using glbinding::Function< ReturnType, Arguments >::Signature = ReturnType( *) (Arguments...) |
The c pointer type for a function call.
| using glbinding::Function< ReturnType, Arguments >::BeforeCallback = typename CallbackType<void, Arguments...>::type |
The callback type for the before callback.
| using glbinding::Function< ReturnType, Arguments >::AfterCallback = typename CallbackType<ReturnType, Arguments...>::type |
The callback type for the after callback.
| glbinding::Function< ReturnType, Arguments >::Function | ( | const char * | name | ) |
Constructor.
| [in] | name | The actual exported OpenGL API function name, including the 'gl' prefix |
|
inline |
Executes a function call on the resolved function pointer and passes the arguments.
| [in] | arguments | The arguments for the function call |
|
inline |
Executes a function call on the resolved function pointer and passes the arguments.
| [in] | arguments | The arguments for the function call |
|
inline |
Executes a function call on the resolved function pointer and passes the arguments.
| [in] | arguments | The arguments for the function call |
|
inline |
Register a callback that is triggered before a function call to the OpenGL driver.
| [in] | callback | The callback to register |
|
inline |
Clears any previously registered before callback.
|
inline |
Register a callback that is triggered after a function call to the OpenGL driver.
| [in] | callback | The callback to register |
|
inline |
Clears any previously registered after callback.
|
inline |
The accessor for the beforeCallback.
|
inline |
The accessor for the afterCallback.
|
overridevirtual |
Checks for existence of the current configured state.
true if the current state still exists, else falseImplements glbinding::AbstractFunction.
References glbinding::AbstractFunction::currentPos().
|
overridevirtual |
Checks for existence of a state.
| [in] | pos | The index of the state to check |
true if the state exists, else false Implements glbinding::AbstractFunction.
References glbinding::AbstractFunction::maxPos().
|
overridevirtual |
Get current state.
Implements glbinding::AbstractFunction.
References glbinding::AbstractFunction::currentPos().
|
overridevirtual |
Get state.
| [in] | pos | The index of the state |
Implements glbinding::AbstractFunction.
References glbinding::AbstractFunction::maxPos().
|
overridevirtual |
Resize internal cache of states.
| [in] | count | New cache size |
Implements glbinding::AbstractFunction.
|
friend |
|
mutableprotected |
List of States the function is registered in.
|
protected |
The currently registered before callback.
|
protected |
The currently registered after callback.
1.9.8