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...

Detailed Description

C++ encapsulation of GLSL Program Object.

Constructor & Destructor Documentation

GLSLProgramCommon()

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

Constructor should only be used by GLSLLinkProgramManager and GLSLProgramPipelineManager.

~GLSLProgramCommon()

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

virtual

Member Function Documentation

activate()

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.

extractLayoutQualifiers()

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

virtual

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

getAttributeIndex()

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.

getComputeProgram()

GLSLGpuProgram* Ogre::GLSLProgramCommon::getComputeProgram ( ) const

inline

getDomainProgram()

GLSLGpuProgram* Ogre::GLSLProgramCommon::getDomainProgram ( ) const

inline

getFragmentProgram()

GLSLGpuProgram* Ogre::GLSLProgramCommon::getFragmentProgram ( ) const

inline

getGeometryProgram()

GLSLGpuProgram* Ogre::GLSLProgramCommon::getGeometryProgram ( ) const

inline

getGLProgramHandle()

GLuint Ogre::GLSLProgramCommon::getGLProgramHandle ( void  ) const

inline

Get the GL Handle for the program object.

getHullProgram()

GLSLGpuProgram* Ogre::GLSLProgramCommon::getHullProgram ( ) const

inline

getVertexArrayObject()

GL3PlusVertexArrayObject* Ogre::GLSLProgramCommon::getVertexArrayObject ( )

inline

getVertexProgram()

GLSLGpuProgram* Ogre::GLSLProgramCommon::getVertexProgram ( ) const

inline

isAttributeValid()

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

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

isSkeletalAnimationIncluded()

bool Ogre::GLSLProgramCommon::isSkeletalAnimationIncluded ( void  ) const

inline

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.

setSkeletalAnimationIncluded()

void Ogre::GLSLProgramCommon::setSkeletalAnimationIncluded ( bool  included )

inline

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.

updatePassIterationUniforms()

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.

updateUniformBlocks()

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.

updateUniforms()

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.

---

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

• OgreGLSLProgramCommon.h