Ogre::RTShader::ProgramManager Class Reference

A singleton manager class that manages shader based programs. More...

#include <OgreShaderProgramManager.h>

Inheritance diagram for Ogre::RTShader::ProgramManager:

Public Member Functions
	ProgramManager ()
	Class default constructor.
	~ProgramManager ()
	Class destructor.
void	acquirePrograms (Pass *pass, TargetRenderState *renderState)
	Acquire CPU/GPU programs set associated with the given render state and bind them to the pass.
void	flushGpuProgramsCache ()
	Flush the local GPU programs cache.
void	releasePrograms (Pass *pass, TargetRenderState *renderState)
	Release CPU/GPU programs set associated with the given render state and pass.

Static Public Member Functions
static ProgramManager &	getSingleton ()
	Override standard Singleton retrieval.
static ProgramManager *	getSingletonPtr ()
	Get the singleton instance.

Friends
class	ProgramSet
class	ShaderGenerator
class	TargetRenderState

Detailed Description

A singleton manager class that manages shader based programs.

Constructor & Destructor Documentation

ProgramManager()

Ogre::RTShader::ProgramManager::ProgramManager

(

)

Class default constructor.

~ProgramManager()

Ogre::RTShader::ProgramManager::~ProgramManager

(

)

Class destructor.

Member Function Documentation

getSingleton()

static ProgramManager & Ogre::RTShader::ProgramManager::getSingleton ( )

static

Override standard Singleton retrieval.

Remarks

Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

getSingletonPtr()

static ProgramManager * Ogre::RTShader::ProgramManager::getSingletonPtr ( )

static

Get the singleton instance.

acquirePrograms()

void Ogre::RTShader::ProgramManager::acquirePrograms	(	Pass *	pass,
		TargetRenderState *	renderState
	)

Acquire CPU/GPU programs set associated with the given render state and bind them to the pass.

Parameters

pass	The pass to bind the programs to.
renderState	The render state that describes the program that need to be generated.

releasePrograms()

void Ogre::RTShader::ProgramManager::releasePrograms	(	Pass *	pass,
		TargetRenderState *	renderState
	)

Release CPU/GPU programs set associated with the given render state and pass.

Parameters

pass	The pass to release the programs from.
renderState	The render state holds the programs.

flushGpuProgramsCache()

void Ogre::RTShader::ProgramManager::flushGpuProgramsCache

(

)

Flush the local GPU programs cache.

Friends And Related Function Documentation

ProgramSet

friend class ProgramSet

friend

TargetRenderState

friend class TargetRenderState

friend

ShaderGenerator

friend class ShaderGenerator

friend

---

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

• OgreShaderProgramManager.h