Ogre::CompositionTargetPass Class Reference
Core » Effects

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

`#include <OgreCompositionTargetPass.h>`

Inheritance diagram for Ogre::CompositionTargetPass:
[legend]

## Public Types

enum | InputMode { IM_NONE, IM_PREVIOUS }
| Input mode of a TargetPass. More...
typedef vector< CompositionPass * >::type | 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 ()
| 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 ()
| Get the number of passes. More...
bool | getOnlyInitial ()
| Get "only initial" flag. More...
const String & | getOutputName () const
| Get output local texture name. More...
CompositionTechnique * | getParent ()
| Get parent object. More...
CompositionPass * | getPass (size_t idx)
| Get a pass. 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 | operator delete (void *ptr)
void | operator delete (void *ptr, void *)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info More...
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new More...
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info More...
void * | operator new[] (size_t sz)
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 | 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...

## Private Attributes

InputMode | mInputMode
| Input mode. More...
float | mLodBias
| LOD bias of this render. More...
String | mMaterialScheme
| Material scheme name. More...
bool | mOnlyInitial
| This target pass is only executed initially after the effect has been enabled. More...
String | mOutputName
| (local) output texture More...
CompositionTechnique * | mParent
| Parent technique. More...
Passes | mPasses
| Passes. More...
bool | mShadowsEnabled
| Shadows option. More...
uint32 | mVisibilityMask
| Visibility mask for this render. More...

## Detailed Description

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

Definition at line 45 of file OgreCompositionTargetPass.h.

## Member Typedef Documentation

## Passes

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

Definition at line 58 of file OgreCompositionTargetPass.h.

## PassIterator

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

Definition at line 59 of file OgreCompositionTargetPass.h.

## Member Enumeration Documentation

## InputMode

enum Ogre::CompositionTargetPass::InputMode

Input mode of a TargetPass.

Enumerator
IM_NONE |
IM_PREVIOUS | No input. Output of previous Composition in chain

Definition at line 53 of file OgreCompositionTargetPass.h.

## Constructor & Destructor Documentation

## CompositionTargetPass()

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

## ~CompositionTargetPass()

Ogre::CompositionTargetPass::~CompositionTargetPass | ( |  | ) |

## Member Function Documentation

## _isSupported()

bool Ogre::CompositionTargetPass::_isSupported | ( | void |  | ) |

Determine if this target pass is supported on the current rendering device.

## createPass()

CompositionPass* Ogre::CompositionTargetPass::createPass | ( |  | ) |

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

## getInputMode()

InputMode Ogre::CompositionTargetPass::getInputMode | ( |  | ) | const

Get input mode.

## getLodBias()

float Ogre::CompositionTargetPass::getLodBias | ( |  | ) |

Get the scene LOD bias used by this pass.

## getMaterialScheme()

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.

## getNumPasses()

size_t Ogre::CompositionTargetPass::getNumPasses | ( |  | ) |

Get the number of passes.

## getOnlyInitial()

bool Ogre::CompositionTargetPass::getOnlyInitial | ( |  | ) |

Get "only initial" flag.

## getOutputName()

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

Get output local texture name.

## getParent()

CompositionTechnique* Ogre::CompositionTargetPass::getParent | ( |  | ) |

Get parent object.

## getPass()

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

Get a pass.

## getPassIterator()

PassIterator Ogre::CompositionTargetPass::getPassIterator | ( | void |  | ) |

Get an iterator over the Passes in this TargetPass.

## getShadowsEnabled()

bool Ogre::CompositionTargetPass::getShadowsEnabled | ( | void |  | ) | const

Get whether shadows are enabled in this target pass.

Remarks
  Only applicable to targets that render the scene as one of their passes.

## getVisibilityMask()

uint32 Ogre::CompositionTargetPass::getVisibilityMask | ( |  | ) |

Get the scene visibility mask used by this pass.

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |
| ) |  |

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr
| ) |  |

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func
| ) |  |

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) |

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## removeAllPasses()

void Ogre::CompositionTargetPass::removeAllPasses | ( |  | ) |

Remove all passes.

## removePass()

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

Remove a pass.

It will also be destroyed.

## setInputMode()

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

Set input mode of this TargetPass.

## setLodBias()

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.

## setMaterialScheme()

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.

## setOnlyInitial()

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.

## setOutputName()

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

Set output local texture name.

## setShadowsEnabled()

void Ogre::CompositionTargetPass::setShadowsEnabled | ( | bool | enabled | ) |

Set whether shadows are enabled in this target pass.

Remarks
  Only applicable to targets that render the scene as one of their passes.

## setVisibilityMask()

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

Set the scene visibility mask used by this pass.

## Member Data Documentation

## mInputMode

InputMode Ogre::CompositionTargetPass::mInputMode

private

Input mode.

Definition at line 153 of file OgreCompositionTargetPass.h.

## mLodBias

float Ogre::CompositionTargetPass::mLodBias

private

LOD bias of this render.

Definition at line 164 of file OgreCompositionTargetPass.h.

## mMaterialScheme

String Ogre::CompositionTargetPass::mMaterialScheme

private

Material scheme name.

Definition at line 166 of file OgreCompositionTargetPass.h.

## mOnlyInitial

bool Ogre::CompositionTargetPass::mOnlyInitial

private

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

Definition at line 160 of file OgreCompositionTargetPass.h.

## mOutputName

String Ogre::CompositionTargetPass::mOutputName

private

(local) output texture

Definition at line 155 of file OgreCompositionTargetPass.h.

## mParent

CompositionTechnique* Ogre::CompositionTargetPass::mParent

private

Parent technique.

Definition at line 151 of file OgreCompositionTargetPass.h.

## mPasses

Passes Ogre::CompositionTargetPass::mPasses

private

Passes.

Definition at line 157 of file OgreCompositionTargetPass.h.

## mShadowsEnabled

bool Ogre::CompositionTargetPass::mShadowsEnabled

private

Shadows option.

Definition at line 168 of file OgreCompositionTargetPass.h.

## mVisibilityMask

uint32 Ogre::CompositionTargetPass::mVisibilityMask

private

Visibility mask for this render.

Definition at line 162 of file OgreCompositionTargetPass.h.

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

- OgreCompositionTargetPass.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.