Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

Ogre::CompositionTargetPass Class Reference

Object representing one render to a RenderTarget or Viewport in the Ogre Composition framework. More...

#include <OgreCompositionTargetPass.h>

List of all members.

Public Types

typedef std::vector< CompositionPass * > Passes
typedef VectorIterator< Passes > PassIterator
enum  InputMode { IM_NONE, IM_PREVIOUS }
 Input mode of a TargetPass. More...


Public Member Functions

 CompositionTargetPass (CompositionTechnique *parent)
 ~CompositionTargetPass ()
void setInputMode (InputMode mode)
 Set input mode of this TargetPass.

InputMode getInputMode () const
 Get input mode.

void setOutputName (const String &out)
 Set output local texture name.

const String & getOutputName () const
 Get output local texture name.

void setOnlyInitial (bool value)
 Set "only initial" flag.

bool getOnlyInitial ()
 Get "only initial" flag.

void setVisibilityMask (uint32 mask)
 Set the scene visiblity mask used by this pass.

uint32 getVisibilityMask ()
 Get the scene visiblity mask used by this pass.

void setMaterialScheme (const String &schemeName)
 Set the material scheme used by this target pass.

const String & getMaterialScheme (void) const
 Get the material scheme used by this target pass.

void setLodBias (float bias)
 Set the scene LOD bias used by this pass.

float getLodBias ()
 Get the scene LOD bias used by this pass.

CompositionPass * createPass ()
 Create a new pass, and return a pointer to it.

void removePass (size_t idx)
 Remove a pass.

CompositionPass * getPass (size_t idx)
 Get a pass.

size_t getNumPasses ()
 Get the number of passes.

void removeAllPasses ()
 Remove all passes.

PassIterator getPassIterator (void)
 Get an iterator over the Passes in this TargetPass.

CompositionTechnique * getParent ()
 Get parent object.


Private Attributes

CompositionTechnique * mParent
 Parent technique.

InputMode mInputMode
 Input name.

String mOutputName
 (local) output texture

Passes mPasses
 Passes.

bool mOnlyInitial
 This target pass is only executed initially after the effect has been enabled.

uint32 mVisibilityMask
 Visibility mask for this render.

float mLodBias
 LOD bias of this render.

String mMaterialScheme
 Material scheme name.

Detailed Description

Object representing one render to a RenderTarget or Viewport in the Ogre Composition framework.

Definition at line 35 of file OgreCompositionTargetPass.h.

Member Typedef Documentation

typedef std::vector<CompositionPass *> Ogre::CompositionTargetPass::Passes
 

Definition at line 48 of file OgreCompositionTargetPass.h.

typedef VectorIterator<Passes> Ogre::CompositionTargetPass::PassIterator
 

Definition at line 49 of file OgreCompositionTargetPass.h.

Member Enumeration Documentation

enum Ogre::CompositionTargetPass::InputMode
 

Input mode of a TargetPass.

Enumeration values:
IM_NONE 
IM_PREVIOUS 

Definition at line 43 of file OgreCompositionTargetPass.h.

Constructor & Destructor Documentation

Ogre::CompositionTargetPass::CompositionTargetPass (  CompositionTechnique *  parent  ) 
 

Ogre::CompositionTargetPass::~CompositionTargetPass (   ) 
 

Member Function Documentation

CompositionPass* Ogre::CompositionTargetPass::createPass (   ) 
 

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

InputMode Ogre::CompositionTargetPass::getInputMode (   )  const
 

Get input mode.

float Ogre::CompositionTargetPass::getLodBias (   ) 
 

Get the scene LOD bias used by this pass.

const String& Ogre::CompositionTargetPass::getMaterialScheme (  void   )  const
 

Get the material scheme used by this target pass.

Remarks:
Only applicable to targets that render the scene as one of their passes.
See also:
Technique::setScheme.

size_t Ogre::CompositionTargetPass::getNumPasses (   ) 
 

Get the number of passes.

bool Ogre::CompositionTargetPass::getOnlyInitial (   ) 
 

Get "only initial" flag.

const String& Ogre::CompositionTargetPass::getOutputName (   )  const
 

Get output local texture name.

CompositionTechnique* Ogre::CompositionTargetPass::getParent (   ) 
 

Get parent object.

CompositionPass* Ogre::CompositionTargetPass::getPass (  size_t  idx  ) 
 

Get a pass.

PassIterator Ogre::CompositionTargetPass::getPassIterator (  void   ) 
 

Get an iterator over the Passes in this TargetPass.

uint32 Ogre::CompositionTargetPass::getVisibilityMask (   ) 
 

Get the scene visiblity mask used by this pass.

void Ogre::CompositionTargetPass::removeAllPasses (   ) 
 

Remove all passes.

void Ogre::CompositionTargetPass::removePass (  size_t  idx  ) 
 

Remove a pass.

It will also be destroyed.

void Ogre::CompositionTargetPass::setInputMode (  InputMode  mode  ) 
 

Set input mode of this TargetPass.

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.

void Ogre::CompositionTargetPass::setMaterialScheme (  const String &  schemeName  ) 
 

Set the material scheme used by this target pass.

Remarks:
Only applicable to targets that render the scene as one of their passes.
See also:
Technique::setScheme.

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.

void Ogre::CompositionTargetPass::setOutputName (  const String &  out  ) 
 

Set output local texture name.

void Ogre::CompositionTargetPass::setVisibilityMask (  uint32  mask  ) 
 

Set the scene visiblity mask used by this pass.

Member Data Documentation

InputMode Ogre::CompositionTargetPass::mInputMode [private]
 

Input name.

Definition at line 126 of file OgreCompositionTargetPass.h.

float Ogre::CompositionTargetPass::mLodBias [private]
 

LOD bias of this render.

Definition at line 137 of file OgreCompositionTargetPass.h.

String Ogre::CompositionTargetPass::mMaterialScheme [private]
 

Material scheme name.

Definition at line 139 of file OgreCompositionTargetPass.h.

bool Ogre::CompositionTargetPass::mOnlyInitial [private]
 

This target pass is only executed initially after the effect has been enabled.

Definition at line 133 of file OgreCompositionTargetPass.h.

String Ogre::CompositionTargetPass::mOutputName [private]
 

(local) output texture

Definition at line 128 of file OgreCompositionTargetPass.h.

CompositionTechnique* Ogre::CompositionTargetPass::mParent [private]
 

Parent technique.

Definition at line 124 of file OgreCompositionTargetPass.h.

Passes Ogre::CompositionTargetPass::mPasses [private]
 

Passes.

Definition at line 130 of file OgreCompositionTargetPass.h.

uint32 Ogre::CompositionTargetPass::mVisibilityMask [private]
 

Visibility mask for this render.

Definition at line 135 of file OgreCompositionTargetPass.h.

The documentation for this class was generated from the following file:

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:38:27 2006