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

Specialisation of HighLevelGpuProgram to provide support for OpenGL Shader Language (GLSL) for OpenGL. More...

#include <OgreGLSLProgramPipeline.h>

+ Inheritance diagram for Ogre::GLSLProgramPipeline:

Public Member Functions

 GLSLProgramPipeline (GLSLGpuProgram *vertexProgram, GLSLGpuProgram *geometryProgram, GLSLGpuProgram *fragmentProgram, GLSLGpuProgram *hullProgram, GLSLGpuProgram *domainProgram, GLSLGpuProgram *computeProgram)
 Constructor should only be used by GLSLProgramPipelineManager. More...
 
virtual ~GLSLProgramPipeline ()
 
void activate (void)
 Makes a program pipeline 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...
 
GLuint getGLProgramPipelineHandle () const
 GL Program Pipeline Handle. 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 pipeline 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 pipeline object uniforms using data from GpuProgramParameters. More...
 

Detailed Description

Specialisation of HighLevelGpuProgram to provide support for OpenGL Shader Language (GLSL) for OpenGL.

Remarks
GLSL has no target assembler or entry point specification like DirectX 9 HLSL. Vertex and Fragment shaders only have one entry point called "main".
When a shader is compiled, microcode is generated but can not be accessed by the application. GLSL also does not provide assembler low level output after compiling. The GL Render system assumes that the Gpu program is a GL Gpu program so GLSLProgramPipeline will create a GLSLGpuProgram that is subclassed from GLGpuProgram for the low level implementation. The GLProgram class will create a shader and program object and compile the source but will not create a pipeline object. It's up to GLGpuProgram class to request a program pipeline object to link the program object to.
Note
GLSL supports multiple modular shader objects that can be attached to one program object to form a single shader. This is supported through the "attach" material script command. All the modules to be attached are listed on the same line as the attach command separated by white space.

Constructor & Destructor Documentation

◆ GLSLProgramPipeline()

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

Constructor should only be used by GLSLProgramPipelineManager.

◆ ~GLSLProgramPipeline()

virtual Ogre::GLSLProgramPipeline::~GLSLProgramPipeline ( )
virtual

Member Function Documentation

◆ activate()

void Ogre::GLSLProgramPipeline::activate ( void  )
virtual

Makes a program pipeline 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::GLSLProgramPipeline::getAttributeIndex ( VertexElementSemantic  semantic,
uint  index 
)
virtual

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

Reimplemented from Ogre::GLSLProgramCommon.

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

◆ getGLProgramPipelineHandle()

GLuint Ogre::GLSLProgramPipeline::getGLProgramPipelineHandle ( ) const
inline

GL Program Pipeline Handle.

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

Updates program pipeline 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::GLSLProgramPipeline::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::GLSLProgramPipeline::updateUniforms ( GpuProgramParametersSharedPtr  params,
uint16  mask,
GpuProgramType  fromProgType 
)
virtual

Updates program pipeline 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: