Ogre::ResourceManager Class Reference

Defines a generic resource handler. More...

#include <OgreResourceManager.h>

Inheritance diagram for Ogre::ResourceManager:

Collaboration diagram for Ogre::ResourceManager:

Classes
class	ResourcePool
	Definition of a pool of resources, which users can use to reuse similar resources many times without destroying and recreating them. More...

Public Types
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

Public Member Functions
	ResourceManager ()
virtual	~ResourceManager ()
virtual void	_notifyResourceLoaded (Resource *res)
	Notify this manager that a resource which it manages has been loaded. More...
virtual void	_notifyResourceTouched (Resource *res)
	Notify this manager that a resource which it manages has been 'touched', i.e. More...
virtual void	_notifyResourceUnloaded (Resource *res)
	Notify this manager that a resource which it manages has been unloaded. More...
virtual ResourceCreateOrRetrieveResult	createOrRetrieve (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
	Create a new resource, or retrieve an existing one with the same name if it already exists. More...
virtual ResourcePtr	createResource (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
	Creates a new blank resource, but does not immediately load it. More...
void	destroyAllResourcePools ()
	destroy all pools More...
void	destroyResourcePool (ResourcePool *pool)
	Destroy a resource pool. More...
void	destroyResourcePool (const String &name)
	Destroy a resource pool. More...
virtual ResourcePtr	getByHandle (ResourceHandle handle)
	Retrieves a pointer to a resource by handle, or null if the resource does not exist. More...
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 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...
virtual const StringVector &	getScriptPatterns (void) const
	Gets the file patterns which should be used to find scripts for this ResourceManager. More...
virtual bool	getVerbose (void)
	Gets whether this manager and its resources habitually produce log output. More...
virtual ResourcePtr	load (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, bool backgroundThread=false)
	Generic load method, used to create a Resource specific to this ResourceManager without using one of the specialised 'load' methods (containing per-Resource-type parameters). More...
void	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	removeUnreferencedResources (bool reloadableOnly=true)
	Remove all resources which are not referenced by any other object. More...
virtual bool	resourceExists (const String &name)
	Returns whether the named resource exists in this manager. More...
virtual bool	resourceExists (ResourceHandle handle)
	Returns whether a resource with the given handle exists in this manager. More...
virtual void	setMemoryBudget (size_t bytes)
	Set a limit on the amount of memory this resource handler may use. More...
virtual void	setVerbose (bool v)
	Sets whether this manager and its resources habitually produce log output. More...
virtual void	unload (const String &name)
	Unloads a single resource by name. More...
virtual void	unload (ResourceHandle handle)
	Unloads a single resource by handle. More...
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...

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

Protected Attributes
Real	mLoadOrder
	Loading order relative to other managers, higher is later. More...
size_t	mMemoryBudget
AtomicScalar< size_t >	mMemoryUsage
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...
StringVector	mScriptPatterns
	Patterns to use to look for scripts if supported (e.g. *.overlay) More...
bool	mVerbose
	In bytes. More...

Detailed Description

Defines a generic resource handler.

Remarks

A resource manager is responsible for managing a pool of resources of a particular type. It must index them, look them up, load and destroy them. It may also need to stay within a defined memory budget, and temporarily unload some resources if it needs to to stay within this budget.

Resource managers use a priority system to determine what can be unloaded, and a Least Recently Used (LRU) policy within resources of the same priority.

Resources can be loaded using the generalised load interface, and they can be unloaded and removed. In addition, each subclass of ResourceManager will likely define custom 'load' methods which take explicit parameters depending on the kind of resource being created.

Note

Resources can be loaded and unloaded through the Resource class, but they can only be removed (and thus eventually destroyed) using their parent ResourceManager.

If OGRE_THREAD_SUPPORT is 1, this class is thread-safe.

Definition at line 122 of file OgreResourceManager.h.

Member Typedef Documentation

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

Definition at line 152 of file OgreResourceManager.h.

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

Definition at line 543 of file OgreResourceManager.h.

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

Definition at line 541 of file OgreResourceManager.h.

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

Definition at line 564 of file OgreResourceManager.h.

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

protected

Definition at line 575 of file OgreResourceManager.h.

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

Definition at line 542 of file OgreResourceManager.h.

Constructor & Destructor Documentation

Ogre::ResourceManager::ResourceManager

(

)

virtual Ogre::ResourceManager::~ResourceManager ( )

virtual

Member Function Documentation

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

virtual

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

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

virtual

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

used.

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

virtual

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

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

protectedvirtual

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

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

protectedvirtual

Checks memory usage and pages out if required.

This is automatically done after a new resource is loaded.

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

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

Implemented in Ogre::MeshManager, Ogre::MaterialManager, Ogre::SkeletonManager, Ogre::FontManager, Ogre::BspResourceManager, Ogre::HighLevelGpuProgramManager, Ogre::CompositorManager, Ogre::GLTextureManager, Ogre::GLESTextureManager, Ogre::GLES2TextureManager, Ogre::GL3PlusTextureManager, Ogre::GLGpuProgramManager, Ogre::GL3PlusGpuProgramManager, Ogre::GLESGpuProgramManager, Ogre::GLES2GpuProgramManager, Ogre::D3D11GpuProgramManager, Ogre::D3D11TextureManager, Ogre::D3D9GpuProgramManager, and Ogre::D3D9TextureManager.

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

virtual

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.

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

virtual

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

void Ogre::ResourceManager::destroyAllResourcePools

(

)

destroy all pools

void Ogre::ResourceManager::destroyResourcePool

(

ResourcePool *

pool

)

Destroy a resource pool.

void Ogre::ResourceManager::destroyResourcePool

(

const String &

name

)

Destroy a resource pool.

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

virtual

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

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

inlinevirtual

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.

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

virtual

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

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

inlinevirtual

Gets the current memory usage, in bytes.

Definition at line 185 of file OgreResourceManager.h.

ResourceHandle Ogre::ResourceManager::getNextHandle ( void  )

protected

Allocates the next handle.

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

virtual

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

ResourceMapIterator Ogre::ResourceManager::getResourceIterator ( void  )

inline

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.

ResourcePool* Ogre::ResourceManager::getResourcePool

(

const String &

name

)

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

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

inline

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

Definition at line 464 of file OgreResourceManager.h.

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

inlinevirtual

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.

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

inlinevirtual

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

Definition at line 470 of file OgreResourceManager.h.

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

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

template<class Alloc >

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

inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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

inlinevirtual

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.

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

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

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

virtual

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

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

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

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

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

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 )

protectedvirtual

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

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

virtual

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 )

inlinevirtual

Returns whether the named resource exists in this manager.

Definition at line 357 of file OgreResourceManager.h.

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

inlinevirtual

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

Definition at line 362 of file OgreResourceManager.h.

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

virtual

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.

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

inlinevirtual

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

Definition at line 467 of file OgreResourceManager.h.

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

virtual

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

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

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

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

Real Ogre::ResourceManager::mLoadOrder

protected

Loading order relative to other managers, higher is later.

Definition at line 559 of file OgreResourceManager.h.

size_t Ogre::ResourceManager::mMemoryBudget

protected

Definition at line 548 of file OgreResourceManager.h.

AtomicScalar<size_t> Ogre::ResourceManager::mMemoryUsage

protected

Definition at line 550 of file OgreResourceManager.h.

AtomicScalar<ResourceHandle> Ogre::ResourceManager::mNextHandle

protected

In bytes.

Definition at line 549 of file OgreResourceManager.h.

ResourcePoolMap Ogre::ResourceManager::mResourcePoolMap

protected

Definition at line 576 of file OgreResourceManager.h.

ResourceMap Ogre::ResourceManager::mResources

protected

Definition at line 546 of file OgreResourceManager.h.

ResourceHandleMap Ogre::ResourceManager::mResourcesByHandle

protected

Definition at line 545 of file OgreResourceManager.h.

ResourceWithGroupMap Ogre::ResourceManager::mResourcesWithGroup

protected

Definition at line 547 of file OgreResourceManager.h.

String Ogre::ResourceManager::mResourceType

protected

String identifying the resource type this manager handles.

Definition at line 561 of file OgreResourceManager.h.

StringVector Ogre::ResourceManager::mScriptPatterns

protected

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

Definition at line 557 of file OgreResourceManager.h.

bool Ogre::ResourceManager::mVerbose

protected

In bytes.

Definition at line 552 of file OgreResourceManager.h.

Ogre::ResourceManager::OGRE_AUTO_MUTEX

Definition at line 125 of file OgreResourceManager.h.

---

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

• OgreResourceManager.h