![]() |
OGRE 14.3
Object-Oriented Graphics Rendering Engine
|
Base composition technique, can be subclassed in plugins. More...
#include <OgreCompositionTechnique.h>
Inheritance diagram for Ogre::CompositionTechnique:Classes | |
| class | TextureDefinition |
| Local texture definition. More... | |
Public Types | |
| typedef std::vector< CompositionTargetPass * > | TargetPasses |
| Typedefs for several iterators. | |
| typedef VectorIterator< TargetPasses > | TargetPassIterator |
| typedef VectorIterator< TextureDefinitions > | TextureDefinitionIterator |
| typedef std::vector< TextureDefinition * > | TextureDefinitions |
| enum | TextureScope { TS_LOCAL , TS_CHAIN , TS_GLOBAL } |
Public Member Functions | |
| CompositionTechnique (Compositor *parent) | |
| virtual | ~CompositionTechnique () |
| CompositionTargetPass * | createTargetPass () |
| Create a new target pass, and return a pointer to it. | |
| TextureDefinition * | createTextureDefinition (const String &name) |
| Create a new local texture definition, and return a pointer to it. | |
| const String & | getCompositorLogicName () const |
| Get the compositor logic name assigned to this technique. | |
| size_t | getNumTargetPasses () const |
| Get the number of target passes. | |
| size_t | getNumTextureDefinitions () const |
| Get the number of local texture definitions. | |
| CompositionTargetPass * | getOutputTargetPass () const |
| Get output (final) target pass. | |
| Compositor * | getParent () |
| Get parent object. | |
| const String & | getSchemeName () const |
| Get the scheme name assigned to this technique. | |
| CompositionTargetPass * | getTargetPass (size_t idx) const |
| Get a target pass. | |
| const TargetPasses & | getTargetPasses () const |
| Get the TargetPasses in this Technique. | |
| TargetPassIterator | getTargetPassIterator (void) |
| TextureDefinition * | getTextureDefinition (const String &name) const |
| Get a local texture definition with a specific name. | |
| TextureDefinition * | getTextureDefinition (size_t idx) const |
| Get a local texture definition. | |
| TextureDefinitionIterator | getTextureDefinitionIterator (void) |
| const TextureDefinitions & | getTextureDefinitions () const |
| Get the TextureDefinitions in this Technique. | |
| virtual bool | isSupported (bool allowTextureDegradation) |
| Determine if this technique is supported on the current rendering device. | |
| void | removeAllTargetPasses () |
| Remove all target passes. | |
| void | removeAllTextureDefinitions () |
| Remove all Texture Definitions. | |
| void | removeTargetPass (size_t idx) |
| Remove a target pass. | |
| void | removeTextureDefinition (size_t idx) |
| Remove and destroy a local texture definition. | |
| void | setCompositorLogicName (const String &compositorLogicName) |
| Set the name of the compositor logic assigned to this technique. | |
| virtual void | setSchemeName (const String &schemeName) |
| Assign a scheme name to this technique, used to switch between multiple techniques by choice rather than for hardware compatibility. | |
Base composition technique, can be subclassed in plugins.
| typedef std::vector<CompositionTargetPass *> Ogre::CompositionTechnique::TargetPasses |
Typedefs for several iterators.
| typedef std::vector<TextureDefinition*> Ogre::CompositionTechnique::TextureDefinitions |
| Ogre::CompositionTechnique::CompositionTechnique | ( | Compositor * | parent | ) |
|
virtual |
| TextureDefinition * Ogre::CompositionTechnique::createTextureDefinition | ( | const String & | name | ) |
Create a new local texture definition, and return a pointer to it.
| name | Name of the local texture |
| void Ogre::CompositionTechnique::removeTextureDefinition | ( | size_t | idx | ) |
Remove and destroy a local texture definition.
|
inline |
Get a local texture definition.
| TextureDefinition * Ogre::CompositionTechnique::getTextureDefinition | ( | const String & | name | ) | const |
Get a local texture definition with a specific name.
|
inline |
Get the number of local texture definitions.
| void Ogre::CompositionTechnique::removeAllTextureDefinitions | ( | ) |
Remove all Texture Definitions.
|
inline |
Get the TextureDefinitions in this Technique.
| TextureDefinitionIterator Ogre::CompositionTechnique::getTextureDefinitionIterator | ( | void | ) |
| CompositionTargetPass * Ogre::CompositionTechnique::createTargetPass | ( | ) |
Create a new target pass, and return a pointer to it.
| void Ogre::CompositionTechnique::removeTargetPass | ( | size_t | idx | ) |
Remove a target pass.
It will also be destroyed.
|
inline |
Get a target pass.
|
inline |
Get the number of target passes.
| void Ogre::CompositionTechnique::removeAllTargetPasses | ( | ) |
Remove all target passes.
|
inline |
Get the TargetPasses in this Technique.
| TargetPassIterator Ogre::CompositionTechnique::getTargetPassIterator | ( | void | ) |
|
inline |
Get output (final) target pass.
|
virtual |
Determine if this technique is supported on the current rendering device.
| allowTextureDegradation | True to accept a reduction in texture depth |
|
virtual |
Assign a scheme name to this technique, used to switch between multiple techniques by choice rather than for hardware compatibility.
|
inline |
Get the scheme name assigned to this technique.
|
inline |
Set the name of the compositor logic assigned to this technique.
Instances of this technique will be auto-coupled with the matching logic.
|
inline |
Get the compositor logic name assigned to this technique.
| Compositor * Ogre::CompositionTechnique::getParent | ( | ) |
Get parent object.