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

#include <OgreCompositionTargetPass.h>

Inheritance diagram for Ogre::CompositionTargetPass:

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.
CompositionPass *	createPass ()
	Create a new pass, and return a pointer to it.
InputMode	getInputMode () const
	Get input mode.
float	getLodBias ()
	Get the scene LOD bias used by this pass.
const String &	getMaterialScheme (void) const
	Get the material scheme used by this target pass.
size_t	getNumPasses ()
	Get the number of passes.
bool	getOnlyInitial ()
	Get "only initial" flag.
const String &	getOutputName () const
	Get output local texture name.
CompositionTechnique *	getParent ()
	Get parent object.
CompositionPass *	getPass (size_t idx)
	Get a pass.
PassIterator	getPassIterator (void)
	Get an iterator over the Passes in this TargetPass.
bool	getShadowsEnabled (void) const
	Get whether shadows are enabled in this target pass.
uint32	getVisibilityMask ()
	Get the scene visibility mask used by this pass.
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
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
void	removeAllPasses ()
	Remove all passes.
void	removePass (size_t idx)
	Remove a pass.
void	setInputMode (InputMode mode)
	Set input mode of this TargetPass.
void	setLodBias (float bias)
	Set the scene LOD bias used by this pass.
void	setMaterialScheme (const String &schemeName)
	Set the material scheme used by this target pass.
void	setOnlyInitial (bool value)
	Set "only initial" flag.
void	setOutputName (const String &out)
	Set output local texture name.
void	setShadowsEnabled (bool enabled)
	Set whether shadows are enabled in this target pass.
void	setVisibilityMask (uint32 mask)
	Set the scene visibility mask used by this pass.
Private Attributes
InputMode	mInputMode
	Input mode.
float	mLodBias
	LOD bias of this render.
String	mMaterialScheme
	Material scheme name.
bool	mOnlyInitial
	This target pass is only executed initially after the effect has been enabled.
String	mOutputName
	(local) output texture
CompositionTechnique *	mParent
	Parent technique.
Passes	mPasses
	Passes.
bool	mShadowsEnabled
	Shadows option.
uint32	mVisibilityMask
	Visibility mask for this render.

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

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

Definition at line 58 of file OgreCompositionTargetPass.h.

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

Definition at line 59 of file OgreCompositionTargetPass.h.

Member Enumeration Documentation

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

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

Ogre::CompositionTargetPass::~CompositionTargetPass ( )

Member Function Documentation

bool Ogre::CompositionTargetPass::_isSupported ( void )

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

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.

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.

uint32 Ogre::CompositionTargetPass::getVisibilityMask ( )

Get the scene visibility mask used by this pass.

template<class Alloc >

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

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)		`[inherited]`

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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.

template<class Alloc >

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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.

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.

template<class Alloc >

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

Definition at line 73 of file OgreMemoryAllocatedObject.h.

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.

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.

template<class Alloc >

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

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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::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.

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

Set the scene visibility mask used by this pass.

Member Data Documentation

InputMode Ogre::CompositionTargetPass::mInputMode [private]

Input mode.

Definition at line 153 of file OgreCompositionTargetPass.h.

float Ogre::CompositionTargetPass::mLodBias [private]

LOD bias of this render.

Definition at line 164 of file OgreCompositionTargetPass.h.

String Ogre::CompositionTargetPass::mMaterialScheme [private]

Material scheme name.

Definition at line 166 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 160 of file OgreCompositionTargetPass.h.

String Ogre::CompositionTargetPass::mOutputName [private]

(local) output texture

Definition at line 155 of file OgreCompositionTargetPass.h.

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

Parent technique.

Definition at line 151 of file OgreCompositionTargetPass.h.

Passes Ogre::CompositionTargetPass::mPasses [private]

Passes.

Definition at line 157 of file OgreCompositionTargetPass.h.

bool Ogre::CompositionTargetPass::mShadowsEnabled [private]

Shadows option.

Definition at line 168 of file OgreCompositionTargetPass.h.

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

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation