| OGRE 1.10.8 Object-Oriented Graphics Rendering Engine

Public Member Functions | List of all members
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:
[legend]

## 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 | bindFixedAttributes (GLuint program)
GLSLShader * | getComputeShader () const
GLSLShader * | getDomainShader () const
GLSLShader * | getFragmentShader () const
GLSLShader * | getGeometryShader () const
GLuint | getGLProgramPipelineHandle () const
| GL Program Pipeline Handle. More...
GLSLShader * | getHullShader () const
GLSLShader * | getVertexShader () const
void | setTransformFeedbackVaryings (const std::vector< String > &nameStrings)
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...

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

## ◆ getGLProgramPipelineHandle()

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

GL Program Pipeline Handle.

## ◆ updateUniforms()

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

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

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

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

## ◆ updateUniformBlocks()

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

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

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

## ◆ updatePassIterationUniforms()

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

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

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

## ◆ activate()

void Ogre::GLSLSeparableProgram::activate | ( | void |  | ) |

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

## ◆ bindFixedAttributes()

void Ogre::GLSLProgram::bindFixedAttributes | ( | GLuint | program | ) |
| inherited

## ◆ getVertexShader()

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

## ◆ getHullShader()

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

## ◆ getDomainShader()

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

## ◆ getGeometryShader()

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

## ◆ getFragmentShader()

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

## ◆ getComputeShader()

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

## ◆ setTransformFeedbackVaryings()

void Ogre::GLSLProgram::setTransformFeedbackVaryings | ( | const std::vector< String > & | nameStrings | ) |
| inherited

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

- OgreGLSLSeparableProgram.h