OGRE: Ogre::CompositorTargetDef Class Reference

| OGRE 2.2.4 Object-Oriented Graphics Rendering Engine

Public Member Functions | List of all members
Ogre::CompositorTargetDef Class Reference
Core » Effects

`#include <OgreCompositorPassDef.h>`

Inheritance diagram for Ogre::CompositorTargetDef:
[legend]

## Public Member Functions
| CompositorTargetDef (const String &renderTargetName, uint32 rtIndex, CompositorNodeDef *parentNodeDef)
| ~CompositorTargetDef ()
CompositorPassDef * | addPass (CompositorPassType passType, IdString customId=IdString())
const CompositorPassDefVec & | getCompositorPasses () const
CompositorPassDefVec & | getCompositorPassesNonConst ()
| @See getNodeDefinition. More...
const CompositorNodeDef * | getParentNodeDef (void) const
IdString | getRenderTargetName () const
String | getRenderTargetNameStr () const
uint32 | getRtIndex (void) const
uint8 | getShadowMapSupportedLightTypes (void) const
void | operator delete (void *ptr)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete (void *ptr, void *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)
void * | operator new (size_t sz)
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 *ptr)
| placement operator new More...
void * | operator new[] (size_t sz)
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info More...
void | setNumPasses (size_t numPasses)
| Reserves enough memory for all passes (efficient allocation) More...
void | setShadowMapSupportedLightTypes (uint8 types)

## Constructor & Destructor Documentation

## ◆ CompositorTargetDef()

Ogre::CompositorTargetDef::CompositorTargetDef | ( | const String & | renderTargetName,
|  | uint32 | rtIndex,
|  | CompositorNodeDef * | parentNodeDef
| ) |  |

## ◆ ~CompositorTargetDef()

Ogre::CompositorTargetDef::~CompositorTargetDef | ( |  | ) |

## Member Function Documentation

## ◆ addPass()

CompositorPassDef* Ogre::CompositorTargetDef::addPass | ( | CompositorPassType | passType,
|  | IdString | customId = `IdString()`
| ) |  |

## ◆ getCompositorPasses()

const CompositorPassDefVec& Ogre::CompositorTargetDef::getCompositorPasses | ( |  | ) | const
| inline

## ◆ getCompositorPassesNonConst()

CompositorPassDefVec& Ogre::CompositorTargetDef::getCompositorPassesNonConst | ( |  | ) |
| inline

@See getNodeDefinition.

Returns a non-const pointer. Use this only if you know what you're doing. Modifying a NodeDef while it's being used by CompositorNode instances is undefined. It's safe if you're sure it's not being used.

## ◆ getParentNodeDef()

const CompositorNodeDef* Ogre::CompositorTargetDef::getParentNodeDef | ( | void |  | ) | const
| inline

## ◆ getRenderTargetName()

IdString Ogre::CompositorTargetDef::getRenderTargetName | ( |  | ) | const
| inline

## ◆ getRenderTargetNameStr()

String Ogre::CompositorTargetDef::getRenderTargetNameStr | ( |  | ) | const
| inline

## ◆ getRtIndex()

uint32 Ogre::CompositorTargetDef::getRtIndex | ( | void |  | ) | const
| inline

## ◆ getShadowMapSupportedLightTypes()

uint8 Ogre::CompositorTargetDef::getShadowMapSupportedLightTypes | ( | void |  | ) | const
| inline

## ◆ operator delete() [1/3]

template<class Alloc >

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

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

template<class Alloc >

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

## ◆ operator delete() [3/3]

template<class Alloc >

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

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

template<class Alloc >

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

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

template<class Alloc >

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

## ◆ operator new() [1/3]

template<class Alloc >

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

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

template<class Alloc >

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

operator new, with debug line info

## ◆ operator new() [3/3]

template<class Alloc >

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

placement operator new

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

template<class Alloc >

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

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

template<class Alloc >

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

array operator new, with debug line info

## ◆ setNumPasses()

void Ogre::CompositorTargetDef::setNumPasses | ( | size_t | numPasses | ) |
| inline

Reserves enough memory for all passes (efficient allocation)

Remarks
  Calling this function is not obligatory, but recommended

Parameters

  numPasses | The number of passes expected to contain.

## ◆ setShadowMapSupportedLightTypes()

void Ogre::CompositorTargetDef::setShadowMapSupportedLightTypes | ( | uint8 | types | ) |
| inline

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

- OgreCompositorPassDef.h