#include <OgreGpuProgramManager.h>

Inheritance diagram for Ogre::GpuProgramManager:

Public Types
typedef MemoryDataStreamPtr	Microcode

typedef std::map< String, Microcode >	MicrocodeMap

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

typedef std::map< String, GpuSharedParametersPtr >	SharedParametersMap

typedef std::set< String >	SyntaxCodes

Public Member Functions
	GpuProgramManager ()

virtual	~GpuProgramManager ()

virtual void	_notifyResourceLoaded (Resource *res)
	Notify this manager that a resource which it manages has been loaded. More...

virtual void	_notifyResourceTouched (Resource *res)
	Notify this manager that a resource which it manages has been 'touched', i.e. More...

virtual void	_notifyResourceUnloaded (Resource *res)
	Notify this manager that a resource which it manages has been unloaded. More...

void	addMicrocodeToCache (uint32 id, const Microcode &microcode)
	Adds a microcode for a program to the microcode cache. More...

void	addMicrocodeToCache (String name, const Microcode &microcode)

virtual ResourcePtr	create (const String &name, const String &group, GpuProgramType gptype, const String &syntaxCode, bool isManual=false, ManualResourceLoader *loader=0)
	General create method, using specific create parameters instead of name / value pairs. More...

Microcode	createMicrocode (size_t size) const
	Creates a microcode to be later added to the cache. 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...

virtual GpuProgramParametersSharedPtr	createParameters (void)
	Creates a new GpuProgramParameters instance which can be used to bind parameters to your programs. More...

virtual GpuProgramPtr	createProgram (const String &name, const String &groupName, const String &filename, GpuProgramType gptype, const String &syntaxCode)
	Create a new, unloaded GpuProgram from a file of assembly. More...

virtual GpuProgramPtr	createProgramFromString (const String &name, const String &groupName, const String &code, GpuProgramType gptype, const String &syntaxCode)
	Create a GPU program from a string of assembly code. More...

ResourcePtr	createResource (const String &name, const String &group, bool isManual=false, ManualResourceLoader loader=0, const NameValuePairList createParams=0)
	Creates a new blank resource, but does not immediately load it. More...

virtual GpuSharedParametersPtr	createSharedParameters (const String &name)
	Create a new set of shared parameters, which can be used across many GpuProgramParameters objects of different structures. More...

void	destroyAllResourcePools ()
	destroy all pools More...

void	destroyResourcePool (ResourcePool *pool)
	Destroy a resource pool. More...

void	destroyResourcePool (const String &name)
	Destroy a resource pool. More...

virtual const SharedParametersMap &	getAvailableSharedParameters () const
	Get (const) access to the available shared parameter sets. More...

virtual ResourcePtr	getByHandle (ResourceHandle handle)
	Retrieves a pointer to a resource by handle, or null if the resource does not exist. More...

GpuProgramPtr	getByName (const String &name, const String &group=RGN_DEFAULT, bool preferHighLevelPrograms=true)
	Get a resource by name. 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...

const Microcode &	getMicrocodeFromCache (uint32 id) const
	Returns a microcode for a program from the microcode cache. More...

const Microcode &	getMicrocodeFromCache (String name) const

ResourcePtr	getResourceByName (const String &name, const String &group, bool preferHighLevelPrograms)
	Overrides the standard ResourceManager getResourceByName method. More...

ResourcePtr	getResourceByName (const String &name, const String &group=RGN_DEFAULT)

ResourceMapIterator	getResourceIterator (void)
	Returns an iterator over all resources in this manager. More...

ResourcePool *	getResourcePool (const String &name)
	Create a resource pool, or reuse one that already exists. More...

const String &	getResourceType (void) const
	Gets a string identifying the type of resource this manager handles. More...

bool	getSaveMicrocodesToCache () const
	Get if the microcode of a shader should be saved to a cache. More...

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

virtual GpuSharedParametersPtr	getSharedParameters (const String &name) const
	Retrieve a set of shared parameters, which can be used across many GpuProgramParameters objects of different structures. More...

virtual const SyntaxCodes &	getSupportedSyntax (void) const
	Returns the syntaxes that this manager supports. More...

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

bool	isCacheDirty (void) const
	Returns true if the microcodecache changed during the run. More...

bool	isMicrocodeAvailableInCache (uint32 id) const
	Check if a microcode is available for a program in the microcode cache. More...

bool	isMicrocodeAvailableInCache (String name) const

virtual bool	isSyntaxSupported (const String &syntaxCode) const
	Returns whether a given syntax code (e.g. More...

virtual GpuProgramPtr	load (const String &name, const String &groupName, const String &filename, GpuProgramType gptype, const String &syntaxCode)
	Loads a GPU program from a file of assembly. More...

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

virtual GpuProgramPtr	loadFromString (const String &name, const String &groupName, const String &code, GpuProgramType gptype, const String &syntaxCode)
	Loads a GPU program from a string of assembly code. More...

void	loadMicrocodeCache (DataStreamPtr stream)
	Loads the microcode cache from disk. More...

void	parseScript (DataStreamPtr &stream, const String &groupName)
	Parse the definition of a set of resources from a script file. More...

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

void	removeMicrocodeFromCache (uint32 id)
	Removes a microcode for a program from the microcode cache. More...

void	removeMicrocodeFromCache (String name)

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

void	saveMicrocodeCache (DataStreamPtr stream) const
	Saves the microcode cache to disk. More...

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

void	setSaveMicrocodesToCache (bool val)
	Set if the microcode of a shader should be saved to a cache. 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 bool	canGetCompiledShaderBuffer ()

static GpuProgramManager &	getSingleton (void)
	Get the singleton instance. More...

static GpuProgramManager *	getSingletonPtr (void)
	Get the singleton instance. More...

Public Attributes
	OGRE_AUTO_MUTEX

Member Typedef Documentation

◆ SyntaxCodes

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

◆ SharedParametersMap

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

◆ Microcode

typedef MemoryDataStreamPtr Ogre::GpuProgramManager::Microcode

◆ MicrocodeMap

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

◆ 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

◆ GpuProgramManager()

Ogre::GpuProgramManager::GpuProgramManager ( )

◆ ~GpuProgramManager()

virtual Ogre::GpuProgramManager::~GpuProgramManager ( )

virtual

Member Function Documentation

◆ getByName()

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

Get a resource by name.

See also: GpuProgramManager::getResourceByName

◆ load() [1/2]

virtual GpuProgramPtr Ogre::GpuProgramManager::load	(	const String &	name,
		const String &	groupName,
		const String &	filename,
		GpuProgramType	gptype,
		const String &	syntaxCode
	)

virtual

Loads a GPU program from a file of assembly.

Remarks: This method creates a new program of the type specified as the second parameter. As with all types of ResourceManager, this class will search for the file in all resource locations it has been configured to look in.

Parameters

name	The name of the GpuProgram
groupName	The name of the resource group
filename	The file to load
gptype	The type of program to create
syntaxCode	The name of the syntax to be used for this program e.g. arbvp1, vs_1_1

◆ loadFromString()

virtual GpuProgramPtr Ogre::GpuProgramManager::loadFromString	(	const String &	name,
		const String &	groupName,
		const String &	code,
		GpuProgramType	gptype,
		const String &	syntaxCode
	)

virtual

Loads a GPU program from a string of assembly code.

Remarks: The assembly code must be compatible with this manager - call the getSupportedSyntax method for details of the supported syntaxes

Parameters

name	The identifying name to give this program, which can be used to retrieve this program later with getByName.
groupName	The name of the resource group
code	A string of assembly code which will form the program to run
gptype	The type of program to create.
syntaxCode	The name of the syntax to be used for this program e.g. arbvp1, vs_1_1

◆ getSupportedSyntax()

virtual const SyntaxCodes& Ogre::GpuProgramManager::getSupportedSyntax ( void ) const

virtual

Returns the syntaxes that this manager supports.

◆ isSyntaxSupported()

virtual bool Ogre::GpuProgramManager::isSyntaxSupported ( const String & syntaxCode ) const

virtual

Returns whether a given syntax code (e.g.

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

◆ createParameters()

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

virtual

Creates a new GpuProgramParameters instance which can be used to bind parameters to your programs.

Remarks: Program parameters can be shared between multiple programs if you wish.

◆ createProgram()

virtual GpuProgramPtr Ogre::GpuProgramManager::createProgram	(	const String &	name,
		const String &	groupName,
		const String &	filename,
		GpuProgramType	gptype,
		const String &	syntaxCode
	)

virtual

Create a new, unloaded GpuProgram from a file of assembly.

Remarks: Use this method in preference to the 'load' methods if you wish to define a GpuProgram, but not load it yet; useful for saving memory.

: This method creates a new program of the type specified as the second parameter. As with all types of ResourceManager, this class will search for the file in all resource locations it has been configured to look in.

Parameters

name	The name of the program
groupName	The name of the resource group
filename	The file to load
syntaxCode	The name of the syntax to be used for this program e.g. arbvp1, vs_1_1
gptype	The type of program to create

◆ createProgramFromString()

virtual GpuProgramPtr Ogre::GpuProgramManager::createProgramFromString	(	const String &	name,
		const String &	groupName,
		const String &	code,
		GpuProgramType	gptype,
		const String &	syntaxCode
	)

virtual

Create a GPU program from a string of assembly code.

Remarks: Use this method in preference to the 'load' methods if you wish to define a GpuProgram, but not load it yet; useful for saving memory.

: The assembly code must be compatible with this manager - call the getSupportedSyntax method for details of the supported syntaxes

Parameters

name	The identifying name to give this program, which can be used to retrieve this program later with getByName.
groupName	The name of the resource group
code	A string of assembly code which will form the program to run
gptype	The type of program to create.
syntaxCode	The name of the syntax to be used for this program e.g. arbvp1, vs_1_1

◆ create()

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

virtual

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

◆ getResourceByName() [1/2]

ResourcePtr Ogre::GpuProgramManager::getResourceByName	(	const String &	name,
		const String &	group,
		bool	preferHighLevelPrograms
	)

Overrides the standard ResourceManager getResourceByName method.

Parameters

name	The name of the program to retrieve
group	The name of the resource group to attach this new resource to
preferHighLevelPrograms	If set to true (the default), high level programs will be returned in preference to low-level programs.

◆ getResourceByName() [2/2]

ResourcePtr Ogre::GpuProgramManager::getResourceByName	(	const String &	name,
		const String &	group = `RGN_DEFAULT`
	)

virtual

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

Reimplemented from Ogre::ResourceManager.

◆ createSharedParameters()

virtual GpuSharedParametersPtr Ogre::GpuProgramManager::createSharedParameters ( const String & name )

virtual

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

Parameters

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

◆ getSharedParameters()

virtual GpuSharedParametersPtr Ogre::GpuProgramManager::getSharedParameters ( const String & name ) const

virtual

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

◆ getAvailableSharedParameters()

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

virtual

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

◆ getSaveMicrocodesToCache()

bool Ogre::GpuProgramManager::getSaveMicrocodesToCache ( ) const

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

◆ setSaveMicrocodesToCache()

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

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

◆ isCacheDirty()

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

Returns true if the microcodecache changed during the run.

◆ canGetCompiledShaderBuffer()

static bool Ogre::GpuProgramManager::canGetCompiledShaderBuffer ( )

static

◆ isMicrocodeAvailableInCache() [1/2]

bool Ogre::GpuProgramManager::isMicrocodeAvailableInCache ( uint32 id ) const

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

Parameters

id	The id of the program.

◆ isMicrocodeAvailableInCache() [2/2]

bool Ogre::GpuProgramManager::isMicrocodeAvailableInCache ( String name ) const

inline

Deprecated:

References Ogre::FastHash().

◆ getMicrocodeFromCache() [1/2]

const Microcode& Ogre::GpuProgramManager::getMicrocodeFromCache ( uint32 id ) const

Returns a microcode for a program from the microcode cache.

Parameters

id	The name of the program.

◆ getMicrocodeFromCache() [2/2]

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

inline

Deprecated:

References Ogre::FastHash().

◆ createMicrocode()

Microcode Ogre::GpuProgramManager::createMicrocode ( size_t size ) const

Creates a microcode to be later added to the cache.

Parameters

size	The size of the microcode in bytes

◆ addMicrocodeToCache() [1/2]

void Ogre::GpuProgramManager::addMicrocodeToCache	(	uint32	id,
		const Microcode &	microcode
	)

Adds a microcode for a program to the microcode cache.

Parameters

id	The id of the program
microcode	the program binary

◆ addMicrocodeToCache() [2/2]

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

inline

Deprecated:

References Ogre::FastHash().

◆ removeMicrocodeFromCache() [1/2]

void Ogre::GpuProgramManager::removeMicrocodeFromCache ( uint32 id )

Removes a microcode for a program from the microcode cache.

Parameters

id	The name of the program.

◆ removeMicrocodeFromCache() [2/2]

void Ogre::GpuProgramManager::removeMicrocodeFromCache ( String name )

inline

Deprecated:

References Ogre::FastHash().

◆ saveMicrocodeCache()

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

Saves the microcode cache to disk.

Parameters

stream The destination stream

◆ loadMicrocodeCache()

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

Loads the microcode cache from disk.

Parameters

stream The source stream

◆ getSingleton()

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

static

Get the singleton instance.

◆ getSingletonPtr()

static GpuProgramManager* Ogre::GpuProgramManager::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.

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

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.

◆ parseScript()

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

inlinevirtualinherited

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

◆ 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

◆ OGRE_AUTO_MUTEX

Ogre::ResourceManager::OGRE_AUTO_MUTEX

inherited

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

OgreGpuProgramManager.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Member Typedef Documentation

◆ SyntaxCodes

◆ SharedParametersMap

◆ Microcode

◆ MicrocodeMap

◆ ResourceCreateOrRetrieveResult

◆ ResourceMap

◆ ResourceWithGroupMap

◆ ResourceHandleMap

◆ ResourceMapIterator

Constructor & Destructor Documentation

◆ GpuProgramManager()

◆ ~GpuProgramManager()

Member Function Documentation

◆ getByName()

◆ load() [1/2]

◆ loadFromString()

◆ getSupportedSyntax()

◆ isSyntaxSupported()

◆ createParameters()

◆ createProgram()

◆ createProgramFromString()

◆ create()

◆ getResourceByName() [1/2]

◆ getResourceByName() [2/2]

◆ createSharedParameters()

◆ getSharedParameters()

◆ getAvailableSharedParameters()

◆ getSaveMicrocodesToCache()

◆ setSaveMicrocodesToCache()

◆ isCacheDirty()

◆ canGetCompiledShaderBuffer()

◆ isMicrocodeAvailableInCache() [1/2]

◆ isMicrocodeAvailableInCache() [2/2]

◆ getMicrocodeFromCache() [1/2]

◆ getMicrocodeFromCache() [2/2]

◆ createMicrocode()

◆ addMicrocodeToCache() [1/2]

◆ addMicrocodeToCache() [2/2]

◆ removeMicrocodeFromCache() [1/2]

◆ removeMicrocodeFromCache() [2/2]

◆ saveMicrocodeCache()

◆ loadMicrocodeCache()

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

◆ getByHandle()

◆ resourceExists() [1/2]

◆ resourceExists() [2/2]

◆ _notifyResourceTouched()

◆ _notifyResourceLoaded()

◆ _notifyResourceUnloaded()

◆ prepare()

◆ load() [2/2]

◆ getScriptPatterns()

◆ parseScript()

◆ getLoadingOrder()

◆ getResourceType()

◆ setVerbose()