osg::Program Class Reference

#include <Program.h>

Inheritance diagram for osg::Program:

Collaboration diagram for osg::Program:

Classes
struct	ActiveVarInfo
class	PerContextProgram
class	ProgramBinary
struct	ProgramObjects
struct	UniformBlockInfo

Public Types
typedef std::map< std::string, GLuint >	AttribBindingList
typedef std::map< std::string, GLuint >	FragDataBindingList
typedef std::map< std::string, GLuint >	UniformBlockBindingList
typedef std::map< unsigned int, ActiveVarInfo >	ActiveUniformMap
typedef std::map< std::string, ActiveVarInfo >	ActiveVarInfoMap
typedef std::map< std::string, UniformBlockInfo >	UniformBlockMap
Public Types inherited from osg::StateAttribute
enum	Values {   OFF = 0x0, ON = 0x1, OVERRIDE = 0x2, PROTECTED = 0x4,   INHERIT = 0x8 }
enum	Type {   TEXTURE, POLYGONMODE, POLYGONOFFSET, MATERIAL,   ALPHAFUNC, ANTIALIAS, COLORTABLE, CULLFACE,   FOG, FRONTFACE, LIGHT, POINT,   LINEWIDTH, LINESTIPPLE, POLYGONSTIPPLE, SHADEMODEL,   TEXENV, TEXENVFILTER, TEXGEN, TEXMAT,   LIGHTMODEL, BLENDFUNC, BLENDEQUATION, LOGICOP,   STENCIL, COLORMASK, DEPTH, VIEWPORT,   SCISSOR, BLENDCOLOR, MULTISAMPLE, CLIPPLANE,   COLORMATRIX, VERTEXPROGRAM, FRAGMENTPROGRAM, POINTSPRITE,   PROGRAM, CLAMPCOLOR, HINT, SAMPLEMASKI,   PRIMITIVERESTARTINDEX, CLIPCONTROL, VALIDATOR, VIEWMATRIXEXTRACTOR,   OSGNV_PARAMETER_BLOCK, OSGNVEXT_TEXTURE_SHADER, OSGNVEXT_VERTEX_PROGRAM, OSGNVEXT_REGISTER_COMBINERS,   OSGNVCG_PROGRAM, OSGNVSLANG_PROGRAM, OSGNVPARSE_PROGRAM_PARSER, UNIFORMBUFFERBINDING,   TRANSFORMFEEDBACKBUFFERBINDING, ATOMICCOUNTERBUFFERBINDING, PATCH_PARAMETER, FRAME_BUFFER_OBJECT,   VERTEX_ATTRIB_DIVISOR, SHADERSTORAGEBUFFERBINDING, CAPABILITY = 100 }
typedef GLenum	GLMode
typedef unsigned int	GLModeValue
typedef unsigned int	OverrideValue
typedef std::pair< Type, unsigned int >	TypeMemberPair
typedef std::vector< StateSet * >	ParentList
typedef osg::StateAttributeCallback	Callback
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions
	Program ()
	Program (const Program &rhs, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	META_StateAttribute (osg, Program, PROGRAM)
virtual int	compare (const osg::StateAttribute &sa) const
virtual void	apply (osg::State &state) const
virtual void	setThreadSafeRefUnref (bool threadSafe)
virtual void	compileGLObjects (osg::State &state) const
virtual void	resizeGLObjectBuffers (unsigned int maxSize)
virtual void	releaseGLObjects (osg::State *state=0) const
void	dirtyProgram ()
bool	addShader (Shader *shader)
unsigned int	getNumShaders () const
Shader *	getShader (unsigned int i)
const Shader *	getShader (unsigned int i) const
bool	removeShader (Shader *shader)
void	setParameter (GLenum pname, GLint value)
GLint	getParameter (GLenum pname) const
void	setComputeGroups (GLint numGroupsX, GLint numGroupsY, GLint numGroupsZ)
void	getComputeGroups (GLint &numGroupsX, GLint &numGroupsY, GLint &numGroupsZ) const
void	addBindAttribLocation (const std::string &name, GLuint index)
void	removeBindAttribLocation (const std::string &name)
void	addBindFragDataLocation (const std::string &name, GLuint index)
void	removeBindFragDataLocation (const std::string &name)
void	addBindUniformBlock (const std::string &name, GLuint index)
void	removeBindUniformBlock (const std::string &name)
void	removeTransformFeedBackVarying (const std::string &name)
void	addTransformFeedBackVarying (const std::string &outname)
unsigned int	getNumTransformFeedBackVaryings () const
const std::string &	getTransformFeedBackVarying (unsigned int i) const
void	setTransformFeedBackMode (GLenum e)
GLenum	getTransformFeedBackMode () const
void	setShaderDefines (const ShaderDefines &shaderDefs)
ShaderDefines &	getShaderDefines ()
const ShaderDefines &	getShaderDefines () const
void	setProgramBinary (ProgramBinary *programBinary)
ProgramBinary *	getProgramBinary ()
const ProgramBinary *	getProgramBinary () const
const AttribBindingList &	getAttribBindingList () const
const FragDataBindingList &	getFragDataBindingList () const
const UniformBlockBindingList &	getUniformBlockBindingList () const
bool	isFixedFunction () const
bool	getGlProgramInfoLog (unsigned int contextID, std::string &log) const
PerContextProgram *	getPCP (State &state) const
Public Member Functions inherited from osg::StateAttribute
	StateAttribute ()
	StateAttribute (const StateAttribute &sa, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual Object *	cloneType () const =0
virtual Object *	clone (const CopyOp &) const =0
virtual bool	isSameKindAs (const Object *obj) const
virtual const char *	libraryName () const
virtual const char *	className () const
virtual StateAttribute *	asStateAttribute ()
virtual const StateAttribute *	asStateAttribute () const
virtual Texture *	asTexture ()
virtual const Texture *	asTexture () const
virtual Type	getType () const =0
virtual unsigned int	getMember () const
TypeMemberPair	getTypeMemberPair () const
virtual bool	isTextureAttribute () const
bool	operator< (const StateAttribute &rhs) const
bool	operator== (const StateAttribute &rhs) const
bool	operator!= (const StateAttribute &rhs) const
const ParentList &	getParents () const
StateSet *	getParent (unsigned int i)
const StateSet *	getParent (unsigned int i) const
unsigned int	getNumParents () const
void	setShaderComponent (ShaderComponent *sc)
ShaderComponent *	getShaderComponent ()
const ShaderComponent *	getShaderComponent () const
virtual bool	getModeUsage (ModeUsage &) const
virtual bool	checkValidityOfAssociatedModes (osg::State &) const
void	setUpdateCallback (StateAttributeCallback *uc)
StateAttributeCallback *	getUpdateCallback ()
const StateAttributeCallback *	getUpdateCallback () const
void	setEventCallback (StateAttributeCallback *ec)
StateAttributeCallback *	getEventCallback ()
const StateAttributeCallback *	getEventCallback () const
Public Member Functions inherited from osg::Object
	Object ()
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
std::string	getCompoundClassName () const
virtual Node *	asNode ()
virtual const Node *	asNode () const
virtual NodeVisitor *	asNodeVisitor ()
virtual const NodeVisitor *	asNodeVisitor () const
virtual Uniform *	asUniform ()
virtual const Uniform *	asUniform () const
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)
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

Static Public Member Functions
static void	deleteGlProgram (unsigned int contextID, GLuint program)
static void	flushDeletedGlPrograms (unsigned int contextID, double currentTime, double &availableTime)
static void	discardDeletedGlPrograms (unsigned int contextID)
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 Types
typedef std::vector< ref_ptr < Shader > >	ShaderList

Protected Member Functions
virtual	~Program ()
Protected Member Functions inherited from osg::StateAttribute
virtual	~StateAttribute ()
void	addParent (osg::StateSet *object)
void	removeParent (osg::StateSet *object)
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

Protected Attributes
osg::buffered_value < osg::ref_ptr< ProgramObjects > >	_pcpList
AttribBindingList	_attribBindingList
FragDataBindingList	_fragDataBindingList
UniformBlockBindingList	_uniformBlockBindingList
ShaderList	_shaderList
osg::ref_ptr< ProgramBinary >	_programBinary
GLint	_geometryVerticesOut
GLint	_geometryInputType
GLint	_geometryOutputType
GLint	_numGroupsX
GLint	_numGroupsY
GLint	_numGroupsZ
GLenum	_feedbackmode
std::vector< std::string >	_feedbackout
ShaderDefines	_shaderDefines
Protected Attributes inherited from osg::StateAttribute
ParentList	_parents
ref_ptr< ShaderComponent >	_shaderComponent
ref_ptr< StateAttributeCallback >	_updateCallback
ref_ptr< StateAttributeCallback >	_eventCallback
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

Friends
class	PerContextProgram

Detailed Description

osg::Program is an application-level abstraction of an OpenGL glProgram. It is an osg::StateAttribute that, when applied, will activate a glProgram for subsequent rendering. osg::Shaders containing the actual shader source code are attached to a Program, which will then manage the compilation, linking, and activation of the GLSL program. osg::Program will automatically manage per-context instancing of the OpenGL glPrograms, if that is necessary for a particular display configuration.

Definition at line 51 of file Program.h.

Member Typedef Documentation

typedef std::map< unsigned int, ActiveVarInfo > osg::Program::ActiveUniformMap

Definition at line 253 of file Program.h.

typedef std::map< std::string, ActiveVarInfo > osg::Program::ActiveVarInfoMap

Definition at line 254 of file Program.h.

typedef std::map<std::string,GLuint> osg::Program::AttribBindingList

Definition at line 217 of file Program.h.

typedef std::map<std::string,GLuint> osg::Program::FragDataBindingList

Definition at line 218 of file Program.h.

typedef std::vector< ref_ptr<Shader> > osg::Program::ShaderList

protected

Definition at line 443 of file Program.h.

typedef std::map<std::string,GLuint> osg::Program::UniformBlockBindingList

Definition at line 219 of file Program.h.

typedef std::map<std::string, UniformBlockInfo> osg::Program::UniformBlockMap

Definition at line 267 of file Program.h.

Constructor & Destructor Documentation

osg::Program::Program

(

)

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

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::Program::~Program ( )

protectedvirtual

Member Function Documentation

void osg::Program::addBindAttribLocation	(	const std::string &	name,
		GLuint	index
	)

Add an attribute location binding.

void osg::Program::addBindFragDataLocation	(	const std::string &	name,
		GLuint	index
	)

Add an frag data location binding. See EXT_gpu_shader4 for BindFragDataLocationEXT

void osg::Program::addBindUniformBlock	(	const std::string &	name,
		GLuint	index
	)

Add a uniform block binding to an index target. XXX This should not be an attribute of the program. It should be a pseudo-uniform that can live in StateSet objects because it is cheap to set.

bool osg::Program::addShader

(

Shader *

shader

)

Attach an osg::Shader to this osg::Program. Mark Program as needing relink. Return true for success

void osg::Program::addTransformFeedBackVarying ( const std::string &  outname )

inline

Add a TransformFeedBack Varying Name.

Definition at line 137 of file Program.h.

virtual void osg::Program::apply ( osg::State &  state ) const

virtual

If enabled, activate our program in the GL pipeline, performing any rebuild operations that might be pending.

Reimplemented from osg::StateAttribute.

virtual int osg::Program::compare ( const osg::StateAttribute &  sa ) const

virtual

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

Implements osg::StateAttribute.

virtual void osg::Program::compileGLObjects ( osg::State &  state ) const

virtual

Compile program and associated shaders.

Reimplemented from osg::StateAttribute.

static void osg::Program::deleteGlProgram ( unsigned int  contextID, GLuint  program  )

static

Mark internal glProgram for deletion. Deletion requests are queued until they can be executed in the proper GL context.

void osg::Program::dirtyProgram

(

)

Mark our PCSOs as needing relink

static void osg::Program::discardDeletedGlPrograms ( unsigned int  contextID )

static

discard all the cached glPrograms which need to be deleted in the OpenGL context related to contextID. Note, unlike flush no OpenGL calls are made, instead the handles are all removed. this call is useful for when an OpenGL context has been destroyed.

static void osg::Program::flushDeletedGlPrograms ( unsigned int  contextID, double  currentTime, double &  availableTime  )

static

flush all the cached glPrograms which need to be deleted in the OpenGL context related to contextID.

const AttribBindingList& osg::Program::getAttribBindingList ( ) const

inline

Definition at line 221 of file Program.h.

void osg::Program::getComputeGroups	(	GLint &	numGroupsX,
		GLint &	numGroupsY,
		GLint &	numGroupsZ
	)		const

const FragDataBindingList& osg::Program::getFragDataBindingList ( ) const

inline

Definition at line 222 of file Program.h.

bool osg::Program::getGlProgramInfoLog	(	unsigned int	contextID,
		std::string &	log
	)		const

Query InfoLog from a glProgram

unsigned int osg::Program::getNumShaders ( ) const

inline

Definition at line 89 of file Program.h.

unsigned int osg::Program::getNumTransformFeedBackVaryings ( ) const

inline

Get number of TransformFeedBack Varyings.

Definition at line 143 of file Program.h.

GLint osg::Program::getParameter

(

GLenum

pname

)

const

PerContextProgram* osg::Program::getPCP

(

State &

state

)

const

Get the PCP for a particular GL context

ProgramBinary* osg::Program::getProgramBinary ( )

inline

Get the Program's ProgramBinary, return NULL if none is assigned.

Definition at line 212 of file Program.h.

const ProgramBinary* osg::Program::getProgramBinary ( ) const

inline

Get the const Program's ProgramBinary, return NULL if none is assigned.

Definition at line 215 of file Program.h.

Shader* osg::Program::getShader ( unsigned int  i )

inline

Definition at line 91 of file Program.h.

const Shader* osg::Program::getShader ( unsigned int  i ) const

inline

Definition at line 92 of file Program.h.

ShaderDefines& osg::Program::getShaderDefines ( )

inline

Definition at line 156 of file Program.h.

const ShaderDefines& osg::Program::getShaderDefines ( ) const

inline

Definition at line 157 of file Program.h.

GLenum osg::Program::getTransformFeedBackMode ( ) const

inline

Get TransformFeedBack Mode.

Definition at line 152 of file Program.h.

const std::string& osg::Program::getTransformFeedBackVarying ( unsigned int  i ) const

inline

Get const TransformFeedBack Varying at index i.

Definition at line 146 of file Program.h.

const UniformBlockBindingList& osg::Program::getUniformBlockBindingList ( ) const

inline

Definition at line 223 of file Program.h.

bool osg::Program::isFixedFunction

(

)

const

Return true if this Program represents "fixed-functionality" rendering

osg::Program::META_StateAttribute	(	osg	,
		Program	,
		PROGRAM
	)

virtual void osg::Program::releaseGLObjects ( osg::State *  state = 0 ) const

virtual

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

Reimplemented from osg::StateAttribute.

void osg::Program::removeBindAttribLocation

(

const std::string &

name

)

Remove an attribute location binding.

void osg::Program::removeBindFragDataLocation

(

const std::string &

name

)

Remove an frag data location binding.

void osg::Program::removeBindUniformBlock

(

const std::string &

name

)

Remove a uniform block binding.

bool osg::Program::removeShader

(

Shader *

shader

)

Remove osg::Shader from this osg::Program. Mark Program as needing relink. Return true for success

void osg::Program::removeTransformFeedBackVarying ( const std::string &  name )

inline

Remove a TransformFeedBackVarying.

Definition at line 128 of file Program.h.

virtual void osg::Program::resizeGLObjectBuffers ( unsigned int  maxSize )

virtual

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::StateAttribute.

void osg::Program::setComputeGroups	(	GLint	numGroupsX,
		GLint	numGroupsY,
		GLint	numGroupsZ
	)

Set/get compute shader work groups

void osg::Program::setParameter	(	GLenum	pname,
		GLint	value
	)

Set/get GL program parameters

void osg::Program::setProgramBinary ( ProgramBinary *  programBinary )

inline

Set the Program using a ProgramBinary. If a ProgramBinary is not yet available then setting an empty one signals that compileProgramBinary will be called later.

Definition at line 209 of file Program.h.

void osg::Program::setShaderDefines ( const ShaderDefines &  shaderDefs )

inline

Experimental.

Definition at line 155 of file Program.h.

virtual void osg::Program::setThreadSafeRefUnref ( bool  threadSafe )

virtual

Set whether to use a mutex to ensure ref() and unref() are thread safe.

Reimplemented from osg::Object.

void osg::Program::setTransformFeedBackMode ( GLenum  e )

inline

Set TransformFeedBack Mode.

Definition at line 149 of file Program.h.

Friends And Related Function Documentation

friend class PerContextProgram

friend

Definition at line 274 of file Program.h.

Member Data Documentation

AttribBindingList osg::Program::_attribBindingList

protected

Definition at line 439 of file Program.h.

GLenum osg::Program::_feedbackmode

protected

TransformFeedBack

Definition at line 460 of file Program.h.

std::vector<std::string> osg::Program::_feedbackout

protected

Definition at line 461 of file Program.h.

FragDataBindingList osg::Program::_fragDataBindingList

protected

Definition at line 440 of file Program.h.

GLint osg::Program::_geometryInputType

protected

Definition at line 450 of file Program.h.

GLint osg::Program::_geometryOutputType

protected

Definition at line 451 of file Program.h.

GLint osg::Program::_geometryVerticesOut

protected

Parameters maintained with glProgramParameteriEXT

Definition at line 449 of file Program.h.

GLint osg::Program::_numGroupsX

protected

Parameter maintained with glDispatchCompute

Definition at line 455 of file Program.h.

GLint osg::Program::_numGroupsY

protected

Definition at line 456 of file Program.h.

GLint osg::Program::_numGroupsZ

protected

Definition at line 457 of file Program.h.

osg::buffered_value< osg::ref_ptr<ProgramObjects> > osg::Program::_pcpList

mutableprotected

Definition at line 438 of file Program.h.

osg::ref_ptr<ProgramBinary> osg::Program::_programBinary

protected

Definition at line 446 of file Program.h.

ShaderDefines osg::Program::_shaderDefines

protected

Definition at line 463 of file Program.h.

ShaderList osg::Program::_shaderList

protected

Definition at line 444 of file Program.h.

UniformBlockBindingList osg::Program::_uniformBlockBindingList

protected

Definition at line 441 of file Program.h.

---

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

• osg_head/include/osg/Program.h