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

#include <OgreCompositorPassQuadDef.h>

+ Inheritance diagram for Ogre::CompositorPassQuadDef:
+ Collaboration diagram for Ogre::CompositorPassQuadDef:

Classes

struct  QuadTextureSource
 

Public Types

enum  FrustumCorners { NO_CORNERS, VIEW_SPACE_CORNERS, WORLD_SPACE_CORNERS }
 
typedef vector
< QuadTextureSource >::type 
TextureSources
 

Public Member Functions

 CompositorPassQuadDef (CompositorNodeDef *parentNodeDef, uint32 rtIndex)
 
void addQuadTextureSource (size_t texUnitIdx, const String &textureName, size_t mrtIndex)
 Indicates the pass to change the texture units to use the specified texture sources. More...
 
uint32 getRtIndex (void) const
 
const TextureSourcesgetTextureSources (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...
 
IdString mCameraName
 
bool mEndRtUpdate
 End if we're the last consecutive pass to alter the contents of the same render target. More...
 
FrustumCorners mFrustumCorners
 Type of frustum corners to pass in the quad normals. 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...
 
bool mIsResolve
 When true, the user is telling Ogre this pass just performs a custom FSAA resolve filter. More...
 
String mMaterialName
 
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...
 
bool mUseQuad
 Whether to use a full screen quad or triangle. More...
 
float mVpHeight
 
float mVpLeft
 Viewport's region to draw. More...
 
float mVpTop
 
float mVpWidth
 

Protected Attributes

CompositorNodeDefmParentNodeDef
 
TextureSources mTextureSources
 

Detailed Description

Definition at line 48 of file OgreCompositorPassQuadDef.h.

Member Typedef Documentation

Member Enumeration Documentation

Enumerator
NO_CORNERS 
VIEW_SPACE_CORNERS 
WORLD_SPACE_CORNERS 

Definition at line 70 of file OgreCompositorPassQuadDef.h.

Constructor & Destructor Documentation

Ogre::CompositorPassQuadDef::CompositorPassQuadDef ( CompositorNodeDef parentNodeDef,
uint32  rtIndex 
)
inline

Definition at line 98 of file OgreCompositorPassQuadDef.h.

Member Function Documentation

void Ogre::CompositorPassQuadDef::addQuadTextureSource ( size_t  texUnitIdx,
const String textureName,
size_t  mrtIndex 
)

Indicates the pass to change the texture units to use the specified texture sources.

QuadTextureSource for params

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

Definition at line 118 of file OgreCompositorPassDef.h.

const TextureSources& Ogre::CompositorPassQuadDef::getTextureSources ( void  ) const
inline

Definition at line 112 of file OgreCompositorPassQuadDef.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.

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.

IdString Ogre::CompositorPassQuadDef::mCameraName

Definition at line 96 of file OgreCompositorPassQuadDef.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.

FrustumCorners Ogre::CompositorPassQuadDef::mFrustumCorners

Type of frustum corners to pass in the quad normals.

mCameraName contains which camera's frustum to pass

Definition at line 95 of file OgreCompositorPassQuadDef.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.

bool Ogre::CompositorPassQuadDef::mIsResolve

When true, the user is telling Ogre this pass just performs a custom FSAA resolve filter.

Hence we should skip this pass for those APIs that don't support explicit resolving TODO: Not really implemented yet!!!

Remarks
TextureDefinitionBase::TextureDefinition::fsaaExplicitResolve

Definition at line 88 of file OgreCompositorPassQuadDef.h.

String Ogre::CompositorPassQuadDef::mMaterialName

Definition at line 90 of file OgreCompositorPassQuadDef.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.

CompositorNodeDef* Ogre::CompositorPassQuadDef::mParentNodeDef
protected

Definition at line 67 of file OgreCompositorPassQuadDef.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.

TextureSources Ogre::CompositorPassQuadDef::mTextureSources
protected

Definition at line 66 of file OgreCompositorPassQuadDef.h.

bool Ogre::CompositorPassQuadDef::mUseQuad

Whether to use a full screen quad or triangle.

(default: false). Note that you may not always get the triangle (for example, if you ask for WORLD_SPACE_CORNERS)

Definition at line 80 of file OgreCompositorPassQuadDef.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: