osg::Shader Class Reference

osg::Shader is an application-level abstraction of an OpenGL glShader. More...

Inheritance diagram for osg::Shader:

Collaboration diagram for osg::Shader:

Classes
class	PerContextShader
	PerContextShader (PCS) is an OSG-internal encapsulation of glShader per-GL context. More...
struct	ShaderObjects

Public Types
enum	Type {   VERTEX = GL_VERTEX_SHADER, TESSCONTROL = GL_TESS_CONTROL_SHADER, TESSEVALUATION = GL_TESS_EVALUATION_SHADER, GEOMETRY = GL_GEOMETRY_SHADER,   FRAGMENT = GL_FRAGMENT_SHADER, COMPUTE = GL_COMPUTE_SHADER, UNDEFINED = -1 }
enum	ShaderDefinesMode { USE_SHADER_PRAGMA, USE_MANUAL_SETTINGS }
typedef std::multimap< float, std::string >	CodeInjectionMap
	The code injection map used when generating the main shader during main shader composition. More...
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions
	Shader (Type type=UNDEFINED)
	Shader (Type type, const std::string &source)
	Shader (Type type, ShaderBinary *shaderBinary)
	Shader (const Shader &rhs, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy. More...
	META_Object (osg, Shader)
int	compare (const Shader &rhs) const
bool	setType (Type t)
	Set the Shader type as an enum. More...
Type	getType () const
	Get the Shader type as an enum. More...
const char *	getTypename () const
	Get the Shader type as a descriptive string. More...
void	setFileName (const std::string &fileName)
	Set file name for the shader source code. More...
const std::string &	getFileName () const
	Get filename to which the shader source code belongs. More...
void	setShaderSource (const std::string &sourceText)
	Set the Shader's source code text from a string. More...
const std::string &	getShaderSource () const
	Query the shader's source code text.
void	setShaderDefinesMode (ShaderDefinesMode sdm)
ShaderDefinesMode	getShaderDefinesMode () const
void	setShaderDefines (const ShaderDefines &shaderDefs)
ShaderDefines &	getShaderDefines ()
const ShaderDefines &	getShaderDefines () const
void	setShaderRequirements (const ShaderDefines &shaderDefs)
ShaderDefines &	getShaderRequirements ()
const ShaderDefines &	getShaderRequirements () const
void	setShaderBinary (ShaderBinary *shaderBinary)
	Set the Shader using a ShaderBinary. More...
ShaderBinary *	getShaderBinary ()
	Get the Shader's ShaderBinary, return NULL if none is assigned. More...
const ShaderBinary *	getShaderBinary () const
	Get the const Shader's ShaderBinary, return NULL if none is assigned. More...
bool	loadShaderSourceFromFile (const std::string &fileName)
	Load the Shader's source code text from a file. More...
void	addCodeInjection (float position, const std::string &code)
	Add code injection that will be placed in the main shader to enable support for this shader. More...
CodeInjectionMap &	getCodeInjectionMap ()
	Get the code injection map. More...
const CodeInjectionMap &	getCodeInjectionMap () const
	Get the const code injection map. More...
virtual void	resizeGLObjectBuffers (unsigned int maxSize)
	Resize any per context GLObject buffers to specified size. More...
void	releaseGLObjects (osg::State *state=0) const
	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. More...
void	dirtyShader ()
	Mark our PCSs as needing recompilation. More...
void	compileShader (osg::State &state) const
	If needed, compile the PCS's glShader.
PerContextShader *	getPCS (osg::State &state) const
Public Member Functions inherited from osg::Object
	Object ()
	Construct an object. More...
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
virtual Object *	cloneType () const =0
	Clone the type of an object, with Object* return type. More...
virtual Object *	clone (const CopyOp &) const =0
	Clone an object, with Object* return type. More...
virtual bool	isSameKindAs (const Object *) const
virtual const char *	libraryName () const =0
	return the name of the object's library. More...
virtual const char *	className () const =0
	return the name of the object's class type. More...
std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name. More...
virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
virtual void	setName (const std::string &name)
	Set the name of object using C++ style string. More...
void	setName (const char *name)
	Set the name of object using a C style string. More...
const std::string &	getName () const
	Get the name of object. More...
void	setDataVariance (DataVariance dv)
	Set the data variance of this object. More...
DataVariance	getDataVariance () const
	Get the data variance of this object. More...
virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc. More...
void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object. More...
template<class T >
void	setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...
const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...
osg::UserDataContainer *	getOrCreateUserDataContainer ()
	Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
template<class T >
void	setUserData (const ref_ptr< T > &ud)
virtual Referenced *	getUserData ()
	Get user data. More...
virtual const Referenced *	getUserData () const
	Get const user data. More...
template<typename T >
bool	getUserValue (const std::string &name, T &value) const
	Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
template<typename T >
void	setUserValue (const std::string &name, const T &value)
	Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool	getUserValue (const std::string &name, T &value) const
	provide implementation of osg::Object::getUserValue(..) template
Public Member Functions inherited from osg::Referenced
	Referenced (bool threadSafeRefUnref)
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
	Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
bool	getThreadSafeRefUnref () const
OpenThreads::Mutex *	getRefMutex () const
	Get the mutex used to ensure thread safety of ref()/unref(). More...
OpenThreads::Mutex *	getRefMutex () const
int	ref () const
	Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
int	unref () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
int	referenceCount () const
	Return the number of pointers currently referencing this object. More...
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...
ObserverSet *	getOrCreateObserverSet () const
	Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
void	addObserver (Observer *observer) const
	Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
void	removeObserver (Observer *observer) const
	Remove Observer that is observing this object. More...

Static Public Member Functions
static Shader *	readShaderFile (Type type, const std::string &fileName)
	Read shader source from file and then constructor shader of specified type. More...
static void	deleteGlShader (unsigned int contextID, GLuint shader)
	Mark internal glShader for deletion. More...
static void	flushDeletedGlShaders (unsigned int contextID, double currentTime, double &availableTime)
	flush all the cached glShaders which need to be deleted in the OpenGL context related to contextID. More...
static void	discardDeletedGlShaders (unsigned int contextID)
	discard all the cached glShaders which need to be deleted in the OpenGL context related to contextID. More...
static Shader::Type	getTypeId (const std::string &tname)
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
	Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
	Set whether reference counting should use a mutex for thread safe reference counting. More...
static bool	getThreadSafeReferenceCounting ()
	Get whether reference counting is active. More...
static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

Protected Types
typedef std::set< osg::Program *>	ProgramSet
	osg::Programs that this osg::Shader is attached to

Protected Member Functions
bool	addProgramRef (osg::Program *program)
bool	removeProgramRef (osg::Program *program)
void	_computeShaderDefines ()
void	_parseShaderDefines (const std::string &str, ShaderDefines &defines)
Protected Member Functions inherited from osg::Object
virtual	~Object ()
	Object destructor. More...
Protected Member Functions inherited from osg::Referenced
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const

Protected Attributes
Type	_type
std::string	_shaderFileName
std::string	_shaderSource
osg::ref_ptr< ShaderBinary >	_shaderBinary
CodeInjectionMap	_codeInjectionMap
ShaderDefinesMode	_shaderDefinesMode
ShaderDefines	_shaderDefines
ShaderDefines	_shaderRequirements
ProgramSet	_programSet
osg::buffered_value< osg::ref_ptr< ShaderObjects > >	_pcsList
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
OpenThreads::Mutex *	_refMutex
int	_refCount
void *	_observerSet

Friends
class	osg::Program

Detailed Description

osg::Shader is an application-level abstraction of an OpenGL glShader.

It is a container to load the shader source code text and manage its compilation. An osg::Shader may be attached to more than one osg::Program. Shader will automatically manage per-context instancing of the internal objects, if that is necessary for a particular display configuration.

Member Typedef Documentation

CodeInjectionMap

typedef std::multimap<float, std::string> osg::Shader::CodeInjectionMap

The code injection map used when generating the main shader during main shader composition.

Constructor & Destructor Documentation

Shader()

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

Copy constructor using CopyOp to manage deep vs shallow copy.

Member Function Documentation

addCodeInjection()

void osg::Shader::addCodeInjection ( float  position, const std::string &  code  )

inline

Add code injection that will be placed in the main shader to enable support for this shader.

The position is set up so that code to be inserted before the main() will have a negative value, a position between 0 and 1.0 will be inserted in main() and a position greater than 1.0 will be placed after the main(). During shader composition all the code injections are sorted in ascending order and then placed in the appropriate section of the main shader.

deleteGlShader()

static void osg::Shader::deleteGlShader ( unsigned int  contextID, GLuint  shader  )

static

Mark internal glShader for deletion.

Deletion requests are queued until they can be executed in the proper GL context.

dirtyShader()

void osg::Shader::dirtyShader

(

)

Mark our PCSs as needing recompilation.

Also mark Programs that depend on us as needing relink

discardDeletedGlShaders()

static void osg::Shader::discardDeletedGlShaders ( unsigned int  contextID )

static

discard all the cached glShaders 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.

flushDeletedGlShaders()

static void osg::Shader::flushDeletedGlShaders ( unsigned int  contextID, double  currentTime, double &  availableTime  )

static

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

getCodeInjectionMap() [1/2]

CodeInjectionMap& osg::Shader::getCodeInjectionMap ( )

inline

Get the code injection map.

getCodeInjectionMap() [2/2]

const CodeInjectionMap& osg::Shader::getCodeInjectionMap ( ) const

inline

Get the const code injection map.

getFileName()

const std::string& osg::Shader::getFileName ( ) const

inline

Get filename to which the shader source code belongs.

getShaderBinary() [1/2]

ShaderBinary* osg::Shader::getShaderBinary ( )

inline

Get the Shader's ShaderBinary, return NULL if none is assigned.

getShaderBinary() [2/2]

const ShaderBinary* osg::Shader::getShaderBinary ( ) const

inline

Get the const Shader's ShaderBinary, return NULL if none is assigned.

getType()

Type osg::Shader::getType ( ) const

inline

Get the Shader type as an enum.

getTypename()

const char* osg::Shader::getTypename

(

)

const

Get the Shader type as a descriptive string.

loadShaderSourceFromFile()

bool osg::Shader::loadShaderSourceFromFile

(

const std::string &

fileName

)

Load the Shader's source code text from a file.

readShaderFile()

static Shader* osg::Shader::readShaderFile ( Type  type, const std::string &  fileName  )

static

Read shader source from file and then constructor shader of specified type.

Return the resulting Shader or 0 if no valid shader source could be read.

releaseGLObjects()

void osg::Shader::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::Object.

resizeGLObjectBuffers()

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

virtual

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Object.

setFileName()

void osg::Shader::setFileName ( const std::string &  fileName )

inline

Set file name for the shader source code.

setShaderBinary()

void osg::Shader::setShaderBinary ( ShaderBinary *  shaderBinary )

inline

Set the Shader using a ShaderBinary.

setShaderSource()

void osg::Shader::setShaderSource

(

const std::string &

sourceText

)

Set the Shader's source code text from a string.

setType()

bool osg::Shader::setType

(

Type

t

)

Set the Shader type as an enum.

---

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

• /home/karlu20/private/installs/OpenSceneGraph/include/osg/Shader