OGRE  master
Object-Oriented Graphics Rendering Engine
Ogre::GpuProgramManager Class Reference

This ResourceManager manages GPU shader programs. More...

#include <OgreGpuProgramManager.h>

+ Inheritance diagram for Ogre::GpuProgramManager:

Public Types

typedef MemoryDataStreamPtr Microcode
 
typedef std::map< String, GpuSharedParametersPtrSharedParametersMap
 
typedef std::set< StringSyntaxCodes
 
- Public Types inherited from Ogre::ResourceManager
typedef std::pair< ResourcePtr, bool > ResourceCreateOrRetrieveResult
 
typedef std::map< ResourceHandle, ResourcePtrResourceHandleMap
 
typedef std::unordered_map< String, ResourcePtrResourceMap
 
typedef MapIterator< ResourceHandleMapResourceMapIterator
 
typedef std::unordered_map< String, ResourceMapResourceWithGroupMap
 

Public Member Functions

 GpuProgramManager ()
 
virtual ~GpuProgramManager ()
 
void addFactory (GpuProgramFactory *factory)
 Add a new factory object for programs of a given language. More...
 
void addMicrocodeToCache (uint32 id, const Microcode &microcode)
 Adds a microcode for a program to the microcode cache. More...
 
GpuProgramPtr create (const String &name, const String &group, GpuProgramType gptype, const String &language, bool isManual=false, ManualResourceLoader *loader=0)
 General create method, using specific create parameters instead of name / value pairs. More...
 
virtual GpuProgramPtr createProgram (const String &name, const String &groupName, const String &filename, GpuProgramType gptype, const String &syntaxCode)
 Create a new, unloaded GpuProgram from a file of assembly. More...
 
GpuProgramPtr createProgram (const String &name, const String &groupName, const String &language, GpuProgramType gptype)
 Create a new, unloaded GpuProgram. More...
 
virtual GpuProgramPtr createProgramFromString (const String &name, const String &groupName, const String &code, GpuProgramType gptype, const String &syntaxCode)
 Create a GPU program from a string of assembly code. More...
 
virtual GpuSharedParametersPtr createSharedParameters (const String &name)
 Create a new set of shared parameters, which can be used across many GpuProgramParameters objects of different structures. More...
 
virtual const SharedParametersMapgetAvailableSharedParameters () const
 Get (const) access to the available shared parameter sets. More...
 
GpuProgramPtr getByName (const String &name, const String &group=RGN_DEFAULT) const
 Get a GPU Program by name. More...
 
GpuProgramPtr getByName (const String &name, const String &group, bool preferHighLevelPrograms) const
 
const MicrocodegetMicrocodeFromCache (uint32 id) const
 Returns a microcode for a program from the microcode cache. More...
 
bool getSaveMicrocodesToCache () const
 Get if the microcode of a shader should be saved to a cache. More...
 
virtual GpuSharedParametersPtr getSharedParameters (const String &name) const
 Retrieve a set of shared parameters, which can be used across many GpuProgramParameters objects of different structures. More...
 
bool isCacheDirty (void) const
 Returns true if the microcodecache changed during the run. More...
 
bool isLanguageSupported (const String &lang) const
 Returns whether a given high-level language (e.g. More...
 
bool isMicrocodeAvailableInCache (uint32 id) const
 Check if a microcode is available for a program in the microcode cache. More...
 
virtual GpuProgramPtr load (const String &name, const String &groupName, const String &filename, GpuProgramType gptype, const String &syntaxCode)
 Loads a GPU program from a file. More...
 
virtual GpuProgramPtr loadFromString (const String &name, const String &groupName, const String &code, GpuProgramType gptype, const String &syntaxCode)
 Loads a GPU program from a string. More...
 
void loadMicrocodeCache (const DataStreamPtr &stream)
 Loads the microcode cache from disk. More...
 
void removeFactory (GpuProgramFactory *factory)
 Remove a factory object for programs of a given language. More...
 
void removeMicrocodeFromCache (uint32 id)
 Removes a microcode for a program from the microcode cache. More...
 
void saveMicrocodeCache (const DataStreamPtr &stream) const
 Saves the microcode cache to disk. More...
 
void setSaveMicrocodesToCache (bool val)
 Set if the microcode of a shader should be saved to a cache. More...
 
- Public Member Functions inherited from Ogre::ResourceManager
 ResourceManager ()
 
virtual ~ResourceManager ()
 
virtual void _notifyResourceLoaded (Resource *res)
 Notify this manager that a resource which it manages has been loaded. More...
 
virtual void _notifyResourceTouched (Resource *res)
 Notify this manager that a resource which it manages has been 'touched', i.e. More...
 
virtual void _notifyResourceUnloaded (Resource *res)
 Notify this manager that a resource which it manages has been unloaded. More...
 
ResourceCreateOrRetrieveResult createOrRetrieve (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
 Create a new resource, or retrieve an existing one with the same name if it already exists. More...
 
ResourcePtr createResource (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
 Creates a new blank resource, but does not immediately load it. More...
 
void destroyAllResourcePools ()
 destroy all pools More...
 
void destroyResourcePool (ResourcePool *pool)
 Destroy a resource pool. More...
 
void destroyResourcePool (const String &name)
 Destroy a resource pool. More...
 
virtual ResourcePtr getByHandle (ResourceHandle handle) const
 Retrieves a pointer to a resource by handle, or null if the resource does not exist. More...
 
Real getLoadingOrder (void) const override
 Gets the loading order for scripts of this type. More...
 
size_t getMemoryBudget (void) const
 Get the limit on the amount of memory this resource handler may use. More...
 
size_t getMemoryUsage (void) const
 Gets the current memory usage, in bytes. More...
 
virtual ResourcePtr getResourceByName (const String &name, const String &groupName=RGN_DEFAULT) const
 Retrieves a pointer to a resource by name, or null if the resource does not exist. More...
 
ResourceMapIterator getResourceIterator (void)
 Returns an iterator over all resources in this manager. More...
 
ResourcePoolgetResourcePool (const String &name)
 Create a resource pool, or reuse one that already exists. More...
 
const StringgetResourceType (void) const
 Gets a string identifying the type of resource this manager handles. More...
 
const StringVectorgetScriptPatterns (void) const override
 Gets the file patterns which should be used to find scripts for this class. More...
 
bool getVerbose (void)
 Gets whether this manager and its resources habitually produce log output. More...
 
ResourcePtr load (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, bool backgroundThread=false)
 Generic load method, used to create a Resource specific to this ResourceManager without using one of the specialised 'load' methods (containing per-Resource-type parameters). More...
 
void parseScript (DataStreamPtr &stream, const String &groupName) override
 Parse a script file. More...
 
ResourcePtr prepare (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, bool backgroundThread=false)
 Generic prepare method, used to create a Resource specific to this ResourceManager without using one of the specialised 'prepare' methods (containing per-Resource-type parameters). More...
 
void reloadAll (bool reloadableOnly=true)
 Caused all currently loaded resources to be reloaded. More...
 
virtual void reloadAll (Resource::LoadingFlags flags)
 Caused all currently loaded resources to be reloaded. More...
 
void reloadUnreferencedResources (bool reloadableOnly=true)
 Caused all currently loaded but not referenced by any other object resources to be reloaded. More...
 
void remove (const ResourcePtr &r)
 Remove a single resource. More...
 
void remove (const String &name, const String &group=RGN_DEFAULT)
 
void remove (ResourceHandle handle)
 
virtual void removeAll (void)
 Removes all resources. More...
 
virtual void removeUnreferencedResources (bool reloadableOnly=true)
 Remove all resources which are not referenced by any other object. More...
 
bool resourceExists (const String &name, const String &group=RGN_DEFAULT) const
 Returns whether the named resource exists in this manager. More...
 
bool resourceExists (ResourceHandle handle) const
 Returns whether a resource with the given handle exists in this manager. More...
 
void setMemoryBudget (size_t bytes)
 Set a limit on the amount of memory this resource handler may use. More...
 
void setVerbose (bool v)
 Sets whether this manager and its resources habitually produce log output. More...
 
void unload (const String &name, const String &group=RGN_DEFAULT)
 Unloads a single resource by name. More...
 
void unload (ResourceHandle handle)
 Unloads a single resource by handle. More...
 
void unloadAll (bool reloadableOnly=true)
 Unloads all resources. More...
 
virtual void unloadAll (Resource::LoadingFlags flags)
 Unloads all resources. More...
 
void unloadUnreferencedResources (bool reloadableOnly=true)
 Unload all resources which are not referenced by any other object. More...
 
- Public Member Functions inherited from Ogre::ScriptLoader
virtual ~ScriptLoader ()
 
- Public Member Functions inherited from Ogre::Singleton< GpuProgramManager >
 Singleton (void)
 
 ~Singleton (void)
 

Static Public Member Functions

static bool canGetCompiledShaderBuffer ()
 
static Microcode createMicrocode (size_t size)
 Creates a microcode to be later added to the cache. More...
 
static GpuProgramParametersPtr createParameters (void)
 Creates a new GpuProgramParameters instance which can be used to bind parameters to your programs. More...
 
static GpuProgramManagergetSingleton (void)
 Get the singleton instance. More...
 
static GpuProgramManagergetSingletonPtr (void)
 Get the singleton instance. More...
 
static const SyntaxCodesgetSupportedSyntax (void)
 Returns the syntaxes that the RenderSystem supports. More...
 
static bool isSyntaxSupported (const String &syntaxCode)
 Returns whether a given syntax code (e.g. More...
 
- Static Public Member Functions inherited from Ogre::Singleton< GpuProgramManager >
static GpuProgramManagergetSingleton (void)
 Get the singleton instance. More...
 
static GpuProgramManagergetSingletonPtr (void)
 Get the singleton instance. More...
 

Detailed Description

This ResourceManager manages GPU shader programs.

This class not only manages the programs themselves, it also manages the factory classes which allow the creation of programs using a variety of syntaxes. Plugins can be created which register themselves as program factories and as such the engine can be extended to accept virtually any kind of program provided a plugin is written.

Member Typedef Documentation

◆ SyntaxCodes

◆ SharedParametersMap

◆ Microcode

Constructor & Destructor Documentation

◆ GpuProgramManager()

Ogre::GpuProgramManager::GpuProgramManager ( )

◆ ~GpuProgramManager()

virtual Ogre::GpuProgramManager::~GpuProgramManager ( )
virtual

Member Function Documentation

◆ getByName() [1/2]

GpuProgramPtr Ogre::GpuProgramManager::getByName ( const String name,
const String group = RGN_DEFAULT 
) const

Get a GPU Program by name.

For example, a GPU Program defined in some .program file.

See also
GpuProgramManager::getResourceByName

◆ getByName() [2/2]

GpuProgramPtr Ogre::GpuProgramManager::getByName ( const String name,
const String group,
bool  preferHighLevelPrograms 
) const
inline
Deprecated:
preferHighLevelPrograms has no effect

◆ load()

virtual GpuProgramPtr Ogre::GpuProgramManager::load ( const String name,
const String groupName,
const String filename,
GpuProgramType  gptype,
const String syntaxCode 
)
virtual

Loads a GPU program from a file.

This method creates a new program of the type specified as the second parameter. As with all types of ResourceManager, this class will search for the file in all resource locations it has been configured to look in.

Parameters
nameThe name of the GpuProgram
groupNameThe name of the resource group
filenameThe file to load
gptypeThe type of program to create
syntaxCodeThe name of the syntax to be used for this program e.g. arbvp1, vs_1_1

◆ loadFromString()

virtual GpuProgramPtr Ogre::GpuProgramManager::loadFromString ( const String name,
const String groupName,
const String code,
GpuProgramType  gptype,
const String syntaxCode 
)
virtual

Loads a GPU program from a string.

The assembly code must be compatible with this manager - call the getSupportedSyntax method for details of the supported syntaxes

Parameters
nameThe identifying name to give this program, which can be used to retrieve this program later with getByName.
groupNameThe name of the resource group
codeA string of assembly code which will form the program to run
gptypeThe type of program to create.
syntaxCodeThe name of the syntax to be used for this program e.g. arbvp1, vs_1_1

◆ getSupportedSyntax()

static const SyntaxCodes& Ogre::GpuProgramManager::getSupportedSyntax ( void  )
static

Returns the syntaxes that the RenderSystem supports.

◆ isSyntaxSupported()

static bool Ogre::GpuProgramManager::isSyntaxSupported ( const String syntaxCode)
static

Returns whether a given syntax code (e.g.

"glsl330", "vs_4_0", "arbvp1") is supported.

◆ isLanguageSupported()

bool Ogre::GpuProgramManager::isLanguageSupported ( const String lang) const

Returns whether a given high-level language (e.g.

"glsl", "hlsl") is supported.

◆ createParameters()

static GpuProgramParametersPtr Ogre::GpuProgramManager::createParameters ( void  )
inlinestatic

Creates a new GpuProgramParameters instance which can be used to bind parameters to your programs.

Program parameters can be shared between multiple programs if you wish.

◆ createProgram() [1/2]

virtual GpuProgramPtr Ogre::GpuProgramManager::createProgram ( const String name,
const String groupName,
const String filename,
GpuProgramType  gptype,
const String syntaxCode 
)
virtual

Create a new, unloaded GpuProgram from a file of assembly.

Use this method in preference to the 'load' methods if you wish to define a GpuProgram, but not load it yet; useful for saving memory.

This method creates a new program of the type specified as the second parameter. As with all types of ResourceManager, this class will search for the file in all resource locations it has been configured to look in.
Parameters
nameThe name of the program
groupNameThe name of the resource group
filenameThe file to load
syntaxCodeThe name of the syntax to be used for this program e.g. arbvp1, vs_1_1
gptypeThe type of program to create

◆ createProgramFromString()

virtual GpuProgramPtr Ogre::GpuProgramManager::createProgramFromString ( const String name,
const String groupName,
const String code,
GpuProgramType  gptype,
const String syntaxCode 
)
virtual

Create a GPU program from a string of assembly code.

Use this method in preference to the 'load' methods if you wish to define a GpuProgram, but not load it yet; useful for saving memory.

The assembly code must be compatible with this manager - call the getSupportedSyntax method for details of the supported syntaxes
Parameters
nameThe identifying name to give this program, which can be used to retrieve this program later with getByName.
groupNameThe name of the resource group
codeA string of assembly code which will form the program to run
gptypeThe type of program to create.
syntaxCodeThe name of the syntax to be used for this program e.g. arbvp1, vs_1_1

◆ create()

GpuProgramPtr Ogre::GpuProgramManager::create ( const String name,
const String group,
GpuProgramType  gptype,
const String language,
bool  isManual = false,
ManualResourceLoader loader = 0 
)

General create method, using specific create parameters instead of name / value pairs.

◆ createProgram() [2/2]

GpuProgramPtr Ogre::GpuProgramManager::createProgram ( const String name,
const String groupName,
const String language,
GpuProgramType  gptype 
)
inline

Create a new, unloaded GpuProgram.

This method creates a new program of the type specified as the second and third parameters. You will have to call further methods on the returned program in order to define the program fully before you can load it.
Parameters
nameThe identifying name of the program
groupNameThe name of the resource group which this program is to be a member of
languageCode of the language to use (e.g. "cg")
gptypeThe type of program to create

◆ createSharedParameters()

virtual GpuSharedParametersPtr Ogre::GpuProgramManager::createSharedParameters ( const String name)
virtual

Create a new set of shared parameters, which can be used across many GpuProgramParameters objects of different structures.

Parameters
nameThe name to give the shared parameters so you can refer to them later.

◆ getSharedParameters()

virtual GpuSharedParametersPtr Ogre::GpuProgramManager::getSharedParameters ( const String name) const
virtual

Retrieve a set of shared parameters, which can be used across many GpuProgramParameters objects of different structures.

◆ getAvailableSharedParameters()

virtual const SharedParametersMap& Ogre::GpuProgramManager::getAvailableSharedParameters ( ) const
virtual

Get (const) access to the available shared parameter sets.

◆ getSaveMicrocodesToCache()

bool Ogre::GpuProgramManager::getSaveMicrocodesToCache ( ) const

Get if the microcode of a shader should be saved to a cache.

◆ setSaveMicrocodesToCache()

void Ogre::GpuProgramManager::setSaveMicrocodesToCache ( bool  val)

Set if the microcode of a shader should be saved to a cache.

◆ isCacheDirty()

bool Ogre::GpuProgramManager::isCacheDirty ( void  ) const

Returns true if the microcodecache changed during the run.

◆ canGetCompiledShaderBuffer()

static bool Ogre::GpuProgramManager::canGetCompiledShaderBuffer ( )
static

◆ isMicrocodeAvailableInCache()

bool Ogre::GpuProgramManager::isMicrocodeAvailableInCache ( uint32  id) const

Check if a microcode is available for a program in the microcode cache.

Parameters
idThe id of the program.

◆ getMicrocodeFromCache()

const Microcode& Ogre::GpuProgramManager::getMicrocodeFromCache ( uint32  id) const

Returns a microcode for a program from the microcode cache.

Parameters
idThe name of the program.

◆ createMicrocode()

static Microcode Ogre::GpuProgramManager::createMicrocode ( size_t  size)
inlinestatic

Creates a microcode to be later added to the cache.

Parameters
sizeThe size of the microcode in bytes

◆ addMicrocodeToCache()

void Ogre::GpuProgramManager::addMicrocodeToCache ( uint32  id,
const Microcode microcode 
)

Adds a microcode for a program to the microcode cache.

Parameters
idThe id of the program
microcodethe program binary

◆ removeMicrocodeFromCache()

void Ogre::GpuProgramManager::removeMicrocodeFromCache ( uint32  id)

Removes a microcode for a program from the microcode cache.

Parameters
idThe name of the program.

◆ saveMicrocodeCache()

void Ogre::GpuProgramManager::saveMicrocodeCache ( const DataStreamPtr stream) const

Saves the microcode cache to disk.

Parameters
streamThe destination stream

◆ loadMicrocodeCache()

void Ogre::GpuProgramManager::loadMicrocodeCache ( const DataStreamPtr stream)

Loads the microcode cache from disk.

Parameters
streamThe source stream

◆ addFactory()

void Ogre::GpuProgramManager::addFactory ( GpuProgramFactory factory)

Add a new factory object for programs of a given language.

Referenced by Ogre::GLGpuProgramManager::registerProgramFactory().

◆ removeFactory()

void Ogre::GpuProgramManager::removeFactory ( GpuProgramFactory factory)

Remove a factory object for programs of a given language.

◆ getSingleton()

static GpuProgramManager& Ogre::GpuProgramManager::getSingleton ( void  )
static

Get the singleton instance.

Referenced by Ogre::GLGpuProgramManager::registerProgramFactory().

◆ getSingletonPtr()

static GpuProgramManager* Ogre::GpuProgramManager::getSingletonPtr ( void  )
static

Get the singleton instance.


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