Class representing a Compositor object. More...

#include <OgreCompositor.h>

Inheritance diagram for Ogre::Compositor:

Public Types
enum	LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING, LOADSTATE_PREPARED, LOADSTATE_PREPARING }
	Enum identifying the loading state of the resource. More...
typedef VectorIterator < Techniques >	TechniqueIterator
typedef vector < CompositionTechnique * > ::type	Techniques
	Data types for internal lists.
Public Member Functions
	Compositor (ResourceManager creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader loader=0)
	~Compositor ()
virtual void	_dirtyState ()
	Manually mark the state of this resource as having been changed.
virtual void	_fireLoadingComplete (bool wasBackgroundLoaded)
	Firing of loading complete event.
virtual void	_firePreparingComplete (bool wasBackgroundLoaded)
	Firing of preparing complete event.
virtual void	_fireUnloadingComplete (void)
	Firing of unloading complete event.
virtual void	_notifyOrigin (const String &origin)
	Notify this resource of it's origin.
virtual void	addListener (Listener *lis)
	Register a listener on this resource.
virtual void	changeGroupOwnership (const String &newGroup)
	Change the resource group ownership of a Resource.
virtual void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object.
CompositionTechnique *	createTechnique ()
	Create a new technique, and return a pointer to it.
virtual void	escalateLoading ()
	Escalates the loading of a background loaded resource.
virtual ResourceManager *	getCreator (void)
	Gets the manager which created this resource.
virtual const String &	getGroup (void) const
	Gets the group which this resource is a member of.
virtual ResourceHandle	getHandle (void) const
virtual LoadingState	getLoadingState () const
	Returns the current loading state.
virtual const String &	getName (void) const
	Gets resource name.
size_t	getNumSupportedTechniques ()
	Get the number of supported techniques.
size_t	getNumTechniques ()
	Get the number of techniques.
virtual const String &	getOrigin (void) const
	Get the origin of this resource, e.g.
ParamDictionary *	getParamDictionary (void)
	Retrieves the parameter dictionary for this class.
const ParamDictionary *	getParamDictionary (void) const
virtual String	getParameter (const String &name) const
	Generic parameter retrieval method.
const ParameterList &	getParameters (void) const
	Retrieves a list of parameters valid for this object.
RenderTarget *	getRenderTarget (const String &name)
	Get the render target for a given render texture name.
virtual size_t	getSize (void) const
	Retrieves info about the size of the resource.
virtual size_t	getStateCount () const
	Returns the number of times this resource has changed state, which generally means the number of times it has been loaded.
CompositionTechnique *	getSupportedTechnique (size_t idx)
	Get a supported technique.
CompositionTechnique *	getSupportedTechnique (const String &schemeName=StringUtil::BLANK)
	Get a pointer to a supported technique for a given scheme.
TechniqueIterator	getSupportedTechniqueIterator (void)
	Gets an iterator over all the Techniques which are supported by the current card.
CompositionTechnique *	getTechnique (size_t idx)
	Get a technique.
TechniqueIterator	getTechniqueIterator (void)
	Get an iterator over the Techniques in this compositor.
TexturePtr	getTextureInstance (const String &name, size_t mrtIndex)
	Get the instance of a global texture.
const String &	getTextureInstanceName (const String &name, size_t mrtIndex)
	Get the instance name for a global texture.
virtual bool	isBackgroundLoaded (void) const
	Returns whether this Resource has been earmarked for background loading.
virtual bool	isLoaded (void) const
	Returns true if the Resource has been loaded, false otherwise.
virtual bool	isLoading () const
	Returns whether the resource is currently in the process of background loading.
virtual bool	isManuallyLoaded (void) const
	Is this resource manually loaded?
virtual bool	isPrepared (void) const
	Returns true if the Resource has been prepared, false otherwise.
virtual bool	isReloadable (void) const
	Returns true if the Resource is reloadable, false otherwise.
virtual void	load (bool backgroundThread=false)
	Loads the resource, if it is not already.
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
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
virtual void	prepare (bool backgroundThread=false)
	Prepares the resource for load, if it is not already.
virtual void	reload (void)
	Reloads the resource, if it is already loaded.
void	removeAllTechniques ()
	Remove all techniques.
virtual void	removeListener (Listener *lis)
	Remove a listener on this resource.
void	removeTechnique (size_t idx)
	Remove a technique.
virtual void	setBackgroundLoaded (bool bl)
	Tells the resource whether it is background loaded or not.
virtual bool	setParameter (const String &name, const String &value)
	Generic parameter setting method.
virtual void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method.
virtual void	touch (void)
	'Touches' the resource to indicate it has been used.
virtual void	unload (void)
	Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Static Public Member Functions
static void	cleanupDictionary ()
	Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
Public Attributes
	OGRE_AUTO_MUTEX
Protected Types
typedef set< Listener * >::type	ListenerList
Protected Member Functions
size_t	calculateSize (void) const
void	compile ()
	Check supportedness of techniques.
bool	createParamDictionary (const String &className)
	Internal method for creating a parameter dictionary for the class, if it does not already exist.
void	loadImpl (void)
	OGRE_MUTEX (mListenerListMutex)
virtual void	postLoadImpl (void)
	Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.
virtual void	postUnloadImpl (void)
	Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.
virtual void	preLoadImpl (void)
	Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.
virtual void	prepareImpl (void)
	Internal implementation of the meat of the 'prepare' action.
virtual void	preUnloadImpl (void)
	Internal hook to perform actions before the unload process.
void	unloadImpl (void)
virtual void	unprepareImpl (void)
	Internal function for undoing the 'prepare' action.
Protected Attributes
ResourceManager *	mCreator
	Creator.
String	mGroup
	The name of the resource group.
ResourceHandle	mHandle
	Numeric handle for more efficient look up than name.
volatile bool	mIsBackgroundLoaded
	Is this resource going to be background loaded? Only applicable for multithreaded.
bool	mIsManual
	Is this file manually loaded?
ListenerList	mListenerList
ManualResourceLoader *	mLoader
	Optional manual loader; if provided, data is loaded from here instead of a file.
AtomicScalar< LoadingState >	mLoadingState
	Is the resource currently loaded?
String	mName
	Unique name of the resource.
String	mOrigin
	Origin of this resource (e.g. script name) - optional.
size_t	mSize
	The size of the resource in bytes.
size_t	mStateCount
	State count, the number of times this resource has changed state.
Private Types
typedef map< String, MultiRenderTarget * >::type	GlobalMRTMap
	Store a list of MRTs we've created.
typedef map< String, TexturePtr >::type	GlobalTextureMap
	Map from name->local texture.
Private Member Functions
void	createGlobalTextures ()
	Create global rendertextures.
void	freeGlobalTextures ()
	Destroy global rendertextures.
Private Attributes
bool	mCompilationRequired
	Compilation required This is set if the techniques change and the supportedness of techniques has to be re-evaluated.
GlobalMRTMap	mGlobalMRTs
GlobalTextureMap	mGlobalTextures
Techniques	mSupportedTechniques
Techniques	mTechniques

Detailed Description

Class representing a Compositor object.

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.

Definition at line 50 of file OgreCompositor.h.

Member Typedef Documentation

typedef map<String,MultiRenderTarget*>::type Ogre::Compositor::GlobalMRTMap [private]

Store a list of MRTs we've created.

Definition at line 173 of file OgreCompositor.h.

typedef map<String,TexturePtr>::type Ogre::Compositor::GlobalTextureMap [private]

Map from name->local texture.

Definition at line 170 of file OgreCompositor.h.

typedef set<Listener*>::type Ogre::Resource::ListenerList [protected, inherited]

Definition at line 166 of file OgreResource.h.

typedef VectorIterator<Techniques> Ogre::Compositor::TechniqueIterator

Definition at line 59 of file OgreCompositor.h.

typedef vector<CompositionTechnique *>::type Ogre::Compositor::Techniques

Data types for internal lists.

Definition at line 58 of file OgreCompositor.h.

Member Enumeration Documentation

enum Ogre::Resource::LoadingState [inherited]

Enum identifying the loading state of the resource.

Enumerator:

LOADSTATE_UNLOADED	Not loaded.
LOADSTATE_LOADING	Loading is in progress.
LOADSTATE_LOADED	Fully loaded.
LOADSTATE_UNLOADING	Currently unloading.
LOADSTATE_PREPARED	Fully prepared.
LOADSTATE_PREPARING	Preparing is in progress.

Definition at line 127 of file OgreResource.h.

Constructor & Destructor Documentation

Ogre::Compositor::Compositor	(	ResourceManager *	creator,
		const String &	name,
		ResourceHandle	handle,
		const String &	group,
		bool	isManual = `false`,
		ManualResourceLoader *	loader = `0`
	)

Ogre::Compositor::~Compositor ( )

Member Function Documentation

virtual void Ogre::Resource::_dirtyState ( ) [virtual, inherited]

Manually mark the state of this resource as having been changed.

Remarks:: You only need to call this from outside if you explicitly want derived objects to think this object has changed.

See also:: getStateCount.

virtual void Ogre::Resource::_fireLoadingComplete ( bool wasBackgroundLoaded ) [virtual, inherited]

Firing of loading complete event.

Remarks:: You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.

Parameters:

wasBackgroundLoaded Whether this was a background loaded event

virtual void Ogre::Resource::_firePreparingComplete ( bool wasBackgroundLoaded ) [virtual, inherited]

Firing of preparing complete event.

Remarks:: You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.

Parameters:

wasBackgroundLoaded Whether this was a background loaded event

virtual void Ogre::Resource::_fireUnloadingComplete ( void ) [virtual, inherited]

Firing of unloading complete event.

Remarks:: You should call this from the thread that runs the main frame loop to avoid having to make the receivers of this event thread-safe. If you use Ogre's built in frame loop you don't need to call this yourself.

virtual void Ogre::Resource::_notifyOrigin ( const String & origin ) [virtual, inherited]

Notify this resource of it's origin.

Definition at line 420 of file OgreResource.h.

virtual void Ogre::Resource::addListener ( Listener * lis ) [virtual, inherited]

Register a listener on this resource.

See also:: Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

size_t Ogre::Compositor::calculateSize ( void ) const [protected, virtual]

Calculate the size of a resource; this will only be called after 'load'.

Reimplemented from Ogre::Resource.

virtual void Ogre::Resource::changeGroupOwnership ( const String & newGroup ) [virtual, inherited]

Change the resource group ownership of a Resource.

Remarks:: This method is generally reserved for internal use, although if you really know what you're doing you can use it to move this resource from one group to another.

Parameters:

newGroup Name of the new group

static void Ogre::StringInterface::cleanupDictionary ( ) [static, inherited]

Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.

MaterialManager) initializes.

void Ogre::Compositor::compile ( ) [protected]

Check supportedness of techniques.

virtual void Ogre::StringInterface::copyParametersTo ( StringInterface * dest ) const [virtual, inherited]

Method for copying this object's parameters to another object.

Remarks:: This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop.

: Any unrecognised parameters will be ignored as with setParameter method.

Parameters:

dest	Pointer to object to have it's parameters set the same as this object.

Definition at line 303 of file OgreStringInterface.h.

References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().

void Ogre::Compositor::createGlobalTextures ( ) [private]

Create global rendertextures.

bool Ogre::StringInterface::createParamDictionary ( const String & className ) [protected, inherited]

Internal method for creating a parameter dictionary for the class, if it does not already exist.

Remarks:: This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance).

Parameters:

className the name of the class using the dictionary

Returns:: true if a new dictionary was created, false if it was already there

Definition at line 186 of file OgreStringInterface.h.

References OGRE_LOCK_MUTEX.

CompositionTechnique* Ogre::Compositor::createTechnique ( )

Create a new technique, and return a pointer to it.

virtual void Ogre::Resource::escalateLoading ( ) [virtual, inherited]

Escalates the loading of a background loaded resource.

Remarks:: If a resource is set to load in the background, but something needs it before it's been loaded, there could be a problem. If the user of this resource really can't wait, they can escalate the loading which basically pulls the loading into the current thread immediately. If the resource is already being loaded but just hasn't quite finished then this method will simply wait until the background load is complete.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

void Ogre::Compositor::freeGlobalTextures ( ) [private]

Destroy global rendertextures.

virtual ResourceManager* Ogre::Resource::getCreator ( void ) [virtual, inherited]

Gets the manager which created this resource.

Definition at line 411 of file OgreResource.h.

virtual const String& Ogre::Resource::getGroup ( void ) const [virtual, inherited]

Gets the group which this resource is a member of.

Definition at line 399 of file OgreResource.h.

virtual ResourceHandle Ogre::Resource::getHandle ( void ) const [virtual, inherited]

Reimplemented in Ogre::SkeletonInstance.

Definition at line 317 of file OgreResource.h.

virtual LoadingState Ogre::Resource::getLoadingState ( ) const [virtual, inherited]

Returns the current loading state.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 348 of file OgreResource.h.

virtual const String& Ogre::Resource::getName ( void ) const [virtual, inherited]

Gets resource name.

Reimplemented in Ogre::SkeletonInstance.

Definition at line 312 of file OgreResource.h.

size_t Ogre::Compositor::getNumSupportedTechniques ( )

Get the number of supported techniques.

Remarks:: The supported technique list is only available after this compositor has been compiled, which typically happens on loading it. Therefore, if this method returns an empty list, try calling Compositor::load.

size_t Ogre::Compositor::getNumTechniques ( )

Get the number of techniques.

virtual const String& Ogre::Resource::getOrigin ( void ) const [virtual, inherited]

Get the origin of this resource, e.g.

a script file name.

Remarks:: This property will only contain something if the creator of this resource chose to populate it. Script loaders are advised to populate it.

Definition at line 418 of file OgreResource.h.

ParamDictionary* Ogre::StringInterface::getParamDictionary ( void ) [inherited]

Retrieves the parameter dictionary for this class.

Remarks:: Only valid to call this after createParamDictionary.

Returns:: Pointer to ParamDictionary shared by all instances of this class which you can add parameters to, retrieve parameters etc.

Definition at line 219 of file OgreStringInterface.h.

const ParamDictionary* Ogre::StringInterface::getParamDictionary ( void ) const [inherited]

Definition at line 224 of file OgreStringInterface.h.

virtual String Ogre::StringInterface::getParameter ( const String & name ) const [virtual, inherited]

Generic parameter retrieval method.

Remarks:: Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use StringConverter to convert this string back into a native type.

Parameters:

name	The name of the parameter to get

Returns:: String value of parameter, blank if not found

Definition at line 272 of file OgreStringInterface.h.

References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().

const ParameterList& Ogre::StringInterface::getParameters ( void ) const [inherited]

Retrieves a list of parameters valid for this object.

Returns:: A reference to a static list of ParameterDef objects.

RenderTarget* Ogre::Compositor::getRenderTarget ( const String & name )

Get the render target for a given render texture name.

Remarks:: You can use this to add listeners etc, but do not use it to update the targets manually or any other modifications, the compositor instance is in charge of this.

virtual size_t Ogre::Resource::getSize ( void ) const [virtual, inherited]

Retrieves info about the size of the resource.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 301 of file OgreResource.h.

virtual size_t Ogre::Resource::getStateCount ( ) const [virtual, inherited]

Returns the number of times this resource has changed state, which generally means the number of times it has been loaded.

Objects that build derived data based on the resource can check this value against a copy they kept last time they built this derived data, in order to know whether it needs rebuilding. This is a nice way of monitoring changes without having a tightly-bound callback.

Definition at line 429 of file OgreResource.h.

CompositionTechnique* Ogre::Compositor::getSupportedTechnique ( size_t idx )

Get a supported technique.

Remarks:: The supported technique list is only available after this compositor has been compiled, which typically happens on loading it. Therefore, if this method returns an empty list, try calling Compositor::load.

CompositionTechnique* Ogre::Compositor::getSupportedTechnique ( const String & schemeName = StringUtil::BLANK )

Get a pointer to a supported technique for a given scheme.

Remarks:: If there is no specific supported technique with this scheme name, then the first supported technique with no specific scheme will be returned.

Parameters:

schemeName The scheme name you are looking for. Blank means to look for techniques with no scheme associated

TechniqueIterator Ogre::Compositor::getSupportedTechniqueIterator ( void )

Gets an iterator over all the Techniques which are supported by the current card.

Remarks:: The supported technique list is only available after this compositor has been compiled, which typically happens on loading it. Therefore, if this method returns an empty list, try calling Compositor::load.

CompositionTechnique* Ogre::Compositor::getTechnique ( size_t idx )

Get a technique.

TechniqueIterator Ogre::Compositor::getTechniqueIterator ( void )

Get an iterator over the Techniques in this compositor.

TexturePtr Ogre::Compositor::getTextureInstance	(	const String &	name,
		size_t	mrtIndex
	)

Get the instance of a global texture.

Parameters:

name	The name of the texture in the original compositor definition
mrtIndex	If name identifies a MRT, which texture attachment to retrieve

Returns:: The texture pointer, corresponds to a real texture

const String& Ogre::Compositor::getTextureInstanceName	(	const String &	name,
		size_t	mrtIndex
	)

Get the instance name for a global texture.

Parameters:

name	The name of the texture in the original compositor definition
mrtIndex	If name identifies a MRT, which texture attachment to retrieve

Returns:: The instance name for the texture, corresponds to a real texture

virtual bool Ogre::Resource::isBackgroundLoaded ( void ) const [virtual, inherited]

Returns whether this Resource has been earmarked for background loading.

Remarks:: This option only makes sense when you have built Ogre with thread support (OGRE_THREAD_SUPPORT). If a resource has been marked for background loading, then it won't load on demand like normal when load() is called. Instead, it will ignore request to load() except if the caller indicates it is the background loader. Any other users of this resource should check isLoaded(), and if that returns false, don't use the resource and come back later.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 365 of file OgreResource.h.

virtual bool Ogre::Resource::isLoaded ( void ) const [virtual, inherited]

Returns true if the Resource has been loaded, false otherwise.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 332 of file OgreResource.h.

virtual bool Ogre::Resource::isLoading ( ) const [virtual, inherited]

Returns whether the resource is currently in the process of background loading.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 341 of file OgreResource.h.

virtual bool Ogre::Resource::isManuallyLoaded ( void ) const [virtual, inherited]

Is this resource manually loaded?

Definition at line 289 of file OgreResource.h.

virtual bool Ogre::Resource::isPrepared ( void ) const [virtual, inherited]

Returns true if the Resource has been prepared, false otherwise.

Definition at line 324 of file OgreResource.h.

virtual bool Ogre::Resource::isReloadable ( void ) const [virtual, inherited]

Returns true if the Resource is reloadable, false otherwise.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 282 of file OgreResource.h.

virtual void Ogre::Resource::load ( bool backgroundThread = false ) [virtual, inherited]

Loads the resource, if it is not already.

Remarks:: If the resource is loaded from a file, loading is automatic. If not, if for example this resource gained it's data from procedural calls rather than loading from a file, then this resource will not reload on it's own.

Parameters:

backgroundThread Indicates whether the caller of this method is the background resource loading thread.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

void Ogre::Compositor::loadImpl ( void ) [protected, virtual]

Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader.

Implements Ogre::Resource.

Ogre::Resource::OGRE_MUTEX ( mListenerListMutex ) [protected, inherited]

template<class Alloc >

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

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

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
	)		`[inherited]`

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 ) [inherited]

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

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
	)		`[inherited]`

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 ) [inherited]

Definition at line 91 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::Resource::postLoadImpl ( void ) [protected, virtual, inherited]

Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.

Note:: Mutex will have already been acquired by the loading thread. Also, this call will occur even when using a ManualResourceLoader (when loadImpl is not actually called)

Reimplemented in Ogre::Mesh, Ogre::D3D9Texture, and Ogre::D3D11Texture.

Definition at line 191 of file OgreResource.h.

virtual void Ogre::Resource::postUnloadImpl ( void ) [protected, virtual, inherited]

Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.

Note:: Mutex will have already been acquired by the unloading thread.

Definition at line 201 of file OgreResource.h.

virtual void Ogre::Resource::preLoadImpl ( void ) [protected, virtual, inherited]

Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.

Note:: Mutex will have already been acquired by the loading thread. Also, this call will occur even when using a ManualResourceLoader (when loadImpl is not actually called)

Definition at line 184 of file OgreResource.h.

virtual void Ogre::Resource::prepare ( bool backgroundThread = false ) [virtual, inherited]

Prepares the resource for load, if it is not already.

One can call prepare() before load(), but this is not required as load() will call prepare() itself, if needed. When OGRE_THREAD_SUPPORT==1 both load() and prepare() are thread-safe. When OGRE_THREAD_SUPPORT==2 however, only prepare() is thread-safe. The reason for this function is to allow a background thread to do some of the loading work, without requiring the whole render system to be thread-safe. The background thread would call prepare() while the main render loop would later call load(). So long as prepare() remains thread-safe, subclasses can arbitrarily split the work of loading a resource between load() and prepare(). It is best to try and do as much work in prepare(), however, since this will leave less work for the main render thread to do and thus increase FPS.

Parameters:

backgroundThread Whether this is occurring in a background thread

virtual void Ogre::Resource::prepareImpl ( void ) [protected, virtual, inherited]

Internal implementation of the meat of the 'prepare' action.

Reimplemented in Ogre::Mesh, Ogre::D3D9Texture, Ogre::D3D11Texture, Ogre::Material, Ogre::PatchMesh, Ogre::GLTexture, and Ogre::GL3PlusTexture.

Definition at line 205 of file OgreResource.h.

virtual void Ogre::Resource::preUnloadImpl ( void ) [protected, virtual, inherited]

Internal hook to perform actions before the unload process.

Note:: Mutex will have already been acquired by the unloading thread.

Definition at line 196 of file OgreResource.h.

virtual void Ogre::Resource::reload ( void ) [virtual, inherited]

Reloads the resource, if it is already loaded.

Remarks:: Calls unload() and then load() again, if the resource is already loaded. If it is not loaded already, then nothing happens.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

void Ogre::Compositor::removeAllTechniques ( )

Remove all techniques.

virtual void Ogre::Resource::removeListener ( Listener * lis ) [virtual, inherited]

Remove a listener on this resource.

See also:: Resource::Listener

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

void Ogre::Compositor::removeTechnique ( size_t idx )

Remove a technique.

It will also be destroyed.

virtual void Ogre::Resource::setBackgroundLoaded ( bool bl ) [virtual, inherited]

Tells the resource whether it is background loaded or not.

See also:: Resource::isBackgroundLoaded. Note that calling this only defers the normal on-demand loading behaviour of a resource, it does not actually set up a thread to make sure the resource gets loaded in the background. You should use ResourceBackgroundLoadingQueue to manage the actual loading (which will call this method itself).

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

Definition at line 375 of file OgreResource.h.

virtual bool Ogre::StringInterface::setParameter	(	const String &	name,
		const String &	value
	)		`[virtual, inherited]`

Generic parameter setting method.

Remarks:: Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters:

name	The name of the parameter to set
value	String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information.

Returns:: true if set was successful, false otherwise (NB no exceptions thrown - tolerant method)

Referenced by Ogre::StringInterface::copyParametersTo().

virtual void Ogre::StringInterface::setParameterList ( const NameValuePairList & paramList ) [virtual, inherited]

Generic multiple parameter setting method.

Remarks:: Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from StringInterface::getParameters.

Parameters:

paramList Name/value pair list

virtual void Ogre::Resource::touch ( void ) [virtual, inherited]

'Touches' the resource to indicate it has been used.

Reimplemented in Ogre::Material, and Ogre::UnifiedHighLevelGpuProgram.

Referenced by Ogre::Material::touch().

virtual void Ogre::Resource::unload ( void ) [virtual, inherited]

Unloads the resource; this is not permanent, the resource can be reloaded later if required.

Reimplemented in Ogre::UnifiedHighLevelGpuProgram.

void Ogre::Compositor::unloadImpl ( void ) [protected, virtual]

Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.

Implements Ogre::Resource.