OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::GLSLProgramPipelineManager Class Reference

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

#include <OgreGLSLProgramPipelineManager.h>

+ Inheritance diagram for Ogre::GLSLProgramPipelineManager:
+ Collaboration diagram for Ogre::GLSLProgramPipelineManager:

Public Member Functions

 GLSLProgramPipelineManager (void)
 
 ~GLSLProgramPipelineManager (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...
 
GLSLProgramPipelinegetActiveProgramPipeline (void)
 Get the program object that links the two active program objects together. More...
 
void setActiveComputeLinkProgram (GLSLGpuProgram *computGpuProgram)
 
void setActiveFragmentLinkProgram (GLSLGpuProgram *fragmentGpuProgram)
 
void setActiveGeometryLinkProgram (GLSLGpuProgram *geometryGpuProgram)
 
void setActiveTessDomainLinkProgram (GLSLGpuProgram *domainGpuProgram)
 
void setActiveTessHullLinkProgram (GLSLGpuProgram *hullGpuProgram)
 
void setActiveVertexLinkProgram (GLSLGpuProgram *vertexGpuProgram)
 Set the active vertex and fragment link programs for the next rendering state. More...
 

Static Public Member Functions

static GLSLProgramPipelineManagergetSingleton (void)
 
static GLSLProgramPipelineManagergetSingletonPtr (void)
 

Protected Types

typedef map< String, GLenum >::type StringToEnumMap
 

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

GLSLGpuProgrammActiveComputeGpuProgram
 
GLSLGpuProgrammActiveDomainGpuProgram
 
GLSLGpuProgrammActiveFragmentGpuProgram
 
GLSLGpuProgrammActiveGeometryGpuProgram
 
GLSLGpuProgrammActiveHullGpuProgram
 
GLSLGpuProgrammActiveVertexGpuProgram
 Active objects defining the active rendering gpu state. More...
 
StringToEnumMap mTypeEnumMap
 

Static Protected Attributes

static GLSLProgramPipelineManagermsSingleton
 

Private Types

typedef
ProgramPipelineMap::iterator 
ProgramPipelineIterator
 
typedef map< uint32,
GLSLProgramPipeline * >::type 
ProgramPipelineMap
 

Private Attributes

GLSLProgramPipelinemActiveProgramPipeline
 Active objects defining the active rendering gpu state. More...
 
ProgramPipelineMap mProgramPipelines
 Container holding previously created program pipeline objects. More...
 

Detailed Description

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

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

Definition at line 48 of file OgreGLSLProgramPipelineManager.h.

Member Typedef Documentation

typedef ProgramPipelineMap::iterator Ogre::GLSLProgramPipelineManager::ProgramPipelineIterator
private

Definition at line 53 of file OgreGLSLProgramPipelineManager.h.

typedef map<String, GLenum>::type Ogre::GLSLProgramManagerCommon::StringToEnumMap
protectedinherited

Definition at line 60 of file OgreGLSLProgramManagerCommon.h.

Constructor & Destructor Documentation

Ogre::GLSLProgramPipelineManager::GLSLProgramPipelineManager ( void  )
Ogre::GLSLProgramPipelineManager::~GLSLProgramPipelineManager ( 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).
GLSLProgramPipeline* Ogre::GLSLProgramPipelineManager::getActiveProgramPipeline ( void  )

Get the program object that links the two active program objects together.

If a program pipeline object was not already created and linked a new one is created and linked.

static GLSLProgramPipelineManager& Ogre::GLSLProgramPipelineManager::getSingleton ( void  )
static
static GLSLProgramPipelineManager* Ogre::GLSLProgramPipelineManager::getSingletonPtr ( void  )
static
void Ogre::GLSLProgramManagerCommon::parseIndividualConstant ( const String src,
GpuNamedConstants defs,
String::size_type  currPos,
const String filename,
GpuSharedParametersPtr  sharedParams 
)
protectedinherited
void Ogre::GLSLProgramPipelineManager::setActiveComputeLinkProgram ( GLSLGpuProgram computGpuProgram)
void Ogre::GLSLProgramPipelineManager::setActiveFragmentLinkProgram ( GLSLGpuProgram fragmentGpuProgram)
void Ogre::GLSLProgramPipelineManager::setActiveGeometryLinkProgram ( GLSLGpuProgram geometryGpuProgram)
void Ogre::GLSLProgramPipelineManager::setActiveTessDomainLinkProgram ( GLSLGpuProgram domainGpuProgram)
void Ogre::GLSLProgramPipelineManager::setActiveTessHullLinkProgram ( GLSLGpuProgram hullGpuProgram)
void Ogre::GLSLProgramPipelineManager::setActiveVertexLinkProgram ( GLSLGpuProgram vertexGpuProgram)

Set the active vertex and fragment link programs for the next rendering state.

The active program pipeline 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.

GLSLProgramPipeline* Ogre::GLSLProgramPipelineManager::mActiveProgramPipeline
private

Active objects defining the active rendering gpu state.

Definition at line 59 of file OgreGLSLProgramPipelineManager.h.

GLSLGpuProgram* Ogre::GLSLProgramManagerCommon::mActiveVertexGpuProgram
protectedinherited

Active objects defining the active rendering gpu state.

Definition at line 53 of file OgreGLSLProgramManagerCommon.h.

ProgramPipelineMap Ogre::GLSLProgramPipelineManager::mProgramPipelines
private

Container holding previously created program pipeline objects.

Definition at line 56 of file OgreGLSLProgramPipelineManager.h.

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

Definition at line 75 of file OgreSingleton.h.

StringToEnumMap Ogre::GLSLProgramManagerCommon::mTypeEnumMap
protectedinherited

Definition at line 61 of file OgreGLSLProgramManagerCommon.h.


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