osg::Program::ProgramBinary Class Reference

#include <Program.h>

Inheritance diagram for osg::Program::ProgramBinary:

Collaboration diagram for osg::Program::ProgramBinary:

Public Member Functions
	ProgramBinary ()
	ProgramBinary (const ProgramBinary &rhs, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	META_Object (osg, ProgramBinary)
void	assign (unsigned int size, const unsigned char *data)
void	setFormat (GLenum format)
GLenum	getFormat () const
unsigned int	getSize () const
unsigned char *	getData ()
const unsigned char *	getData () const
Public Member Functions inherited from osg::Object
	Object ()
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual Object *	cloneType () const =0
virtual Object *	clone (const CopyOp &) const =0
virtual bool	isSameKindAs (const Object *) const
virtual const char *	libraryName () const =0
virtual const char *	className () const =0
std::string	getCompoundClassName () const
virtual Node *	asNode ()
virtual const Node *	asNode () const
virtual NodeVisitor *	asNodeVisitor ()
virtual const NodeVisitor *	asNodeVisitor () const
virtual StateAttribute *	asStateAttribute ()
virtual const StateAttribute *	asStateAttribute () const
virtual Uniform *	asUniform ()
virtual const Uniform *	asUniform () const
virtual void	setThreadSafeRefUnref (bool threadSafe)
virtual void	setName (const std::string &name)
void	setName (const char *name)
const std::string &	getName () const
void	setDataVariance (DataVariance dv)
DataVariance	getDataVariance () const
virtual void	computeDataVariance ()
void	setUserDataContainer (osg::UserDataContainer *udc)
osg::UserDataContainer *	getUserDataContainer ()
const osg::UserDataContainer *	getUserDataContainer () const
osg::UserDataContainer *	getOrCreateUserDataContainer ()
virtual void	setUserData (Referenced *obj)
virtual Referenced *	getUserData ()
virtual const Referenced *	getUserData () const
template<typename T >
bool	getUserValue (const std::string &name, T &value) const
template<typename T >
void	setUserValue (const std::string &name, const T &value)
virtual void	resizeGLObjectBuffers (unsigned int)
virtual void	releaseGLObjects (osg::State *=0) const
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
OpenThreads::Mutex *	getRefMutex () const
int	ref () const
int	unref () const
int	unref_nodelete () const
int	referenceCount () const
ObserverSet *	getObserverSet () const
ObserverSet *	getOrCreateObserverSet () const
void	addObserver (Observer *observer) const
void	removeObserver (Observer *observer) const

Protected Attributes
std::vector< unsigned char >	_data
GLenum	_format
Protected Attributes inherited from osg::Object
std::string	_name
DataVariance	_dataVariance
osg::UserDataContainer *	_userDataContainer
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr	_observerSet
OpenThreads::Atomic	_refCount

Additional Inherited Members
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool	getThreadSafeReferenceCounting ()
static void	setDeleteHandler (DeleteHandler *handler)
static DeleteHandler *	getDeleteHandler ()
Protected Member Functions inherited from osg::Object
virtual	~Object ()
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const

Detailed Description

Simple class for wrapping up the data used in glProgramBinary and glGetProgramBinary. On the first run of your application Programs should be assigned an empty ProgramBinary. Before your application exits it should retrieve the program binary via Program::PerContextProgram::compileProgramBinary and save it to disk. When your application is run subsequently, load your binary from disk and use it to set the data of a ProgramBinary, and set the ProgramBinary on the associated Program. This will typically result in Program::compileGLObjects executing much faster.

Definition at line 168 of file Program.h.

Constructor & Destructor Documentation

osg::Program::ProgramBinary::ProgramBinary

(

)

osg::Program::ProgramBinary::ProgramBinary	(	const ProgramBinary &	rhs,
		const osg::CopyOp &	copyop = osg::CopyOp::SHALLOW_COPY
	)

Copy constructor using CopyOp to manage deep vs shallow copy.

Member Function Documentation

void osg::Program::ProgramBinary::assign	(	unsigned int	size,
		const unsigned char *	data
	)

Allocated a data buffer of specified size/*/ void allocate(unsigned int size);

/** Assign program binary data, copying the specified data into locally stored data buffer, the original data can then be deleted.

unsigned char* osg::Program::ProgramBinary::getData ( )

inline

Get a ptr to the program binary data.

Definition at line 195 of file Program.h.

const unsigned char* osg::Program::ProgramBinary::getData ( ) const

inline

Get a const ptr to the program binary data.

Definition at line 198 of file Program.h.

GLenum osg::Program::ProgramBinary::getFormat ( ) const

inline

Get the format of the program binary data.

Definition at line 189 of file Program.h.

unsigned int osg::Program::ProgramBinary::getSize ( ) const

inline

Get the size of the program binary data.

Definition at line 192 of file Program.h.

osg::Program::ProgramBinary::META_Object	(	osg	,
		ProgramBinary
	)

void osg::Program::ProgramBinary::setFormat ( GLenum  format )

inline

Set the format of the program binary data.

Definition at line 186 of file Program.h.

Member Data Documentation

std::vector<unsigned char> osg::Program::ProgramBinary::_data

protected

Definition at line 201 of file Program.h.

GLenum osg::Program::ProgramBinary::_format

protected

Definition at line 202 of file Program.h.

---

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

• osg_head/include/osg/Program.h