glbinding::AbstractFunction Class Reference

The AbstractFunction represents an OpenGL API function. More...

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

Inheritance diagram for glbinding::AbstractFunction:

Classes
struct	State
	The State struct represents the configuration of an OpenGL function for one thread. This includes the driver function pointer (is allowed to differ between contexts) and the callback mask. More...

Public Member Functions
	AbstractFunction (const char *name)
	Constructor. More...
virtual	~AbstractFunction ()
	Destructor to guarantee correct memory deallocation of subclasses. More...
const char *	name () const
	Name accessor. More...
void	resolveAddress ()
	Lookup the function pointer and stores it in the current state. More...
bool	isResolved () const
	Check for a valid function pointer in the current state. More...
ProcAddress	address () const
	Function pointer accessor. More...
CallbackMask	callbackMask () const
	Callback mask accessor. More...
void	setCallbackMask (CallbackMask mask)
	Reconfigures the callback mask for the current state. More...
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. More...
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. More...
bool	isEnabled (CallbackMask mask) const
	Check if all bits of the parameter are set in the currently configured callback mask of the current state. More...
bool	isAnyEnabled (CallbackMask mask) const
	Check if any bit of the parameter is set in the currently configured callback mask of the current state. More...
void	unresolved () const
	Triggers a call of the unresolved callback. More...
void	before (const FunctionCall &call) const
	Triggers a call of the before callback, passing the parameters. More...
void	after (const FunctionCall &call) const
	Triggers a call of the after callback, passing the parameters and return value. More...

Protected Member Functions
bool	hasState () const
	Checks for existance of the current configured state. More...
bool	hasState (int pos) const
	Checks for existance of a state. More...
State &	state () const
	Current state accessor. More...
State &	state (int pos) const
	State accessor. More...

Static Protected Member Functions
static void	provideState (int pos)
	Extend the function states to include the state identified through pos. More...
static void	neglectState (int pos)
	Reconfigures the states so that the state identified through pos is neglected. More...
static void	setStatePos (int pos)
	Updates the currently used state. More...

Protected Attributes
const char *	m_name
	The OpenGL API function name, including the 'gl' prefix. More...
std::vector< State >	m_states
	The list of all states. More...

Static Protected Attributes
static int	s_maxpos
	The global maximum of states per function. More...

Friends
class	Binding
	For state configuration. More...

Detailed Description

The AbstractFunction represents an OpenGL API function.

Constructor & Destructor Documentation

glbinding::AbstractFunction::AbstractFunction

(

const char *

name

)

Constructor.

Parameters

[in]

name

The actual exported OpenGL API function name, including the 'gl' prefix.

virtual glbinding::AbstractFunction::~AbstractFunction ( )

virtual

Destructor to guarantee correct memory deallocation of subclasses.

Member Function Documentation

const char* glbinding::AbstractFunction::name

(

)

const

Name accessor.

Returns

The function name.

void glbinding::AbstractFunction::resolveAddress

(

)

Lookup the function pointer and stores it in the current state.

bool glbinding::AbstractFunction::isResolved

(

)

const

Check for a valid function pointer in the current state.

Returns

true iff a valid function pointer is stored in the current state.

ProcAddress glbinding::AbstractFunction::address

(

)

const

Function pointer accessor.

Returns

The function pointer.

Referenced by glbinding::Function< ReturnType, Arguments >::call().

CallbackMask glbinding::AbstractFunction::callbackMask

(

)

const

Callback mask accessor.

Returns

Returns the currently configured callback mask for the current state.

void glbinding::AbstractFunction::setCallbackMask

(

CallbackMask

mask

)

Reconfigures the callback mask for the current state.

Parameters

[in]

mask

The new callback mask.

void glbinding::AbstractFunction::addCallbackMask

(

CallbackMask

mask

)

Reconfigures the callback mask for the current state in means of a bit-wise 'or' operation with the current callback mask.

Parameters

[in]

mask

The callback mask to include.

void glbinding::AbstractFunction::removeCallbackMask

(

CallbackMask

mask

)

Reconfigures the callback mask for the current state in means of a bit-wise 'clear' operation of the current callback mask.

Parameters

[in]

mask

The callback mask to exclude.

bool glbinding::AbstractFunction::isEnabled

(

CallbackMask

mask

)

const

Check if all bits of the parameter are set in the currently configured callback mask of the current state.

Parameters

[in]

mask

The mask to check against.

Returns

true iff all bits are set.

Referenced by glbinding::Function< ReturnType, Arguments >::call().

bool glbinding::AbstractFunction::isAnyEnabled

(

CallbackMask

mask

)

const

Check if any bit of the parameter is set in the currently configured callback mask of the current state.

Parameters

[in]

mask

The mask to check against.

Returns

true iff at least one bit is set.

Referenced by glbinding::Function< ReturnType, Arguments >::call().

void glbinding::AbstractFunction::unresolved

(

)

const

Triggers a call of the unresolved callback.

Referenced by glbinding::Function< ReturnType, Arguments >::call().

void glbinding::AbstractFunction::before

(

const FunctionCall &

call

)

const

Triggers a call of the before callback, passing the parameters.

Parameters

[in]

call

The parameters of the current function call.

void glbinding::AbstractFunction::after

(

const FunctionCall &

call

)

const

Triggers a call of the after callback, passing the parameters and return value.

Parameters

[in]

call

The parameters and the return value of the current function call.

bool glbinding::AbstractFunction::hasState ( ) const

protected

Checks for existance of the current configured state.

Returns

true iff the current state still exists.

This method is usually used to detect invalid state clean up.

bool glbinding::AbstractFunction::hasState ( int  pos ) const

protected

Checks for existance of a state.

Parameters

[in]

pos

The index of the state to check.

Returns

true iff the state exists.

State& glbinding::AbstractFunction::state ( ) const

protected

Current state accessor.

Returns

The current state

State& glbinding::AbstractFunction::state ( int  pos ) const

protected

State accessor.

Parameters

[in]

pos

The index of the state

Returns

The state

static void glbinding::AbstractFunction::provideState ( int  pos )

staticprotected

Extend the function states to include the state identified through pos.

Parameters

pos	The index of the state to provide.

static void glbinding::AbstractFunction::neglectState ( int  pos )

staticprotected

Reconfigures the states so that the state identified through pos is neglected.

Parameters

pos	The index of the state to neglect.

static void glbinding::AbstractFunction::setStatePos ( int  pos )

staticprotected

Updates the currently used state.

Parameters

pos	The index of the new state.

Friends And Related Function Documentation

friend class Binding

friend

For state configuration.

Member Data Documentation

const char* glbinding::AbstractFunction::m_name

protected

The OpenGL API function name, including the 'gl' prefix.

std::vector<State> glbinding::AbstractFunction::m_states

mutableprotected

The list of all states.

int glbinding::AbstractFunction::s_maxpos

staticprotected

The global maximum of states per function.

---

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

• AbstractFunction.h