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

Interface to abstract all types of pass definitions (. More...

#include <OgreCompositorPassDef.h>

+ Inheritance diagram for Ogre::CompositorPassDef:
+ Collaboration diagram for Ogre::CompositorPassDef:

Public Member Functions

 CompositorPassDef (CompositorPassType passType, uint32 rtIndex)
 
virtual ~CompositorPassDef ()
 
uint32 getRtIndex (void) const
 
CompositorPassType getType () const
 
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)
 

Public Attributes

bool mBeginRtUpdate
 True if a previous pass doesn't alter the contents of the same render target we do TODO: Fill this automatically. More...
 
bool mEndRtUpdate
 End if we're the last consecutive pass to alter the contents of the same render target. More...
 
uint32 mIdentifier
 Custom value in case there's a listener attached (to identify the pass) More...
 
bool mIncludeOverlays
 TODO: Refactor OgreOverlay to remove this design atrocity. More...
 
uint32 mNumInitialPasses
 Number of times to perform the pass before stopping. -1 to never stop. More...
 
uint32 mShadowMapIdx
 Shadow map index it belongs to (only filled in passes owned by Shadow Nodes) More...
 
float mVpHeight
 
float mVpLeft
 Viewport's region to draw. More...
 
float mVpTop
 
float mVpWidth
 

Private Attributes

CompositorPassType mPassType
 
uint32 mRtIndex
 Used for cubemaps and 3D textures. More...
 

Detailed Description

Interface to abstract all types of pass definitions (.

See also
CompositorPassType): PASS_SCENE ( CompositorPassSceneDef) PASS_QUAD ( CompositorPassQuadDef) PASS_CLEAR ( CompositorPassClearDef) PASS_STENCIL ( CompositorPassStencilDef) This class doesn't do much on its own. See the derived types for more information A definition is shared by all pass instantiations (i.e. Five CompositorPassScene can share the same CompositorPassSceneDef) and are asumed to remain const throughout their lifetime.
Modifying a definition while there are active instantiations is undefined. Some implementations may see the change (eg. changing CompositorPassSceneDef::mFirstRQ) immediately while not see others (eg. changing CompositorPassSceneDef::mCameraName) Also crashes could happen depending on the changes being made.

Definition at line 73 of file OgreCompositorPassDef.h.

Constructor & Destructor Documentation

Ogre::CompositorPassDef::CompositorPassDef ( CompositorPassType  passType,
uint32  rtIndex 
)
inline

Definition at line 108 of file OgreCompositorPassDef.h.

virtual Ogre::CompositorPassDef::~CompositorPassDef ( )
inlinevirtual

Definition at line 115 of file OgreCompositorPassDef.h.

Member Function Documentation

uint32 Ogre::CompositorPassDef::getRtIndex ( void  ) const
inline

Definition at line 118 of file OgreCompositorPassDef.h.

CompositorPassType Ogre::CompositorPassDef::getType ( void  ) const
inline

Definition at line 117 of file OgreCompositorPassDef.h.

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

Definition at line 96 of file OgreMemoryAllocatedObject.h.

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

Definition at line 102 of file OgreMemoryAllocatedObject.h.

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

Definition at line 108 of file OgreMemoryAllocatedObject.h.

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

Definition at line 113 of file OgreMemoryAllocatedObject.h.

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

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 
)
inlineinherited

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)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

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

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 
)
inlineinherited

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)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

Member Data Documentation

bool Ogre::CompositorPassDef::mBeginRtUpdate

True if a previous pass doesn't alter the contents of the same render target we do TODO: Fill this automatically.

Definition at line 98 of file OgreCompositorPassDef.h.

bool Ogre::CompositorPassDef::mEndRtUpdate

End if we're the last consecutive pass to alter the contents of the same render target.

Definition at line 100 of file OgreCompositorPassDef.h.

uint32 Ogre::CompositorPassDef::mIdentifier

Custom value in case there's a listener attached (to identify the pass)

Definition at line 94 of file OgreCompositorPassDef.h.

bool Ogre::CompositorPassDef::mIncludeOverlays

TODO: Refactor OgreOverlay to remove this design atrocity.

A custom overlay pass is a better alternative (or just use their own RQ)

Definition at line 105 of file OgreCompositorPassDef.h.

uint32 Ogre::CompositorPassDef::mNumInitialPasses

Number of times to perform the pass before stopping. -1 to never stop.

Definition at line 91 of file OgreCompositorPassDef.h.

CompositorPassType Ogre::CompositorPassDef::mPassType
private

Definition at line 75 of file OgreCompositorPassDef.h.

uint32 Ogre::CompositorPassDef::mRtIndex
private

Used for cubemaps and 3D textures.

Definition at line 78 of file OgreCompositorPassDef.h.

uint32 Ogre::CompositorPassDef::mShadowMapIdx

Shadow map index it belongs to (only filled in passes owned by Shadow Nodes)

Definition at line 88 of file OgreCompositorPassDef.h.

float Ogre::CompositorPassDef::mVpHeight

Definition at line 85 of file OgreCompositorPassDef.h.

float Ogre::CompositorPassDef::mVpLeft

Viewport's region to draw.

Definition at line 82 of file OgreCompositorPassDef.h.

float Ogre::CompositorPassDef::mVpTop

Definition at line 83 of file OgreCompositorPassDef.h.

float Ogre::CompositorPassDef::mVpWidth

Definition at line 84 of file OgreCompositorPassDef.h.


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