Ogre::MaterialManager Class Reference

Class for managing Material settings for Ogre. More...

#include <OgreMaterialManager.h>

Inheritance diagram for Ogre::MaterialManager:

Classes
class	Listener
	Listener on any general material events. More...

Public Types
typedef std::pair< ResourcePtr, bool >	ResourceCreateOrRetrieveResult
typedef map< ResourceHandle, ResourcePtr >::type	ResourceHandleMap
typedef unordered_map< String, ResourcePtr >::type	ResourceMap
typedef MapIterator< ResourceHandleMap >	ResourceMapIterator
typedef unordered_map< String, ResourceMap >::type	ResourceWithGroupMap

Public Member Functions
	MaterialManager ()
	Default constructor. More...
virtual	~MaterialManager ()
	Default destructor. More...
virtual Technique *	_arbitrateMissingTechniqueForActiveScheme (Material *mat, unsigned short lodIndex, const Renderable *rend)
	Internal method for sorting out missing technique for a scheme. More...
virtual unsigned short	_getActiveSchemeIndex () const
	Internal method - returns the active scheme index. More...
virtual unsigned short	_getSchemeIndex (const String &name)
	Internal method - returns index for a given material scheme name. More...
virtual const String &	_getSchemeName (unsigned short index)
	Internal method - returns name for a given material scheme index. More...
virtual void	_notifyAfterIlluminationPassesCreated (Technique *mat)
	Internal method for sorting out illumination passes for a scheme. More...
virtual void	_notifyBeforeIlluminationPassesCleared (Technique *mat)
	Internal method for sorting out illumination passes for a scheme. More...
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	addListener (Listener *l, const Ogre::String &schemeName=BLANKSTRING)
	Add a listener to handle material events. More...
MaterialPtr	create (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
	Create a new material. More...
virtual ResourceCreateOrRetrieveResult	createOrRetrieve (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
	Create a new resource, or retrieve an existing one with the same name if it already exists. More...
virtual ResourcePtr	createResource (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *createParams=0)
	Creates a new blank resource, but does not immediately load it. More...
void	destroyAllResourcePools ()
	destroy all pools More...
void	destroyResourcePool (const String &name)
	Destroy a resource pool. More...
void	destroyResourcePool (ResourcePool *pool)
	Destroy a resource pool. More...
virtual const String &	getActiveScheme () const
	Returns the name of the active material scheme. More...
virtual ResourcePtr	getByHandle (ResourceHandle handle)
	Retrieves a pointer to a resource by handle, or null if the resource does not exist. More...
MaterialPtr	getByName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
	Get a resource by name. More...
virtual MaterialPtr	getDefaultSettings () const
	Returns a pointer to the default Material settings. More...
Real	getLoadingOrder () const override
	Gets the relative loading order of resources of this type. More...
virtual size_t	getMemoryBudget () const
	Get the limit on the amount of memory this resource handler may use. More...
virtual size_t	getMemoryUsage () const
	Gets the current memory usage, in bytes. More...
virtual ResourcePtr	getResourceByName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
	Retrieves a pointer to a resource by name, or null if the resource does not exist. More...
ResourceMapIterator	getResourceIterator ()
	Returns an iterator over all resources in this manager. More...
ResourcePool *	getResourcePool (const String &name)
	Create a resource pool, or reuse one that already exists. More...
const String &	getResourceType () const
	Gets a string identifying the type of resource this manager handles. More...
const StringVector &	getScriptPatterns () const override
	Gets the file patterns which should be used to find scripts for this ResourceManager. More...
virtual bool	getVerbose ()
	Gets whether this manager and its resources habitually produce log output. More...
void	initialise ()
	Initialises the material manager, which also triggers it to parse all available .program and .material scripts. 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, const char *, int, const char *)
void	operator delete (void *ptr, void *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
void *	operator new (size_t sz)
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 *ptr)
	placement operator new More...
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info More...
void	parseScript (DataStreamPtr &stream, const String &groupName) override
virtual ResourcePtr	prepare (const String &name, const String &group, bool isManual=false, ManualResourceLoader *loader=0, const NameValuePairList *loadParams=0, bool backgroundThread=false)
	Generic prepare method, used to create a Resource specific to this ResourceManager without using one of the specialised 'prepare' methods (containing per-Resource-type parameters). More...
void	reloadAll (bool reloadableOnly=true)
	Caused all currently loaded resources to be reloaded. More...
virtual void	reloadAll (Resource::LoadingFlags flags)
	Caused all currently loaded resources to be reloaded. More...
void	reloadUnreferencedResources (bool reloadableOnly=true)
	Caused all currently loaded but not referenced by any other object resources to be reloaded. More...
virtual void	remove (const ResourcePtr &r)
	Remove a single resource. More...
virtual void	remove (const String &name)
	Remove a single resource by name. More...
virtual void	remove (ResourceHandle handle)
	Remove a single resource by handle. More...
virtual void	removeAll ()
	Removes all resources. More...
virtual void	removeListener (Listener *l, const Ogre::String &schemeName=BLANKSTRING)
	Remove a listener handling material events. 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	setActiveScheme (const String &schemeName)
	Sets the name of the active material scheme. More...
virtual void	setMemoryBudget (size_t bytes)
	Set a limit on the amount of memory this resource handler may use. More...
virtual void	setVerbose (bool v)
	Sets whether this manager and its resources habitually produce log output. More...
virtual void	unload (const String &name)
	Unloads a single resource by name. More...
virtual void	unload (ResourceHandle handle)
	Unloads a single resource by handle. More...
void	unloadAll (bool reloadableOnly=true)
	Unloads all resources. More...
virtual void	unloadAll (Resource::LoadingFlags flags)
	Unloads all resources. More...
void	unloadUnreferencedResources (bool reloadableOnly=true)
	Unload all resources which are not referenced by any other object. More...

Static Public Member Functions
static MaterialManager &	getSingleton ()
	Override standard Singleton retrieval. More...
static MaterialManager *	getSingletonPtr ()
	Override standard Singleton retrieval. More...

Public Attributes
	OGRE_AUTO_MUTEX

Static Public Attributes
static String	DEFAULT_SCHEME_NAME
	Default material scheme. More...

Detailed Description

Class for managing Material settings for Ogre.

Remarks

Materials control the eventual surface rendering properties of geometry. This class manages the library of materials, dealing with programmatic registrations and lookups, as well as loading predefined Material settings from scripts.

When loaded from a script, a Material is in an 'unloaded' state and only stores the settings required. It does not at that stage load any textures. This is because the material settings may be loaded 'en masse' from bulk material script files, but only a subset will actually be required.

Because this is a subclass of ResourceManager, any files loaded will be searched for in any path or archive added to the resource paths/archives. See ResourceManager for details.

For a definition of the material script format, see the Tutorials/MaterialScript.html file.

Member Typedef Documentation

ResourceCreateOrRetrieveResult

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

inherited

ResourceHandleMap

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

inherited

ResourceMap

typedef unordered_map< String, ResourcePtr >::type Ogre::ResourceManager::ResourceMap

inherited

ResourceMapIterator

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

inherited

ResourceWithGroupMap

typedef unordered_map< String, ResourceMap >::type Ogre::ResourceManager::ResourceWithGroupMap

inherited

Constructor & Destructor Documentation

MaterialManager()

Ogre::MaterialManager::MaterialManager

(

)

Default constructor.

~MaterialManager()

virtual Ogre::MaterialManager::~MaterialManager ( )

virtual

Default destructor.

Member Function Documentation

_arbitrateMissingTechniqueForActiveScheme()

virtual Technique* Ogre::MaterialManager::_arbitrateMissingTechniqueForActiveScheme ( Material *  mat, unsigned short  lodIndex, const Renderable *  rend  )

virtual

Internal method for sorting out missing technique for a scheme.

_getActiveSchemeIndex()

virtual unsigned short Ogre::MaterialManager::_getActiveSchemeIndex ( ) const

virtual

Internal method - returns the active scheme index.

See also

Technique::setSchemeName

_getSchemeIndex()

virtual unsigned short Ogre::MaterialManager::_getSchemeIndex ( const String &  name )

virtual

Internal method - returns index for a given material scheme name.

See also

Technique::setSchemeName

_getSchemeName()

virtual const String& Ogre::MaterialManager::_getSchemeName ( unsigned short  index )

virtual

Internal method - returns name for a given material scheme index.

See also

Technique::setSchemeName

_notifyAfterIlluminationPassesCreated()

virtual void Ogre::MaterialManager::_notifyAfterIlluminationPassesCreated ( Technique *  mat )

virtual

Internal method for sorting out illumination passes for a scheme.

_notifyBeforeIlluminationPassesCleared()

virtual void Ogre::MaterialManager::_notifyBeforeIlluminationPassesCleared ( Technique *  mat )

virtual

Internal method for sorting out illumination passes for a scheme.

_notifyResourceLoaded()

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

virtualinherited

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

_notifyResourceTouched()

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

virtualinherited

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

used.

_notifyResourceUnloaded()

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

virtualinherited

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

addListener()

virtual void Ogre::MaterialManager::addListener ( Listener *  l, const Ogre::String &  schemeName = BLANKSTRING  )

virtual

Add a listener to handle material events.

If schemeName is supplied, the listener will only receive events for that certain scheme.

create()

MaterialPtr Ogre::MaterialManager::create	(	const String &	name,
		const String &	group,
		bool	isManual = false,
		ManualResourceLoader *	loader = 0,
		const NameValuePairList *	createParams = 0
	)

Create a new material.

See also

ResourceManager::createResource

createOrRetrieve()

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

virtualinherited

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.

createResource()

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

virtualinherited

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

destroyAllResourcePools()

void Ogre::ResourceManager::destroyAllResourcePools ( )

inherited

destroy all pools

destroyResourcePool() [1/2]

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

inherited

Destroy a resource pool.

destroyResourcePool() [2/2]

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

inherited

Destroy a resource pool.

getActiveScheme()

virtual const String& Ogre::MaterialManager::getActiveScheme ( ) const

virtual

Returns the name of the active material scheme.

See also

Technique::setSchemeName

getByHandle()

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

virtualinherited

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

getByName()

MaterialPtr Ogre::MaterialManager::getByName	(	const String &	name,
		const String &	groupName = ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME
	)

Get a resource by name.

See also

ResourceManager::getResourceByName

getDefaultSettings()

virtual MaterialPtr Ogre::MaterialManager::getDefaultSettings ( ) const

inlinevirtual

Returns a pointer to the default Material settings.

Remarks

Ogre comes configured with a set of defaults for newly created materials. If you wish to have a different set of defaults, simply call this method and change the returned Material's settings. All materials created from then on will be configured with the new defaults you have specified.

The default settings begin as a single Technique with a single, non-programmable Pass:

• ambient = ColourValue::White
• diffuse = ColourValue::White
• specular = ColourValue::Black
• emmissive = ColourValue::Black
• shininess = 0
• No texture unit settings (& hence no textures)
• SourceBlendFactor = SBF_ONE
• DestBlendFactor = SBF_ZERO (no blend, replace with new colour)
• Depth buffer checking on
• Depth buffer writing on
• Depth buffer comparison function = CMPF_LESS_EQUAL
• Colour buffer writing on for all channels
• Culling mode = CULL_CLOCKWISE
• Ambient lighting = ColourValue(0.5, 0.5, 0.5) (mid-grey)
• Dynamic lighting enabled
• Gourad shading mode
• Bilinear texture filtering

getLoadingOrder()

Real Ogre::ResourceManager::getLoadingOrder ( ) const

inlineoverridevirtualinherited

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.

getMemoryBudget()

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

virtualinherited

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

getMemoryUsage()

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

inlinevirtualinherited

Gets the current memory usage, in bytes.

getResourceByName()

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

virtualinherited

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

getResourceIterator()

ResourceMapIterator Ogre::ResourceManager::getResourceIterator ( )

inlineinherited

Returns an iterator over all resources in this manager.

Note

Use of this iterator is NOT thread safe!

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

inlineinherited

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

getScriptPatterns()

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

inlineoverridevirtualinherited

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.

getSingleton()

static MaterialManager& Ogre::MaterialManager::getSingleton ( )

static

Override standard Singleton retrieval.

Remarks

Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

getSingletonPtr()

static MaterialManager* Ogre::MaterialManager::getSingletonPtr ( )

static

Override standard Singleton retrieval.

Remarks

Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

getVerbose()

virtual bool Ogre::ResourceManager::getVerbose ( )

inlinevirtualinherited

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

initialise()

void Ogre::MaterialManager::initialise

(

)

Initialises the material manager, which also triggers it to parse all available .program and .material scripts.

load()

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

virtualinherited

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

operator delete() [1/3]

template<class Alloc >

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

inlineinherited

operator delete() [2/3]

template<class Alloc >

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

inlineinherited

operator delete() [3/3]

template<class Alloc >

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

inlineinherited

operator delete[]() [1/2]

template<class Alloc >

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

inlineinherited

operator delete[]() [2/2]

template<class Alloc >

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

inlineinherited

operator new() [1/3]

template<class Alloc >

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

inlineinherited

operator new() [2/3]

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

operator new() [3/3]

template<class Alloc >

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

inlineinherited

placement operator new

operator new[]() [1/2]

template<class Alloc >

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

inlineinherited

operator new[]() [2/2]

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

parseScript()

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

overridevirtual

See also

ScriptLoader::parseScript

Implements Ogre::ScriptLoader.

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  )

virtualinherited

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

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

inlineinherited

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.

References Ogre::Resource::LF_DEFAULT, and Ogre::Resource::LF_INCLUDE_NON_RELOADABLE.

reloadAll() [2/2]

virtual void Ogre::ResourceManager::reloadAll ( Resource::LoadingFlags  flags )

virtualinherited

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

flags

Allow to restrict processing to only reloadable and/or unreferenced resources. Additionally, reloading could be done with preserving some selected resource states that could be used elsewhere.

See also

Resource::LoadingFlags for additional information.

reloadUnreferencedResources()

void Ogre::ResourceManager::reloadUnreferencedResources ( bool  reloadableOnly = true )

inlineinherited

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.

References Ogre::Resource::LF_ONLY_UNREFERENCED, and Ogre::Resource::LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE.

remove() [1/3]

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

virtualinherited

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 )

virtualinherited

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 )

virtualinherited

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

virtualinherited

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.

removeListener()

virtual void Ogre::MaterialManager::removeListener ( Listener *  l, const Ogre::String &  schemeName = BLANKSTRING  )

virtual

Remove a listener handling material events.

If the listener was added with a custom scheme name, it needs to be supplied here as well.

removeUnreferencedResources()

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

virtualinherited

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 )

inlinevirtualinherited

Returns whether the named resource exists in this manager.

resourceExists() [2/2]

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

inlinevirtualinherited

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

setActiveScheme()

virtual void Ogre::MaterialManager::setActiveScheme ( const String &  schemeName )

virtual

Sets the name of the active material scheme.

See also

Technique::setSchemeName

setMemoryBudget()

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

virtualinherited

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.

setVerbose()

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

inlinevirtualinherited

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

unload() [1/2]

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

virtualinherited

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 )

virtualinherited

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

void Ogre::ResourceManager::unloadAll ( bool  reloadableOnly = true )

inlineinherited

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.

References Ogre::Resource::LF_DEFAULT, and Ogre::Resource::LF_INCLUDE_NON_RELOADABLE.

unloadAll() [2/2]

virtual void Ogre::ResourceManager::unloadAll ( Resource::LoadingFlags  flags )

virtualinherited

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

flags

Allow to restrict processing to only reloadable and/or unreferenced resources.

See also

Resource::LoadingFlags for additional information.

unloadUnreferencedResources()

void Ogre::ResourceManager::unloadUnreferencedResources ( bool  reloadableOnly = true )

inlineinherited

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.

References Ogre::Resource::LF_ONLY_UNREFERENCED, and Ogre::Resource::LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE.

Member Data Documentation

DEFAULT_SCHEME_NAME

String Ogre::MaterialManager::DEFAULT_SCHEME_NAME

static

Default material scheme.

OGRE_AUTO_MUTEX

Ogre::ResourceManager::OGRE_AUTO_MUTEX

inherited

---

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

• OgreMaterialManager.h