#include <Shader.h>

Inheritance diagram for osg::Shader:

Collaboration diagram for osg::Shader:

Classes
class	PerContextShader

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

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)

	META_Object (osg, Shader)

int	compare (const Shader &rhs) const

bool	setType (Type t)

Type	getType () const

const char *	getTypename () const

void	setFileName (const std::string &fileName)

const std::string &	getFileName () const

void	setShaderSource (const std::string &sourceText)

const std::string &	getShaderSource () const

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)

ShaderBinary *	getShaderBinary ()

const ShaderBinary *	getShaderBinary () const

bool	loadShaderSourceFromFile (const std::string &fileName)

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

CodeInjectionMap &	getCodeInjectionMap ()

const CodeInjectionMap &	getCodeInjectionMap () const

virtual void	resizeGLObjectBuffers (unsigned int maxSize)

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

void	dirtyShader ()

void	compileShader (osg::State &state) const

PerContextShader *	getPCS (osg::State &state) 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)

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 Shader *	readShaderFile (Type type, const std::string &fileName)

static void	deleteGlShader (unsigned int contextID, GLuint shader)

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

static void	discardDeletedGlShaders (unsigned int contextID)

static Shader::Type	getTypeId (const std::string &tname)

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::set< osg::Program * >	ProgramSet

Protected Member Functions
virtual	~Shader ()

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 ()

Protected Member Functions inherited from osg::Referenced
virtual	~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

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.

Definition at line 88 of file Shader.h.

Member Typedef Documentation

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

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

Definition at line 175 of file Shader.h.

typedef std::set< osg::Program* > osg::Shader::ProgramSet

protected

osg::Programs that this osg::Shader is attached to

Definition at line 323 of file Shader.h.

Member Enumeration Documentation

enum osg::Shader::ShaderDefinesMode

Enumerator
USE_SHADER_PRAGMA
USE_MANUAL_SETTINGS

Definition at line 137 of file Shader.h.

enum osg::Shader::Type

Enumerator
VERTEX
TESSCONTROL
TESSEVALUATION
GEOMETRY
FRAGMENT
COMPUTE
UNDEFINED

Definition at line 92 of file Shader.h.

Constructor & Destructor Documentation

osg::Shader::Shader ( Type type = UNDEFINED )

osg::Shader::Shader	(	Type	type,
		const std::string &	source
	)

osg::Shader::Shader	(	Type	type,
		ShaderBinary *	shaderBinary
	)

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

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osg::Shader::~Shader ( )

protectedvirtual

Member Function Documentation

void osg::Shader::_computeShaderDefines ( )

protected

void osg::Shader::_parseShaderDefines	(	const std::string &	str,
		ShaderDefines &	defines
	)

protected

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.

Definition at line 183 of file Shader.h.

bool osg::Shader::addProgramRef ( osg::Program * program )

protected

int osg::Shader::compare ( const Shader & rhs ) const

void osg::Shader::compileShader ( osg::State & state ) const

If needed, compile the PCS's glShader

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.

void osg::Shader::dirtyShader ( )

Mark our PCSs as needing recompilation. Also mark Programs that depend on us as needing relink

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.

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.

CodeInjectionMap& osg::Shader::getCodeInjectionMap ( )

inline

Get the code injection map.

Definition at line 186 of file Shader.h.

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

inline

Get the const code injection map.

Definition at line 189 of file Shader.h.

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

inline

Get filename to which the shader source code belongs.

Definition at line 127 of file Shader.h.

PerContextShader* osg::Shader::getPCS ( osg::State & state ) const

ShaderBinary* osg::Shader::getShaderBinary ( )

inline

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

Definition at line 160 of file Shader.h.

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

inline

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

Definition at line 163 of file Shader.h.

ShaderDefines& osg::Shader::getShaderDefines ( )

inline

Definition at line 148 of file Shader.h.

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

inline

Definition at line 149 of file Shader.h.

ShaderDefinesMode osg::Shader::getShaderDefinesMode ( ) const

inline

Definition at line 144 of file Shader.h.

ShaderDefines& osg::Shader::getShaderRequirements ( )

inline

Definition at line 152 of file Shader.h.

const ShaderDefines& osg::Shader::getShaderRequirements ( ) const

inline

Definition at line 153 of file Shader.h.

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

inline

Query the shader's source code text

Definition at line 134 of file Shader.h.

Type osg::Shader::getType ( ) const

inline

Get the Shader type as an enum.

Definition at line 117 of file Shader.h.

static Shader::Type osg::Shader::getTypeId ( const std::string & tname )

static

const char* osg::Shader::getTypename ( ) const

Get the Shader type as a descriptive string.

bool osg::Shader::loadShaderSourceFromFile ( const std::string & fileName )

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

osg::Shader::META_Object	(	osg	,
		Shader
	)

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.

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.

bool osg::Shader::removeProgramRef ( osg::Program * program )

protected

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

virtual

Resize any per context GLObject buffers to specified size.

Reimplemented from osg::Object.

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

inline

Set file name for the shader source code.

Definition at line 124 of file Shader.h.

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

inline

Set the Shader using a ShaderBinary.

Definition at line 157 of file Shader.h.

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

inline

Definition at line 147 of file Shader.h.

void osg::Shader::setShaderDefinesMode ( ShaderDefinesMode sdm )

inline

Definition at line 143 of file Shader.h.

void osg::Shader::setShaderRequirements ( const ShaderDefines & shaderDefs )

inline

Definition at line 151 of file Shader.h.

void osg::Shader::setShaderSource ( const std::string & sourceText )

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

bool osg::Shader::setType ( Type t )

Set the Shader type as an enum.

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class osg::Program

friend

Definition at line 301 of file Shader.h.

Member Data Documentation

CodeInjectionMap osg::Shader::_codeInjectionMap

protected

Definition at line 315 of file Shader.h.

osg::buffered_value< osg::ref_ptr<ShaderObjects> > osg::Shader::_pcsList

mutableprotected

Definition at line 325 of file Shader.h.

ProgramSet osg::Shader::_programSet

protected

Definition at line 324 of file Shader.h.

osg::ref_ptr<ShaderBinary> osg::Shader::_shaderBinary

protected

Definition at line 313 of file Shader.h.

ShaderDefines osg::Shader::_shaderDefines

protected

Definition at line 319 of file Shader.h.

ShaderDefinesMode osg::Shader::_shaderDefinesMode

protected

Definition at line 318 of file Shader.h.

std::string osg::Shader::_shaderFileName

protected

Definition at line 311 of file Shader.h.

ShaderDefines osg::Shader::_shaderRequirements

protected

Definition at line 320 of file Shader.h.

std::string osg::Shader::_shaderSource

protected

Definition at line 312 of file Shader.h.

Type osg::Shader::_type

protected

Definition at line 310 of file Shader.h.

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

osg_head/include/osg/Shader.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation