Class for managing Compositor settings for Ogre. More...

#include <OgreCompositorManager.h>

Inheritance diagram for Ogre::CompositorManager:

Collaboration diagram for Ogre::CompositorManager:

Classes
struct	TextureDef

struct	TextureDefLess

Public Types
typedef std::pair< ResourcePtr, bool >	ResourceCreateOrRetrieveResult

typedef map< ResourceHandle, ResourcePtr >::type	ResourceHandleMap

typedef HashMap< String, ResourcePtr >	ResourceMap

typedef MapIterator < ResourceHandleMap >	ResourceMapIterator

typedef HashMap< String, ResourceMap >	ResourceWithGroupMap

typedef set< Texture * >::type	UniqueTextureSet

Public Member Functions
	CompositorManager ()

virtual	~CompositorManager ()

Renderable *	_getTexturedRectangle2D ()
	Get a textured fullscreen 2D rectangle, for internal use. 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...

void	_reconstructAllCompositorResources ()
	Internal method for forcing all active compositors to recreate their resources. More...

CompositorInstance *	addCompositor (Viewport *vp, const String &compositor, int addPosition=-1)
	Add a compositor to a viewport. More...

CompositorPtr	create (const String &name, const String &group, bool isManual=false, ManualResourceLoader loader=0, const NameValuePairList createParams=0)
	Create a new compositor. More...

Resource *	createImpl (const String &name, ResourceHandle handle, const String &group, bool isManual, ManualResourceLoader loader, const NameValuePairList params)
	Overridden from ResourceManager. More...

virtual ResourceCreateOrRetrieveResult	createOrRetrieve (const String &name, const String &group, bool isManual=false, ManualResourceLoader loader=0, const NameValuePairList createParams=0)
	Create a new resource, or retrieve an existing one with the same name if it already exists. More...

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

void	destroyAllResourcePools ()
	destroy all pools More...

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

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

void	freePooledTextures (bool onlyIfUnreferenced=true)
	Free pooled textures from the shared pool (compositor instances still using them will keep them in memory though). More...

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

CompositorPtr	getByName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
	Get a resource by name. More...

CompositorChain *	getCompositorChain (Viewport *vp)
	Get the compositor chain for a Viewport. More...

CompositorLogic *	getCompositorLogic (const String &name)
	Get a compositor logic by its name. More...

CustomCompositionPass *	getCustomCompositionPass (const String &name)
	Get a custom composition pass by its name. More...

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

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

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

TexturePtr	getPooledTexture (const String &name, const String &localName, size_t w, size_t h, PixelFormat f, uint aa, const String &aaHint, bool srgb, UniqueTextureSet &texturesAlreadyAssigned, CompositorInstance *inst, CompositionTechnique::TextureScope scope)
	Utility function to get an existing pooled texture matching a given definition, or creating one if one doesn't exist. More...

virtual ResourcePtr	getResourceByName (const String &name, const String &groupName=ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME)
	Retrieves a pointer to a resource by name, or null if the resource does not exist. More...

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

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

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

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

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

bool	hasCompositorChain (Viewport *vp) const
	Returns whether exists compositor chain for a viewport. More...

void	initialise (void)
	Initialises the Compositor manager, which also triggers it to parse all available .compositor 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, void )

void	operator delete (void ptr, const char , int, const char *)

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, const char , int, const char *)

void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info More...

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *ptr)
	placement operator new More...

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info More...

void *	operator new[] (size_t sz)

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

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	registerCompositorLogic (const String &name, CompositorLogic *logic)
	Register a compositor logic for listening in to expecting composition techniques. More...

void	registerCustomCompositionPass (const String &name, CustomCompositionPass *customPass)
	Register a custom composition pass. More...

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

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

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

virtual void	remove (const String &name)
	Remove a single resource by name. More...

virtual void	remove (ResourceHandle handle)
	Remove a single resource by handle. More...

void	removeAll (void)
	Overridden from ResourceManager since we have to clean up chains too. More...

void	removeCompositor (Viewport *vp, const String &compositor)
	Remove a compositor from a viewport. More...

void	removeCompositorChain (Viewport *vp)
	Remove the compositor chain from a viewport if exists. 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...

void	setCompositorEnabled (Viewport *vp, const String &compositor, bool value)
	Set the state of a compositor on a viewport to enabled or disabled. More...

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

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

virtual void	unload (const String &name)
	Unloads a single resource by name. More...

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

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

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

void	unregisterCompositorLogic (const String &name)
	Removes a listener for compositor logic registered with registerCompositorLogic. More...

Static Public Member Functions
static CompositorManager &	getSingleton (void)
	Override standard Singleton retrieval. More...

static CompositorManager *	getSingletonPtr (void)
	Override standard Singleton retrieval. More...

Public Attributes
	OGRE_AUTO_MUTEX

Protected Types
typedef map< String, ResourcePool * >::type	ResourcePoolMap

Protected Member Functions
virtual void	addImpl (ResourcePtr &res)
	Add a newly created resource to the manager (note weak reference) More...

virtual void	checkUsage (void)
	Checks memory usage and pages out if required. More...

ResourceHandle	getNextHandle (void)
	Allocates the next handle. More...

virtual void	removeImpl (ResourcePtr &res)
	Remove a resource from this manager; remove it from the lists. More...

Protected Attributes
Real	mLoadOrder
	Loading order relative to other managers, higher is later. More...

size_t	mMemoryBudget

AtomicScalar< size_t >	mMemoryUsage

AtomicScalar< ResourceHandle >	mNextHandle
	In bytes. More...

ResourcePoolMap	mResourcePoolMap

ResourceMap	mResources

ResourceHandleMap	mResourcesByHandle

ResourceWithGroupMap	mResourcesWithGroup

String	mResourceType
	String identifying the resource type this manager handles. More...

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

bool	mVerbose
	In bytes. More...

Static Protected Attributes
static CompositorManager *	msSingleton

Private Types
typedef map< Viewport , CompositorChain >::type	Chains

typedef map< StringPair, TextureDefMap >::type	ChainTexturesByDef

typedef map< String, CompositorLogic * >::type	CompositorLogicMap
	Map of registered compositor logics. More...

typedef map< String, CustomCompositionPass * > ::type	CustomCompositionPassMap
	Map of registered custom composition passes. More...

typedef vector < CompositorInstance * >::type	Instances
	List of instances. More...

typedef std::pair< String, String >	StringPair

typedef map< TextureDef, TexturePtr, TextureDefLess > ::type	TextureDefMap

typedef VectorIterator < TextureList >	TextureIterator

typedef vector< TexturePtr >::type	TextureList

typedef map< TextureDef, TextureList *, TextureDefLess > ::type	TexturesByDef

Private Member Functions
void	freeChains ()
	Clear composition chains for all viewports. More...

bool	isInputPreviousTarget (CompositorInstance *inst, const Ogre::String &localName)

bool	isInputPreviousTarget (CompositorInstance *inst, TexturePtr tex)

bool	isInputToOutputTarget (CompositorInstance *inst, const Ogre::String &localName)

bool	isInputToOutputTarget (CompositorInstance *inst, TexturePtr tex)

Private Attributes
Chains	mChains

ChainTexturesByDef	mChainTexturesByDef

CompositorLogicMap	mCompositorLogics

CustomCompositionPassMap	mCustomCompositionPasses

Instances	mInstances

Rectangle2D *	mRectangle

TexturesByDef	mTexturesByDef

Detailed Description

Class for managing Compositor settings for Ogre.

Compositors provide the means to flexibly "composite" the final rendering result from multiple scene renders and intermediate operations like rendering fullscreen quads. This makes it possible to apply postfilter effects, HDRI postprocessing, and shadow effects to a Viewport.

: When loaded from a script, a Compositor 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.

Definition at line 59 of file OgreCompositorManager.h.

Member Typedef Documentation

typedef map<Viewport*, CompositorChain*>::type Ogre::CompositorManager::Chains

private

Definition at line 211 of file OgreCompositorManager.h.

typedef map<StringPair, TextureDefMap>::type Ogre::CompositorManager::ChainTexturesByDef

private

Definition at line 290 of file OgreCompositorManager.h.

typedef map<String, CompositorLogic*>::type Ogre::CompositorManager::CompositorLogicMap

private

Map of registered compositor logics.

Definition at line 225 of file OgreCompositorManager.h.

typedef map<String, CustomCompositionPass*>::type Ogre::CompositorManager::CustomCompositionPassMap

private

Map of registered custom composition passes.

Definition at line 229 of file OgreCompositorManager.h.

typedef vector<CompositorInstance *>::type Ogre::CompositorManager::Instances

private

List of instances.

Definition at line 221 of file OgreCompositorManager.h.

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

inherited

Definition at line 152 of file OgreResourceManager.h.

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

inherited

Definition at line 543 of file OgreResourceManager.h.

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

inherited

Definition at line 541 of file OgreResourceManager.h.

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

inherited

Definition at line 564 of file OgreResourceManager.h.

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

protectedinherited

Definition at line 575 of file OgreResourceManager.h.

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

inherited

Definition at line 542 of file OgreResourceManager.h.

typedef std::pair<String, String> Ogre::CompositorManager::StringPair

private

Definition at line 288 of file OgreCompositorManager.h.

typedef map<TextureDef, TexturePtr, TextureDefLess>::type Ogre::CompositorManager::TextureDefMap

private

Definition at line 289 of file OgreCompositorManager.h.

typedef VectorIterator<TextureList> Ogre::CompositorManager::TextureIterator

private

Definition at line 233 of file OgreCompositorManager.h.

typedef vector<TexturePtr>::type Ogre::CompositorManager::TextureList

private

Definition at line 232 of file OgreCompositorManager.h.

typedef map<TextureDef, TextureList*, TextureDefLess>::type Ogre::CompositorManager::TexturesByDef

private

Definition at line 285 of file OgreCompositorManager.h.

typedef set<Texture*>::type Ogre::CompositorManager::UniqueTextureSet

Definition at line 136 of file OgreCompositorManager.h.

Constructor & Destructor Documentation

Ogre::CompositorManager::CompositorManager ( )

virtual Ogre::CompositorManager::~CompositorManager ( )

virtual

Member Function Documentation

Renderable* Ogre::CompositorManager::_getTexturedRectangle2D ( )

Get a textured fullscreen 2D rectangle, for internal use.

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

virtualinherited

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

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

virtualinherited

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

used.

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

virtualinherited

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

void Ogre::CompositorManager::_reconstructAllCompositorResources ( )

Internal method for forcing all active compositors to recreate their resources.

CompositorInstance* Ogre::CompositorManager::addCompositor	(	Viewport *	vp,
		const String &	compositor,
		int	addPosition = `-1`
	)

Add a compositor to a viewport.

By default, it is added to end of the chain, after the other compositors.

Parameters

vp	Viewport to modify
compositor	The name of the compositor to apply
addPosition	At which position to add, defaults to the end (-1).

Returns: pointer to instance, or 0 if it failed.

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

protectedvirtualinherited

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

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

protectedvirtualinherited

Checks memory usage and pages out if required.

This is automatically done after a new resource is loaded.

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

Create a new compositor.

See also: ResourceManager::createResource

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

virtual

Overridden from ResourceManager.

Implements Ogre::ResourceManager.

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.

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

void Ogre::ResourceManager::destroyAllResourcePools ( )

inherited

destroy all pools

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

inherited

Destroy a resource pool.

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

inherited

Destroy a resource pool.

void Ogre::CompositorManager::freeChains ( )

private

Clear composition chains for all viewports.

void Ogre::CompositorManager::freePooledTextures ( bool onlyIfUnreferenced = true )

Free pooled textures from the shared pool (compositor instances still using them will keep them in memory though).

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

virtualinherited

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

CompositorPtr Ogre::CompositorManager::getByName	(	const String &	name,
		const String &	groupName = `ResourceGroupManager::AUTODETECT_RESOURCE_GROUP_NAME`
	)

Get a resource by name.

See also: ResourceManager::getResourceByName

CompositorChain* Ogre::CompositorManager::getCompositorChain ( Viewport * vp )

Get the compositor chain for a Viewport.

If there is none yet, a new compositor chain is registered. XXX We need a _notifyViewportRemoved to find out when this viewport disappears, so we can destroy its chain as well.

CompositorLogic* Ogre::CompositorManager::getCompositorLogic ( const String & name )

Get a compositor logic by its name.

CustomCompositionPass* Ogre::CompositorManager::getCustomCompositionPass ( const String & name )

Get a custom composition pass by its name.

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

Definition at line 461 of file OgreResourceManager.h.

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

virtualinherited

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

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

inlinevirtualinherited

Gets the current memory usage, in bytes.

Definition at line 185 of file OgreResourceManager.h.

ResourceHandle Ogre::ResourceManager::getNextHandle ( void )

protectedinherited

Allocates the next handle.

TexturePtr Ogre::CompositorManager::getPooledTexture	(	const String &	name,
		const String &	localName,
		size_t	w,
		size_t	h,
		PixelFormat	f,
		uint	aa,
		const String &	aaHint,
		bool	srgb,
		UniqueTextureSet &	texturesAlreadyAssigned,
		CompositorInstance *	inst,
		CompositionTechnique::TextureScope	scope
	)

Utility function to get an existing pooled texture matching a given definition, or creating one if one doesn't exist.

It also takes into account whether a pooled texture has already been supplied to this same requester already, in which case it won't give the same texture twice (this is important for example if you request 2 ping-pong textures, you don't want to get the same texture for both requests!

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.

ResourceMapIterator Ogre::ResourceManager::getResourceIterator ( void )

inlineinherited

Returns an iterator over all resources in this manager.

Note: Use of this iterator is NOT thread safe!

Definition at line 569 of file OgreResourceManager.h.

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

inherited

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

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

inlineinherited

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

Definition at line 464 of file OgreResourceManager.h.

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

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

Implements Ogre::ScriptLoader.

Definition at line 437 of file OgreResourceManager.h.

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

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.

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

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.

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

inlinevirtualinherited

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

Definition at line 470 of file OgreResourceManager.h.

bool Ogre::CompositorManager::hasCompositorChain ( Viewport * vp ) const

Returns whether exists compositor chain for a viewport.

void Ogre::CompositorManager::initialise ( void )

Initialises the Compositor manager, which also triggers it to parse all available .compositor scripts.

bool Ogre::CompositorManager::isInputPreviousTarget	(	CompositorInstance *	inst,
		const Ogre::String &	localName
	)

private

bool Ogre::CompositorManager::isInputPreviousTarget	(	CompositorInstance *	inst,
		TexturePtr	tex
	)

private

bool Ogre::CompositorManager::isInputToOutputTarget	(	CompositorInstance *	inst,
		const Ogre::String &	localName
	)

private

bool Ogre::CompositorManager::isInputToOutputTarget	(	CompositorInstance *	inst,
		TexturePtr	tex
	)

private

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

template<class Alloc >

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

inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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

virtual

See also: ScriptLoader::parseScript

Reimplemented from Ogre::ResourceManager.

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

void Ogre::CompositorManager::registerCompositorLogic	(	const String &	name,
		CompositorLogic *	logic
	)

Register a compositor logic for listening in to expecting composition techniques.

void Ogre::CompositorManager::registerCustomCompositionPass	(	const String &	name,
		CustomCompositionPass *	customPass
	)

Register a custom composition pass.

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

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

reloadableOnly If true (the default), only reload the resource that is reloadable. Because some resources isn't reloadable, they will be unloaded but can't loaded again. Thus, you might not want to them unloaded. Or, you might unload all of them, and then populate them manually later.

See also: Resource::isReloadable for resource is reloadable.

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

virtualinherited

Caused all currently loaded but not referenced by any other object resources to be reloaded.

Remarks: This method behaves like reloadAll, except that it only reloads resources which are not in use, i.e. not referenced by other objects.

: Some referenced resource may exists 'weak' pointer to their sub-components (e.g. Entity held pointer to SubMesh), in this case, unload or reload that resource will cause dangerous pointer access. Use this function instead of reloadAll allows you avoid fail in those situations.

Parameters

reloadableOnly If true (the default), only reloads resources which can be subsequently automatically reloaded.

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

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.

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.

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.

void Ogre::CompositorManager::removeAll ( void )

virtual

Overridden from ResourceManager since we have to clean up chains too.

Reimplemented from Ogre::ResourceManager.

void Ogre::CompositorManager::removeCompositor	(	Viewport *	vp,
		const String &	compositor
	)

Remove a compositor from a viewport.

void Ogre::CompositorManager::removeCompositorChain ( Viewport * vp )

Remove the compositor chain from a viewport if exists.

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

protectedvirtualinherited

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

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.

virtual bool Ogre::ResourceManager::resourceExists ( const String & name )

inlinevirtualinherited

Returns whether the named resource exists in this manager.

Definition at line 357 of file OgreResourceManager.h.

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

inlinevirtualinherited

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

Definition at line 362 of file OgreResourceManager.h.

void Ogre::CompositorManager::setCompositorEnabled	(	Viewport *	vp,
		const String &	compositor,
		bool	value
	)

Set the state of a compositor on a viewport to enabled or disabled.

Disabling a compositor stops it from rendering but does not free any resources. This can be more efficient than using removeCompositor and addCompositor in cases the filter is switched on and off a lot.

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.

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

inlinevirtualinherited

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

Definition at line 467 of file OgreResourceManager.h.

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

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.

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.

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

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

reloadableOnly If true (the default), only unload the resource that is reloadable. Because some resources isn't reloadable, they will be unloaded but can't load them later. Thus, you might not want to them unloaded. Or, you might unload all of them, and then populate them manually later.

See also: Resource::isReloadable for resource is reloadable.

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

virtualinherited

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.

void Ogre::CompositorManager::unregisterCompositorLogic ( const String & name )

Removes a listener for compositor logic registered with registerCompositorLogic.

Member Data Documentation

Chains Ogre::CompositorManager::mChains

private

Definition at line 212 of file OgreCompositorManager.h.

ChainTexturesByDef Ogre::CompositorManager::mChainTexturesByDef

private

Definition at line 292 of file OgreCompositorManager.h.

CompositorLogicMap Ogre::CompositorManager::mCompositorLogics

private

Definition at line 226 of file OgreCompositorManager.h.

CustomCompositionPassMap Ogre::CompositorManager::mCustomCompositionPasses

private

Definition at line 230 of file OgreCompositorManager.h.

Instances Ogre::CompositorManager::mInstances

private

Definition at line 222 of file OgreCompositorManager.h.

Real Ogre::ResourceManager::mLoadOrder

protectedinherited

Loading order relative to other managers, higher is later.

Definition at line 559 of file OgreResourceManager.h.

size_t Ogre::ResourceManager::mMemoryBudget

protectedinherited

Definition at line 548 of file OgreResourceManager.h.

AtomicScalar<size_t> Ogre::ResourceManager::mMemoryUsage

protectedinherited

Definition at line 550 of file OgreResourceManager.h.

AtomicScalar<ResourceHandle> Ogre::ResourceManager::mNextHandle

protectedinherited

In bytes.

Definition at line 549 of file OgreResourceManager.h.

Rectangle2D* Ogre::CompositorManager::mRectangle

private

Definition at line 218 of file OgreCompositorManager.h.

ResourcePoolMap Ogre::ResourceManager::mResourcePoolMap

protectedinherited

Definition at line 576 of file OgreResourceManager.h.

ResourceMap Ogre::ResourceManager::mResources

protectedinherited

Definition at line 546 of file OgreResourceManager.h.

ResourceHandleMap Ogre::ResourceManager::mResourcesByHandle

protectedinherited

Definition at line 545 of file OgreResourceManager.h.

ResourceWithGroupMap Ogre::ResourceManager::mResourcesWithGroup

protectedinherited

Definition at line 547 of file OgreResourceManager.h.

String Ogre::ResourceManager::mResourceType

protectedinherited

String identifying the resource type this manager handles.

Definition at line 561 of file OgreResourceManager.h.

StringVector Ogre::ResourceManager::mScriptPatterns

protectedinherited

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

Definition at line 557 of file OgreResourceManager.h.

CompositorManager * Ogre::Singleton< CompositorManager >::msSingleton

staticprotectedinherited

Definition at line 75 of file OgreSingleton.h.

TexturesByDef Ogre::CompositorManager::mTexturesByDef

private

Definition at line 286 of file OgreCompositorManager.h.

bool Ogre::ResourceManager::mVerbose

protectedinherited

In bytes.

Definition at line 552 of file OgreResourceManager.h.

Ogre::ResourceManager::OGRE_AUTO_MUTEX

inherited

Definition at line 125 of file OgreResourceManager.h.

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

OgreCompositorManager.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation