OGRE
1.11.6
Object-Oriented Graphics Rendering Engine
|
Class representing a Compositor object. More...
#include <OgreCompositor.h>
Public Types | |
enum | LoadingFlags { LF_DEFAULT = 0, LF_INCLUDE_NON_RELOADABLE = 1, LF_ONLY_UNREFERENCED = 2, LF_ONLY_UNREFERENCED_INCLUDE_NON_RELOADABLE = 3, LF_PRESERVE_STATE = 4 } |
Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior. More... | |
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 std::vector< CompositionTechnique * > | Techniques |
Data types for internal lists. More... | |
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. More... | |
void | _fireLoadingComplete (bool wasBackgroundLoaded) |
Firing of loading complete event. More... | |
void | _firePreparingComplete (bool wasBackgroundLoaded) |
Firing of preparing complete event. More... | |
void | _fireUnloadingComplete (void) |
Firing of unloading complete event. More... | |
void | _notifyOrigin (const String &origin) |
Notify this resource of it's origin. More... | |
virtual void | addListener (Listener *lis) |
Register a listener on this resource. More... | |
virtual void | changeGroupOwnership (const String &newGroup) |
Change the resource group ownership of a Resource. More... | |
void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. More... | |
CompositionTechnique * | createTechnique () |
Create a new technique, and return a pointer to it. More... | |
virtual void | escalateLoading () |
Escalates the loading of a background loaded resource. More... | |
ResourceManager * | getCreator (void) |
Gets the manager which created this resource. More... | |
virtual const String & | getGroup (void) const |
Gets the group which this resource is a member of. More... | |
virtual ResourceHandle | getHandle (void) const |
virtual LoadingState | getLoadingState () const |
Returns the current loading state. More... | |
virtual const String & | getName (void) const |
Gets resource name. More... | |
size_t | getNumSupportedTechniques () |
Get the number of supported techniques. More... | |
size_t | getNumTechniques () |
Get the number of techniques. More... | |
const String & | getOrigin (void) const |
Get the origin of this resource, e.g. More... | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. More... | |
const ParamDictionary * | getParamDictionary (void) const |
String | getParameter (const String &name) const |
Generic parameter retrieval method. More... | |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. More... | |
RenderTarget * | getRenderTarget (const String &name) |
Get the render target for a given render texture name. More... | |
virtual size_t | getSize (void) const |
Retrieves info about the size of the resource. More... | |
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. More... | |
CompositionTechnique * | getSupportedTechnique (size_t idx) |
Get a supported technique. More... | |
CompositionTechnique * | getSupportedTechnique (const String &schemeName=BLANKSTRING) |
Get a pointer to a supported technique for a given scheme. More... | |
TechniqueIterator | getSupportedTechniqueIterator (void) |
Gets an iterator over all the Techniques which are supported by the current card. More... | |
CompositionTechnique * | getTechnique (size_t idx) |
Get a technique. More... | |
TechniqueIterator | getTechniqueIterator (void) |
Get an iterator over the Techniques in this compositor. More... | |
TexturePtr | getTextureInstance (const String &name, size_t mrtIndex) |
Get the instance of a global texture. More... | |
const String & | getTextureInstanceName (const String &name, size_t mrtIndex) |
Get the instance name for a global texture. More... | |
virtual bool | isBackgroundLoaded (void) const |
Returns whether this Resource has been earmarked for background loading. More... | |
virtual bool | isLoaded (void) const |
Returns true if the Resource has been loaded, false otherwise. More... | |
virtual bool | isLoading () const |
Returns whether the resource is currently in the process of background loading. More... | |
virtual bool | isManuallyLoaded (void) const |
Is this resource manually loaded? More... | |
virtual bool | isPrepared (void) const |
Returns true if the Resource has been prepared, false otherwise. More... | |
virtual bool | isReloadable (void) const |
Returns true if the Resource is reloadable, false otherwise. More... | |
virtual void | load (bool backgroundThread=false) |
Loads the resource, if it is not already. More... | |
virtual void | prepare (bool backgroundThread=false) |
Prepares the resource for load, if it is not already. More... | |
virtual void | reload (LoadingFlags flags=LF_DEFAULT) |
Reloads the resource, if it is already loaded. More... | |
void | removeAllTechniques () |
Remove all techniques. More... | |
virtual void | removeListener (Listener *lis) |
Remove a listener on this resource. More... | |
void | removeTechnique (size_t idx) |
Remove a technique. More... | |
virtual void | setBackgroundLoaded (bool bl) |
Tells the resource whether it is background loaded or not. More... | |
bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. More... | |
void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. More... | |
virtual void | touch (void) |
'Touches' the resource to indicate it has been used. More... | |
virtual void | unload (void) |
Unloads the resource; this is not permanent, the resource can be reloaded later if required. More... | |
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. More... | |
Public Attributes | |
OGRE_AUTO_MUTEX | |
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.
typedef std::vector<CompositionTechnique *> Ogre::Compositor::Techniques |
Data types for internal lists.
|
inherited |
|
inherited |
Enum that allow to choose subset of unloaded/reloaded resources and to adjust reloading behavior.
Ogre::Compositor::Compositor | ( | ResourceManager * | creator, |
const String & | name, | ||
ResourceHandle | handle, | ||
const String & | group, | ||
bool | isManual = false , |
||
ManualResourceLoader * | loader = 0 |
||
) |
Ogre::Compositor::~Compositor | ( | ) |
CompositionTechnique* Ogre::Compositor::createTechnique | ( | ) |
Create a new technique, and return a pointer to it.
void Ogre::Compositor::removeTechnique | ( | size_t | idx | ) |
Remove a technique.
It will also be destroyed.
CompositionTechnique* Ogre::Compositor::getTechnique | ( | size_t | idx | ) |
Get a technique.
size_t Ogre::Compositor::getNumTechniques | ( | ) |
Get the number of techniques.
void Ogre::Compositor::removeAllTechniques | ( | ) |
Remove all techniques.
TechniqueIterator Ogre::Compositor::getTechniqueIterator | ( | void | ) |
Get an iterator over the Techniques in this compositor.
CompositionTechnique* Ogre::Compositor::getSupportedTechnique | ( | size_t | idx | ) |
Get a supported technique.
size_t Ogre::Compositor::getNumSupportedTechniques | ( | ) |
Get the number of supported techniques.
TechniqueIterator Ogre::Compositor::getSupportedTechniqueIterator | ( | void | ) |
Gets an iterator over all the Techniques which are supported by the current card.
CompositionTechnique* Ogre::Compositor::getSupportedTechnique | ( | const String & | schemeName = BLANKSTRING | ) |
Get a pointer to a supported technique for a given scheme.
schemeName | The scheme name you are looking for. Blank means to look for techniques with no scheme associated |
Get the instance name for a global texture.
name | The name of the texture in the original compositor definition |
mrtIndex | If name identifies a MRT, which texture attachment to retrieve |
TexturePtr Ogre::Compositor::getTextureInstance | ( | const String & | name, |
size_t | mrtIndex | ||
) |
Get the instance of a global texture.
name | The name of the texture in the original compositor definition |
mrtIndex | If name identifies a MRT, which texture attachment to retrieve |
RenderTarget* Ogre::Compositor::getRenderTarget | ( | const String & | name | ) |
Get the render target for a given render texture name.
|
virtualinherited |
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.
backgroundThread | Whether this is occurring in a background thread |
|
virtualinherited |
Loads the resource, if it is not already.
backgroundThread | Indicates whether the caller of this method is the background resource loading thread. |
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
Reloads the resource, if it is already loaded.
Reimplemented in Ogre::Mesh, and Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Returns true if the Resource is reloadable, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Is this resource manually loaded?
|
virtualinherited |
Unloads the resource; this is not permanent, the resource can be reloaded later if required.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Retrieves info about the size of the resource.
Reimplemented in Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
'Touches' the resource to indicate it has been used.
Reimplemented in Ogre::Material, Ogre::CgProgram, and Ogre::UnifiedHighLevelGpuProgram.
Referenced by Ogre::Material::touch().
|
inlinevirtualinherited |
Gets resource name.
Reimplemented in Ogre::SkeletonInstance.
Referenced by Ogre::GpuProgramUsage::getProgramName(), and OgreBites::TrayManager::resourceLoadStarted().
|
inlinevirtualinherited |
Reimplemented in Ogre::SkeletonInstance.
|
inlinevirtualinherited |
Returns true if the Resource has been prepared, false otherwise.
|
inlinevirtualinherited |
Returns true if the Resource has been loaded, false otherwise.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Returns whether the resource is currently in the process of background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Returns the current loading state.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Returns whether this Resource has been earmarked for background loading.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Tells the resource whether it is background loaded or not.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
Escalates the loading of a background loaded resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
Register a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
virtualinherited |
Remove a listener on this resource.
Reimplemented in Ogre::UnifiedHighLevelGpuProgram.
|
inlinevirtualinherited |
Gets the group which this resource is a member of.
Reimplemented in Ogre::SkeletonInstance.
|
virtualinherited |
Change the resource group ownership of a Resource.
newGroup | Name of the new group |
|
inlineinherited |
Gets the manager which created this resource.
|
inlineinherited |
Get the origin of this resource, e.g.
a script file name.
|
inlineinherited |
Notify this resource of it's origin.
|
inlinevirtualinherited |
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.
|
virtualinherited |
Manually mark the state of this resource as having been changed.
|
inherited |
Firing of loading complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
|
inherited |
Firing of preparing complete event.
wasBackgroundLoaded | Whether this was a background loaded event |
|
inherited |
Firing of unloading complete event.
|
inlineinherited |
Retrieves the parameter dictionary for this class.
|
inlineinherited |
|
inherited |
Retrieves a list of parameters valid for this object.
Generic parameter setting method.
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. |
Referenced by Ogre::StringInterface::copyParametersTo().
|
inherited |
Generic multiple parameter setting method.
paramList | Name/value pair list |
Generic parameter retrieval method.
name | The name of the parameter to get |
References Ogre::ParamCommand::doGet().
|
inlineinherited |
Method for copying this object's parameters to another object.
dest | Pointer to object to have it's parameters set the same as this object. |
References Ogre::StringInterface::setParameter().
|
staticinherited |
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.
|
inherited |