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

Specialisation of GLSLProgram to provide support for separable programs via the OpenGL program pipeline. More...

#include <OgreGLSLSeparableProgram.h>

+ Inheritance diagram for Ogre::GLSLSeparableProgram:

Public Member Functions

 GLSLSeparableProgram (GLSLShader *vertexShader, GLSLShader *hullShader, GLSLShader *domainShader, GLSLShader *geometryShader, GLSLShader *fragmentShader, GLSLShader *computeShader)
 Constructor should only be used by GLSLSeparableProgramManager. More...
 
 ~GLSLSeparableProgram ()
 
void activate (void)
 Makes a program pipeline object active by making sure it is linked and then putting it in use. More...
 
void attachChildShader (const String &name)
 Attach another GLSL Shader to this one. More...
 
void attachToProgramObject (const GLuint programObject)
 
bool compile (const bool checkErrors=false)
 Compile source into shader object. More...
 
GpuProgramParametersSharedPtr createParameters (void)
 Overridden from GpuProgram. More...
 
void detachFromProgramObject (const GLuint programObject)
 
virtual void extractLayoutQualifiers (void)
 Finds layout qualifiers in the shader source and sets attribute indices appropriately. More...
 
String getAttachedShaderNames () const
 
GLint getAttributeIndex (VertexElementSemantic semantic, uint index)
 Get the index of a non-standard attribute bound in the linked code. More...
 
bool getColumnMajorMatrices (void) const
 Gets whether matrix packed in column-major order. More...
 
GLSLShadergetComputeShader () const
 
GLSLShadergetDomainShader () const
 
GLSLShadergetFragmentShader () const
 
GLSLShadergetGeometryShader () const
 
GLuint getGLProgramHandle () const
 
GLuint getGLProgramHandle (void) const
 Get the GL Handle for the program object. More...
 
GLuint getGLProgramPipelineHandle () const
 GL Program Pipeline Handle. More...
 
GLuint getGLShaderHandle () const
 
GLSLShadergetHullShader () const
 
virtual RenderOperation::OperationType getInputOperationType (void) const
 Returns the operation type that this geometry program expects to receive as input. More...
 
const StringgetLanguage (void) const
 Overridden from GpuProgram. More...
 
virtual int getMaxOutputVertices (void) const
 Returns the maximum number of vertices that this geometry program can output in a single run. More...
 
virtual RenderOperation::OperationType getOutputOperationType (void) const
 Returns the operation type that this geometry program will emit. More...
 
bool getPassFogStates (void) const
 
bool getPassSurfaceAndLightStates (void) const
 
bool getPassTransformStates (void) const
 Overridden. More...
 
const StringgetPreprocessorDefines (void) const
 Sets the preprocessor defines use to compile the program. More...
 
GL3PlusOldVertexArrayObjectgetVertexArrayObject ()
 
GLSLShadergetVertexShader () 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 setColumnMajorMatrices (bool columnMajor)
 Sets whether matrix packing in column-major order. More...
 
virtual void setInputOperationType (RenderOperation::OperationType operationType)
 Sets the operation type that this geometry program expects to receive. More...
 
virtual void setMaxOutputVertices (int maxOutputVertices)
 Set the maximum number of vertices that a single run of this geometry program can emit. More...
 
virtual void setOutputOperationType (RenderOperation::OperationType operationType)
 Set the operation type that this geometry program will emit. More...
 
void setPreprocessorDefines (const String &defines)
 Sets the preprocessor defines use to compile the program. More...
 
void setSkeletalAnimationIncluded (bool included)
 Sets whether the linked program includes the required instructions to perform skeletal animation. More...
 
void updateAtomicCounters (GpuProgramParametersSharedPtr params, uint16 mask, GpuProgramType fromProgType)
 Updates program object atomic counter buffers using data from GpuProgramParameters. More...
 
void updatePassIterationUniforms (GpuProgramParametersSharedPtr params)
 Updates program pipeline object uniforms using data from pass iteration GpuProgramParameters. More...
 
void updateUniformBlocks (GpuProgramParametersSharedPtr params, uint16 mask, GpuProgramType fromProgType)
 Updates program object uniform blocks using shared parameter data from GpuProgramParameters. More...
 
void updateUniforms (GpuProgramParametersSharedPtr params, uint16 mask, GpuProgramType fromProgType)
 Updates program pipeline object uniforms using named and indexed parameter data from GpuProgramParameters. More...
 

Public Attributes

GLint mBaseInstanceLocation
 

Detailed Description

Specialisation of GLSLProgram to provide support for separable programs via the OpenGL program pipeline.

Separable programs consist of shader objects which have been individually linked. This allows for invidual shaders in a program pipeline to be swapped without recompiling the program object, as would be necessary with monolithic programs. This is especially useful in the common case of only entities which change only a few of the shaders in the pipeline while leaving the rest the same.

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 GLSLSeparableProgram will create a GL3PlusShader 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 supportsn 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

◆ GLSLSeparableProgram()

Ogre::GLSLSeparableProgram::GLSLSeparableProgram ( GLSLShader vertexShader,
GLSLShader hullShader,
GLSLShader domainShader,
GLSLShader geometryShader,
GLSLShader fragmentShader,
GLSLShader computeShader 
)

Constructor should only be used by GLSLSeparableProgramManager.

◆ ~GLSLSeparableProgram()

Ogre::GLSLSeparableProgram::~GLSLSeparableProgram ( )

Member Function Documentation

◆ activate()

void Ogre::GLSLSeparableProgram::activate ( void  )
virtual

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

Implements Ogre::GLSLProgram.

◆ attachChildShader()

void Ogre::GLSLProgram::attachChildShader ( const String name)
inherited

Attach another GLSL Shader to this one.

◆ attachToProgramObject()

void Ogre::GLSLProgram::attachToProgramObject ( const GLuint  programObject)
inherited

◆ compile()

bool Ogre::GLSLProgram::compile ( const bool  checkErrors = false)
inherited

Compile source into shader object.

◆ createParameters()

GpuProgramParametersSharedPtr Ogre::GLSLProgram::createParameters ( void  )
inherited

Overridden from GpuProgram.

◆ detachFromProgramObject()

void Ogre::GLSLProgram::detachFromProgramObject ( const GLuint  programObject)
inherited

◆ extractLayoutQualifiers()

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

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

◆ getAttachedShaderNames()

String Ogre::GLSLProgram::getAttachedShaderNames ( ) const
inlineinherited

◆ getAttributeIndex()

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

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

Reimplemented from Ogre::GLSLProgram.

◆ getColumnMajorMatrices()

bool Ogre::GLSLProgram::getColumnMajorMatrices ( void  ) const
inlineinherited

Gets whether matrix packed in column-major order.

◆ getComputeShader()

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

◆ getDomainShader()

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

◆ getFragmentShader()

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

◆ getGeometryShader()

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

◆ getGLProgramHandle() [1/2]

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

◆ getGLProgramHandle() [2/2]

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

Get the GL Handle for the program object.

◆ getGLProgramPipelineHandle()

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

GL Program Pipeline Handle.

◆ getGLShaderHandle()

GLuint Ogre::GLSLProgram::getGLShaderHandle ( ) const
inlineinherited

◆ getHullShader()

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

◆ getInputOperationType()

virtual RenderOperation::OperationType Ogre::GLSLProgram::getInputOperationType ( void  ) const
inlinevirtualinherited

Returns the operation type that this geometry program expects to receive as input.

◆ getLanguage()

const String& Ogre::GLSLProgram::getLanguage ( void  ) const
inherited

Overridden from GpuProgram.

◆ getMaxOutputVertices()

virtual int Ogre::GLSLProgram::getMaxOutputVertices ( void  ) const
inlinevirtualinherited

Returns the maximum number of vertices that this geometry program can output in a single run.

◆ getOutputOperationType()

virtual RenderOperation::OperationType Ogre::GLSLProgram::getOutputOperationType ( void  ) const
inlinevirtualinherited

Returns the operation type that this geometry program will emit.

◆ getPassFogStates()

bool Ogre::GLSLProgram::getPassFogStates ( void  ) const
inherited

◆ getPassSurfaceAndLightStates()

bool Ogre::GLSLProgram::getPassSurfaceAndLightStates ( void  ) const
inherited

◆ getPassTransformStates()

bool Ogre::GLSLProgram::getPassTransformStates ( void  ) const
inherited

Overridden.

◆ getPreprocessorDefines()

const String& Ogre::GLSLProgram::getPreprocessorDefines ( void  ) const
inlineinherited

Sets the preprocessor defines use to compile the program.

◆ getVertexArrayObject()

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

◆ getVertexShader()

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

◆ isAttributeValid()

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

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

◆ isSkeletalAnimationIncluded()

bool Ogre::GLSLProgram::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.

◆ setColumnMajorMatrices()

void Ogre::GLSLProgram::setColumnMajorMatrices ( bool  columnMajor)
inlineinherited

Sets whether matrix packing in column-major order.

◆ setInputOperationType()

virtual void Ogre::GLSLProgram::setInputOperationType ( RenderOperation::OperationType  operationType)
inlinevirtualinherited

Sets the operation type that this geometry program expects to receive.

◆ setMaxOutputVertices()

virtual void Ogre::GLSLProgram::setMaxOutputVertices ( int  maxOutputVertices)
inlinevirtualinherited

Set the maximum number of vertices that a single run of this geometry program can emit.

◆ setOutputOperationType()

virtual void Ogre::GLSLProgram::setOutputOperationType ( RenderOperation::OperationType  operationType)
inlinevirtualinherited

Set the operation type that this geometry program will emit.

◆ setPreprocessorDefines()

void Ogre::GLSLProgram::setPreprocessorDefines ( const String defines)
inlineinherited

Sets the preprocessor defines use to compile the program.

◆ setSkeletalAnimationIncluded()

void Ogre::GLSLProgram::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.

◆ updateAtomicCounters()

void Ogre::GLSLSeparableProgram::updateAtomicCounters ( GpuProgramParametersSharedPtr  params,
uint16  mask,
GpuProgramType  fromProgType 
)

Updates program object atomic counter buffers using data from GpuProgramParameters.

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

◆ updatePassIterationUniforms()

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

Updates program pipeline object uniforms using data from pass iteration GpuProgramParameters.

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

Implements Ogre::GLSLProgram.

◆ updateUniformBlocks()

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

Updates program object uniform blocks using shared parameter data from GpuProgramParameters.

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

Implements Ogre::GLSLProgram.

◆ updateUniforms()

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

Updates program pipeline object uniforms using named and indexed parameter data from GpuProgramParameters.

normally called by GLSLShader::bindProgramParameters() just before rendering occurs.

Implements Ogre::GLSLProgram.

Member Data Documentation

◆ mBaseInstanceLocation

GLint Ogre::GLSLProgram::mBaseInstanceLocation
inherited

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