osg::GraphicsContext Class Reference

Base class for providing Windowing API agnostic access to creating and managing graphics context. More...

Inheritance diagram for osg::GraphicsContext:

[legend]List of all members.


Public Types
typedef std::list< ref_ptr< Operation > >	OperationQueue
typedef std::list< osg::Camera * >	Cameras
Public Member Functions
void	add (Operation *operation)
	Add operation to end of OperationQueue.
void	remove (Operation *operation)
	Remove operation from OperationQueue.
void	remove (const std::string &name)
	Remove named operation from OperationQueue.
void	removeAllOperations ()
	Remove all operations from OperationQueue.
void	runOperations ()
	Run the operations.
OperationQueue &	getOperationsQueue ()
	Get the operations queue, not you must use the OperationsMutex when accessing the queue.
OpenThreads::Mutex *	getOperationsMutex ()
	Get the operations queue mutex.
osg::RefBlock *	getOperationsBlock ()
	Get the operations queue block used to mark an empty queue, if you end items into the empty queu you must release this block.
Operation *	getCurrentOperation ()
	Get the current operations that is being run.
const Traits *	getTraits () const
	Get the traits of the GraphicsContext.
virtual bool	valid () const =0
	Return whether a valid and usable GraphicsContext has been created.
void	setState (State *state)
	Set the State object which tracks the current OpenGL state for this graphics context.
State *	getState ()
	Get the State object which tracks the current OpenGL state for this graphics context.
const State *	getState () const
	Get the const State object which tracks the current OpenGL state for this graphics context.
void	setClearColor (const Vec4 &color)
	Sets the clear color.
const Vec4 &	getClearColor () const
	Returns the clear color.
void	setClearMask (GLbitfield mask)
	Set the clear mask used in glClear(.
GLbitfield	getClearMask () const
	Get the clear mask.
virtual void	clear ()
	Do an OpenGL clear of the full graphics context/window.
bool	realize ()
	Realise the GraphicsContext.
void	close (bool callCloseImplementation=true)
	close the graphics context.
void	swapBuffers ()
	swap the front and back buffers.
bool	isRealized () const
	Return true if the graphics context has been realised and is ready to use.
bool	makeCurrent ()
	Make this graphics context current.
bool	makeContextCurrent (GraphicsContext *readContext)
	Make this graphics context current with specified read context.
bool	releaseContext ()
	Release the graphics context.
bool	isCurrent () const
	Return true if the current thread has this OpenGL graphics context.
void	bindPBufferToTexture (GLenum buffer)
	Bind the graphics context to associated texture.
void	createGraphicsThread ()
	Create a graphics thread to the graphics context, so that the thread handles all OpenGL operations.
void	setGraphicsThread (OperationsThread *gt)
	Assign a graphics thread to the graphics context, so that the thread handles all OpenGL operations.
OperationsThread *	getGraphicsThread ()
	Get the graphics thread assigned the graphics context.
const OperationsThread *	getGraphicsThread () const
	Get the const graphics thread assigned the graphics context.
virtual bool	realizeImplementation ()=0
	Realise the GraphicsContext implementation, Pure virtual - must be implemented by concrate implementations of GraphicsContext.
virtual bool	isRealizedImplementation () const =0
	Return true if the graphics context has been realised, and is ready to use, implementation.
virtual void	closeImplementation ()=0
	Close the graphics context implementation.
virtual bool	makeCurrentImplementation ()=0
	Make this graphics context current implementation.
virtual bool	makeContextCurrentImplementation (GraphicsContext *readContext)=0
	Make this graphics context current with specified read context implementation.
virtual bool	releaseContextImplementation ()=0
	Release the graphics context implementation.
virtual void	bindPBufferToTextureImplementation (GLenum buffer)=0
	Pure virtual, Bind the graphics context to associated texture implementation.
virtual void	swapBuffersImplementation ()=0
	Swap the front and back buffers implementation.
void	resized (int x, int y, int width, int height)
	resized method should be called when the underlying window has been resized and the GraphicsWindow and associated Cameras must be updated to keep in sync with the new size.
void	setResizedCallback (ResizedCallback *rc)
	Set the resized callback which overrides the GraphicsConext::realizedImplementation(), allow developers to provide custom behavior in response to a window being resized.
ResizedCallback *	getResizedCallback ()
	Get the resized callback which overrides the GraphicsConext::realizedImplementation().
const ResizedCallback *	getResizedCallback () const
	Get the const resized callback which overrides the GraphicsConext::realizedImplementation().
virtual void	resizedImplementation (int x, int y, int width, int height)
	resized implementation, by default resizes the viewports and aspect ratios the cameras associated with the graphics Window.
Cameras &	getCameras ()
	Get the the list of cameras associated with this graphics context.
const Cameras &	getCameras () const
	Get the the const list of cameras associated with this graphics context.
virtual bool	isSameKindAs (const Object *object) const
virtual const char *	libraryName () const
	return the name of the object's library.
virtual const char *	className () const
	return the name of the object's class type.
Static Public Member Functions
static void	setWindowingSystemInterface (WindowingSystemInterface *wsInterface)
	Set the querry the windowing system for screens and create graphics context - this functor should be supplied by the windows toolkit.
static WindowingSystemInterface *	getWindowingSystemInterface ()
	Get the WindowingSystemInterface.
static GraphicsContext *	createGraphicsContext (Traits *traits)
	Create a graphics context for a specified set of traits.
static unsigned int	createNewContextID ()
	Create a contextID for a new graphics context, this contextID is used to set up the osg::State associate with context.
static void	incrementContextIDUsageCount (unsigned int contextID)
	Increment the usage count associate with a contextID.
static void	decrementContextIDUsageCount (unsigned int contextID)
	Decrement the usage count associate with a contextID.
Protected Member Functions
	GraphicsContext ()
	GraphicsContext (const GraphicsContext &, const osg::CopyOp &)
virtual	~GraphicsContext ()
virtual Object *	cloneType () const
	Clone the type of an object, with Object* return type.
virtual Object *	clone (const CopyOp &) const
	Clone an object, with Object* return type.
void	addCamera (osg::Camera *camera)
void	removeCamera (osg::Camera *camera)
Protected Attributes
Cameras	_cameras
ref_ptr< Traits >	_traits
ref_ptr< State >	_state
Vec4	_clearColor
GLbitfield	_clearMask
OpenThreads::Thread *	_threadOfLastMakeCurrent
OpenThreads::Mutex	_operationsMutex
osg::ref_ptr< osg::RefBlock >	_operationsBlock
OperationQueue	_operations
osg::ref_ptr< Operation >	_currentOperation
ref_ptr< OperationsThread >	_graphicsThread
ref_ptr< ResizedCallback >	_resizedCallback
Friends
class	osg::Camera
Classes
struct	ResizedCallback
struct	ScreenIdentifier
struct	Traits
	GraphicsContext Traits object provides the specification of what type of graphics context is required. More...
struct	WindowingSystemInterface
	Callback to be implemented to provide access to Windowing API's ability to create Windows/pbuffers. More...

Detailed Description

Base class for providing Windowing API agnostic access to creating and managing graphics context.

Member Typedef Documentation

typedef std::list< osg::Camera* > osg::GraphicsContext::Cameras

typedef std::list< ref_ptr<Operation> > osg::GraphicsContext::OperationQueue

Constructor & Destructor Documentation

osg::GraphicsContext::GraphicsContext ( ) [protected]

osg::GraphicsContext::GraphicsContext ( const GraphicsContext & ,

const osg::CopyOp &

) [protected]

virtual osg::GraphicsContext::~GraphicsContext ( ) [protected, virtual]

Member Function Documentation

void osg::GraphicsContext::add ( Operation * operation )

Add operation to end of OperationQueue.

void osg::GraphicsContext::addCamera ( osg::Camera * camera ) [protected]

void osg::GraphicsContext::bindPBufferToTexture ( GLenum buffer ) [inline]

Bind the graphics context to associated texture.

virtual void osg::GraphicsContext::bindPBufferToTextureImplementation ( GLenum buffer ) [pure virtual]

Pure virtual, Bind the graphics context to associated texture implementation.
Pure virtual - must be implemented by concrate implementations of GraphicsContext.
Implemented in osgViewer::GraphicsWindow.

virtual const char* osg::GraphicsContext::className ( ) const [inline, virtual]

return the name of the object's class type.
Must be defined by derived classes.
Implements osg::Object.
Reimplemented in osgViewer::GraphicsWindowWin32, osgViewer::GraphicsWindowX11, osgViewer::GraphicsWindow, and osgViewer::GraphicsWindowEmbedded.

virtual void osg::GraphicsContext::clear ( ) [virtual]

Do an OpenGL clear of the full graphics context/window.
Note, must only be called from a thread with this context current.

virtual Object* osg::GraphicsContext::clone ( const CopyOp & ) const [inline, protected, virtual]

Clone an object, with Object* return type.
Must be defined by derived classes.
Implements osg::Object.

virtual Object* osg::GraphicsContext::cloneType ( ) const [inline, protected, virtual]

Clone the type of an object, with Object* return type.
Must be defined by derived classes.
Implements osg::Object.

void osg::GraphicsContext::close ( bool callCloseImplementation = true )

close the graphics context.
close(bool) stops any associated graphics threads, releases the contextID for the GraphicsContext then optional calls closeImplementation() to do the actual deletion of the graphics. This call is made optional as there are times when the graphics context has already been deleted externally and only the OSG side of the its data need to be closed down.

virtual void osg::GraphicsContext::closeImplementation ( ) [pure virtual]

Close the graphics context implementation.
Pure virtual - must be implemented by concrate implementations of GraphicsContext.
Implemented in osgViewer::GraphicsWindowWin32, osgViewer::GraphicsWindowX11, osgViewer::GraphicsWindow, and osgViewer::GraphicsWindowEmbedded.

static GraphicsContext* osg::GraphicsContext::createGraphicsContext ( Traits * traits ) [static]

Create a graphics context for a specified set of traits.

void osg::GraphicsContext::createGraphicsThread ( )

Create a graphics thread to the graphics context, so that the thread handles all OpenGL operations.

static unsigned int osg::GraphicsContext::createNewContextID ( ) [static]

Create a contextID for a new graphics context, this contextID is used to set up the osg::State associate with context.
Automatically increments the usage count of the contextID to 1.

static void osg::GraphicsContext::decrementContextIDUsageCount ( unsigned int contextID ) [static]

Decrement the usage count associate with a contextID.
Once the contextID goes to 0 the contextID is then free to be reused.

const Cameras& osg::GraphicsContext::getCameras ( ) const [inline]

Get the the const list of cameras associated with this graphics context.

Cameras& osg::GraphicsContext::getCameras ( ) [inline]

Get the the list of cameras associated with this graphics context.

const Vec4& osg::GraphicsContext::getClearColor ( ) const [inline]

Returns the clear color.

GLbitfield osg::GraphicsContext::getClearMask ( ) const [inline]

Get the clear mask.

Operation* osg::GraphicsContext::getCurrentOperation ( ) [inline]

Get the current operations that is being run.

const OperationsThread* osg::GraphicsContext::getGraphicsThread ( ) const [inline]

Get the const graphics thread assigned the graphics context.

OperationsThread* osg::GraphicsContext::getGraphicsThread ( ) [inline]

Get the graphics thread assigned the graphics context.

osg::RefBlock* osg::GraphicsContext::getOperationsBlock ( ) [inline]

Get the operations queue block used to mark an empty queue, if you end items into the empty queu you must release this block.

OpenThreads::Mutex* osg::GraphicsContext::getOperationsMutex ( ) [inline]

Get the operations queue mutex.

OperationQueue& osg::GraphicsContext::getOperationsQueue ( ) [inline]

Get the operations queue, not you must use the OperationsMutex when accessing the queue.

const ResizedCallback* osg::GraphicsContext::getResizedCallback ( ) const [inline]

Get the const resized callback which overrides the GraphicsConext::realizedImplementation().

ResizedCallback* osg::GraphicsContext::getResizedCallback ( ) [inline]

Get the resized callback which overrides the GraphicsConext::realizedImplementation().

const State* osg::GraphicsContext::getState ( ) const [inline]

Get the const State object which tracks the current OpenGL state for this graphics context.

State* osg::GraphicsContext::getState ( ) [inline]

Get the State object which tracks the current OpenGL state for this graphics context.

const Traits* osg::GraphicsContext::getTraits ( ) const [inline]

Get the traits of the GraphicsContext.

static WindowingSystemInterface* osg::GraphicsContext::getWindowingSystemInterface ( ) [static]

Get the WindowingSystemInterface.

static void osg::GraphicsContext::incrementContextIDUsageCount ( unsigned int contextID ) [static]

Increment the usage count associate with a contextID.
The usage count speficies how many graphics contexts a specific contextID is shared between.

bool osg::GraphicsContext::isCurrent ( ) const [inline]

Return true if the current thread has this OpenGL graphics context.

bool osg::GraphicsContext::isRealized ( ) const [inline]

Return true if the graphics context has been realised and is ready to use.

virtual bool osg::GraphicsContext::isRealizedImplementation ( ) const [pure virtual]

Return true if the graphics context has been realised, and is ready to use, implementation.
Pure virtual - must be implemented by concrate implementations of GraphicsContext.
Implemented in osgViewer::GraphicsWindowWin32, osgViewer::GraphicsWindowX11, osgViewer::GraphicsWindow, and osgViewer::GraphicsWindowEmbedded.

virtual bool osg::GraphicsContext::isSameKindAs ( const Object * object ) const [inline, virtual]

Reimplemented from osg::Object.

virtual const char* osg::GraphicsContext::libraryName ( ) const [inline, virtual]

return the name of the object's library.
Must be defined by derived classes. The OpenSceneGraph convention is that the namespace of a library is the same as the library name.
Implements osg::Object.
Reimplemented in osgViewer::GraphicsWindowWin32, osgViewer::GraphicsWindowX11, osgViewer::GraphicsWindow, and osgViewer::GraphicsWindowEmbedded.

bool osg::GraphicsContext::makeContextCurrent ( GraphicsContext * readContext )

Make this graphics context current with specified read context.
Implementated by calling makeContextCurrentImplementation(). Returns true on success.

virtual bool osg::GraphicsContext::makeContextCurrentImplementation ( GraphicsContext * readContext ) [pure virtual]

Make this graphics context current with specified read context implementation.
Pure virtual - must be implemented by concrate implementations of GraphicsContext.

bool osg::GraphicsContext::makeCurrent ( )

Make this graphics context current.
Implementated by calling makeCurrentImplementation(). Returns true on success.

virtual bool osg::GraphicsContext::makeCurrentImplementation ( ) [pure virtual]

Make this graphics context current implementation.
Pure virtual - must be implemented by concrate implementations of GraphicsContext.
Implemented in osgViewer::GraphicsWindowWin32, osgViewer::GraphicsWindowX11, osgViewer::GraphicsWindow, and osgViewer::GraphicsWindowEmbedded.

bool osg::GraphicsContext::realize ( )

Realise the GraphicsContext.

virtual bool osg::GraphicsContext::realizeImplementation ( ) [pure virtual]

Realise the GraphicsContext implementation, Pure virtual - must be implemented by concrate implementations of GraphicsContext.

Implemented in osgViewer::GraphicsWindowWin32, osgViewer::GraphicsWindowX11, osgViewer::GraphicsWindow, and osgViewer::GraphicsWindowEmbedded.

bool osg::GraphicsContext::releaseContext ( )

Release the graphics context.
Returns true on success.

virtual bool osg::GraphicsContext::releaseContextImplementation ( ) [pure virtual]

Release the graphics context implementation.

Implemented in osgViewer::GraphicsWindowWin32, osgViewer::GraphicsWindowX11, osgViewer::GraphicsWindow, and osgViewer::GraphicsWindowEmbedded.

void osg::GraphicsContext::remove ( const std::string & name )

Remove named operation from OperationQueue.

void osg::GraphicsContext::remove ( Operation * operation )

Remove operation from OperationQueue.

void osg::GraphicsContext::removeAllOperations ( )

Remove all operations from OperationQueue.

void osg::GraphicsContext::removeCamera ( osg::Camera * camera ) [protected]

void osg::GraphicsContext::resized ( int x,

int y,

int width,

int height

) [inline]

resized method should be called when the underlying window has been resized and the GraphicsWindow and associated Cameras must be updated to keep in sync with the new size.

virtual void osg::GraphicsContext::resizedImplementation ( int x,

int y,

int width,

int height

) [virtual]

resized implementation, by default resizes the viewports and aspect ratios the cameras associated with the graphics Window.

void osg::GraphicsContext::runOperations ( )

Run the operations.

void osg::GraphicsContext::setClearColor ( const Vec4 & color ) [inline]

Sets the clear color.

void osg::GraphicsContext::setClearMask ( GLbitfield mask ) [inline]

Set the clear mask used in glClear(.
.). Defaults to GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT.

void osg::GraphicsContext::setGraphicsThread ( OperationsThread * gt )

Assign a graphics thread to the graphics context, so that the thread handles all OpenGL operations.

void osg::GraphicsContext::setResizedCallback ( ResizedCallback * rc ) [inline]

Set the resized callback which overrides the GraphicsConext::realizedImplementation(), allow developers to provide custom behavior in response to a window being resized.

void osg::GraphicsContext::setState ( State * state ) [inline]

Set the State object which tracks the current OpenGL state for this graphics context.

static void osg::GraphicsContext::setWindowingSystemInterface ( WindowingSystemInterface * wsInterface ) [static]

Set the querry the windowing system for screens and create graphics context - this functor should be supplied by the windows toolkit.

void osg::GraphicsContext::swapBuffers ( )

swap the front and back buffers.

virtual void osg::GraphicsContext::swapBuffersImplementation ( ) [pure virtual]

Swap the front and back buffers implementation.
Pure virtual - must be implemented by Concrate implementations of GraphicsContext.
Implemented in osgViewer::GraphicsWindowWin32, osgViewer::GraphicsWindowX11, osgViewer::GraphicsWindow, and osgViewer::GraphicsWindowEmbedded.