OGRE-Next  3.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::GpuProgramManager Class Referenceabstract

#include <OgreGpuProgramManager.h>

+ Inheritance diagram for Ogre::GpuProgramManager:

Classes

struct  Hash
 

Public Types

typedef MemoryDataStreamPtr Microcode
 
typedef map< Hash, Microcode >::type MicrocodeMap
 
typedef map< String, GpuSharedParametersPtr >::type SharedParametersMap
 
typedef set< String >::type SyntaxCodes
 
- Public Types inherited from Ogre::ResourceManager
typedef std::pair< ResourcePtr, bool > ResourceCreateOrRetrieveResult
 
typedef map< ResourceHandle, ResourcePtr >::type ResourceHandleMap
 
typedef unordered_map< String, ResourcePtr >::type ResourceMap
 
typedef MapIterator< ResourceHandleMapResourceMapIterator
 
typedef unordered_map< String, ResourceMap >::type ResourceWithGroupMap
 

Public Member Functions

 GpuProgramManager ()
 
virtual ~GpuProgramManager ()
 
virtual void addMicrocodeToCache (const String &source, const Microcode &microcode)
 Adds a microcode for a program to the microcode cache. More...
 
bool canGetCompiledShaderBuffer ()
 
virtual void clearMicrocodeCache ()
 Deletes all microcodes. Useful when hot reloading. More...
 
virtual ResourcePtr create (const String &name, const String &group, GpuProgramType gptype, const String &syntaxCode, bool isManual=false, ManualResourceLoader *loader=0)
 General create method, using specific create parameters instead of name / value pairs. More...
 
virtual Microcode createMicrocode (const uint32 size) const
 Creates a microcode to be later added to the cache. More...
 
virtual GpuProgramParametersSharedPtr createParameters ()
 Creates a new GpuProgramParameters instance which can be used to bind parameters to your programs. 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...
 
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, bool preferHighLevelPrograms=true)
 Get a resource by name. More...
 
virtual const MicrocodegetMicrocodeFromCache (const String &source) const
 Returns a microcode for a program from the microcode cache. More...
 
ResourcePtr getResourceByName (const String &name, bool preferHighLevelPrograms=true)
 Overrides the standard ResourceManager getResourceByName method. More...
 
bool getSaveMicrocodesToCache ()
 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...
 
virtual const SyntaxCodesgetSupportedSyntax () const
 Returns the syntaxes that this manager supports. More...
 
bool isCacheDirty () const
 Returns true if the microcodecache changed during the run. More...
 
virtual bool isMicrocodeAvailableInCache (const String &source) const
 Check if a microcode is available for a program in the microcode cache. More...
 
virtual bool isSyntaxSupported (const String &syntaxCode) const
 Returns whether a given syntax code (e.g. 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 of assembly. 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 of assembly code. More...
 
virtual void loadMicrocodeCache (DataStreamPtr stream)
 Loads the microcode cache from disk. More...
 
virtual void removeMicrocodeFromCache (const String &source)
 Removes a microcode for a program from the microcode cache. More...
 
virtual void saveMicrocodeCache (DataStreamPtr stream) const
 Saves the microcode cache to disk. More...
 
void setSaveMicrocodesToCache (const bool val)
 Set if the microcode of a shader should be saved to a cache. More...
 
- Public Member Functions inherited from Ogre::ResourceManager
 ResourceManager ()
 
 ~ResourceManager () override
 
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...
 
virtual 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...
 
virtual 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 (const String &name)
 Destroy a resource pool. More...
 
void destroyResourcePool (ResourcePool *pool)
 Destroy a resource pool. More...
 
virtual ResourcePtr getByHandle (ResourceHandle handle)
 Retrieves a pointer to a resource by handle, or null if the resource does not exist. More...
 
Real getLoadingOrder () const override
 Gets the relative loading order of resources of this type. More...
 
virtual size_t getMemoryBudget () const
 Get the limit on the amount of memory this resource handler may use. More...
 
virtual size_t getMemoryUsage () const
 Gets the current memory usage, in bytes. More...
 
virtual ResourcePtr getResourceByName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
 Retrieves a pointer to a resource by name, or null if the resource does not exist. More...
 
ResourceMapIterator getResourceIterator ()
 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 () const
 Gets a string identifying the type of resource this manager handles. More...
 
const StringVectorgetScriptPatterns () const override
 Gets the file patterns which should be used to find scripts for this ResourceManager. More...
 
virtual bool getVerbose ()
 Gets whether this manager and its resources habitually produce log output. More...
 
virtual 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 the definition of a set of resources from a script file. More...
 
virtual 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...
 
virtual void remove (const ResourcePtr &r)
 Remove a single resource. More...
 
virtual void remove (const String &name)
 Remove a single resource by name. More...
 
virtual void remove (ResourceHandle handle)
 Remove a single resource by handle. More...
 
virtual void removeAll ()
 Removes all resources. More...
 
virtual void removeUnreferencedResources (bool reloadableOnly=true)
 Remove all resources which are not referenced by any other object. More...
 
virtual bool resourceExists (const String &name)
 Returns whether the named resource exists in this manager. More...
 
virtual bool resourceExists (ResourceHandle handle)
 Returns whether a resource with the given handle exists in this manager. More...
 
virtual void setMemoryBudget (size_t bytes)
 Set a limit on the amount of memory this resource handler may use. More...
 
virtual void setVerbose (bool v)
 Sets whether this manager and its resources habitually produce log output. More...
 
virtual void unload (const String &name)
 Unloads a single resource by name. More...
 
virtual 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 ()
 
 ~Singleton ()
 

Static Public Member Functions

static GpuProgramManagergetSingleton ()
 Override standard Singleton retrieval. More...
 
static GpuProgramManagergetSingletonPtr ()
 Override standard Singleton retrieval. More...
 
- Static Public Member Functions inherited from Ogre::Singleton< GpuProgramManager >
static GpuProgramManagergetSingleton ()
 
static GpuProgramManagergetSingletonPtr ()
 

Additional Inherited Members

- Public Attributes inherited from Ogre::ResourceManager
 OGRE_AUTO_MUTEX
 

Member Typedef Documentation

◆ Microcode

◆ MicrocodeMap

◆ SharedParametersMap

◆ SyntaxCodes

Constructor & Destructor Documentation

◆ GpuProgramManager()

Ogre::GpuProgramManager::GpuProgramManager ( )

◆ ~GpuProgramManager()

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

Member Function Documentation

◆ addMicrocodeToCache()

virtual void Ogre::GpuProgramManager::addMicrocodeToCache ( const String source,
const Microcode microcode 
)
virtual

Adds a microcode for a program to the microcode cache.

Parameters
nameThe name of the program.

◆ canGetCompiledShaderBuffer()

bool Ogre::GpuProgramManager::canGetCompiledShaderBuffer ( )

◆ clearMicrocodeCache()

virtual void Ogre::GpuProgramManager::clearMicrocodeCache ( )
virtual

Deletes all microcodes. Useful when hot reloading.

◆ create()

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

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

◆ createMicrocode()

virtual Microcode Ogre::GpuProgramManager::createMicrocode ( const uint32  size) const
virtual

Creates a microcode to be later added to the cache.

Parameters
sizeThe size of the microcode in bytes

◆ createParameters()

virtual GpuProgramParametersSharedPtr Ogre::GpuProgramManager::createParameters ( )
virtual

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

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

◆ createProgram()

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.

Remarks
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.

Remarks
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

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

◆ getAvailableSharedParameters()

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

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

◆ getByName()

GpuProgramPtr Ogre::GpuProgramManager::getByName ( const String name,
bool  preferHighLevelPrograms = true 
)

Get a resource by name.

See also
GpuProgramManager::getResourceByName

◆ getMicrocodeFromCache()

virtual const Microcode& Ogre::GpuProgramManager::getMicrocodeFromCache ( const String source) const
virtual

Returns a microcode for a program from the microcode cache.

Parameters
nameThe name of the program.

◆ getResourceByName()

ResourcePtr Ogre::GpuProgramManager::getResourceByName ( const String name,
bool  preferHighLevelPrograms = true 
)

Overrides the standard ResourceManager getResourceByName method.

Parameters
nameThe name of the program to retrieve
preferHighLevelProgramsIf set to true (the default), high level programs will be returned in preference to low-level programs.

◆ getSaveMicrocodesToCache()

bool Ogre::GpuProgramManager::getSaveMicrocodesToCache ( )

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

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

◆ getSingleton()

static GpuProgramManager& Ogre::GpuProgramManager::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 GpuProgramManager* Ogre::GpuProgramManager::getSingletonPtr ( )
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.

◆ getSupportedSyntax()

virtual const SyntaxCodes& Ogre::GpuProgramManager::getSupportedSyntax ( ) const
virtual

Returns the syntaxes that this manager supports.

◆ isCacheDirty()

bool Ogre::GpuProgramManager::isCacheDirty ( ) const

Returns true if the microcodecache changed during the run.

◆ isMicrocodeAvailableInCache()

virtual bool Ogre::GpuProgramManager::isMicrocodeAvailableInCache ( const String source) const
virtual

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

Parameters
nameThe name of the program.

◆ isSyntaxSupported()

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

Returns whether a given syntax code (e.g.

"ps_1_3", "fp20", "arbvp1") is supported.

◆ 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 of assembly.

Remarks
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 of assembly code.

Remarks
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

◆ loadMicrocodeCache()

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

Loads the microcode cache from disk.

Parameters
streamThe source stream

◆ removeMicrocodeFromCache()

virtual void Ogre::GpuProgramManager::removeMicrocodeFromCache ( const String source)
virtual

Removes a microcode for a program from the microcode cache.

Parameters
nameThe name of the program.

◆ saveMicrocodeCache()

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

Saves the microcode cache to disk.

Parameters
streamThe destination stream

◆ setSaveMicrocodesToCache()

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

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


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