![]() |
OGRE
1.10.12
Object-Oriented Graphics Rendering Engine
|
#include <OgreGpuProgramManager.h>
Public Types | |
typedef MemoryDataStreamPtr | Microcode |
typedef map< String, Microcode >::type | MicrocodeMap |
typedef std::pair< ResourcePtr, bool > | ResourceCreateOrRetrieveResult |
typedef map< ResourceHandle, ResourcePtr >::type | ResourceHandleMap |
typedef OGRE_HashMap< String, ResourcePtr > | ResourceMap |
typedef MapIterator< ResourceHandleMap > | ResourceMapIterator |
typedef OGRE_HashMap< String, ResourceMap > | ResourceWithGroupMap |
typedef map< String, GpuSharedParametersPtr >::type | SharedParametersMap |
typedef set< String >::type | SyntaxCodes |
Public Member Functions | |
GpuProgramManager () | |
virtual | ~GpuProgramManager () |
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 void | addMicrocodeToCache (const String &name, const Microcode µcode) |
Adds a microcode for a program to the microcode cache. More... | |
bool | canGetCompiledShaderBuffer () |
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... | |
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 GpuProgramParametersSharedPtr | createParameters (void) |
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... | |
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... | |
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... | |
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 const SharedParametersMap & | getAvailableSharedParameters () const |
Get (const) access to the available shared parameter sets. More... | |
virtual ResourcePtr | getByHandle (ResourceHandle handle) |
Retrieves a pointer to a resource by handle, or null if the resource does not exist. More... | |
GpuProgramPtr | getByName (const String &name, const String &group OGRE_RESOURCE_GROUP_INIT, bool preferHighLevelPrograms=true) |
Get a resource by name. More... | |
Real | getLoadingOrder (void) const |
Gets the relative loading order of resources 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 const Microcode & | getMicrocodeFromCache (const String &name) const |
Returns a microcode for a program from the microcode cache. More... | |
ResourcePtr | getResourceByName (const String &name, const String &group OGRE_RESOURCE_GROUP_INIT, bool preferHighLevelPrograms=true) |
Overrides the standard ResourceManager getResourceByName method. More... | |
virtual ResourcePtr | getResourceByName (const String &name, const String &groupName OGRE_RESOURCE_GROUP_INIT) |
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... | |
ResourcePool * | getResourcePool (const String &name) |
Create a resource pool, or reuse one that already exists. More... | |
const String & | getResourceType (void) const |
Gets a string identifying the type of resource this manager handles. More... | |
bool | getSaveMicrocodesToCache () |
Get if the microcode of a shader should be saved to a cache. More... | |
const StringVector & | getScriptPatterns (void) const |
Gets the file patterns which should be used to find scripts for this ResourceManager. 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 SyntaxCodes & | getSupportedSyntax (void) const |
Returns the syntaxes that this manager supports. More... | |
bool | getVerbose (void) |
Gets whether this manager and its resources habitually produce log output. More... | |
bool | isCacheDirty (void) const |
Returns true if the microcodecache changed during the run. More... | |
virtual bool | isMicrocodeAvailableInCache (const String &name) 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... | |
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... | |
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... | |
void | parseScript (DataStreamPtr &stream, const String &groupName) |
Parse the definition of a set of resources from 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 OGRE_RESOURCE_GROUP_INIT) |
void | remove (ResourceHandle handle) |
virtual void | removeAll (void) |
Removes all resources. More... | |
virtual void | removeMicrocodeFromCache (const String &name) |
Removes a microcode for a program from the microcode cache. 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 OGRE_RESOURCE_GROUP_INIT) |
Returns whether the named resource exists in this manager. More... | |
bool | resourceExists (ResourceHandle handle) |
Returns whether a resource with the given handle exists in this manager. More... | |
virtual void | saveMicrocodeCache (DataStreamPtr stream) const |
Saves the microcode cache to disk. More... | |
void | setMemoryBudget (size_t bytes) |
Set a limit on the amount of memory this resource handler may use. More... | |
void | setSaveMicrocodesToCache (const bool val) |
Set if the microcode of a shader should be saved to a cache. 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 OGRE_RESOURCE_GROUP_INIT) |
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... | |
Static Public Member Functions | |
static GpuProgramManager & | getSingleton (void) |
Get the singleton instance. More... | |
static GpuProgramManager * | getSingletonPtr (void) |
Get the singleton instance. More... | |
Public Attributes | |
OGRE_AUTO_MUTEX | |
typedef set<String>::type Ogre::GpuProgramManager::SyntaxCodes |
typedef map<String, GpuSharedParametersPtr>::type Ogre::GpuProgramManager::SharedParametersMap |
typedef map<String, Microcode>::type Ogre::GpuProgramManager::MicrocodeMap |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Ogre::GpuProgramManager::GpuProgramManager | ( | ) |
|
virtual |
GpuProgramPtr Ogre::GpuProgramManager::getByName | ( | const String & | name, |
const String &group | OGRE_RESOURCE_GROUP_INIT, | ||
bool | preferHighLevelPrograms = true |
||
) |
Get a resource by name.
|
virtual |
Loads a GPU program from a file of assembly.
name | The name of the GpuProgram |
groupName | The name of the resource group |
filename | The file to load |
gptype | The type of program to create |
syntaxCode | The name of the syntax to be used for this program e.g. arbvp1, vs_1_1 |
|
virtual |
Loads a GPU program from a string of assembly code.
name | The identifying name to give this program, which can be used to retrieve this program later with getByName. |
groupName | The name of the resource group |
code | A string of assembly code which will form the program to run |
gptype | The type of program to create. |
syntaxCode | The name of the syntax to be used for this program e.g. arbvp1, vs_1_1 |
|
virtual |
Returns the syntaxes that this manager supports.
|
virtual |
Returns whether a given syntax code (e.g.
"ps_1_3", "fp20", "arbvp1") is supported.
|
virtual |
Creates a new GpuProgramParameters instance which can be used to bind parameters to your programs.
|
virtual |
Create a new, unloaded GpuProgram from a file of assembly.
name | The name of the program |
groupName | The name of the resource group |
filename | The file to load |
syntaxCode | The name of the syntax to be used for this program e.g. arbvp1, vs_1_1 |
gptype | The type of program to create |
|
virtual |
Create a GPU program from a string of assembly code.
name | The identifying name to give this program, which can be used to retrieve this program later with getByName. |
groupName | The name of the resource group |
code | A string of assembly code which will form the program to run |
gptype | The type of program to create. |
syntaxCode | The name of the syntax to be used for this program e.g. arbvp1, vs_1_1 |
|
virtual |
General create method, using specific create parameters instead of name / value pairs.
ResourcePtr Ogre::GpuProgramManager::getResourceByName | ( | const String & | name, |
const String &group | OGRE_RESOURCE_GROUP_INIT, | ||
bool | preferHighLevelPrograms = true |
||
) |
Overrides the standard ResourceManager getResourceByName method.
name | The name of the program to retrieve |
preferHighLevelPrograms | If set to true (the default), high level programs will be returned in preference to low-level programs. |
|
virtual |
Create a new set of shared parameters, which can be used across many GpuProgramParameters objects of different structures.
name | The name to give the shared parameters so you can refer to them later. |
|
virtual |
Retrieve a set of shared parameters, which can be used across many GpuProgramParameters objects of different structures.
|
virtual |
Get (const) access to the available shared parameter sets.
bool Ogre::GpuProgramManager::getSaveMicrocodesToCache | ( | ) |
Get if the microcode of a shader should be saved to a cache.
void Ogre::GpuProgramManager::setSaveMicrocodesToCache | ( | const bool | val | ) |
Set if the microcode of a shader should be saved to a cache.
bool Ogre::GpuProgramManager::isCacheDirty | ( | void | ) | const |
Returns true if the microcodecache changed during the run.
bool Ogre::GpuProgramManager::canGetCompiledShaderBuffer | ( | ) |
|
virtual |
Check if a microcode is available for a program in the microcode cache.
name | The name of the program. |
|
virtual |
Returns a microcode for a program from the microcode cache.
name | The name of the program. |
Creates a microcode to be later added to the cache.
size | The size of the microcode in bytes |
|
virtual |
Adds a microcode for a program to the microcode cache.
name | The name of the program. |
|
virtual |
Removes a microcode for a program from the microcode cache.
name | The name of the program. |
|
virtual |
Saves the microcode cache to disk.
stream | The destination stream |
|
virtual |
Loads the microcode cache from disk.
stream | The source stream |
|
static |
Get the singleton instance.
|
static |
Get the singleton instance.
|
inherited |
Creates a new blank resource, but does not immediately load it.
name | The unique name of the resource |
group | The name of the resource group to attach this new resource to |
isManual | Is this resource manually loaded? If so, you should really populate the loader parameter in order that the load process can call the loader back when loading is required. |
loader | Pointer to a ManualLoader implementation which will be called when the Resource wishes to load (should be supplied if you set isManual to true). You can in fact leave this parameter null if you wish, but the Resource will never be able to reload if anything ever causes it to unload. Therefore provision of a proper ManualLoader instance is strongly recommended. |
createParams | If any parameters are required to create an instance, they should be supplied here as name / value pairs |
|
inherited |
Create a new resource, or retrieve an existing one with the same name if it already exists.
|
inherited |
Set a limit on the amount of memory this resource handler may use.
|
inherited |
Get the limit on the amount of memory this resource handler may use.
|
inlineinherited |
Gets the current memory usage, in bytes.
References OGRE_RESOURCE_GROUP_INIT.
|
inherited |
Unloads a single resource by name.
|
inherited |
Unloads a single resource by handle.
|
inlineinherited |
Unloads all resources.
reloadableOnly | If true (the default), only unload the resource that is reloadable. Because some resources isn't reloadable, they will be unloaded but can't load them later. Thus, you might not want to them unloaded. Or, you might unload all of them, and then populate them manually later. |
References Ogre::Resource::LF_DEFAULT, and Ogre::Resource::LF_INCLUDE_NON_RELOADABLE.
|
virtualinherited |
Unloads all resources.
flags | Allow to restrict processing to only reloadable and/or unreferenced resources. |
|
inlineinherited |
Caused all currently loaded resources to be reloaded.
reloadableOnly | If true (the default), only reload the resource that is reloadable. Because some resources isn't reloadable, they will be unloaded but can't loaded again. Thus, you might not want to them unloaded. Or, you might unload all of them, and then populate them manually later. |
References Ogre::Resource::LF_DEFAULT, and Ogre::Resource::LF_INCLUDE_NON_RELOADABLE.
|
virtualinherited |
Caused all currently loaded resources to be reloaded.
flags | Allow to restrict processing to only reloadable and/or unreferenced resources. Additionally, reloading could be done with preserving some selected resource states that could be used elsewhere. |
|
inlineinherited |
Unload all resources which are not referenced by any other object.
reloadableOnly | If true (the default), only unloads resources which can be subsequently automatically reloaded. |
References Ogre::Resource::LF_ONLY_UNREFERENCED, and Ogre::Resource::LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE.
|
inlineinherited |
Caused all currently loaded but not referenced by any other object resources to be reloaded.
reloadableOnly | If true (the default), only reloads resources which can be subsequently automatically reloaded. |
References Ogre::Resource::LF_ONLY_UNREFERENCED, Ogre::Resource::LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE, and OGRE_RESOURCE_GROUP_INIT.
|
inherited |
Remove a single resource.
|
inherited |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
inherited |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
virtualinherited |
Removes all resources.
Reimplemented in Ogre::CompositorManager.
|
virtualinherited |
Remove all resources which are not referenced by any other object.
reloadableOnly | If true (the default), only removes resources which can be subsequently automatically reloaded. |
|
virtualinherited |
Retrieves a pointer to a resource by name, or null if the resource does not exist.
|
virtualinherited |
Retrieves a pointer to a resource by handle, or null if the resource does not exist.
|
inlineinherited |
Returns whether the named resource exists in this manager.
References Ogre::SharedPtr< T >::get().
|
inlineinherited |
Returns whether a resource with the given handle exists in this manager.
References Ogre::SharedPtr< T >::get().
|
virtualinherited |
Notify this manager that a resource which it manages has been 'touched', i.e.
used.
|
virtualinherited |
Notify this manager that a resource which it manages has been loaded.
|
virtualinherited |
Notify this manager that a resource which it manages has been unloaded.
|
inherited |
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).
name | The name of the Resource |
group | The resource group to which this resource will belong |
isManual | Is the resource to be manually loaded? If so, you should provide a value for the loader parameter |
loader | The manual loader which is to perform the required actions when this resource is loaded; only applicable when you specify true for the previous parameter |
loadParams | Optional pointer to a list of name/value pairs containing loading parameters for this type of resource. |
backgroundThread | Optional boolean which lets the load routine know if it is being run on the background resource loading thread |
|
inherited |
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).
name | The name of the Resource |
group | The resource group to which this resource will belong |
isManual | Is the resource to be manually loaded? If so, you should provide a value for the loader parameter |
loader | The manual loader which is to perform the required actions when this resource is loaded; only applicable when you specify true for the previous parameter |
loadParams | Optional pointer to a list of name/value pairs containing loading parameters for this type of resource. |
backgroundThread | Optional boolean which lets the load routine know if it is being run on the background resource loading thread |
|
inlinevirtualinherited |
Gets the file patterns which should be used to find scripts for this ResourceManager.
Implements Ogre::ScriptLoader.
|
inlinevirtualinherited |
Parse the definition of a set of resources from a script file.
stream | Weak reference to a data stream which is the source of the script |
groupName | The name of the resource group that resources which are parsed are to become a member of. If this group is loaded or unloaded, then the resources discovered in this script will be loaded / unloaded with it. |
Implements Ogre::ScriptLoader.
Reimplemented in Ogre::FontManager.
|
inlinevirtualinherited |
Gets the relative loading order of resources of this type.
Implements Ogre::ScriptLoader.
|
inlineinherited |
Gets a string identifying the type of resource this manager handles.
|
inlineinherited |
Sets whether this manager and its resources habitually produce log output.
|
inlineinherited |
Gets whether this manager and its resources habitually produce log output.
|
inherited |
Create a resource pool, or reuse one that already exists.
|
inherited |
Destroy a resource pool.
|
inherited |
Destroy a resource pool.
|
inherited |
destroy all pools
|
inlineinherited |
Returns an iterator over all resources in this manager.
|
inherited |