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 std::map< ResourceHandle, ResourcePtr >	ResourceHandleMap

typedef std::unordered_map< String, ResourcePtr >	ResourceMap

typedef MapIterator< ResourceHandleMap >	ResourceMapIterator

typedef std::unordered_map< String, ResourceMap >	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 (void) 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...

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

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 const String &	getActiveScheme (void) 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...

unsigned int	getDefaultAnisotropy () const
	Get the default maxAnisotropy. More...

MaterialPtr	getDefaultMaterial (bool useLighting=true)
	Get a default material that is always available even when no resources were loaded. More...

virtual MaterialPtr	getDefaultSettings (void) const
	Returns a pointer to the default Material settings. More...

virtual FilterOptions	getDefaultTextureFiltering (FilterType ftype) const
	Get the default texture filtering. More...

Real	getLoadingOrder (void) const
	Gets the relative loading order of resources of this type. More...

size_t	getMemoryBudget (void) const
	Get the limit on the amount of memory this resource handler may use. More...

size_t	getMemoryUsage (void) const
	Gets the current memory usage, in bytes. More...

virtual ResourcePtr	getResourceByName (const String &name, const String &groupName=RGN_DEFAULT)
	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...

const StringVector &	getScriptPatterns (void) const
	Gets the file patterns which should be used to find scripts for this ResourceManager. More...

bool	getVerbose (void)
	Gets whether this manager and its resources habitually produce log output. More...

void	initialise (void)
	Initialises the material manager, which also triggers it to parse all available .program and .material scripts. More...

ResourcePtr	load (const String &name, const String &group, bool isManual=false, ManualResourceLoader loader=0, const NameValuePairList loadParams=0, bool backgroundThread=false)
	Generic load method, used to create a Resource specific to this ResourceManager without using one of the specialised 'load' methods (containing per-Resource-type parameters). More...

void	parseScript (DataStreamPtr &stream, const String &groupName)

ResourcePtr	prepare (const String &name, const String &group, bool isManual=false, ManualResourceLoader loader=0, const NameValuePairList loadParams=0, bool backgroundThread=false)
	Generic prepare method, used to create a Resource specific to this ResourceManager without using one of the specialised 'prepare' methods (containing per-Resource-type parameters). More...

void	reloadAll (bool reloadableOnly=true)
	Caused all currently loaded resources to be reloaded. More...

virtual void	reloadAll (Resource::LoadingFlags flags)
	Caused all currently loaded resources to be reloaded. More...

void	reloadUnreferencedResources (bool reloadableOnly=true)
	Caused all currently loaded but not referenced by any other object resources to be reloaded. More...

void	remove (const ResourcePtr &r)
	Remove a single resource. More...

void	remove (const String &name, const String &group=RGN_DEFAULT)

void	remove (ResourceHandle handle)

virtual void	removeAll (void)
	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...

bool	resourceExists (const String &name, const String &group=RGN_DEFAULT)
	Returns whether the named resource exists in this manager. More...

bool	resourceExists (ResourceHandle handle)
	Returns whether a resource with the given handle exists in this manager. More...

virtual void	setActiveScheme (const String &schemeName)
	Sets the name of the active material scheme. More...

void	setDefaultAnisotropy (unsigned int maxAniso)
	Sets the default anisotropy level to be used for loaded textures, for when textures are loaded automatically (e.g. More...

virtual void	setDefaultTextureFiltering (TextureFilterOptions fo)
	Sets the default texture filtering to be used for loaded textures, for when textures are loaded automatically (e.g. More...

virtual void	setDefaultTextureFiltering (FilterType ftype, FilterOptions opts)
	Sets the default texture filtering to be used for loaded textures, for when textures are loaded automatically (e.g. More...

virtual void	setDefaultTextureFiltering (FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter)
	Sets the default texture filtering to be used for loaded textures, for when textures are loaded automatically (e.g. More...

void	setMemoryBudget (size_t bytes)
	Set a limit on the amount of memory this resource handler may use. More...

void	setVerbose (bool v)
	Sets whether this manager and its resources habitually produce log output. More...

void	unload (const String &name, const String &group=RGN_DEFAULT)
	Unloads a single resource by name. More...

void	unload (ResourceHandle handle)
	Unloads a single resource by handle. More...

void	unloadAll (bool reloadableOnly=true)
	Unloads all resources. More...

virtual void	unloadAll (Resource::LoadingFlags flags)
	Unloads all resources. More...

void	unloadUnreferencedResources (bool reloadableOnly=true)
	Unload all resources which are not referenced by any other object. More...

Static Public Member Functions
static MaterialManager &	getSingleton (void)
	Get the singleton instance. More...

static MaterialManager *	getSingletonPtr (void)
	Get the singleton instance. 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.

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 Material Scripts.

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

Member Typedef Documentation

◆ ResourceCreateOrRetrieveResult

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

inherited

◆ ResourceMap

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

inherited

◆ ResourceWithGroupMap

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

inherited

◆ ResourceHandleMap

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

inherited

◆ ResourceMapIterator

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

inherited

Constructor & Destructor Documentation

◆ MaterialManager()

Ogre::MaterialManager::MaterialManager ( )

Default constructor.

◆ ~MaterialManager()

virtual Ogre::MaterialManager::~MaterialManager ( )

virtual

Default destructor.

Member Function Documentation

◆ 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

◆ 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

◆ getDefaultMaterial()

MaterialPtr Ogre::MaterialManager::getDefaultMaterial ( bool useLighting = true )

Get a default material that is always available even when no resources were loaded.

Parameters

useLighting whether the material should be lit

◆ initialise()

void Ogre::MaterialManager::initialise ( void )

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

◆ parseScript()

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

virtual

See also: ScriptLoader::parseScript

Implements Ogre::ScriptLoader.

◆ setDefaultTextureFiltering() [1/3]

virtual void Ogre::MaterialManager::setDefaultTextureFiltering ( TextureFilterOptions fo )

virtual

Sets the default texture filtering to be used for loaded textures, for when textures are loaded automatically (e.g.

by Material class) or when 'load' is called with the default parameters by the application.

Note: The default value is TFO_BILINEAR.

◆ setDefaultTextureFiltering() [2/3]

virtual void Ogre::MaterialManager::setDefaultTextureFiltering	(	FilterType	ftype,
		FilterOptions	opts
	)

virtual

Sets the default texture filtering to be used for loaded textures, for when textures are loaded automatically (e.g.

by Material class) or when 'load' is called with the default parameters by the application.

◆ setDefaultTextureFiltering() [3/3]

virtual void Ogre::MaterialManager::setDefaultTextureFiltering	(	FilterOptions	minFilter,
		FilterOptions	magFilter,
		FilterOptions	mipFilter
	)

virtual

Sets the default texture filtering to be used for loaded textures, for when textures are loaded automatically (e.g.

by Material class) or when 'load' is called with the default parameters by the application.

◆ getDefaultTextureFiltering()

virtual FilterOptions Ogre::MaterialManager::getDefaultTextureFiltering ( FilterType ftype ) const

virtual

Get the default texture filtering.

◆ setDefaultAnisotropy()

void Ogre::MaterialManager::setDefaultAnisotropy ( unsigned int maxAniso )

Sets the default anisotropy level to be used for loaded textures, for when textures are loaded automatically (e.g.

by Material class) or when 'load' is called with the default parameters by the application.

Note: The default value is 1 (no anisotropy).

◆ getDefaultAnisotropy()

unsigned int Ogre::MaterialManager::getDefaultAnisotropy ( ) const

Get the default maxAnisotropy.

◆ getDefaultSettings()

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

inlinevirtual

Returns a pointer to the default Material settings.

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

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

References Ogre::BLANKSTRING.

◆ _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

◆ _getActiveSchemeIndex()

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

virtual

Internal method - returns the active scheme index.

See also: Technique::setSchemeName

◆ getActiveScheme()

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

virtual

Returns the name of the active material scheme.

See also: Technique::setSchemeName

◆ setActiveScheme()

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

virtual

Sets the name of the active material scheme.

See also: Technique::setSchemeName

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

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

◆ _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.

◆ _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.

◆ getSingleton()

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

static

Get the singleton instance.

◆ getSingletonPtr()

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

static

Get the singleton instance.

◆ createResource()

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

inherited

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

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

◆ createOrRetrieve()

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

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.

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

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

Referenced by Ogre::TextureManager::getSampler().

◆ setMemoryBudget()

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

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.

◆ getMemoryBudget()

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

inherited

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

◆ getMemoryUsage()

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

inlineinherited

Gets the current memory usage, in bytes.

References OGRE_RESOURCE_GROUP_INIT.

◆ unload() [1/2]

void Ogre::ResourceManager::unload	(	const String &	name,
		const String &	group = `RGN_DEFAULT`
	)

inherited

Unloads a single resource by name.

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

See also: ResourceGroupManager for unloading of resource groups.

◆ unload() [2/2]

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

inherited

Unloads a single resource by handle.

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

See also: ResourceGroupManager for unloading of resource groups.

◆ unloadAll() [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.

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

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

◆ 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, Ogre::Resource::LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE, and OGRE_RESOURCE_GROUP_INIT.

◆ remove() [1/3]

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

inherited

Remove a single resource.

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

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

◆ remove() [2/3]

void Ogre::ResourceManager::remove	(	const String &	name,
		const String &	group = `RGN_DEFAULT`
	)

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ remove() [3/3]

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

inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ removeAll()

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

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.

Reimplemented in Ogre::CompositorManager.

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

◆ getResourceByName()

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

virtualinherited

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

Reimplemented in Ogre::GpuProgramManager.

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

◆ resourceExists() [1/2]

bool Ogre::ResourceManager::resourceExists	(	const String &	name,
		const String &	group = `RGN_DEFAULT`
	)

inlineinherited

Returns whether the named resource exists in this manager.

◆ resourceExists() [2/2]

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

inlineinherited

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

◆ _notifyResourceTouched()

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

virtualinherited

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

used.

◆ _notifyResourceLoaded()

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

virtualinherited

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

◆ _notifyResourceUnloaded()

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

virtualinherited

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

◆ prepare()

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

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

◆ load()

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

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

◆ getScriptPatterns()

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

inlinevirtualinherited

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: parseScript

Implements Ogre::ScriptLoader.

◆ getLoadingOrder()

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

inlinevirtualinherited

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.

◆ getResourceType()

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

inlineinherited

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

◆ setVerbose()

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

inlineinherited

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

◆ getVerbose()

bool Ogre::ResourceManager::getVerbose ( void )

inlineinherited

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

◆ getResourcePool()

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

inherited

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

◆ destroyResourcePool() [1/2]

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

inherited

Destroy a resource pool.

◆ destroyResourcePool() [2/2]

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

inherited

Destroy a resource pool.

◆ destroyAllResourcePools()

void Ogre::ResourceManager::destroyAllResourcePools ( )

inherited

destroy all pools

◆ getResourceIterator()

ResourceMapIterator Ogre::ResourceManager::getResourceIterator ( void )

inlineinherited

Returns an iterator over all resources in this manager.

Note: Use of this iterator is NOT thread safe!

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ ResourceCreateOrRetrieveResult

◆ ResourceMap

◆ ResourceWithGroupMap

◆ ResourceHandleMap

◆ ResourceMapIterator

Constructor & Destructor Documentation

◆ MaterialManager()

◆ ~MaterialManager()

Member Function Documentation

◆ create()

◆ getByName()

◆ getDefaultMaterial()

◆ initialise()

◆ parseScript()

◆ setDefaultTextureFiltering() [1/3]

◆ setDefaultTextureFiltering() [2/3]

◆ setDefaultTextureFiltering() [3/3]

◆ getDefaultTextureFiltering()

◆ setDefaultAnisotropy()

◆ getDefaultAnisotropy()

◆ getDefaultSettings()

◆ _getSchemeIndex()

◆ _getSchemeName()

◆ _getActiveSchemeIndex()

◆ getActiveScheme()

◆ setActiveScheme()

◆ addListener()

◆ removeListener()

◆ _arbitrateMissingTechniqueForActiveScheme()

◆ _notifyAfterIlluminationPassesCreated()

◆ _notifyBeforeIlluminationPassesCleared()

◆ getSingleton()

◆ getSingletonPtr()

◆ createResource()

◆ createOrRetrieve()

◆ setMemoryBudget()

◆ getMemoryBudget()

◆ getMemoryUsage()

◆ unload() [1/2]

◆ unload() [2/2]

◆ unloadAll() [1/2]

◆ unloadAll() [2/2]

◆ reloadAll() [1/2]

◆ reloadAll() [2/2]

◆ unloadUnreferencedResources()

◆ reloadUnreferencedResources()

◆ remove() [1/3]

◆ remove() [2/3]

◆ remove() [3/3]

◆ removeAll()

◆ removeUnreferencedResources()

◆ getResourceByName()

◆ getByHandle()

◆ resourceExists() [1/2]

◆ resourceExists() [2/2]

◆ _notifyResourceTouched()

◆ _notifyResourceLoaded()

◆ _notifyResourceUnloaded()

◆ prepare()

◆ load()

◆ getScriptPatterns()

◆ getLoadingOrder()

◆ getResourceType()

◆ setVerbose()

◆ getVerbose()

◆ getResourcePool()

◆ destroyResourcePool() [1/2]

◆ destroyResourcePool() [2/2]

◆ destroyAllResourcePools()

◆ getResourceIterator()

Member Data Documentation

◆ DEFAULT_SCHEME_NAME