Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Types | Private Attributes | List of all members
Ogre::GLSLLinkProgramManager Class Reference

Ogre assumes that there are separate vertex and fragment programs to deal with but GLSL has one program object that represents the active vertex and fragment shader objects during a rendering state. More...

#include <OgreGLSLLinkProgramManager.h>

Inheritance diagram for Ogre::GLSLLinkProgramManager:
Inheritance graph
[legend]

Public Member Functions

 GLSLLinkProgramManager (void)
 
 ~GLSLLinkProgramManager (void)
 
void extractConstantDefs (const String &src, GpuNamedConstants &constantDefs, const String &filename)
 Populate a list of uniforms based on GLSL ES source. More...
 
void extractUniforms (GLuint programObject, const GpuConstantDefinitionMap *vertexConstantDefs, const GpuConstantDefinitionMap *geometryConstantDefs, const GpuConstantDefinitionMap *fragmentConstantDefs, const GpuConstantDefinitionMap *hullConstantDefs, const GpuConstantDefinitionMap *domainConstantDefs, const GpuConstantDefinitionMap *computeConstantDefs, GLUniformReferenceList &list, GLUniformBufferList &sharedList)
 Populate a list of uniforms based on a program object. More...
 
GLSLLinkProgram * getActiveLinkProgram (void)
 Get the program object that links the two active shader objects together if a program object was not already created and linked a new one is created and linked. More...
 
void setActiveComputeShader (GLSLGpuProgram *computeGpuProgram)
 Set the active compute shader for the next rendering state. More...
 
void setActiveDomainShader (GLSLGpuProgram *domainGpuProgram)
 Set the active domain(evaluation) shader for the next rendering state. More...
 
void setActiveFragmentShader (GLSLGpuProgram *fragmentGpuProgram)
 Set the active fragment shader for the next rendering state. More...
 
void setActiveGeometryShader (GLSLGpuProgram *geometryGpuProgram)
 Set the active geometry shader for the next rendering state. More...
 
void setActiveHullShader (GLSLGpuProgram *hullGpuProgram)
 Set the active hull(control) shader for the next rendering state. More...
 
void setActiveVertexShader (GLSLGpuProgram *vertexGpuProgram)
 Set the active vertex shader for the next rendering state. More...
 

Static Public Member Functions

static GLSLLinkProgramManager & getSingleton (void)
 
static GLSLLinkProgramManager * getSingletonPtr (void)
 

Protected Member Functions

void completeDefInfo (GLenum gltype, GpuConstantDefinition &defToUpdate)
 Use type to complete other information. More...
 
bool completeParamSource (const String &paramName, const GpuConstantDefinitionMap *vertexConstantDefs, const GpuConstantDefinitionMap *geometryConstantDefs, const GpuConstantDefinitionMap *fragmentConstantDefs, const GpuConstantDefinitionMap *hullConstantDefs, const GpuConstantDefinitionMap *domainConstantDefs, const GpuConstantDefinitionMap *computeConstantDefs, GLUniformReference &refToUpdate)
 Find where the data for a specific uniform should come from, populate. More...
 
void parseIndividualConstant (const String &src, GpuNamedConstants &defs, String::size_type currPos, const String &filename, GpuSharedParametersPtr sharedParams)
 

Protected Attributes

GLSLGpuProgram * mActiveComputeGpuProgram
 
GLSLGpuProgram * mActiveDomainGpuProgram
 
GLSLGpuProgram * mActiveFragmentGpuProgram
 
GLSLGpuProgram * mActiveGeometryGpuProgram
 
GLSLGpuProgram * mActiveHullGpuProgram
 
GLSLGpuProgram * mActiveVertexGpuProgram
 Active objects defining the active rendering gpu state. More...
 

Static Protected Attributes

static GLSLLinkProgramManager * msSingleton
 

Private Types

typedef LinkProgramMap::iterator LinkProgramIterator
 
typedef map< uint32,
GLSLLinkProgram * >::type 
LinkProgramMap
 
typedef map< String, GLenum >::type StringToEnumMap
 

Private Attributes

GLSLLinkProgram * mActiveLinkProgram
 active objects defining the active rendering gpu state More...
 
LinkProgramMap mLinkPrograms
 container holding previously created program objects More...
 
StringToEnumMap mTypeEnumMap
 

Detailed Description

Ogre assumes that there are separate vertex and fragment programs to deal with but GLSL has one program object that represents the active vertex and fragment shader objects during a rendering state.

GLSL Vertex and fragment shader objects are compiled separately and then attached to a program object and then the program object is linked. Since Ogre can only handle one vertex program and one fragment program being active in a pass, the GLSL Link Program Manager does the same. The GLSL Link program manager acts as a state machine and activates a program object based on the active vertex and fragment program. Previously created program objects are stored along with a unique key in a hash_map for quick retrieval the next time the program object is required.

Definition at line 53 of file Plus/src/GLSL/include/OgreGLSLLinkProgramManager.h.

Member Typedef Documentation

typedef LinkProgramMap::iterator Ogre::GLSLLinkProgramManager::LinkProgramIterator
private

Constructor & Destructor Documentation

Ogre::GLSLLinkProgramManager::GLSLLinkProgramManager ( void  )
Ogre::GLSLLinkProgramManager::~GLSLLinkProgramManager ( void  )

Member Function Documentation

void Ogre::GLSLProgramManagerCommon::completeDefInfo ( GLenum  gltype,
GpuConstantDefinition &  defToUpdate 
)
protectedinherited

Use type to complete other information.

bool Ogre::GLSLProgramManagerCommon::completeParamSource ( const String &  paramName,
const GpuConstantDefinitionMap *  vertexConstantDefs,
const GpuConstantDefinitionMap *  geometryConstantDefs,
const GpuConstantDefinitionMap *  fragmentConstantDefs,
const GpuConstantDefinitionMap *  hullConstantDefs,
const GpuConstantDefinitionMap *  domainConstantDefs,
const GpuConstantDefinitionMap *  computeConstantDefs,
GLUniformReference &  refToUpdate 
)
protectedinherited

Find where the data for a specific uniform should come from, populate.

void Ogre::GLSLProgramManagerCommon::extractConstantDefs ( const String &  src,
GpuNamedConstants &  constantDefs,
const String &  filename 
)
inherited

Populate a list of uniforms based on GLSL ES source.

Parameters
srcReference to the source code
constantDefsThe defs to populate (will not be cleared before adding, clear it yourself before calling this if that's what you want).
filenameThe file name this came from, for logging errors.
void Ogre::GLSLProgramManagerCommon::extractUniforms ( GLuint  programObject,
const GpuConstantDefinitionMap *  vertexConstantDefs,
const GpuConstantDefinitionMap *  geometryConstantDefs,
const GpuConstantDefinitionMap *  fragmentConstantDefs,
const GpuConstantDefinitionMap *  hullConstantDefs,
const GpuConstantDefinitionMap *  domainConstantDefs,
const GpuConstantDefinitionMap *  computeConstantDefs,
GLUniformReferenceList &  list,
GLUniformBufferList &  sharedList 
)
inherited

Populate a list of uniforms based on a program object.

Parameters
programObjectHandle to the program object to query
vertexConstantDefsDefinition of the constants extracted from the vertex program, used to match up physical buffer indexes with program uniforms. May be null if there is no vertex program.
fragmentConstantDefsDefinition of the constants extracted from the fragment program, used to match up physical buffer indexes with program uniforms. May be null if there is no fragment program.
listThe list to populate (will not be cleared before adding, clear it yourself before calling this if that's what you want).
GLSLLinkProgram* Ogre::GLSLLinkProgramManager::getActiveLinkProgram ( void  )

Get the program object that links the two active shader objects together if a program object was not already created and linked a new one is created and linked.

static GLSLLinkProgramManager& Ogre::GLSLLinkProgramManager::getSingleton ( void  )
static
static GLSLLinkProgramManager* Ogre::GLSLLinkProgramManager::getSingletonPtr ( void  )
static
void Ogre::GLSLProgramManagerCommon::parseIndividualConstant ( const String &  src,
GpuNamedConstants &  defs,
String::size_type  currPos,
const String &  filename,
GpuSharedParametersPtr  sharedParams 
)
protectedinherited
void Ogre::GLSLLinkProgramManager::setActiveComputeShader ( GLSLGpuProgram *  computeGpuProgram)

Set the active compute shader for the next rendering state.

The active program object will be cleared. Normally called from the GLSLGpuProgram::bindProgram and unbindProgram methods

void Ogre::GLSLLinkProgramManager::setActiveDomainShader ( GLSLGpuProgram *  domainGpuProgram)

Set the active domain(evaluation) shader for the next rendering state.

The active program object will be cleared. Normally called from the GLSLGpuProgram::bindProgram and unbindProgram methods

void Ogre::GLSLLinkProgramManager::setActiveFragmentShader ( GLSLGpuProgram *  fragmentGpuProgram)

Set the active fragment shader for the next rendering state.

The active program object will be cleared. Normally called from the GLSLGpuProgram::bindProgram and unbindProgram methods

void Ogre::GLSLLinkProgramManager::setActiveGeometryShader ( GLSLGpuProgram *  geometryGpuProgram)

Set the active geometry shader for the next rendering state.

The active program object will be cleared. Normally called from the GLSLGpuProgram::bindProgram and unbindProgram methods

void Ogre::GLSLLinkProgramManager::setActiveHullShader ( GLSLGpuProgram *  hullGpuProgram)

Set the active hull(control) shader for the next rendering state.

The active program object will be cleared. Normally called from the GLSLGpuProgram::bindProgram and unbindProgram methods

void Ogre::GLSLLinkProgramManager::setActiveVertexShader ( GLSLGpuProgram *  vertexGpuProgram)

Set the active vertex shader for the next rendering state.

The active program object will be cleared. Normally called from the GLSLGpuProgram::bindProgram and unbindProgram methods

Member Data Documentation

GLSLGpuProgram* Ogre::GLSLProgramManagerCommon::mActiveComputeGpuProgram
protectedinherited

Definition at line 58 of file OgreGLSLProgramManagerCommon.h.

GLSLGpuProgram* Ogre::GLSLProgramManagerCommon::mActiveDomainGpuProgram
protectedinherited

Definition at line 57 of file OgreGLSLProgramManagerCommon.h.

GLSLGpuProgram* Ogre::GLSLProgramManagerCommon::mActiveFragmentGpuProgram
protectedinherited

Definition at line 55 of file OgreGLSLProgramManagerCommon.h.

GLSLGpuProgram* Ogre::GLSLProgramManagerCommon::mActiveGeometryGpuProgram
protectedinherited

Definition at line 54 of file OgreGLSLProgramManagerCommon.h.

GLSLGpuProgram* Ogre::GLSLProgramManagerCommon::mActiveHullGpuProgram
protectedinherited

Definition at line 56 of file OgreGLSLProgramManagerCommon.h.

GLSLLinkProgram* Ogre::GLSLLinkProgramManager::mActiveLinkProgram
private

active objects defining the active rendering gpu state

Definition at line 65 of file Plus/src/GLSL/include/OgreGLSLLinkProgramManager.h.

GLSLGpuProgram* Ogre::GLSLProgramManagerCommon::mActiveVertexGpuProgram
protectedinherited

Active objects defining the active rendering gpu state.

Definition at line 53 of file OgreGLSLProgramManagerCommon.h.

LinkProgramMap Ogre::GLSLLinkProgramManager::mLinkPrograms
private

container holding previously created program objects

Definition at line 62 of file Plus/src/GLSL/include/OgreGLSLLinkProgramManager.h.

GLSLLinkProgramManager * Ogre::Singleton< GLSLLinkProgramManager >::msSingleton
staticprotectedinherited

Definition at line 75 of file OgreSingleton.h.

StringToEnumMap Ogre::GLSLLinkProgramManager::mTypeEnumMap
private

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

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Tue Mar 18 2014 19:15:43