OGRE-Next  3.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::GLSLProgram Class Referenceabstract

C++ encapsulation of GLSL program object. More...

#include <OgreGLSLProgram.h>

+ Inheritance diagram for Ogre::GLSLProgram:

Public Member Functions

 GLSLProgram (GLSLShader *vertexProgram, GLSLShader *hullProgram, GLSLShader *domainProgram, GLSLShader *geometryProgram, GLSLShader *fragmentProgram, GLSLShader *computeProgram)
 Constructor should only be used by GLSLMonolithicProgramManager and GLSLSeparableProgramManager. More...
 
virtual ~GLSLProgram ()
 
virtual void activate ()=0
 Makes a program object active by making sure it is linked and then putting it in use. More...
 
virtual void extractLayoutQualifiers ()
 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...
 
GLSLShadergetComputeShader () const
 
GLSLShadergetDomainShader () const
 
GLSLShadergetFragmentShader () const
 
GLSLShadergetGeometryShader () const
 
GLuint getGLProgramHandle () const
 Get the GL Handle for the program object. More...
 
GLSLShadergetHullShader () const
 
GL3PlusOldVertexArrayObjectgetVertexArrayObject ()
 
GLSLShadergetVertexShader () const
 
bool isAttributeValid (VertexElementSemantic semantic, uint index)
 Is a non-standard attribute bound in the linked code? More...
 
bool isSkeletalAnimationIncluded () 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 updateUniforms (GpuProgramParametersSharedPtr params, uint16 mask, GpuProgramType fromProgType)=0
 Updates program object uniforms using data from GpuProgramParameters. More...
 

Public Attributes

GLint mBaseInstanceLocation
 

Detailed Description

C++ encapsulation of GLSL program object.

Constructor & Destructor Documentation

◆ GLSLProgram()

Ogre::GLSLProgram::GLSLProgram ( GLSLShader vertexProgram,
GLSLShader hullProgram,
GLSLShader domainProgram,
GLSLShader geometryProgram,
GLSLShader fragmentProgram,
GLSLShader computeProgram 
)

Constructor should only be used by GLSLMonolithicProgramManager and GLSLSeparableProgramManager.

◆ ~GLSLProgram()

virtual Ogre::GLSLProgram::~GLSLProgram ( )
virtual

Member Function Documentation

◆ activate()

virtual void Ogre::GLSLProgram::activate ( )
pure virtual

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

Implemented in Ogre::GLSLMonolithicProgram.

◆ extractLayoutQualifiers()

virtual void Ogre::GLSLProgram::extractLayoutQualifiers ( )
virtual

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

◆ getAttributeIndex()

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

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

◆ getComputeShader()

GLSLShader* Ogre::GLSLProgram::getComputeShader ( ) const
inline

◆ getDomainShader()

GLSLShader* Ogre::GLSLProgram::getDomainShader ( ) const
inline

◆ getFragmentShader()

GLSLShader* Ogre::GLSLProgram::getFragmentShader ( ) const
inline

◆ getGeometryShader()

GLSLShader* Ogre::GLSLProgram::getGeometryShader ( ) const
inline

◆ getGLProgramHandle()

GLuint Ogre::GLSLProgram::getGLProgramHandle ( ) const
inline

Get the GL Handle for the program object.

◆ getHullShader()

GLSLShader* Ogre::GLSLProgram::getHullShader ( ) const
inline

◆ getVertexArrayObject()

GL3PlusOldVertexArrayObject* Ogre::GLSLProgram::getVertexArrayObject ( )
inline

◆ getVertexShader()

GLSLShader* Ogre::GLSLProgram::getVertexShader ( ) const
inline

◆ isAttributeValid()

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

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

◆ isSkeletalAnimationIncluded()

bool Ogre::GLSLProgram::isSkeletalAnimationIncluded ( ) 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::GLSLProgram::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::GLSLProgram::updatePassIterationUniforms ( GpuProgramParametersSharedPtr  params)
pure virtual

Updates program object uniforms using data from pass iteration GpuProgramParameters.

Normally called by GLSLShader::bindMultiPassParameters() just before multi pass rendering occurs.

Implemented in Ogre::GLSLMonolithicProgram.

◆ updateUniforms()

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

Updates program object uniforms using data from GpuProgramParameters.

Normally called by GLSLShader::bindParameters() just before rendering occurs.

Implemented in Ogre::GLSLMonolithicProgram.

Member Data Documentation

◆ mBaseInstanceLocation

GLint Ogre::GLSLProgram::mBaseInstanceLocation

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