osg::VertexProgram Class Reference

Inheritance diagram for osg::VertexProgram:

List of all members.

Public Types
typedef std::map< GLuint, Vec4 >	LocalParamList
typedef std::map< GLenum, Matrix >	MatrixList
Public Member Functions
	VertexProgram ()
	VertexProgram (const VertexProgram &vp, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	META_StateAttribute (osg, VertexProgram, VERTEXPROGRAM)
virtual int	compare (const osg::StateAttribute &sa) const
virtual bool	getModeUsage (ModeUsage &usage) const
GLuint &	getVertexProgramID (unsigned int contextID) const
void	setVertexProgram (const char *program)
void	setVertexProgram (const std::string &program)
const std::string &	getVertexProgram () const
void	setProgramLocalParameter (const GLuint index, const Vec4 &p)
void	setLocalParameters (const LocalParamList &lpl)
LocalParamList &	getLocalParameters ()
const LocalParamList &	getLocalParameters () const
void	setMatrix (const GLenum mode, const Matrix &matrix)
void	setMatrices (const MatrixList &matrices)
MatrixList &	getMatrices ()
const MatrixList &	getMatrices () const
void	dirtyVertexProgramObject ()
virtual void	apply (State &state) const
virtual void	compileGLObjects (State &state) const
virtual void	releaseGLObjects (State *state=0) const
Static Public Member Functions
static void	deleteVertexProgramObject (unsigned int contextID, GLuint handle)
static void	flushDeletedVertexProgramObjects (unsigned int contextID, double currentTime, double &availableTime)
static Extensions *	getExtensions (unsigned int contextID, bool createIfNotInitalized)
static void	setExtensions (unsigned int contextID, Extensions *extensions)
Protected Types
typedef buffered_value< GLuint >	VertexProgramIDList
Protected Member Functions
virtual	~VertexProgram ()
Protected Attributes
VertexProgramIDList	_vertexProgramIDList
std::string	_vertexProgram
LocalParamList	_programLocalParameters
MatrixList	_matrixList
Classes
class	Extensions

---

Detailed Description

VertexProgram - encapsulates the OpenGL ARB vertex program state.

---

Member Typedef Documentation

typedef std::map<GLuint,Vec4> osg::VertexProgram::LocalParamList

typedef std::map<GLenum,Matrix> osg::VertexProgram::MatrixList

typedef buffered_value<GLuint> osg::VertexProgram::VertexProgramIDList [protected]

---

Constructor & Destructor Documentation

osg::VertexProgram::VertexProgram

(

)

osg::VertexProgram::VertexProgram	(	const VertexProgram &	vp,
		const CopyOp &	copyop = CopyOp::SHALLOW_COPY
	)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::VertexProgram::~VertexProgram

(

)

[protected, virtual]

---

Member Function Documentation

virtual void osg::VertexProgram::apply

(

State &

state

)

const [virtual]

apply the OpenGL state attributes. The global state for the current OpenGL context is passed in to allow the StateAttribute to obtain details on the the current context and state.

Implements osg::StateAttribute.

virtual int osg::VertexProgram::compare

(

const osg::StateAttribute &

sa

)

const [inline, virtual]

Return -1 if *this < *rhs, 0 if *this==*rhs, 1 if *this>*rhs.

Implements osg::StateAttribute.

virtual void osg::VertexProgram::compileGLObjects

(

State &

state

)

const [inline, virtual]

default to nothing to compile - all state is applied immediately.

Reimplemented from osg::StateAttribute.

static void osg::VertexProgram::deleteVertexProgramObject	(	unsigned int	contextID,
		GLuint	handle
	)			[static]

Use deleteVertexProgramObject instead of glDeletePrograms to allow OpenGL Vertex Program objects to cached until they can be deleted by the OpenGL context in which they were created, specified by contextID.

void osg::VertexProgram::dirtyVertexProgramObject

(

)

Force a recompile on next apply() of associated OpenGL vertex program objects.

static void osg::VertexProgram::flushDeletedVertexProgramObjects	(	unsigned int	contextID,
		double	currentTime,
		double &	availableTime
	)			[static]

Flush all the cached vertex programs which need to be deleted in the OpenGL context related to contextID.

static Extensions* osg::VertexProgram::getExtensions	(	unsigned int	contextID,
		bool	createIfNotInitalized
	)			[static]

Function to call to get the extension of a specified context. If the Exentsion object for that context has not yet been created and the 'createIfNotInitalized' flag been set to false then returns NULL. If 'createIfNotInitalized' is true then the Extensions object is automatically created. However, in this case the extension object will only be created with the graphics context associated with ContextID.

const LocalParamList& osg::VertexProgram::getLocalParameters

(

)

const [inline]

Get const list of Program Parameters

LocalParamList& osg::VertexProgram::getLocalParameters

(

)

[inline]

Get list of Program Parameters

const MatrixList& osg::VertexProgram::getMatrices

(

)

const [inline]

Get list of Matrices

MatrixList& osg::VertexProgram::getMatrices

(

)

[inline]

Get list of Matrices

virtual bool osg::VertexProgram::getModeUsage

(

ModeUsage &

usage

)

const [inline, virtual]

const std::string& osg::VertexProgram::getVertexProgram

(

)

const [inline]

Get the vertex program.

GLuint& osg::VertexProgram::getVertexProgramID

(

unsigned int

contextID

)

const [inline]

Get the handle to the vertex program ID for the current context.

osg::VertexProgram::META_StateAttribute	(	osg	,
		VertexProgram	,
		VERTEXPROGRAM
	)

virtual void osg::VertexProgram::releaseGLObjects

(

State *

state = 0

)

const [virtual]

Release any OpenGL objects in specified graphics context if State object is passed, otherwise release OpenGL objexts for all graphics contexts if State object pointer is NULL.

Reimplemented from osg::StateAttribute.

static void osg::VertexProgram::setExtensions	(	unsigned int	contextID,
		Extensions *	extensions
	)			[static]

The setExtensions method allows users to override the extensions across graphics contexts. Typically used when you have different extensions supported across graphics pipes but need to ensure that they all use the same low common denominator extensions.

void osg::VertexProgram::setLocalParameters

(

const LocalParamList &

lpl

)

[inline]

Set list of Program Parameters

void osg::VertexProgram::setMatrices

(

const MatrixList &

matrices

)

[inline]

Set list of Matrices

void osg::VertexProgram::setMatrix	(	const GLenum	mode,
		const Matrix &	matrix
	)			[inline]

Matrix

void osg::VertexProgram::setProgramLocalParameter	(	const GLuint	index,
		const Vec4 &	p
	)			[inline]

Set Program Parameters

void osg::VertexProgram::setVertexProgram

(

const std::string &

program

)

[inline]

Set the vertex program using C++ style string.

void osg::VertexProgram::setVertexProgram

(

const char *

program

)

[inline]

Set the vertex program using a C style string.

---

Member Data Documentation

MatrixList osg::VertexProgram::_matrixList [protected]

LocalParamList osg::VertexProgram::_programLocalParameters [protected]

std::string osg::VertexProgram::_vertexProgram [protected]

VertexProgramIDList osg::VertexProgram::_vertexProgramIDList [mutable, protected]

---

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

• VertexProgram

---