#include <OgreCompositor.h>
Inheritance diagram for Ogre::Compositor:
Public Types | |
typedef std::vector< CompositionTechnique * > | Techniques |
Data types for internal lists. | |
typedef VectorIterator< Techniques > | TechniqueIterator |
enum | LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING } |
Enum identifying the loading state of the resource. More... | |
Public Member Functions | |
Compositor (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0) | |
~Compositor () | |
CompositionTechnique * | createTechnique () |
Create a new technique, and return a pointer to it. | |
void | removeTechnique (size_t idx) |
Remove a technique. | |
CompositionTechnique * | getTechnique (size_t idx) |
Get a technique. | |
size_t | getNumTechniques () |
Get the number of techniques. | |
void | removeAllTechniques () |
Remove all techniques. | |
TechniqueIterator | getTechniqueIterator (void) |
Get an iterator over the Techniques in this compositor. | |
CompositionTechnique * | getSupportedTechnique (size_t idx) |
Get a supported technique. | |
size_t | getNumSupportedTechniques () |
Get the number of supported techniques. | |
TechniqueIterator | getSupportedTechniqueIterator (void) |
Gets an iterator over all the Techniques which are supported by the current card. | |
virtual void | load (bool backgroundThread=false) |
Loads the resource, if it is not already. | |
virtual void | reload (void) |
Reloads the resource, if it is already loaded. | |
bool | isReloadable (void) const |
Returns true if the Resource is reloadable, false otherwise. | |
bool | isManuallyLoaded (void) const |
Is this resource manually loaded? | |
virtual void | unload (void) |
Unloads the resource; this is not permanent, the resource can be reloaded later if required. | |
size_t | getSize (void) const |
Retrieves info about the size of the resource. | |
virtual void | touch (void) |
'Touches' the resource to indicate it has been used. | |
const String & | getName (void) const |
Gets resource name. | |
ResourceHandle | getHandle (void) const |
bool | isLoaded (void) const |
Returns true if the Resource has been loaded, false otherwise. | |
LoadingState | isLoading () const |
Returns whether the resource is currently in the process of background loading. | |
LoadingState | getLoadingState () const |
Returns the current loading state. | |
bool | isBackgroundLoaded (void) const |
Returns whether this Resource has been earmarked for background loading. | |
void | setBackgroundLoaded (bool bl) |
Tells the resource whether it is background loaded or not. | |
void | escalateLoading () |
Escalates the loading of a background loaded resource. | |
void | addListener (Listener *lis) |
Register a listener on this resource. | |
void | removeListener (Listener *lis) |
Remove a listener on this resource. | |
const String & | getGroup (void) |
Gets the group which this resource is a member of. | |
void | changeGroupOwnership (const String &newGroup) |
Change the resource group ownership of a Resource. | |
ResourceManager * | getCreator (void) |
Gets the manager which created this resource. | |
const String & | getOrigin (void) const |
Get the origin of this resource, e.g. | |
void | _notifyOrigin (const String &origin) |
Notify this resource of it's origin. | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. | |
const ParamDictionary * | getParamDictionary (void) const |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. | |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. | |
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. | |
Protected Types | |
typedef std::list< Listener * > | ListenerList |
Protected Member Functions | |
void | loadImpl (void) |
| |
void | unloadImpl (void) |
| |
size_t | calculateSize (void) const |
| |
void | compile () |
Check supportedness of techniques. | |
virtual void | preLoadImpl (void) |
Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'. | |
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 | preUnloadImpl (void) |
Internal hook to perform actions before the unload process. | |
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 | queueFireBackgroundLoadingComplete (void) |
Queue the firing of background loading complete event. | |
bool | createParamDictionary (const String &className) |
Internal method for creating a parameter dictionary for the class, if it does not already exist. | |
Protected Attributes | |
ResourceManager * | mCreator |
Creator. | |
String | mName |
Unique name of the resource. | |
String | mGroup |
The name of the resource group. | |
ResourceHandle | mHandle |
Numeric handle for more efficient look up than name. | |
volatile LoadingState | mLoadingState |
Is the resource currently loaded? | |
volatile bool | mIsBackgroundLoaded |
Is this resource going to be background loaded? Only applicable for multithreaded. | |
size_t | mSize |
Mutex to cover the status of loading The size of the resource in bytes. | |
bool | mIsManual |
Is this file manually loaded? | |
String | mOrigin |
Origin of this resource (e.g. script name) - optional. | |
ManualResourceLoader * | mLoader |
Optional manual loader; if provided, data is loaded from here instead of a file. | |
ListenerList | mListenerList |
String | mParamDictName |
Class name for this instance to be used as a lookup (must be initialised by subclasses). | |
Static Protected Attributes | |
static ParamDictionaryMap | msDictionary |
Dictionary of parameters. | |
Private Attributes | |
Techniques | mTechniques |
Techniques | mSupportedTechniques |
bool | mCompilationRequired |
Compilation required This is set if the techniques change and the supportedness of techniques has to be re-evaluated. |
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 43 of file OgreCompositor.h.
|
Definition at line 131 of file OgreResource.h. |
|
Definition at line 52 of file OgreCompositor.h. |
|
Data types for internal lists.
Definition at line 51 of file OgreCompositor.h. |
|
Enum identifying the loading state of the resource.
Definition at line 96 of file OgreResource.h. |
|
|
|
|
|
Notify this resource of it's origin.
Definition at line 357 of file OgreResource.h. |
|
Register a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. |
|
Implements Ogre::Resource. |
|
Change the resource group ownership of a Resource.
|
|
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. |
|
Check supportedness of techniques.
|
|
Method for copying this object's parameters to another object.
Definition at line 300 of file OgreStringInterface.h. References Ogre::ParamDictionary::mParamDefs. |
|
Internal method for creating a parameter dictionary for the class, if it does not already exist.
Definition at line 176 of file OgreStringInterface.h. |
|
Create a new technique, and return a pointer to it.
|
|
Escalates the loading of a background loaded resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. |
|
Gets the manager which created this resource.
Definition at line 348 of file OgreResource.h. |
|
Gets the group which this resource is a member of.
Reimplemented in Ogre::SkeletonInstance. Definition at line 336 of file OgreResource.h. |
|
Reimplemented in Ogre::SkeletonInstance. Definition at line 262 of file OgreResource.h. |
|
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. Definition at line 285 of file OgreResource.h. |
|
Gets resource name.
Reimplemented in Ogre::SkeletonInstance. Definition at line 257 of file OgreResource.h. |
|
Get the number of supported techniques.
|
|
Get the number of techniques.
|
|
Get the origin of this resource, e.g. a script file name.
Definition at line 355 of file OgreResource.h. |
|
Definition at line 213 of file OgreStringInterface.h. |
|
Retrieves the parameter dictionary for this class.
Definition at line 200 of file OgreStringInterface.h. |
|
Generic parameter retrieval method.
Definition at line 269 of file OgreStringInterface.h. References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand(). |
|
Retrieves a list of parameters valid for this object.
|
|
Retrieves info about the size of the resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. Definition at line 246 of file OgreResource.h. |
|
Get a supported technique.
|
|
Gets an iterator over all the Techniques which are supported by the current card.
|
|
Get a technique.
|
|
Get an iterator over the Techniques in this compositor.
|
|
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. Definition at line 302 of file OgreResource.h. |
|
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. Definition at line 269 of file OgreResource.h. |
|
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. Definition at line 278 of file OgreResource.h. |
|
Is this resource manually loaded?
Definition at line 234 of file OgreResource.h. |
|
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. Definition at line 227 of file OgreResource.h. |
|
Loads the resource, if it is not already.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. |
|
Implements Ogre::Resource. |
|
Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.
Reimplemented in Ogre::Mesh. Definition at line 155 of file OgreResource.h. |
|
Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.
Definition at line 165 of file OgreResource.h. |
|
Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.
Definition at line 148 of file OgreResource.h. |
|
Internal hook to perform actions before the unload process.
Definition at line 160 of file OgreResource.h. |
|
Queue the firing of background loading complete event.
|
|
Reloads the resource, if it is already loaded.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. |
|
Remove all techniques.
|
|
Remove a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. |
|
Remove a technique. It will also be destroyed. |
|
Tells the resource whether it is background loaded or not.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. Definition at line 312 of file OgreResource.h. |
|
Generic parameter setting method.
|
|
Generic multiple parameter setting method.
|
|
'Touches' the resource to indicate it has been used.
Reimplemented in Ogre::Material, and Ogre::UnifiedHighLevelGpuProgram. |
|
Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram. |
|
Implements Ogre::Resource. |
|
Compilation required This is set if the techniques change and the supportedness of techniques has to be re-evaluated.
Definition at line 119 of file OgreCompositor.h. |
|
Creator.
Definition at line 109 of file OgreResource.h. |
|
The name of the resource group.
Definition at line 113 of file OgreResource.h. |
|
Numeric handle for more efficient look up than name.
Definition at line 115 of file OgreResource.h. |
|
Is this resource going to be background loaded? Only applicable for multithreaded.
Definition at line 119 of file OgreResource.h. |
|
Is this file manually loaded?
Definition at line 125 of file OgreResource.h. |
|
Definition at line 132 of file OgreResource.h. |
|
Optional manual loader; if provided, data is loaded from here instead of a file.
Definition at line 129 of file OgreResource.h. |
|
Is the resource currently loaded?
Definition at line 117 of file OgreResource.h. |
|
Unique name of the resource.
Definition at line 111 of file OgreResource.h. |
|
Origin of this resource (e.g. script name) - optional.
Definition at line 127 of file OgreResource.h. |
|
Class name for this instance to be used as a lookup (must be initialised by subclasses).
Definition at line 164 of file OgreStringInterface.h. |
|
Dictionary of parameters.
Definition at line 161 of file OgreStringInterface.h. |
|
Mutex to cover the status of loading The size of the resource in bytes.
Definition at line 123 of file OgreResource.h. |
|
Definition at line 114 of file OgreCompositor.h. |
|
Definition at line 113 of file OgreCompositor.h. |
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 25 13:03:40 2007