Ogre::CompositorChannel Struct Reference

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

#include <OgreCompositorChannel.h>

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
RenderTarget *	target
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.

Member Typedef Documentation

TextureVec

typedef vector<TexturePtr>::type Ogre::CompositorChannel::TextureVec

Constructor & Destructor Documentation

CompositorChannel()

Ogre::CompositorChannel::CompositorChannel ( )

inline

Member Function Documentation

isMrt()

bool Ogre::CompositorChannel::isMrt ( ) const

inline

References textures.

isValid()

bool Ogre::CompositorChannel::isValid ( ) const

inline

References target.

operator==()

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

inline

References target.

Member Data Documentation

target

RenderTarget* Ogre::CompositorChannel::target

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

textures

TextureVec Ogre::CompositorChannel::textures

Referenced by isMrt().

---

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

• OgreCompositorChannel.h