Object representing one pass or operation in a composition sequence. More...
#include <OgreCompositionPass.h>
Classes | |
struct | InputTex |
Inputs (for material used for rendering the quad) More... | |
Public Types | |
enum | PassType { PT_CLEAR, PT_STENCIL, PT_RENDERSCENE, PT_RENDERQUAD, PT_RENDERCUSTOM } |
Enumeration that enumerates the various composition pass types. More... | |
Public Member Functions | |
CompositionPass (CompositionTargetPass *parent) | |
~CompositionPass () | |
bool | _isSupported (void) |
Determine if this target pass is supported on the current rendering device. More... | |
void | clearAllInputs () |
Clear all inputs. More... | |
uint32 | getClearBuffers () const |
Get the viewport clear buffers. More... | |
const ColourValue & | getClearColour () const |
Get the viewport clear colour (defaults to 0,0,0,0) More... | |
Real | getClearDepth () const |
Get the viewport clear depth (defaults to 1.0) More... | |
uint32 | getClearStencil () const |
Get the viewport clear stencil value (defaults to 0) More... | |
const String & | getCustomType () const |
Get the type name of this custom composition pass. More... | |
uint8 | getFirstRenderQueue () const |
Get the first render queue to be rendered in this pass (inclusive) More... | |
uint32 | getIdentifier () const |
Get the identifier for this pass. More... | |
const InputTex & | getInput (size_t id) const |
Get the value of an input. More... | |
uint8 | getLastRenderQueue () const |
Get the last render queue to be rendered in this pass (inclusive) More... | |
const MaterialPtr & | getMaterial () const |
Get the material used by this pass. More... | |
const String & | getMaterialScheme (void) const |
Get the material scheme used by this pass. More... | |
size_t | getNumInputs () const |
Get the number of inputs used. More... | |
CompositionTargetPass * | getParent () |
Get parent object. More... | |
bool | getQuadCorners (Real &left, Real &top, Real &right, Real &bottom) const |
Get quad normalised positions [-1;1]x[-1;1]. More... | |
bool | getQuadFarCorners () const |
Returns true if camera frustum far corners are provided in the quad. More... | |
bool | getQuadFarCornersViewSpace () const |
Returns true if the far corners provided in the quad are in view space. More... | |
bool | getStencilCheck () const |
Get stencil check enable. More... | |
StencilOperation | getStencilDepthFailOp () const |
Get stencil depth fail operation. More... | |
StencilOperation | getStencilFailOp () const |
Get stencil fail operation. More... | |
CompareFunction | getStencilFunc () const |
Get stencil compare function. More... | |
uint32 | getStencilMask () const |
Get stencil mask. More... | |
StencilOperation | getStencilPassOp () const |
Get stencil pass operation. More... | |
uint32 | getStencilRefValue () const |
Get stencil reference value. More... | |
bool | getStencilTwoSidedOperation () const |
Get two sided stencil operation. More... | |
PassType | getType () const |
Get the type of composition pass. More... | |
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 | setClearBuffers (uint32 val) |
Would be nice to have for RENDERSCENE: flags to: exclude transparents override material (at least – color) More... | |
void | setClearColour (ColourValue val) |
Set the viewport clear colour (defaults to 0,0,0,0) More... | |
void | setClearDepth (Real depth) |
Set the viewport clear depth (defaults to 1.0) More... | |
void | setClearStencil (uint32 value) |
Set the viewport clear stencil value (defaults to 0) More... | |
void | setCustomType (const String &customType) |
Set the type name of this custom composition pass. More... | |
void | setFirstRenderQueue (uint8 id) |
Set the first render queue to be rendered in this pass (inclusive) More... | |
void | setIdentifier (uint32 id) |
Set an identifier for this pass. More... | |
void | setInput (size_t id, const String &input=StringUtil::BLANK, size_t mrtIndex=0) |
Set an input local texture. More... | |
void | setLastRenderQueue (uint8 id) |
Set the last render queue to be rendered in this pass (inclusive) More... | |
void | setMaterial (const MaterialPtr &mat) |
Set the material used by this pass. More... | |
void | setMaterialName (const String &name) |
Set the material used by this pass. More... | |
void | setMaterialScheme (const String &schemeName) |
Set the material scheme used by this pass. More... | |
void | setQuadCorners (Real left, Real top, Real right, Real bottom) |
Set quad normalised positions [-1;1]x[-1;1]. More... | |
void | setQuadFarCorners (bool farCorners, bool farCornersViewSpace) |
Sets the use of camera frustum far corners provided in the quad's normals. More... | |
void | setStencilCheck (bool value) |
Set stencil check on or off. More... | |
void | setStencilDepthFailOp (StencilOperation value) |
Set stencil depth fail operation. More... | |
void | setStencilFailOp (StencilOperation value) |
Set stencil fail operation. More... | |
void | setStencilFunc (CompareFunction value) |
Set stencil compare function. More... | |
void | setStencilMask (uint32 value) |
Set stencil mask. More... | |
void | setStencilPassOp (StencilOperation value) |
Set stencil pass operation. More... | |
void | setStencilRefValue (uint32 value) |
Set stencil reference value. More... | |
void | setStencilTwoSidedOperation (bool value) |
Set two sided stencil operation. More... | |
void | setType (PassType type) |
Set the type of composition pass. More... | |
Object representing one pass or operation in a composition sequence.
This provides a method to conveniently interleave RenderSystem commands between Render Queues.
Definition at line 46 of file OgreCompositionPass.h.
Enumeration that enumerates the various composition pass types.
Enumerator | |
---|---|
PT_CLEAR | |
PT_STENCIL | |
PT_RENDERSCENE | |
PT_RENDERQUAD | |
PT_RENDERCUSTOM |
Definition at line 54 of file OgreCompositionPass.h.
Ogre::CompositionPass::CompositionPass | ( | CompositionTargetPass * | parent | ) |
Ogre::CompositionPass::~CompositionPass | ( | ) |
bool Ogre::CompositionPass::_isSupported | ( | void | ) |
Determine if this target pass is supported on the current rendering device.
void Ogre::CompositionPass::clearAllInputs | ( | ) |
Clear all inputs.
uint32 Ogre::CompositionPass::getClearBuffers | ( | ) | const |
Get the viewport clear buffers.
const ColourValue& Ogre::CompositionPass::getClearColour | ( | ) | const |
Get the viewport clear colour (defaults to 0,0,0,0)
Real Ogre::CompositionPass::getClearDepth | ( | ) | const |
Get the viewport clear depth (defaults to 1.0)
uint32 Ogre::CompositionPass::getClearStencil | ( | ) | const |
Get the viewport clear stencil value (defaults to 0)
const String& Ogre::CompositionPass::getCustomType | ( | ) | const |
Get the type name of this custom composition pass.
uint8 Ogre::CompositionPass::getFirstRenderQueue | ( | ) | const |
Get the first render queue to be rendered in this pass (inclusive)
uint32 Ogre::CompositionPass::getIdentifier | ( | ) | const |
Get the identifier for this pass.
const InputTex& Ogre::CompositionPass::getInput | ( | size_t | id | ) | const |
Get the value of an input.
id | Input to get. Must be in 0..OGRE_MAX_TEXTURE_LAYERS-1. |
uint8 Ogre::CompositionPass::getLastRenderQueue | ( | ) | const |
Get the last render queue to be rendered in this pass (inclusive)
const MaterialPtr& Ogre::CompositionPass::getMaterial | ( | ) | const |
Get the material used by this pass.
const String& Ogre::CompositionPass::getMaterialScheme | ( | void | ) | const |
Get the material scheme used by this pass.
size_t Ogre::CompositionPass::getNumInputs | ( | ) | const |
Get the number of inputs used.
CompositionTargetPass* Ogre::CompositionPass::getParent | ( | ) |
Get parent object.
bool Ogre::CompositionPass::getQuadCorners | ( | Real & | left, |
Real & | top, | ||
Real & | right, | ||
Real & | bottom | ||
) | const |
Get quad normalised positions [-1;1]x[-1;1].
bool Ogre::CompositionPass::getQuadFarCorners | ( | ) | const |
Returns true if camera frustum far corners are provided in the quad.
bool Ogre::CompositionPass::getQuadFarCornersViewSpace | ( | ) | const |
Returns true if the far corners provided in the quad are in view space.
bool Ogre::CompositionPass::getStencilCheck | ( | ) | const |
Get stencil check enable.
StencilOperation Ogre::CompositionPass::getStencilDepthFailOp | ( | ) | const |
Get stencil depth fail operation.
StencilOperation Ogre::CompositionPass::getStencilFailOp | ( | ) | const |
Get stencil fail operation.
CompareFunction Ogre::CompositionPass::getStencilFunc | ( | ) | const |
Get stencil compare function.
uint32 Ogre::CompositionPass::getStencilMask | ( | ) | const |
Get stencil mask.
StencilOperation Ogre::CompositionPass::getStencilPassOp | ( | ) | const |
Get stencil pass operation.
uint32 Ogre::CompositionPass::getStencilRefValue | ( | ) | const |
Get stencil reference value.
bool Ogre::CompositionPass::getStencilTwoSidedOperation | ( | ) | const |
Get two sided stencil operation.
PassType Ogre::CompositionPass::getType | ( | ) | const |
Get the type of composition pass.
|
inlineinherited |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 67 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 85 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
void Ogre::CompositionPass::setClearBuffers | ( | uint32 | val | ) |
Would be nice to have for RENDERSCENE: flags to: exclude transparents override material (at least – color)
Set the viewport clear buffers (defaults to FBT_COLOUR|FBT_DEPTH)
val | is a combination of FBT_COLOUR, FBT_DEPTH, FBT_STENCIL. |
void Ogre::CompositionPass::setClearColour | ( | ColourValue | val | ) |
Set the viewport clear colour (defaults to 0,0,0,0)
void Ogre::CompositionPass::setClearDepth | ( | Real | depth | ) |
Set the viewport clear depth (defaults to 1.0)
void Ogre::CompositionPass::setClearStencil | ( | uint32 | value | ) |
Set the viewport clear stencil value (defaults to 0)
void Ogre::CompositionPass::setCustomType | ( | const String & | customType | ) |
Set the type name of this custom composition pass.
void Ogre::CompositionPass::setFirstRenderQueue | ( | uint8 | id | ) |
Set the first render queue to be rendered in this pass (inclusive)
void Ogre::CompositionPass::setIdentifier | ( | uint32 | id | ) |
Set an identifier for this pass.
This identifier can be used to "listen in" on this pass with an CompositorInstance::Listener.
void Ogre::CompositionPass::setInput | ( | size_t | id, |
const String & | input = StringUtil::BLANK , |
||
size_t | mrtIndex = 0 |
||
) |
Set an input local texture.
An empty string clears the input.
id | Input to set. Must be in 0..OGRE_MAX_TEXTURE_LAYERS-1 |
input | Which texture to bind to this input. An empty string clears the input. |
mrtIndex | Which surface of an MRT to retrieve |
void Ogre::CompositionPass::setLastRenderQueue | ( | uint8 | id | ) |
Set the last render queue to be rendered in this pass (inclusive)
void Ogre::CompositionPass::setMaterial | ( | const MaterialPtr & | mat | ) |
Set the material used by this pass.
void Ogre::CompositionPass::setMaterialName | ( | const String & | name | ) |
Set the material used by this pass.
void Ogre::CompositionPass::setMaterialScheme | ( | const String & | schemeName | ) |
Set the material scheme used by this pass.
Set quad normalised positions [-1;1]x[-1;1].
void Ogre::CompositionPass::setQuadFarCorners | ( | bool | farCorners, |
bool | farCornersViewSpace | ||
) |
Sets the use of camera frustum far corners provided in the quad's normals.
void Ogre::CompositionPass::setStencilCheck | ( | bool | value | ) |
Set stencil check on or off.
void Ogre::CompositionPass::setStencilDepthFailOp | ( | StencilOperation | value | ) |
Set stencil depth fail operation.
void Ogre::CompositionPass::setStencilFailOp | ( | StencilOperation | value | ) |
Set stencil fail operation.
void Ogre::CompositionPass::setStencilFunc | ( | CompareFunction | value | ) |
Set stencil compare function.
void Ogre::CompositionPass::setStencilMask | ( | uint32 | value | ) |
Set stencil mask.
void Ogre::CompositionPass::setStencilPassOp | ( | StencilOperation | value | ) |
Set stencil pass operation.
void Ogre::CompositionPass::setStencilRefValue | ( | uint32 | value | ) |
Set stencil reference value.
void Ogre::CompositionPass::setStencilTwoSidedOperation | ( | bool | value | ) |
Set two sided stencil operation.
void Ogre::CompositionPass::setType | ( | PassType | type | ) |
Set the type of composition pass.
|
private |
Clear buffers (in case of PT_CLEAR)
Definition at line 319 of file OgreCompositionPass.h.
|
private |
Clear colour (in case of PT_CLEAR)
Definition at line 321 of file OgreCompositionPass.h.
|
private |
Clear depth (in case of PT_CLEAR)
Definition at line 323 of file OgreCompositionPass.h.
|
private |
Clear stencil value (in case of PT_CLEAR)
Definition at line 325 of file OgreCompositionPass.h.
|
private |
Definition at line 349 of file OgreCompositionPass.h.
|
private |
[first,last] render queue to render this pass (in case of PT_RENDERSCENE)
Definition at line 314 of file OgreCompositionPass.h.
|
private |
Identifier for this pass.
Definition at line 310 of file OgreCompositionPass.h.
|
private |
Inputs (for material used for rendering the quad) An empty string signifies that no input is used.
Definition at line 328 of file OgreCompositionPass.h.
|
private |
Definition at line 315 of file OgreCompositionPass.h.
|
private |
Material used for rendering.
Definition at line 312 of file OgreCompositionPass.h.
|
private |
Material scheme name.
Definition at line 317 of file OgreCompositionPass.h.
|
private |
Parent technique.
Definition at line 306 of file OgreCompositionPass.h.
|
private |
Definition at line 345 of file OgreCompositionPass.h.
|
private |
true if quad should not cover whole screen
Definition at line 340 of file OgreCompositionPass.h.
|
private |
Definition at line 347 of file OgreCompositionPass.h.
|
private |
Definition at line 347 of file OgreCompositionPass.h.
|
private |
quad positions in normalised coordinates [-1;1]x[-1;1] (in case of PT_RENDERQUAD)
Definition at line 342 of file OgreCompositionPass.h.
|
private |
Definition at line 344 of file OgreCompositionPass.h.
|
private |
Definition at line 343 of file OgreCompositionPass.h.
|
private |
Stencil operation parameters.
Definition at line 330 of file OgreCompositionPass.h.
|
private |
Definition at line 335 of file OgreCompositionPass.h.
|
private |
Definition at line 334 of file OgreCompositionPass.h.
|
private |
Definition at line 331 of file OgreCompositionPass.h.
|
private |
Definition at line 333 of file OgreCompositionPass.h.
|
private |
Definition at line 336 of file OgreCompositionPass.h.
|
private |
Definition at line 332 of file OgreCompositionPass.h.
|
private |
Definition at line 337 of file OgreCompositionPass.h.
|
private |
Type of composition pass.
Definition at line 308 of file OgreCompositionPass.h.