Ogre::GLSLProgramCommon Class Reference

C++ encapsulation of GLSL Program Object. More...

#include <OgreGLSLProgramCommon.h>

Inheritance diagram for Ogre::GLSLProgramCommon:

Public Member Functions
	GLSLProgramCommon (GLSLGpuProgram *vertexProgram, GLSLGpuProgram *geometryProgram, GLSLGpuProgram *fragmentProgram, GLSLGpuProgram *hullProgram, GLSLGpuProgram *domainProgram, GLSLGpuProgram *computeProgram)
	Constructor should only be used by GLSLLinkProgramManager and GLSLProgramPipelineManager. More...
virtual	~GLSLProgramCommon (void)
virtual void	activate (void)=0
	Makes a program object active by making sure it is linked and then putting it in use. More...
virtual void	extractLayoutQualifiers (void)
	Finds layout qualifiers in the shader source and sets attribute indices appropriately. More...
virtual GLint	getAttributeIndex (VertexElementSemantic semantic, uint index)
	Get the index of a non-standard attribute bound in the linked code. More...
GLSLGpuProgram *	getComputeProgram () const
GLSLGpuProgram *	getDomainProgram () const
GLSLGpuProgram *	getFragmentProgram () const
GLSLGpuProgram *	getGeometryProgram () const
GLuint	getGLProgramHandle (void) const
	Get the GL Handle for the program object. More...
GLSLGpuProgram *	getHullProgram () const
GL3PlusVertexArrayObject *	getVertexArrayObject ()
GLSLGpuProgram *	getVertexProgram () const
bool	isAttributeValid (VertexElementSemantic semantic, uint index)
	Is a non-standard attribute bound in the linked code? More...
bool	isSkeletalAnimationIncluded (void) const
	Returns whether the linked program includes the required instructions to perform skeletal animation. More...
void	setSkeletalAnimationIncluded (bool included)
	Sets whether the linked program includes the required instructions to perform skeletal animation. More...
virtual void	updatePassIterationUniforms (GpuProgramParametersSharedPtr params)=0
	Updates program object uniforms using data from pass iteration GpuProgramParameters. More...
virtual void	updateUniformBlocks (GpuProgramParametersSharedPtr params, uint16 mask, GpuProgramType fromProgType)=0
	Updates program object uniform blocks using data from GpuProgramParameters. More...
virtual void	updateUniforms (GpuProgramParametersSharedPtr params, uint16 mask, GpuProgramType fromProgType)=0
	Updates program object uniforms using data from GpuProgramParameters. More...

Protected Types
typedef set< GLuint >::type	AttributeSet
typedef map< String, VertexElementSemantic >::type	SemanticToStringMap

Protected Member Functions
virtual void	_useProgram (void)=0
	Put a program in use. More...
void	buildGLUniformReferences (void)
	Build uniform references from active named uniforms. More...
virtual void	compileAndLink (void)=0
	Compiles and links the vertex and fragment programs. More...
VertexElementSemantic	getAttributeSemanticEnum (String type)
const char *	getAttributeSemanticString (VertexElementSemantic semantic)
Ogre::String	getCombinedName (void)
void	getMicrocodeFromCache (void)
	Get the the binary data of a program from the microcode cache. More...

Protected Attributes
GLSLGpuProgram *	mComputeProgram
	Linked compute program. More...
GLint	mCustomAttributesIndexes [VES_COUNT][OGRE_MAX_TEXTURE_COORD_SETS]
	An array to hold the attributes indexes. More...
GLSLGpuProgram *	mDomainProgram
	Linked domain(evaluation) program. More...
GLSLGpuProgram *	mFragmentProgram
	Linked fragment program. More...
GLSLGpuProgram *	mGeometryProgram
	Linked geometry program. More...
GLuint	mGLProgramHandle
	GL handle for the program object. More...
GLUniformBufferList	mGLUniformBufferReferences
	Container of uniform buffer references that are active in the program object. More...
GLUniformReferenceList	mGLUniformReferences
	Container of uniform references that are active in the program object. More...
GLSLGpuProgram *	mHullProgram
	Linked hull(control) program. More...
GLint	mLinked
	Flag indicating that the program or pipeline object has been successfully linked. More...
SemanticToStringMap	mSemanticTypeMap
bool	mSkeletalAnimation
	Flag indicating skeletal animation is being performed. More...
bool	mTriedToLinkAndFailed
	Flag indicating that the program or pipeline object has tried to link and failed. More...
bool	mUniformRefsBuilt
	Flag to indicate that uniform references have already been built. More...
GL3PlusVertexArrayObject *	mVertexArrayObject
	GL handle for the vertex array object. More...
GLSLGpuProgram *	mVertexProgram
	Linked vertex program. More...

Detailed Description

C++ encapsulation of GLSL Program Object.

Definition at line 61 of file OgreGLSLProgramCommon.h.

Member Typedef Documentation

typedef set<GLuint>::type Ogre::GLSLProgramCommon::AttributeSet

protected

Definition at line 98 of file OgreGLSLProgramCommon.h.

typedef map<String, VertexElementSemantic>::type Ogre::GLSLProgramCommon::SemanticToStringMap

protected

Definition at line 115 of file OgreGLSLProgramCommon.h.

Constructor & Destructor Documentation

Ogre::GLSLProgramCommon::GLSLProgramCommon	(	GLSLGpuProgram *	vertexProgram,
		GLSLGpuProgram *	geometryProgram,
		GLSLGpuProgram *	fragmentProgram,
		GLSLGpuProgram *	hullProgram,
		GLSLGpuProgram *	domainProgram,
		GLSLGpuProgram *	computeProgram
	)

Constructor should only be used by GLSLLinkProgramManager and GLSLProgramPipelineManager.

virtual Ogre::GLSLProgramCommon::~GLSLProgramCommon ( void  )

virtual

Member Function Documentation

virtual void Ogre::GLSLProgramCommon::_useProgram ( void  )

protectedpure virtual

Put a program in use.

Implemented in Ogre::GLSLProgramPipeline, and Ogre::GLSLLinkProgram.

virtual void Ogre::GLSLProgramCommon::activate ( void  )

pure virtual

Makes a program object active by making sure it is linked and then putting it in use.

Implemented in Ogre::GLSLProgramPipeline, and Ogre::GLSLLinkProgram.

void Ogre::GLSLProgramCommon::buildGLUniformReferences ( void  )

protected

Build uniform references from active named uniforms.

virtual void Ogre::GLSLProgramCommon::compileAndLink ( void  )

protectedpure virtual

Compiles and links the vertex and fragment programs.

Implemented in Ogre::GLSLProgramPipeline, and Ogre::GLSLLinkProgram.

virtual void Ogre::GLSLProgramCommon::extractLayoutQualifiers ( void  )

virtual

Finds layout qualifiers in the shader source and sets attribute indices appropriately.

virtual GLint Ogre::GLSLProgramCommon::getAttributeIndex ( VertexElementSemantic  semantic, uint  index  )

virtual

Get the index of a non-standard attribute bound in the linked code.

Reimplemented in Ogre::GLSLProgramPipeline.

VertexElementSemantic Ogre::GLSLProgramCommon::getAttributeSemanticEnum ( String  type )

protected

const char* Ogre::GLSLProgramCommon::getAttributeSemanticString ( VertexElementSemantic  semantic )

protected

Ogre::String Ogre::GLSLProgramCommon::getCombinedName ( void  )

protected

GLSLGpuProgram* Ogre::GLSLProgramCommon::getComputeProgram

(

)

const

Definition at line 172 of file OgreGLSLProgramCommon.h.

GLSLGpuProgram* Ogre::GLSLProgramCommon::getDomainProgram

(

)

const

Definition at line 171 of file OgreGLSLProgramCommon.h.

GLSLGpuProgram* Ogre::GLSLProgramCommon::getFragmentProgram

(

)

const

Definition at line 168 of file OgreGLSLProgramCommon.h.

GLSLGpuProgram* Ogre::GLSLProgramCommon::getGeometryProgram

(

)

const

Definition at line 169 of file OgreGLSLProgramCommon.h.

GLuint Ogre::GLSLProgramCommon::getGLProgramHandle

(

void

)

const

Get the GL Handle for the program object.

Definition at line 145 of file OgreGLSLProgramCommon.h.

GLSLGpuProgram* Ogre::GLSLProgramCommon::getHullProgram

(

)

const

Definition at line 170 of file OgreGLSLProgramCommon.h.

void Ogre::GLSLProgramCommon::getMicrocodeFromCache ( void  )

protected

Get the the binary data of a program from the microcode cache.

GL3PlusVertexArrayObject* Ogre::GLSLProgramCommon::getVertexArrayObject

(

)

Definition at line 173 of file OgreGLSLProgramCommon.h.

GLSLGpuProgram* Ogre::GLSLProgramCommon::getVertexProgram

(

)

const

Definition at line 167 of file OgreGLSLProgramCommon.h.

bool Ogre::GLSLProgramCommon::isAttributeValid	(	VertexElementSemantic	semantic,
		uint	index
	)

Is a non-standard attribute bound in the linked code?

bool Ogre::GLSLProgramCommon::isSkeletalAnimationIncluded

(

void

)

const

Returns whether the linked program includes the required instructions to perform skeletal animation.

Remarks

If this returns true, OGRE will not blend the geometry according to skeletal animation, it will expect the vertex program to do it.

Definition at line 160 of file OgreGLSLProgramCommon.h.

void Ogre::GLSLProgramCommon::setSkeletalAnimationIncluded

(

bool

included

)

Sets whether the linked program includes the required instructions to perform skeletal animation.

Remarks

If this is set to true, OGRE will not blend the geometry according to skeletal animation, it will expect the vertex program to do it.

Definition at line 152 of file OgreGLSLProgramCommon.h.

virtual void Ogre::GLSLProgramCommon::updatePassIterationUniforms ( GpuProgramParametersSharedPtr  params )

pure virtual

Updates program object uniforms using data from pass iteration GpuProgramParameters.

normally called by GLSLGpuProgram::bindMultiPassParameters() just before multi pass rendering occurs.

Implemented in Ogre::GLSLProgramPipeline, and Ogre::GLSLLinkProgram.

virtual void Ogre::GLSLProgramCommon::updateUniformBlocks ( GpuProgramParametersSharedPtr  params, uint16  mask, GpuProgramType  fromProgType  )

pure virtual

Updates program object uniform blocks using data from GpuProgramParameters.

normally called by GLSLGpuProgram::bindParameters() just before rendering occurs.

Implemented in Ogre::GLSLProgramPipeline, and Ogre::GLSLLinkProgram.

virtual void Ogre::GLSLProgramCommon::updateUniforms ( GpuProgramParametersSharedPtr  params, uint16  mask, GpuProgramType  fromProgType  )

pure virtual

Updates program object uniforms using data from GpuProgramParameters.

normally called by GLSLGpuProgram::bindParameters() just before rendering occurs.

Implemented in Ogre::GLSLProgramPipeline, and Ogre::GLSLLinkProgram.

Member Data Documentation

GLSLGpuProgram* Ogre::GLSLProgramCommon::mComputeProgram

protected

Linked compute program.

Definition at line 81 of file OgreGLSLProgramCommon.h.

GLint Ogre::GLSLProgramCommon::mCustomAttributesIndexes[VES_COUNT][OGRE_MAX_TEXTURE_COORD_SETS]

protected

An array to hold the attributes indexes.

Definition at line 101 of file OgreGLSLProgramCommon.h.

GLSLGpuProgram* Ogre::GLSLProgramCommon::mDomainProgram

protected

Linked domain(evaluation) program.

Definition at line 79 of file OgreGLSLProgramCommon.h.

GLSLGpuProgram* Ogre::GLSLProgramCommon::mFragmentProgram

protected

Linked fragment program.

Definition at line 73 of file OgreGLSLProgramCommon.h.

GLSLGpuProgram* Ogre::GLSLProgramCommon::mGeometryProgram

protected

Linked geometry program.

Definition at line 75 of file OgreGLSLProgramCommon.h.

GLuint Ogre::GLSLProgramCommon::mGLProgramHandle

protected

GL handle for the program object.

Definition at line 88 of file OgreGLSLProgramCommon.h.

GLUniformBufferList Ogre::GLSLProgramCommon::mGLUniformBufferReferences

protected

Container of uniform buffer references that are active in the program object.

Definition at line 68 of file OgreGLSLProgramCommon.h.

GLUniformReferenceList Ogre::GLSLProgramCommon::mGLUniformReferences

protected

Container of uniform references that are active in the program object.

Definition at line 65 of file OgreGLSLProgramCommon.h.

GLSLGpuProgram* Ogre::GLSLProgramCommon::mHullProgram

protected

Linked hull(control) program.

Definition at line 77 of file OgreGLSLProgramCommon.h.

GLint Ogre::GLSLProgramCommon::mLinked

protected

Flag indicating that the program or pipeline object has been successfully linked.

Definition at line 90 of file OgreGLSLProgramCommon.h.

SemanticToStringMap Ogre::GLSLProgramCommon::mSemanticTypeMap

protected

Definition at line 116 of file OgreGLSLProgramCommon.h.

bool Ogre::GLSLProgramCommon::mSkeletalAnimation

protected

Flag indicating skeletal animation is being performed.

Definition at line 94 of file OgreGLSLProgramCommon.h.

bool Ogre::GLSLProgramCommon::mTriedToLinkAndFailed

protected

Flag indicating that the program or pipeline object has tried to link and failed.

Definition at line 92 of file OgreGLSLProgramCommon.h.

bool Ogre::GLSLProgramCommon::mUniformRefsBuilt

protected

Flag to indicate that uniform references have already been built.

Definition at line 86 of file OgreGLSLProgramCommon.h.

GL3PlusVertexArrayObject* Ogre::GLSLProgramCommon::mVertexArrayObject

protected

GL handle for the vertex array object.

Definition at line 83 of file OgreGLSLProgramCommon.h.

GLSLGpuProgram* Ogre::GLSLProgramCommon::mVertexProgram

protected

Linked vertex program.

Definition at line 71 of file OgreGLSLProgramCommon.h.

---

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

• OgreGLSLProgramCommon.h