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

#include <OgreCompositorPassSceneDef.h>

+ Inheritance diagram for Ogre::CompositorPassSceneDef:
+ Collaboration diagram for Ogre::CompositorPassSceneDef:

Public Member Functions

 CompositorPassSceneDef (uint32 rtIndex)
 
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)
 
void setVisibilityMask (uint32 visibilityMask)
 

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 mCameraCubemapReorient
 When true, the camera will be rotated 90°, -90° or 180° depending on the value of mRtIndex and then restored to its original rotation after we're done. More...
 
IdString mCameraName
 When empty, uses the default camera. More...
 
bool mEndRtUpdate
 End if we're the last consecutive pass to alter the contents of the same render target. More...
 
uint8 mFirstRQ
 First Render Queue ID to render. Inclusive. 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...
 
uint8 mLastRQ
 Last Render Queue ID to render. Not inclusive. More...
 
Real mLodBias
 Multiplier to the Lod value. More...
 
IdString mLodCameraName
 When empty, it implies mCameraName == mLodCameraName; except for shadow nodes. More...
 
String mMaterialScheme
 The material scheme used for this pass. 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...
 
IdString mShadowNode
 
ShadowNodeRecalculation mShadowNodeRecalculation
 
bool mUpdateLodLists
 When true, which Lod index is current will be updated. More...
 
uint32 mVisibilityMask
 Viewport's visibility mask while rendering our pass. More...
 
float mVpHeight
 
float mVpLeft
 Viewport's region to draw. More...
 
float mVpTop
 
float mVpWidth
 

Detailed Description

Definition at line 56 of file OgreCompositorPassSceneDef.h.

Constructor & Destructor Documentation

Ogre::CompositorPassSceneDef::CompositorPassSceneDef ( uint32  rtIndex)
inline

Definition at line 101 of file OgreCompositorPassSceneDef.h.

Member Function Documentation

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

Definition at line 118 of file OgreCompositorPassDef.h.

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

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.

void Ogre::CompositorPassSceneDef::setVisibilityMask ( uint32  visibilityMask)
inline

Member Data Documentation

bool Ogre::CompositorPassDef::mBeginRtUpdate
inherited

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::CompositorPassSceneDef::mCameraCubemapReorient

When true, the camera will be rotated 90°, -90° or 180° depending on the value of mRtIndex and then restored to its original rotation after we're done.

Definition at line 78 of file OgreCompositorPassSceneDef.h.

IdString Ogre::CompositorPassSceneDef::mCameraName

When empty, uses the default camera.

Definition at line 64 of file OgreCompositorPassSceneDef.h.

bool Ogre::CompositorPassDef::mEndRtUpdate
inherited

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.

uint8 Ogre::CompositorPassSceneDef::mFirstRQ

First Render Queue ID to render. Inclusive.

Definition at line 71 of file OgreCompositorPassSceneDef.h.

uint32 Ogre::CompositorPassDef::mIdentifier
inherited

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
inherited

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.

uint8 Ogre::CompositorPassSceneDef::mLastRQ

Last Render Queue ID to render. Not inclusive.

Definition at line 73 of file OgreCompositorPassSceneDef.h.

Real Ogre::CompositorPassSceneDef::mLodBias

Multiplier to the Lod value.

What it means depends on the technique. You'll probably want to avoid setting it directly and rather use ::transformBias

Definition at line 94 of file OgreCompositorPassSceneDef.h.

IdString Ogre::CompositorPassSceneDef::mLodCameraName

When empty, it implies mCameraName == mLodCameraName; except for shadow nodes.

For shadow nodes, when empty, it will use the receiver's lod camera.

Definition at line 68 of file OgreCompositorPassSceneDef.h.

String Ogre::CompositorPassSceneDef::mMaterialScheme

The material scheme used for this pass.

If no material scheme is set then it will use the default scheme

Definition at line 99 of file OgreCompositorPassSceneDef.h.

uint32 Ogre::CompositorPassDef::mNumInitialPasses
inherited

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

Definition at line 91 of file OgreCompositorPassDef.h.

uint32 Ogre::CompositorPassDef::mShadowMapIdx
inherited

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

Definition at line 88 of file OgreCompositorPassDef.h.

IdString Ogre::CompositorPassSceneDef::mShadowNode

Definition at line 61 of file OgreCompositorPassSceneDef.h.

ShadowNodeRecalculation Ogre::CompositorPassSceneDef::mShadowNodeRecalculation

Definition at line 62 of file OgreCompositorPassSceneDef.h.

bool Ogre::CompositorPassSceneDef::mUpdateLodLists

When true, which Lod index is current will be updated.

Reasons to set this to false:

  1. You don't use LOD (i.e. you're GPU bottleneck). Setting to false helps CPU.
  2. LODs have been calculated in a previous pass. This happens if previous pass(es) all used the same lod camera and all RenderQueue IDs this pass will use have been rendered already and updated their lod lists.
    Remarks
    Automatically set to false for shadow nodes that leave mLodCameraName empty

Definition at line 88 of file OgreCompositorPassSceneDef.h.

uint32 Ogre::CompositorPassSceneDef::mVisibilityMask

Viewport's visibility mask while rendering our pass.

Definition at line 60 of file OgreCompositorPassSceneDef.h.

float Ogre::CompositorPassDef::mVpHeight
inherited

Definition at line 85 of file OgreCompositorPassDef.h.

float Ogre::CompositorPassDef::mVpLeft
inherited

Viewport's region to draw.

Definition at line 82 of file OgreCompositorPassDef.h.

float Ogre::CompositorPassDef::mVpTop
inherited

Definition at line 83 of file OgreCompositorPassDef.h.

float Ogre::CompositorPassDef::mVpWidth
inherited

Definition at line 84 of file OgreCompositorPassDef.h.


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