Ogre::GLGpuProgramManager Class Reference

`#include <OgreGLGpuProgramManager.h>`

Inheritance diagram for Ogre::GLGpuProgramManager:
[legend]

List of all members.

## Public Types

typedef GpuProgram *(* | CreateGpuProgramCallback )(ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, GpuProgramType gptype, const String &syntaxCode)
typedef set< String >::type | SyntaxCodes
typedef map< String, GpuSharedParametersPtr >::type | SharedParametersMap
typedef MemoryDataStreamPtr | Microcode
typedef map< String, Microcode > ::type | MicrocodeMap
typedef std::pair< ResourcePtr, bool > | ResourceCreateOrRetrieveResult
typedef HashMap< String, ResourcePtr > | ResourceMap
typedef HashMap< String, ResourceMap > | ResourceWithGroupMap
typedef map< ResourceHandle, ResourcePtr >::type | ResourceHandleMap
typedef MapIterator < ResourceHandleMap > | ResourceMapIterator

## Public Member Functions

| GLGpuProgramManager ()
| ~GLGpuProgramManager ()
bool | registerProgramFactory (const String &syntaxCode, CreateGpuProgramCallback createFn)
bool | unregisterProgramFactory (const String &syntaxCode)
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.
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).
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.
virtual const SyntaxCodes & | getSupportedSyntax (void) const
| Returns the syntaxes that this manager supports.
virtual bool | isSyntaxSupported (const String &syntaxCode) const
| Returns whether a given syntax code (e.g.
virtual GpuProgramParametersSharedPtr | createParameters (void)
| Creates a new GpuProgramParameters instance which can be used to bind parameters to your programs.
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.
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.
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.
virtual ResourcePtr | create (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.
ResourcePtr | getByName (const String &name, bool preferHighLevelPrograms=true)
| Overrides the standard ResourceManager getByName method.
virtual ResourcePtr | getByName (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.
virtual GpuSharedParametersPtr | createSharedParameters (const String &name)
| Create a new set of shared parameters, which can be used across many GpuProgramParameters objects of different structures.
virtual GpuSharedParametersPtr | getSharedParameters (const String &name) const
| Retrieve a set of shared parameters, which can be used across many GpuProgramParameters objects of different structures.
virtual const SharedParametersMap & | getAvailableSharedParameters () const
| Get (const) access to the available shared parameter sets.
bool | getSaveMicrocodesToCache ()
| Get if the microcode of a shader should be saved to a cache.
void | setSaveMicrocodesToCache (const bool val)
| Set if the microcode of a shader should be saved to a cache.
bool | canGetCompiledShaderBuffer ()
virtual bool | isMicrocodeAvailableInCache (const String &name) const
| Check if a microcode is available for a program in the microcode cache.
virtual const Microcode & | getMicrocodeFromCache (const String &name) const
| Returns a microcode for a program from the microcode cache.
virtual Microcode | createMicrocode (const size_t size) const
| Creates a microcode to be later added to the cache.
virtual void | addMicrocodeToCache (const String &name, const Microcode &microcode)
| Adds a microcode for a program to the microcode cache.
virtual void | saveMicrocodeCache (DataStreamPtr stream) const
| Saves the microcode cache to disk.
virtual void | loadMicrocodeCache (DataStreamPtr stream)
| Loads the microcode cache from disk.
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.
virtual void | setMemoryBudget (size_t bytes)
| Set a limit on the amount of memory this resource handler may use.
virtual size_t | getMemoryBudget (void) const
| Get the limit on the amount of memory this resource handler may use.
virtual size_t | getMemoryUsage (void) const
| Gets the current memory usage, in bytes.
virtual void | unload (const String &name)
| Unloads a single resource by name.
virtual void | unload (ResourceHandle handle)
| Unloads a single resource by handle.
virtual void | unloadAll (bool reloadableOnly=true)
| Unloads all resources.
virtual void | reloadAll (bool reloadableOnly=true)
| Caused all currently loaded resources to be reloaded.
virtual void | unloadUnreferencedResources (bool reloadableOnly=true)
| Unload all resources which are not referenced by any other object.
virtual void | reloadUnreferencedResources (bool reloadableOnly=true)
| Caused all currently loaded but not referenced by any other object resources to be reloaded.
virtual void | remove (ResourcePtr &r)
| Remove a single resource.
virtual void | remove (const String &name)
| Remove a single resource by name.
virtual void | remove (ResourceHandle handle)
| Remove a single resource by handle.
virtual void | removeAll (void)
| Removes all resources.
virtual void | removeUnreferencedResources (bool reloadableOnly=true)
| Remove all resources which are not referenced by any other object.
virtual ResourcePtr | getByHandle (ResourceHandle handle)
| Retrieves a pointer to a resource by handle, or null if the resource does not exist.
virtual bool | resourceExists (const String &name)
| Returns whether the named resource exists in this manager.
virtual bool | resourceExists (ResourceHandle handle)
| Returns whether a resource with the given handle exists in this manager.
virtual void | _notifyResourceTouched (Resource *res)
| Notify this manager that a resource which it manages has been 'touched', i.e.
virtual void | _notifyResourceLoaded (Resource *res)
| Notify this manager that a resource which it manages has been loaded.
virtual void | _notifyResourceUnloaded (Resource *res)
| Notify this manager that a resource which it manages has been unloaded.
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).
virtual const StringVector & | getScriptPatterns (void) const
| Gets the file patterns which should be used to find scripts for this ResourceManager.
virtual void | parseScript (DataStreamPtr &stream, const String &groupName)
| Parse the definition of a set of resources from a script file.
virtual Real | getLoadingOrder (void) const
| Gets the relative loading order of resources of this type.
const String & | getResourceType (void) const
| Gets a string identifying the type of resource this manager handles.
virtual void | setVerbose (bool v)
| Sets whether this manager and its resources habitually produce log output.
virtual bool | getVerbose (void)
| Gets whether this manager and its resources habitually produce log output.
ResourcePool * | getResourcePool (const String &name)
| Create a resource pool, or reuse one that already exists.
void | destroyResourcePool (ResourcePool *pool)
| Destroy a resource pool.
void | destroyResourcePool (const String &name)
| Destroy a resource pool.
void | destroyAllResourcePools ()
| destroy all pools
ResourceMapIterator | getResourceIterator (void)
| Returns an iterator over all resources in this manager.
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info
void * | operator new[] (size_t sz)
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 *)

## Static Public Member Functions

static GpuProgramManager & | getSingleton (void)
| Override standard Singleton retrieval.
static GpuProgramManager * | getSingletonPtr (void)
| Override standard Singleton retrieval.

## Protected Types

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

## Protected Member Functions

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

## Static Protected Member Functions

static String | addRenderSystemToName (const String &name)

## Protected Attributes

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

## Static Protected Attributes

static GpuProgramManager * | msSingleton

## Private Types

typedef map< String, CreateGpuProgramCallback > ::type | ProgramMap

## Private Attributes

ProgramMap | mProgramMap

## Detailed Description

Definition at line 37 of file OgreGLGpuProgramManager.h.

## Member Typedef Documentation

typedef GpuProgram*(* Ogre::GLGpuProgramManager::CreateGpuProgramCallback)(ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader *loader, GpuProgramType gptype, const String &syntaxCode)

Definition at line 40 of file OgreGLGpuProgramManager.h.

typedef MemoryDataStreamPtr Ogre::GpuProgramManager::Microcode`[inherited]`

Definition at line 53 of file OgreGpuProgramManager.h.

typedef map<String, Microcode>::type Ogre::GpuProgramManager::MicrocodeMap`[inherited]`

Definition at line 54 of file OgreGpuProgramManager.h.

typedef map<String, CreateGpuProgramCallback>::type Ogre::GLGpuProgramManager::ProgramMap`[private]`

Definition at line 46 of file OgreGLGpuProgramManager.h.

typedef std::pair<ResourcePtr, bool> Ogre::ResourceManager::ResourceCreateOrRetrieveResult`[inherited]`

Definition at line 103 of file OgreResourceManager.h.

typedef map<ResourceHandle, ResourcePtr>::type Ogre::ResourceManager::ResourceHandleMap`[inherited]`

Definition at line 494 of file OgreResourceManager.h.

typedef HashMap< String, ResourcePtr > Ogre::ResourceManager::ResourceMap`[inherited]`

Definition at line 492 of file OgreResourceManager.h.

typedef MapIterator<ResourceHandleMap> Ogre::ResourceManager::ResourceMapIterator`[inherited]`

Definition at line 515 of file OgreResourceManager.h.

typedef map<String, ResourcePool*>::type Ogre::ResourceManager::ResourcePoolMap`[protected, inherited]`

Definition at line 526 of file OgreResourceManager.h.

typedef HashMap< String, ResourceMap > Ogre::ResourceManager::ResourceWithGroupMap`[inherited]`

Definition at line 493 of file OgreResourceManager.h.

typedef map<String, GpuSharedParametersPtr>::type Ogre::GpuProgramManager::SharedParametersMap`[inherited]`

Definition at line 51 of file OgreGpuProgramManager.h.

typedef set<String>::type Ogre::GpuProgramManager::SyntaxCodes`[inherited]`

Definition at line 50 of file OgreGpuProgramManager.h.

## Constructor & Destructor Documentation

Ogre::GLGpuProgramManager::GLGpuProgramManager | ( |  | ) |

Ogre::GLGpuProgramManager::~GLGpuProgramManager | ( |  | ) |

## Member Function Documentation

virtual void Ogre::ResourceManager::_notifyResourceLoaded | ( | Resource * | res | ) | `[virtual, inherited]`

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

virtual void Ogre::ResourceManager::_notifyResourceTouched | ( | Resource * | res | ) | `[virtual, inherited]`

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

used.

virtual void Ogre::ResourceManager::_notifyResourceUnloaded | ( | Resource * | res | ) | `[virtual, inherited]`

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

virtual void Ogre::ResourceManager::addImpl | ( | ResourcePtr & | res | ) | `[protected, virtual, inherited]`

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

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

Adds a microcode for a program to the microcode cache.

Parameters:

  name | The name of the program.

static String Ogre::GpuProgramManager::addRenderSystemToName | ( | const String & | name | ) | `[static, protected, inherited]`

bool Ogre::GpuProgramManager::canGetCompiledShaderBuffer | ( |  | ) | `[inherited]`

virtual void Ogre::ResourceManager::checkUsage | ( | void |  | ) | `[protected, virtual, inherited]`

Checks memory usage and pages out if required.

virtual ResourcePtr Ogre::ResourceManager::create | ( | 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

virtual ResourcePtr Ogre::GpuProgramManager::create | ( | const String & | name,
|  | const String & | group,
|  | GpuProgramType | gptype,
|  | const String & | syntaxCode,
|  | bool | isManual = `false`,
|  | ManualResourceLoader * | loader = `0`
| ) |  | `[virtual, inherited]`

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

Resource* Ogre::GLGpuProgramManager::createImpl | ( | const String & | name,
|  | ResourceHandle | handle,
|  | const String & | group,
|  | bool | isManual,
|  | ManualResourceLoader * | loader,
|  | const NameValuePairList * | params
| ) |  | `[protected, virtual]`

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.

Implements Ogre::ResourceManager.

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

Specialised create method with specific parameters.

Implements Ogre::GpuProgramManager.

virtual Microcode Ogre::GpuProgramManager::createMicrocode | ( | const size_t | size | ) | const`[virtual, inherited]`

Creates a microcode to be later added to the cache.

Parameters:

  size | The size of the microcode in bytes

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::create
  ResourceManager::getByName

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

virtual GpuProgramParametersSharedPtr Ogre::GpuProgramManager::createParameters | ( | void |  | ) | `[virtual, inherited]`

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.

virtual GpuProgramPtr Ogre::GpuProgramManager::createProgram | ( | const String & | name,
|  | const String & | groupName,
|  | const String & | filename,
|  | GpuProgramType | gptype,
|  | const String & | syntaxCode
| ) |  | `[virtual, inherited]`

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

virtual GpuProgramPtr Ogre::GpuProgramManager::createProgramFromString | ( | const String & | name,
|  | const String & | groupName,
|  | const String & | code,
|  | GpuProgramType | gptype,
|  | const String & | syntaxCode
| ) |  | `[virtual, inherited]`

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

virtual GpuSharedParametersPtr Ogre::GpuProgramManager::createSharedParameters | ( | const String & | name | ) | `[virtual, inherited]`

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.

void Ogre::ResourceManager::destroyAllResourcePools | ( |  | ) | `[inherited]`

destroy all pools

void Ogre::ResourceManager::destroyResourcePool | ( | ResourcePool * | pool | ) | `[inherited]`

Destroy a resource pool.

void Ogre::ResourceManager::destroyResourcePool | ( | const String & | name | ) | `[inherited]`

Destroy a resource pool.

virtual const SharedParametersMap& Ogre::GpuProgramManager::getAvailableSharedParameters | ( |  | ) | const`[virtual, inherited]`

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

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.

ResourcePtr Ogre::GpuProgramManager::getByName | ( | const String & | name,
|  | bool | preferHighLevelPrograms = `true`
| ) |  | `[inherited]`

Overrides the standard ResourceManager getByName 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.

virtual ResourcePtr Ogre::ResourceManager::getByName | ( | 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.

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 412 of file OgreResourceManager.h.

virtual size_t Ogre::ResourceManager::getMemoryBudget | ( | void |  | ) | const`[virtual, inherited]`

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

virtual size_t Ogre::ResourceManager::getMemoryUsage | ( | void |  | ) | const`[virtual, inherited]`

Gets the current memory usage, in bytes.

Definition at line 136 of file OgreResourceManager.h.

virtual const Microcode& Ogre::GpuProgramManager::getMicrocodeFromCache | ( | const String & | name | ) | const`[virtual, inherited]`

Returns a microcode for a program from the microcode cache.

Parameters:

  name | The name of the program.

ResourceHandle Ogre::ResourceManager::getNextHandle | ( | void |  | ) | `[protected, inherited]`

Allocates the next handle.

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 520 of file OgreResourceManager.h.

ResourcePool* Ogre::ResourceManager::getResourcePool | ( | const String & | name | ) | `[inherited]`

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

const String& Ogre::ResourceManager::getResourceType | ( | void |  | ) | const`[inherited]`

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

Definition at line 415 of file OgreResourceManager.h.

bool Ogre::GpuProgramManager::getSaveMicrocodesToCache | ( |  | ) | `[inherited]`

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

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 388 of file OgreResourceManager.h.

virtual GpuSharedParametersPtr Ogre::GpuProgramManager::getSharedParameters | ( | const String & | name | ) | const`[virtual, inherited]`

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

static GpuProgramManager& Ogre::GpuProgramManager::getSingleton | ( | void |  | ) | `[static, inherited]`

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.

Reimplemented from Ogre::Singleton< GpuProgramManager >.

static GpuProgramManager* Ogre::GpuProgramManager::getSingletonPtr | ( | void |  | ) | `[static, inherited]`

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.

Reimplemented from Ogre::Singleton< GpuProgramManager >.

virtual const SyntaxCodes& Ogre::GpuProgramManager::getSupportedSyntax | ( | void |  | ) | const`[virtual, inherited]`

Returns the syntaxes that this manager supports.

virtual bool Ogre::ResourceManager::getVerbose | ( | void |  | ) | `[virtual, inherited]`

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

Definition at line 421 of file OgreResourceManager.h.

virtual bool Ogre::GpuProgramManager::isMicrocodeAvailableInCache | ( | const String & | name | ) | const`[virtual, inherited]`

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

Parameters:

  name | The name of the program.

virtual bool Ogre::GpuProgramManager::isSyntaxSupported | ( | const String & | syntaxCode | ) | const`[virtual, inherited]`

Returns whether a given syntax code (e.g.

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

virtual GpuProgramPtr Ogre::GpuProgramManager::load | ( | const String & | name,
|  | const String & | groupName,
|  | const String & | filename,
|  | GpuProgramType | gptype,
|  | const String & | syntaxCode
| ) |  | `[virtual, inherited]`

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

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

virtual GpuProgramPtr Ogre::GpuProgramManager::loadFromString | ( | const String & | name,
|  | const String & | groupName,
|  | const String & | code,
|  | GpuProgramType | gptype,
|  | const String & | syntaxCode
| ) |  | `[virtual, inherited]`

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

virtual void Ogre::GpuProgramManager::loadMicrocodeCache | ( | DataStreamPtr | stream | ) | `[virtual, inherited]`

Loads the microcode cache from disk.

Parameters:

  stream | The source stream

template<class Alloc >

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

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 118 of file OgreMemoryAllocatedObject.h.

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 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

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 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 90 of file OgreMemoryAllocatedObject.h.

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 403 of file OgreResourceManager.h.

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

bool Ogre::GLGpuProgramManager::registerProgramFactory | ( | const String & | syntaxCode,
|  | CreateGpuProgramCallback | createFn
| ) |  |

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.

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.

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.

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.

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.

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.

virtual void Ogre::ResourceManager::removeImpl | ( | ResourcePtr & | res | ) | `[protected, virtual, inherited]`

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

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.

virtual bool Ogre::ResourceManager::resourceExists | ( | const String & | name | ) | `[virtual, inherited]`

Returns whether the named resource exists in this manager.

Definition at line 308 of file OgreResourceManager.h.

virtual bool Ogre::ResourceManager::resourceExists | ( | ResourceHandle | handle | ) | `[virtual, inherited]`

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

Definition at line 313 of file OgreResourceManager.h.

virtual void Ogre::GpuProgramManager::saveMicrocodeCache | ( | DataStreamPtr | stream | ) | const`[virtual, inherited]`

Saves the microcode cache to disk.

Parameters:

  stream | The destination stream

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.

void Ogre::GpuProgramManager::setSaveMicrocodesToCache | ( | const bool | val | ) | `[inherited]`

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

virtual void Ogre::ResourceManager::setVerbose | ( | bool | v | ) | `[virtual, inherited]`

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

Definition at line 418 of file OgreResourceManager.h.

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.

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.

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.

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.

bool Ogre::GLGpuProgramManager::unregisterProgramFactory | ( | const String & | syntaxCode | ) |

## Member Data Documentation

Real Ogre::ResourceManager::mLoadOrder`[protected, inherited]`

Loading order relative to other managers, higher is later.

Definition at line 510 of file OgreResourceManager.h.

size_t Ogre::ResourceManager::mMemoryBudget`[protected, inherited]`

Definition at line 500 of file OgreResourceManager.h.

AtomicScalar<size_t> Ogre::ResourceManager::mMemoryUsage`[protected, inherited]`

Definition at line 501 of file OgreResourceManager.h.

MicrocodeMap Ogre::GpuProgramManager::mMicrocodeCache`[protected, inherited]`

Definition at line 59 of file OgreGpuProgramManager.h.

ResourceHandle Ogre::ResourceManager::mNextHandle`[protected, inherited]`

Definition at line 499 of file OgreResourceManager.h.

ProgramMap Ogre::GLGpuProgramManager::mProgramMap`[private]`

Definition at line 47 of file OgreGLGpuProgramManager.h.

ResourcePoolMap Ogre::ResourceManager::mResourcePoolMap`[protected, inherited]`

Definition at line 527 of file OgreResourceManager.h.

ResourceMap Ogre::ResourceManager::mResources`[protected, inherited]`

Definition at line 497 of file OgreResourceManager.h.

ResourceHandleMap Ogre::ResourceManager::mResourcesByHandle`[protected, inherited]`

Definition at line 496 of file OgreResourceManager.h.

ResourceWithGroupMap Ogre::ResourceManager::mResourcesWithGroup`[protected, inherited]`

Definition at line 498 of file OgreResourceManager.h.

String Ogre::ResourceManager::mResourceType`[protected, inherited]`

String identifying the resource type this manager handles.

Definition at line 512 of file OgreResourceManager.h.

bool Ogre::GpuProgramManager::mSaveMicrocodesToCache`[protected, inherited]`

Definition at line 60 of file OgreGpuProgramManager.h.

StringVector Ogre::ResourceManager::mScriptPatterns`[protected, inherited]`

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

Definition at line 508 of file OgreResourceManager.h.

SharedParametersMap Ogre::GpuProgramManager::mSharedParametersMap`[protected, inherited]`

Definition at line 58 of file OgreGpuProgramManager.h.

GpuProgramManager * Ogre::Singleton< GpuProgramManager >::msSingleton`[static, protected, inherited]`

Definition at line 75 of file OgreSingleton.h.

bool Ogre::ResourceManager::mVerbose`[protected, inherited]`

Definition at line 503 of file OgreResourceManager.h.

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

- OgreGLGpuProgramManager.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sun Sep 2 2012 07:27:52