OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::CompositorChannel Struct Reference

A channel in the compositor transports textures between nodes. More...

#include <OgreCompositorChannel.h>

+ Collaboration diagram for Ogre::CompositorChannel:

Public Types

typedef vector< TexturePtr >::type TextureVec
 

Public Member Functions

 CompositorChannel ()
 
bool isMrt () const
 
bool isValid () const
 
bool operator== (const CompositorChannel &right) const
 

Public Attributes

RenderTargettarget
 
TextureVec textures
 

Detailed Description

A channel in the compositor transports textures between nodes.

Unfortunately, Ogre's design of RenderTargets, Textures & MRTs isn't as straightforward and encapsulated as we wanted them to be. Therefore we need this Channel structure to abstract them.

In short, when we want to render to a texture, we need a RenderTarget. When we want to sample from, we need a Texture. Until here there is an almost 1:1 relationship. However when MRTs come into play, this relationship is destroyed and not handled very well by Ogre. We do.

Definition at line 56 of file OgreCompositorChannel.h.

Member Typedef Documentation

Constructor & Destructor Documentation

Ogre::CompositorChannel::CompositorChannel ( )
inline

Definition at line 62 of file OgreCompositorChannel.h.

Member Function Documentation

bool Ogre::CompositorChannel::isMrt ( ) const
inline

Definition at line 64 of file OgreCompositorChannel.h.

References textures.

bool Ogre::CompositorChannel::isValid ( ) const
inline

Definition at line 65 of file OgreCompositorChannel.h.

References target.

bool Ogre::CompositorChannel::operator== ( const CompositorChannel right) const
inline

Definition at line 66 of file OgreCompositorChannel.h.

References target.

Member Data Documentation

RenderTarget* Ogre::CompositorChannel::target

Definition at line 59 of file OgreCompositorChannel.h.

Referenced by isValid(), and operator==().

TextureVec Ogre::CompositorChannel::textures

Definition at line 60 of file OgreCompositorChannel.h.

Referenced by isMrt().


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