OGRE  2.1.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::GLSLLinkProgram Class Reference

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

#include <OgreGLSLLinkProgram.h>

+ Inheritance diagram for Ogre::GLSLLinkProgram:

Public Member Functions

 GLSLLinkProgram (GLSLGpuProgram *vertexProgram, GLSLGpuProgram *geometryProgram, GLSLGpuProgram *fragmentProgram, GLSLGpuProgram *hullProgram, GLSLGpuProgram *domainProgram, GLSLGpuProgram *computeProgram)
 Constructor should only be used by GLSLLinkProgramManager. More...
 
 ~GLSLLinkProgram (void)
 
void activate (void)
 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...
 
GLSLGpuProgramgetComputeProgram () const
 
GLSLGpuProgramgetDomainProgram () const
 
GLSLGpuProgramgetFragmentProgram () const
 
GLSLGpuProgramgetGeometryProgram () const
 
GLuint getGLProgramHandle (void) const
 Get the GL Handle for the program object. More...
 
GLSLGpuProgramgetHullProgram () const
 
GL3PlusVertexArrayObjectgetVertexArrayObject ()
 
GLSLGpuProgramgetVertexProgram () 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)
 Updates program object uniforms using data from pass iteration GpuProgramParameters. More...
 
virtual void updateUniformBlocks (GpuProgramParametersSharedPtr params, uint16 mask, GpuProgramType fromProgType)
 Updates program object uniform blocks using data from GpuProgramParameters. More...
 
virtual void updateUniforms (GpuProgramParametersSharedPtr params, uint16 mask, GpuProgramType fromProgType)
 Updates program object uniforms using data from GpuProgramParameters. More...
 

Detailed Description

C++ encapsulation of GLSL Program Object.

Constructor & Destructor Documentation

◆ GLSLLinkProgram()

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

Constructor should only be used by GLSLLinkProgramManager.

◆ ~GLSLLinkProgram()

Ogre::GLSLLinkProgram::~GLSLLinkProgram ( void  )

Member Function Documentation

◆ activate()

void Ogre::GLSLLinkProgram::activate ( void  )
virtual

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

Implements Ogre::GLSLProgramCommon.

◆ extractLayoutQualifiers()

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

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

◆ getAttributeIndex()

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

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

Reimplemented in Ogre::GLSLProgramPipeline.

◆ getComputeProgram()

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

◆ getDomainProgram()

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

◆ getFragmentProgram()

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

◆ getGeometryProgram()

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

◆ getGLProgramHandle()

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

Get the GL Handle for the program object.

◆ getHullProgram()

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

◆ getVertexArrayObject()

GL3PlusVertexArrayObject* Ogre::GLSLProgramCommon::getVertexArrayObject ( )
inlineinherited

◆ getVertexProgram()

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

◆ isAttributeValid()

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

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

◆ isSkeletalAnimationIncluded()

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

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

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::GLSLLinkProgram::updatePassIterationUniforms ( GpuProgramParametersSharedPtr  params)
virtual

Updates program object uniforms using data from pass iteration GpuProgramParameters.

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

Implements Ogre::GLSLProgramCommon.

◆ updateUniformBlocks()

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

Updates program object uniform blocks using data from GpuProgramParameters.

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

Implements Ogre::GLSLProgramCommon.

◆ updateUniforms()

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

Updates program object uniforms using data from GpuProgramParameters.

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

Implements Ogre::GLSLProgramCommon.


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