OGRE
14.3
Object-Oriented Graphics Rendering Engine
|
Object representing one render to a RenderTarget or Viewport in the Ogre Composition framework. More...
#include <OgreCompositionTargetPass.h>
Public Types | |
enum | InputMode { IM_NONE , IM_PREVIOUS } |
Input mode of a TargetPass. More... | |
typedef std::vector< CompositionPass * > | Passes |
typedef VectorIterator< Passes > | PassIterator |
Public Member Functions | |
CompositionTargetPass (CompositionTechnique *parent) | |
~CompositionTargetPass () | |
bool | _isSupported (void) |
Determine if this target pass is supported on the current rendering device. More... | |
CompositionPass * | createPass (CompositionPass::PassType type=CompositionPass::PT_RENDERQUAD) |
Create a new pass, and return a pointer to it. More... | |
InputMode | getInputMode () const |
Get input mode. More... | |
float | getLodBias () |
Get the scene LOD bias used by this pass. More... | |
const String & | getMaterialScheme (void) const |
Get the material scheme used by this target pass. More... | |
size_t | getNumPasses () const |
Get the number of passes. More... | |
bool | getOnlyInitial () |
Get "only initial" flag. More... | |
const String & | getOutputName () const |
Get output local texture name. More... | |
int | getOutputSlice () const |
CompositionTechnique * | getParent () |
Get parent object. More... | |
CompositionPass * | getPass (size_t idx) const |
Get a pass. More... | |
const Passes & | getPasses () const |
Get the Passes in this TargetPass. More... | |
PassIterator | getPassIterator (void) |
Get an iterator over the Passes in this TargetPass. More... | |
bool | getShadowsEnabled (void) const |
Get whether shadows are enabled in this target pass. More... | |
uint32 | getVisibilityMask () |
Get the scene visibility mask used by this pass. More... | |
void | removeAllPasses () |
Remove all passes. More... | |
void | removePass (size_t idx) |
Remove a pass. More... | |
void | setInputMode (InputMode mode) |
Set input mode of this TargetPass. More... | |
void | setLodBias (float bias) |
Set the scene LOD bias used by this pass. More... | |
void | setMaterialScheme (const String &schemeName) |
Set the material scheme used by this target pass. More... | |
void | setOnlyInitial (bool value) |
Set "only initial" flag. More... | |
void | setOutputName (const String &out) |
Set output local texture name. More... | |
void | setOutputSlice (int slice) |
sets the slice of output texture More... | |
void | setShadowsEnabled (bool enabled) |
Set whether shadows are enabled in this target pass. More... | |
void | setVisibilityMask (uint32 mask) |
Set the scene visibility mask used by this pass. More... | |
Object representing one render to a RenderTarget or Viewport in the Ogre Composition framework.
typedef std::vector<CompositionPass *> Ogre::CompositionTargetPass::Passes |
Ogre::CompositionTargetPass::CompositionTargetPass | ( | CompositionTechnique * | parent | ) |
Ogre::CompositionTargetPass::~CompositionTargetPass | ( | ) |
void Ogre::CompositionTargetPass::setInputMode | ( | InputMode | mode | ) |
Set input mode of this TargetPass.
InputMode Ogre::CompositionTargetPass::getInputMode | ( | ) | const |
Get input mode.
void Ogre::CompositionTargetPass::setOutputName | ( | const String & | out | ) |
Set output local texture name.
const String& Ogre::CompositionTargetPass::getOutputName | ( | ) | const |
Get output local texture name.
|
inline |
sets the slice of output texture
|
inline |
void Ogre::CompositionTargetPass::setOnlyInitial | ( | bool | value | ) |
Set "only initial" flag.
This makes that this target pass is only executed initially after the effect has been enabled.
bool Ogre::CompositionTargetPass::getOnlyInitial | ( | ) |
Get "only initial" flag.
void Ogre::CompositionTargetPass::setVisibilityMask | ( | uint32 | mask | ) |
Set the scene visibility mask used by this pass.
uint32 Ogre::CompositionTargetPass::getVisibilityMask | ( | ) |
Get the scene visibility mask used by this pass.
void Ogre::CompositionTargetPass::setMaterialScheme | ( | const String & | schemeName | ) |
Set the material scheme used by this target pass.
Only applicable to targets that render the scene as one of their passes.
const String& Ogre::CompositionTargetPass::getMaterialScheme | ( | void | ) | const |
Get the material scheme used by this target pass.
Only applicable to targets that render the scene as one of their passes.
void Ogre::CompositionTargetPass::setShadowsEnabled | ( | bool | enabled | ) |
Set whether shadows are enabled in this target pass.
Only applicable to targets that render the scene as one of their passes.
bool Ogre::CompositionTargetPass::getShadowsEnabled | ( | void | ) | const |
Get whether shadows are enabled in this target pass.
Only applicable to targets that render the scene as one of their passes.
void Ogre::CompositionTargetPass::setLodBias | ( | float | bias | ) |
Set the scene LOD bias used by this pass.
The default is 1.0, everything below that means lower quality, higher means higher quality.
float Ogre::CompositionTargetPass::getLodBias | ( | ) |
Get the scene LOD bias used by this pass.
CompositionPass* Ogre::CompositionTargetPass::createPass | ( | CompositionPass::PassType | type = CompositionPass::PT_RENDERQUAD | ) |
Create a new pass, and return a pointer to it.
void Ogre::CompositionTargetPass::removePass | ( | size_t | idx | ) |
Remove a pass.
It will also be destroyed.
|
inline |
Get a pass.
|
inline |
Get the number of passes.
|
inline |
Get the Passes in this TargetPass.
void Ogre::CompositionTargetPass::removeAllPasses | ( | ) |
Remove all passes.
PassIterator Ogre::CompositionTargetPass::getPassIterator | ( | void | ) |
Get an iterator over the Passes in this TargetPass.
CompositionTechnique* Ogre::CompositionTargetPass::getParent | ( | ) |
Get parent object.
bool Ogre::CompositionTargetPass::_isSupported | ( | void | ) |
Determine if this target pass is supported on the current rendering device.