Ogre::GpuProgramManager Class Referenceabstract
Core » Resources

`#include <OgreGpuProgramManager.h>`

Inheritance diagram for Ogre::GpuProgramManager:
[legend]

## Public Types

typedef MemoryDataStreamPtr | Microcode
typedef map< String, Microcode >::type | MicrocodeMap
typedef std::pair< ResourcePtr, bool > | ResourceCreateOrRetrieveResult
typedef map< ResourceHandle, ResourcePtr >::type | ResourceHandleMap
typedef HashMap< String, ResourcePtr > | ResourceMap
typedef MapIterator< ResourceHandleMap > | ResourceMapIterator
typedef 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 &microcode)
| 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...
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 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...
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...
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, bool preferHighLevelPrograms=true)
| Get a resource by name. More...
virtual Real | getLoadingOrder (void) const
| Gets the relative loading order of resources of this type. More...
virtual size_t | getMemoryBudget (void) const
| Get the limit on the amount of memory this resource handler may use. More...
virtual 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, bool preferHighLevelPrograms=true)
| Overrides the standard ResourceManager getResourceByName method. 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 (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...
virtual 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...
virtual 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...
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...
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 | operator delete (void *ptr)
void | operator delete (void *ptr, void *)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info More...
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new More...
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info More...
void * | operator new[] (size_t sz)
virtual void | parseScript (DataStreamPtr &stream, const String &groupName)
| 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...
virtual void | reloadAll (bool reloadableOnly=true)
| Caused all currently loaded resources to be reloaded. More...
virtual void | reloadUnreferencedResources (bool reloadableOnly=true)
| Caused all currently loaded but not referenced by any other object resources to be reloaded. More...
virtual void | remove (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 (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...
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 | saveMicrocodeCache (DataStreamPtr stream) const
| Saves the microcode cache to disk. More...
virtual 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...
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...
virtual void | unloadAll (bool reloadableOnly=true)
| Unloads all resources. More...
virtual 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)
| Override standard Singleton retrieval. More...
static GpuProgramManager * | getSingletonPtr (void)
| Override standard Singleton retrieval. More...

## Public Attributes

| OGRE_AUTO_MUTEX

## Protected Types

typedef map< String, ResourcePool * >::type | ResourcePoolMap

## Protected Member Functions

virtual void | addImpl (ResourcePtr &res)
| Add a newly created resource to the manager (note weak reference) More...
virtual void | checkUsage (void)
| Checks memory usage and pages out if required. More...
virtual Resource * | createImpl (const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, GpuProgramType gptype, const String &syntaxCode)=0
| Specialised create method with specific parameters. More...
virtual Resource * | createImpl (const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, const NameValuePairList *createParams)=0
| Create a new resource instance compatible with this manager (no custom parameters are populated at this point). More...
ResourceHandle | getNextHandle (void)
| Allocates the next handle. More...
virtual void | removeImpl (ResourcePtr &res)
| Remove a resource from this manager; remove it from the lists. More...

## Static Protected Member Functions

static String | addRenderSystemToName (const String &name)

## Protected Attributes

bool | mCacheDirty
Real | mLoadOrder
| Loading order relative to other managers, higher is later. More...
size_t | mMemoryBudget
AtomicScalar< size_t > | mMemoryUsage
MicrocodeMap | mMicrocodeCache
AtomicScalar< ResourceHandle > | mNextHandle
| In bytes. More...
ResourcePoolMap | mResourcePoolMap
ResourceMap | mResources
ResourceHandleMap | mResourcesByHandle
ResourceWithGroupMap | mResourcesWithGroup
String | mResourceType
| String identifying the resource type this manager handles. More...
bool | mSaveMicrocodesToCache
StringVector | mScriptPatterns
| Patterns to use to look for scripts if supported (e.g. *.overlay) More...
SharedParametersMap | mSharedParametersMap
bool | mVerbose
| In bytes. More...

## Static Protected Attributes

static GpuProgramManager * | msSingleton

## Detailed Description

Definition at line 47 of file OgreGpuProgramManager.h.

## Member Typedef Documentation

## Microcode

typedef MemoryDataStreamPtr Ogre::GpuProgramManager::Microcode

Definition at line 54 of file OgreGpuProgramManager.h.

## MicrocodeMap

typedef map<String, Microcode>::type Ogre::GpuProgramManager::MicrocodeMap

Definition at line 55 of file OgreGpuProgramManager.h.

## ResourceCreateOrRetrieveResult

typedef std::pair<ResourcePtr, bool> Ogre::ResourceManager::ResourceCreateOrRetrieveResult

inherited

Definition at line 152 of file OgreResourceManager.h.

## ResourceHandleMap

typedef map<ResourceHandle, ResourcePtr>::type Ogre::ResourceManager::ResourceHandleMap

inherited

Definition at line 543 of file OgreResourceManager.h.

## ResourceMap

typedef HashMap< String, ResourcePtr > Ogre::ResourceManager::ResourceMap

inherited

Definition at line 541 of file OgreResourceManager.h.

## ResourceMapIterator

typedef MapIterator<ResourceHandleMap> Ogre::ResourceManager::ResourceMapIterator

inherited

Definition at line 564 of file OgreResourceManager.h.

## ResourcePoolMap

typedef map<String, ResourcePool*>::type Ogre::ResourceManager::ResourcePoolMap

protected inherited

Definition at line 575 of file OgreResourceManager.h.

## ResourceWithGroupMap

typedef HashMap< String, ResourceMap > Ogre::ResourceManager::ResourceWithGroupMap

inherited

Definition at line 542 of file OgreResourceManager.h.

## SharedParametersMap

typedef map<String, GpuSharedParametersPtr>::type Ogre::GpuProgramManager::SharedParametersMap

Definition at line 52 of file OgreGpuProgramManager.h.

## SyntaxCodes

typedef set<String>::type Ogre::GpuProgramManager::SyntaxCodes

Definition at line 51 of file OgreGpuProgramManager.h.

## Constructor & Destructor Documentation

## GpuProgramManager()

Ogre::GpuProgramManager::GpuProgramManager | ( |  | ) |

## ~GpuProgramManager()

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

virtual

## Member Function Documentation

## _notifyResourceLoaded()

virtual void Ogre::ResourceManager::_notifyResourceLoaded | ( | Resource * | res | ) |

virtual inherited

Notify this manager that a resource which it manages has been loaded.

## _notifyResourceTouched()

virtual void Ogre::ResourceManager::_notifyResourceTouched | ( | Resource * | res | ) |

virtual inherited

Notify this manager that a resource which it manages has been 'touched', i.e.

used.

## _notifyResourceUnloaded()

virtual void Ogre::ResourceManager::_notifyResourceUnloaded | ( | Resource * | res | ) |

virtual inherited

Notify this manager that a resource which it manages has been unloaded.

## addImpl()

virtual void Ogre::ResourceManager::addImpl | ( | ResourcePtr & | res | ) |

protected virtual inherited

Add a newly created resource to the manager (note weak reference)

## addMicrocodeToCache()

virtual void Ogre::GpuProgramManager::addMicrocodeToCache | ( | const String & | name,
|  | const Microcode & | microcode
| ) |  |

virtual

Adds a microcode for a program to the microcode cache.

Parameters

  name | The name of the program.

## addRenderSystemToName()

static String Ogre::GpuProgramManager::addRenderSystemToName | ( | const String & | name | ) |

static protected

## canGetCompiledShaderBuffer()

bool Ogre::GpuProgramManager::canGetCompiledShaderBuffer | ( |  | ) |

## checkUsage()

virtual void Ogre::ResourceManager::checkUsage | ( | void |  | ) |

protected virtual inherited

Checks memory usage and pages out if required.

This is automatically done after a new resource is loaded.

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

## createImpl() [1/2]

virtual Resource* Ogre::GpuProgramManager::createImpl | ( | const String & | name,
|  | ResourceHandle | handle,
|  | const String & | group,
|  | bool | isManual,
|  | ManualResourceLoader * | loader,
|  | GpuProgramType | gptype,
|  | const String & | syntaxCode
| ) |  |

protected pure virtual

Specialised create method with specific parameters.

## createImpl() [2/2]

virtual Resource* Ogre::ResourceManager::createImpl | ( | const String & | name,
|  | ResourceHandle | handle,
|  | const String & | group,
|  | bool | isManual,
|  | ManualResourceLoader * | loader,
|  | const NameValuePairList * | createParams
| ) |  |

protected pure virtual inherited

Create a new resource instance compatible with this manager (no custom parameters are populated at this point).

Remarks
  Subclasses must override this method and create a subclass of Resource.

Parameters

  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. These do not need to be set on the instance (handled elsewhere), just used if required to differentiate which concrete class is created.

Implemented in Ogre::MeshManager, Ogre::MaterialManager, Ogre::SkeletonManager, Ogre::FontManager, Ogre::HighLevelGpuProgramManager, and Ogre::CompositorManager.

## createMicrocode()

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

virtual

Creates a microcode to be later added to the cache.

Parameters

  size | The size of the microcode in bytes

## createOrRetrieve()

virtual ResourceCreateOrRetrieveResult Ogre::ResourceManager::createOrRetrieve | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | createParams = `0`
| ) |  |

virtual inherited

Create a new resource, or retrieve an existing one with the same name if it already exists.

Remarks
  This method performs the same task as calling getByName() followed by create() if that returns null. The advantage is that it does it in one call so there are no race conditions if using multiple threads that could cause getByName() to return null, but create() to fail because another thread created a resource in between.

See also
  ResourceManager::createResource
  ResourceManager::getResourceByName

Returns
  A pair, the first element being the pointer, and the second being an indicator specifying whether the resource was newly created.

## createParameters()

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

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

  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

## 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

  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

## createResource()

virtual ResourcePtr Ogre::ResourceManager::createResource | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | createParams = `0`
| ) |  |

virtual inherited

Creates a new blank resource, but does not immediately load it.

Remarks
  Resource managers handle disparate types of resources, so if you want to get at the detailed interface of this resource, you'll have to cast the result to the subclass you know you're creating.

Parameters

  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

## 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

  name | The name to give the shared parameters so you can refer to them later.

## destroyAllResourcePools()

void Ogre::ResourceManager::destroyAllResourcePools | ( |  | ) |

inherited

destroy all pools

## destroyResourcePool() [1/2]

void Ogre::ResourceManager::destroyResourcePool | ( | ResourcePool * | pool | ) |

inherited

Destroy a resource pool.

## destroyResourcePool() [2/2]

void Ogre::ResourceManager::destroyResourcePool | ( | const String & | name | ) |

inherited

Destroy a resource pool.

## getAvailableSharedParameters()

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

virtual

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

## getByHandle()

virtual ResourcePtr Ogre::ResourceManager::getByHandle | ( | ResourceHandle | handle | ) |

virtual inherited

Retrieves a pointer to a resource by handle, or null if the resource does not exist.

## getByName()

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

Get a resource by name.

See also
  GpuProgramManager::getResourceByName

## getLoadingOrder()

virtual Real Ogre::ResourceManager::getLoadingOrder | ( | void |  | ) | const

virtual inherited

Gets the relative loading order of resources of this type.

Remarks
  There are dependencies between some kinds of resource in terms of loading order, and this value enumerates that. Higher values load later during bulk loading tasks.

Implements Ogre::ScriptLoader.

Definition at line 461 of file OgreResourceManager.h.

## getMemoryBudget()

virtual size_t Ogre::ResourceManager::getMemoryBudget | ( | void |  | ) | const

virtual inherited

Get the limit on the amount of memory this resource handler may use.

## getMemoryUsage()

virtual size_t Ogre::ResourceManager::getMemoryUsage | ( | void |  | ) | const

virtual inherited

Gets the current memory usage, in bytes.

Definition at line 185 of file OgreResourceManager.h.

References Ogre::ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME.

## getMicrocodeFromCache()

virtual const Microcode& Ogre::GpuProgramManager::getMicrocodeFromCache | ( | const String & | name | ) | const

virtual

Returns a microcode for a program from the microcode cache.

Parameters

  name | The name of the program.

## getNextHandle()

ResourceHandle Ogre::ResourceManager::getNextHandle | ( | void |  | ) |

protected inherited

Allocates the next handle.

## getResourceByName() [1/2]

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

Overrides the standard ResourceManager getResourceByName method.

Parameters

  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.

## getResourceByName() [2/2]

virtual ResourcePtr Ogre::ResourceManager::getResourceByName | ( | const String & | name,
|  | const String & | groupName = `ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME`
| ) |  |

virtual inherited

Retrieves a pointer to a resource by name, or null if the resource does not exist.

## getResourceIterator()

ResourceMapIterator Ogre::ResourceManager::getResourceIterator | ( | void |  | ) |

inherited

Returns an iterator over all resources in this manager.

Note
  Use of this iterator is NOT thread safe!

Definition at line 569 of file OgreResourceManager.h.

## getResourcePool()

ResourcePool* Ogre::ResourceManager::getResourcePool | ( | const String & | name | ) |

inherited

Create a resource pool, or reuse one that already exists.

## getResourceType()

const String& Ogre::ResourceManager::getResourceType | ( | void |  | ) | const

inherited

Gets a string identifying the type of resource this manager handles.

Definition at line 464 of file OgreResourceManager.h.

## getSaveMicrocodesToCache()

bool Ogre::GpuProgramManager::getSaveMicrocodesToCache | ( |  | ) |

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

## getScriptPatterns()

virtual const StringVector& Ogre::ResourceManager::getScriptPatterns | ( | void |  | ) | const

virtual inherited

Gets the file patterns which should be used to find scripts for this ResourceManager.

Remarks
  Some resource managers can read script files in order to define resources ahead of time. These resources are added to the available list inside the manager, but none are loaded initially. This allows you to load the items that are used on demand, or to load them all as a group if you wish (through ResourceGroupManager).

  This method lets you determine the file pattern which will be used to identify scripts intended for this manager.

Returns
  A list of file patterns, in the order they should be searched in.

See also
  isScriptingSupported, parseScript

Implements Ogre::ScriptLoader.

Definition at line 437 of file OgreResourceManager.h.

## 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 | ( | void |  | ) |

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 | ( | void |  | ) |

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 | ( | void |  | ) | const

virtual

Returns the syntaxes that this manager supports.

## getVerbose()

virtual bool Ogre::ResourceManager::getVerbose | ( | void |  | ) |

virtual inherited

Gets whether this manager and its resources habitually produce log output.

Definition at line 470 of file OgreResourceManager.h.

## isCacheDirty()

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

Returns true if the microcodecache changed during the run.

## isMicrocodeAvailableInCache()

virtual bool Ogre::GpuProgramManager::isMicrocodeAvailableInCache | ( | const String & | name | ) | const

virtual

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

Parameters

  name | The 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() [1/2]

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

  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

## load() [2/2]

virtual ResourcePtr Ogre::ResourceManager::load | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | loadParams = `0`,
|  | bool | backgroundThread = `false`
| ) |  |

virtual 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).

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

## 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

  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

## loadMicrocodeCache()

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

virtual

Loads the microcode cache from disk.

Parameters

  stream | The source stream

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr
| ) |  |

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) |

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## parseScript()

virtual void Ogre::ResourceManager::parseScript | ( | DataStreamPtr & | stream,
|  | const String & | groupName
| ) |  |

virtual inherited

Parse the definition of a set of resources from a script file.

Remarks
  Some resource managers can read script files in order to define resources ahead of time. These resources are added to the available list inside the manager, but none are loaded initially. This allows you to load the items that are used on demand, or to load them all as a group if you wish (through ResourceGroupManager).

Parameters

  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::MaterialManager, Ogre::CompositorManager, and Ogre::FontManager.

Definition at line 452 of file OgreResourceManager.h.

## prepare()

virtual ResourcePtr Ogre::ResourceManager::prepare | ( | const String & | name,
|  | const String & | group,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`,
|  | const NameValuePairList * | loadParams = `0`,
|  | bool | backgroundThread = `false`
| ) |  |

virtual 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).

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

## reloadAll()

virtual void Ogre::ResourceManager::reloadAll | ( | bool | reloadableOnly = `true` | ) |

virtual inherited

Caused all currently loaded resources to be reloaded.

Remarks
  All resources currently being held in this manager which are also marked as currently loaded will be unloaded, then loaded again.

Parameters

  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.

See also
  Resource::isReloadable for resource is reloadable.

## reloadUnreferencedResources()

virtual void Ogre::ResourceManager::reloadUnreferencedResources | ( | bool | reloadableOnly = `true` | ) |

virtual inherited

Caused all currently loaded but not referenced by any other object resources to be reloaded.

Remarks
  This method behaves like reloadAll, except that it only reloads resources which are not in use, i.e. not referenced by other objects.

  Some referenced resource may exists 'weak' pointer to their sub-components (e.g. Entity held pointer to SubMesh), in this case, unload or reload that resource will cause dangerous pointer access. Use this function instead of reloadAll allows you avoid fail in those situations.

Parameters

  reloadableOnly | If true (the default), only reloads resources which can be subsequently automatically reloaded.

## remove() [1/3]

virtual void Ogre::ResourceManager::remove | ( | ResourcePtr & | r | ) |

virtual inherited

Remove a single resource.

Remarks
  Removes a single resource, meaning it will be removed from the list of valid resources in this manager, also causing it to be unloaded.

Note
  The word 'Destroy' is not used here, since if any other pointers are referring to this resource, it will persist until they have finished with it; however to all intents and purposes it no longer exists and will likely get destroyed imminently.
  If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.

## remove() [2/3]

virtual void Ogre::ResourceManager::remove | ( | const String & | name | ) |

virtual inherited

Remove a single resource by name.

Remarks
  Removes a single resource, meaning it will be removed from the list of valid resources in this manager, also causing it to be unloaded.

Note
  The word 'Destroy' is not used here, since if any other pointers are referring to this resource, it will persist until they have finished with it; however to all intents and purposes it no longer exists and will likely get destroyed imminently.
  If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.

## remove() [3/3]

virtual void Ogre::ResourceManager::remove | ( | ResourceHandle | handle | ) |

virtual inherited

Remove a single resource by handle.

Remarks
  Removes a single resource, meaning it will be removed from the list of valid resources in this manager, also causing it to be unloaded.

Note
  The word 'Destroy' is not used here, since if any other pointers are referring to this resource, it will persist until they have finished with it; however to all intents and purposes it no longer exists and will likely get destroyed imminently.
  If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.

## removeAll()

virtual void Ogre::ResourceManager::removeAll | ( | void |  | ) |

virtual inherited

Removes all resources.

Note
  The word 'Destroy' is not used here, since if any other pointers are referring to these resources, they will persist until they have been finished with; however to all intents and purposes the resources no longer exist and will get destroyed imminently.
  If you do have shared pointers to resources hanging around after the ResourceManager is destroyed, you may get problems on destruction of these resources if they were relying on the manager (especially if it is a plugin). If you find you get problems on shutdown in the destruction of resources, try making sure you release all your shared pointers before you shutdown OGRE.

Reimplemented in Ogre::CompositorManager.

## removeImpl()

virtual void Ogre::ResourceManager::removeImpl | ( | ResourcePtr & | res | ) |

protected virtual inherited

Remove a resource from this manager; remove it from the lists.

## removeMicrocodeFromCache()

virtual void Ogre::GpuProgramManager::removeMicrocodeFromCache | ( | const String & | name | ) |

virtual

Removes a microcode for a program from the microcode cache.

Parameters

  name | The name of the program.

## removeUnreferencedResources()

virtual void Ogre::ResourceManager::removeUnreferencedResources | ( | bool | reloadableOnly = `true` | ) |

virtual inherited

Remove all resources which are not referenced by any other object.

Remarks
  This method behaves like removeAll, except that it only removes resources which are not in use, ie not referenced by other objects. This allows you to free up some memory selectively whilst still keeping the group around (and the resources present, just not using much memory).

  Some referenced resource may exists 'weak' pointer to their sub-components (e.g. Entity held pointer to SubMesh), in this case, remove or reload that resource will cause dangerous pointer access. Use this function instead of removeAll allows you avoid fail in those situations.

Parameters

  reloadableOnly | If true (the default), only removes resources which can be subsequently automatically reloaded.

## resourceExists() [1/2]

virtual bool Ogre::ResourceManager::resourceExists | ( | const String & | name | ) |

virtual inherited

Returns whether the named resource exists in this manager.

Definition at line 357 of file OgreResourceManager.h.

References Ogre::SharedPtr< T >::isNull().

## resourceExists() [2/2]

virtual bool Ogre::ResourceManager::resourceExists | ( | ResourceHandle | handle | ) |

virtual inherited

Returns whether a resource with the given handle exists in this manager.

Definition at line 362 of file OgreResourceManager.h.

References Ogre::SharedPtr< T >::isNull().

## saveMicrocodeCache()

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

virtual

Saves the microcode cache to disk.

Parameters

  stream | The destination stream

## setMemoryBudget()

virtual void Ogre::ResourceManager::setMemoryBudget | ( | size_t | bytes | ) |

virtual inherited

Set a limit on the amount of memory this resource handler may use.

Remarks
  If, when asked to load a new resource, the manager believes it will exceed this memory budget, it will temporarily unload a resource to make room for the new one. This unloading is not permanent and the Resource is not destroyed; it simply needs to be reloaded when next used.

## setSaveMicrocodesToCache()

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

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

## setVerbose()

virtual void Ogre::ResourceManager::setVerbose | ( | bool | v | ) |

virtual inherited

Sets whether this manager and its resources habitually produce log output.

Definition at line 467 of file OgreResourceManager.h.

## unload() [1/2]

virtual void Ogre::ResourceManager::unload | ( | const String & | name | ) |

virtual inherited

Unloads a single resource by name.

Remarks
  Unloaded resources are not removed, they simply free up their memory as much as they can and wait to be reloaded.

See also
  ResourceGroupManager for unloading of resource groups.

## unload() [2/2]

virtual void Ogre::ResourceManager::unload | ( | ResourceHandle | handle | ) |

virtual inherited

Unloads a single resource by handle.

Remarks
  Unloaded resources are not removed, they simply free up their memory as much as they can and wait to be reloaded.

See also
  ResourceGroupManager for unloading of resource groups.

## unloadAll()

virtual void Ogre::ResourceManager::unloadAll | ( | bool | reloadableOnly = `true` | ) |

virtual inherited

Unloads all resources.

Remarks
  Unloaded resources are not removed, they simply free up their memory as much as they can and wait to be reloaded.

See also
  ResourceGroupManager for unloading of resource groups.

Parameters

  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.

See also
  Resource::isReloadable for resource is reloadable.

## unloadUnreferencedResources()

virtual void Ogre::ResourceManager::unloadUnreferencedResources | ( | bool | reloadableOnly = `true` | ) |

virtual inherited

Unload all resources which are not referenced by any other object.

Remarks
  This method behaves like unloadAll, except that it only unloads resources which are not in use, ie not referenced by other objects. This allows you to free up some memory selectively whilst still keeping the group around (and the resources present, just not using much memory).

  Some referenced resource may exists 'weak' pointer to their sub-components (e.g. Entity held pointer to SubMesh), in this case, unload or reload that resource will cause dangerous pointer access. Use this function instead of unloadAll allows you avoid fail in those situations.

Parameters

  reloadableOnly | If true (the default), only unloads resources which can be subsequently automatically reloaded.

## Member Data Documentation

## mCacheDirty

bool Ogre::GpuProgramManager::mCacheDirty

protected

Definition at line 62 of file OgreGpuProgramManager.h.

## mLoadOrder

Real Ogre::ResourceManager::mLoadOrder

protected inherited

Loading order relative to other managers, higher is later.

Definition at line 559 of file OgreResourceManager.h.

## mMemoryBudget

size_t Ogre::ResourceManager::mMemoryBudget

protected inherited

Definition at line 548 of file OgreResourceManager.h.

## mMemoryUsage

AtomicScalar<size_t> Ogre::ResourceManager::mMemoryUsage

protected inherited

Definition at line 550 of file OgreResourceManager.h.

## mMicrocodeCache

MicrocodeMap Ogre::GpuProgramManager::mMicrocodeCache

protected

Definition at line 60 of file OgreGpuProgramManager.h.

## mNextHandle

AtomicScalar<ResourceHandle> Ogre::ResourceManager::mNextHandle

protected inherited

In bytes.

Definition at line 549 of file OgreResourceManager.h.

## mResourcePoolMap

ResourcePoolMap Ogre::ResourceManager::mResourcePoolMap

protected inherited

Definition at line 576 of file OgreResourceManager.h.

## mResources

ResourceMap Ogre::ResourceManager::mResources

protected inherited

Definition at line 546 of file OgreResourceManager.h.

## mResourcesByHandle

ResourceHandleMap Ogre::ResourceManager::mResourcesByHandle

protected inherited

Definition at line 545 of file OgreResourceManager.h.

## mResourcesWithGroup

ResourceWithGroupMap Ogre::ResourceManager::mResourcesWithGroup

protected inherited

Definition at line 547 of file OgreResourceManager.h.

## mResourceType

String Ogre::ResourceManager::mResourceType

protected inherited

String identifying the resource type this manager handles.

Definition at line 561 of file OgreResourceManager.h.

## mSaveMicrocodesToCache

bool Ogre::GpuProgramManager::mSaveMicrocodesToCache

protected

Definition at line 61 of file OgreGpuProgramManager.h.

## mScriptPatterns

StringVector Ogre::ResourceManager::mScriptPatterns

protected inherited

Patterns to use to look for scripts if supported (e.g. *.overlay)

Definition at line 557 of file OgreResourceManager.h.

## mSharedParametersMap

SharedParametersMap Ogre::GpuProgramManager::mSharedParametersMap

protected

Definition at line 59 of file OgreGpuProgramManager.h.

## msSingleton

GpuProgramManager * Ogre::Singleton< GpuProgramManager >::msSingleton

static protected inherited

Definition at line 75 of file OgreSingleton.h.

## mVerbose

bool Ogre::ResourceManager::mVerbose

protected inherited

In bytes.

Definition at line 552 of file OgreResourceManager.h.

## OGRE_AUTO_MUTEX

Ogre::ResourceManager::OGRE_AUTO_MUTEX

inherited

Definition at line 125 of file OgreResourceManager.h.

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

- OgreGpuProgramManager.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.