|  | OGRE 14.3
    Object-Oriented Graphics Rendering Engine | 
Object representing one pass or operation in a composition sequence. More...
#include <OgreCompositionPass.h>
 Inheritance diagram for Ogre::CompositionPass:
 Inheritance diagram for Ogre::CompositionPass:| 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 , PT_COMPUTE } | 
| 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. | |
| void | clearAllInputs () | 
| Clear all inputs. | |
| bool | getAlignCameraToFace () const | 
| bool | getAutomaticColour () const | 
| Retrieves if the clear colour is automatically set to the background colour of the original viewport. | |
| const String & | getCameraName () const | 
| uint32 | getClearBuffers () const | 
| Get the viewport clear buffers. | |
| const ColourValue & | getClearColour () const | 
| Get the viewport clear colour (defaults to 0,0,0,0) | |
| float | getClearDepth () const | 
| Get the viewport clear depth (defaults to 1.0) | |
| uint16 | getClearStencil () const | 
| Get the viewport clear stencil value (defaults to 0) | |
| const String & | getCustomType () const | 
| Get the type name of this custom composition pass. | |
| uint8 | getFirstRenderQueue () const | 
| Get the first render queue to be rendered in this pass (inclusive) | |
| uint32 | getIdentifier () const | 
| Get the identifier for this pass. | |
| const InputTex & | getInput (size_t id) const | 
| Get the value of an input. | |
| uint8 | getLastRenderQueue () const | 
| Get the last render queue to be rendered in this pass (inclusive) | |
| const MaterialPtr & | getMaterial () const | 
| Get the material used by this pass. | |
| const String & | getMaterialScheme (void) const | 
| Get the material scheme used by this pass. | |
| size_t | getNumInputs () const | 
| Get the number of inputs used. | |
| CompositionTargetPass * | getParent () | 
| Get parent object. | |
| bool | getQuadCorners (FloatRect &quad) const | 
| Get quad normalised positions [-1;1]x[-1;1]. | |
| bool | getQuadFarCorners () const | 
| Returns true if camera frustum far corners are provided in the quad. | |
| bool | getQuadFarCornersViewSpace () const | 
| Returns true if the far corners provided in the quad are in view space. | |
| bool | getStencilCheck () const | 
| Get stencil check enable. | |
| StencilOperation | getStencilDepthFailOp () const | 
| Get stencil depth fail operation. | |
| StencilOperation | getStencilFailOp () const | 
| Get stencil fail operation. | |
| CompareFunction | getStencilFunc () const | 
| Get stencil compare function. | |
| uint32 | getStencilMask () const | 
| Get stencil mask. | |
| StencilOperation | getStencilPassOp () const | 
| Get stencil pass operation. | |
| uint32 | getStencilRefValue () const | 
| Get stencil reference value. | |
| const StencilState & | getStencilState () const | 
| bool | getStencilTwoSidedOperation () const | 
| Get two sided stencil operation. | |
| const Vector3i & | getThreadGroups () const | 
| PassType | getType () const | 
| Get the type of composition pass. | |
| void | setAlignCameraToFace (bool val) | 
| void | setAutomaticColour (bool val) | 
| Set the clear colour to be the background colour of the original viewport. | |
| void | setCameraName (const String &name) | 
| void | setClearBuffers (uint32 val) | 
| Would be nice to have for RENDERSCENE: flags to: exclude transparents override material (at least – color) | |
| void | setClearColour (const ColourValue &val) | 
| Set the viewport clear colour (defaults to 0,0,0,0) | |
| void | setClearDepth (float depth) | 
| Set the viewport clear depth (defaults to 1.0) | |
| void | setClearStencil (uint16 value) | 
| Set the viewport clear stencil value (defaults to 0) | |
| void | setCustomType (const String &customType) | 
| Set the type name of this custom composition pass. | |
| void | setFirstRenderQueue (uint8 id) | 
| Set the first render queue to be rendered in this pass (inclusive) | |
| void | setIdentifier (uint32 id) | 
| Set an identifier for this pass. | |
| void | setInput (size_t id, const String &input=BLANKSTRING, size_t mrtIndex=0) | 
| Set an input local texture. | |
| void | setLastRenderQueue (uint8 id) | 
| Set the last render queue to be rendered in this pass (inclusive) | |
| void | setMaterial (const MaterialPtr &mat) | 
| Set the material used by this pass. | |
| void | setMaterialName (const String &name) | 
| Set the material used by this pass. | |
| void | setMaterialScheme (const String &schemeName) | 
| Set the material scheme used by this pass. | |
| void | setQuadCorners (const FloatRect &quad) | 
| Set quad normalised positions [-1;1]x[-1;1]. | |
| void | setQuadFarCorners (bool farCorners, bool farCornersViewSpace) | 
| Sets the use of camera frustum far corners provided in the quad's normals. | |
| void | setStencilCheck (bool value) | 
| Set stencil check on or off. | |
| void | setStencilDepthFailOp (StencilOperation value) | 
| Set stencil depth fail operation. | |
| void | setStencilFailOp (StencilOperation value) | 
| Set stencil fail operation. | |
| void | setStencilFunc (CompareFunction value) | 
| Set stencil compare function. | |
| void | setStencilMask (uint32 value) | 
| Set stencil mask. | |
| void | setStencilPassOp (StencilOperation value) | 
| Set stencil pass operation. | |
| void | setStencilRefValue (uint32 value) | 
| Set stencil reference value. | |
| void | setStencilTwoSidedOperation (bool value) | 
| Set two sided stencil operation. | |
| void | setThreadGroups (const Vector3i &g) | 
| void | setType (PassType type) | 
| Set the type of composition pass. | |
Object representing one pass or operation in a composition sequence.
This provides a method to conveniently interleave RenderSystem commands between Render Queues.
Enumeration that enumerates the various composition pass types.
| Ogre::CompositionPass::CompositionPass | ( | CompositionTargetPass * | parent | ) | 
| Ogre::CompositionPass::~CompositionPass | ( | ) | 
| void Ogre::CompositionPass::setType | ( | PassType | type | ) | 
Set the type of composition pass.
| PassType Ogre::CompositionPass::getType | ( | ) | const | 
Get the type of composition pass.
| 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.
| uint32 Ogre::CompositionPass::getIdentifier | ( | ) | const | 
Get the identifier for this pass.
| 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.
| const MaterialPtr & Ogre::CompositionPass::getMaterial | ( | ) | const | 
Get the material used by this pass.
| void Ogre::CompositionPass::setFirstRenderQueue | ( | uint8 | id | ) | 
Set the first render queue to be rendered in this pass (inclusive)
| uint8 Ogre::CompositionPass::getFirstRenderQueue | ( | ) | const | 
Get the first render queue to be rendered in this pass (inclusive)
| void Ogre::CompositionPass::setLastRenderQueue | ( | uint8 | id | ) | 
Set the last render queue to be rendered in this pass (inclusive)
| uint8 Ogre::CompositionPass::getLastRenderQueue | ( | ) | const | 
Get the last render queue to be rendered in this pass (inclusive)
| void Ogre::CompositionPass::setMaterialScheme | ( | const String & | schemeName | ) | 
Set the material scheme used by this pass.
Only applicable to passes that render the scene.
| const String & Ogre::CompositionPass::getMaterialScheme | ( | void | ) | const | 
Get the material scheme used by this pass.
Only applicable to passes that render the scene.
| 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. | 
| uint32 Ogre::CompositionPass::getClearBuffers | ( | ) | const | 
Get the viewport clear buffers.
| void Ogre::CompositionPass::setClearColour | ( | const ColourValue & | val | ) | 
Set the viewport clear colour (defaults to 0,0,0,0)
| const ColourValue & Ogre::CompositionPass::getClearColour | ( | ) | const | 
Get the viewport clear colour (defaults to 0,0,0,0)
| void Ogre::CompositionPass::setAutomaticColour | ( | bool | val | ) | 
Set the clear colour to be the background colour of the original viewport.
| bool Ogre::CompositionPass::getAutomaticColour | ( | ) | const | 
Retrieves if the clear colour is automatically set to the background colour of the original viewport.
| void Ogre::CompositionPass::setClearDepth | ( | float | depth | ) | 
Set the viewport clear depth (defaults to 1.0)
| float Ogre::CompositionPass::getClearDepth | ( | ) | const | 
Get the viewport clear depth (defaults to 1.0)
| void Ogre::CompositionPass::setClearStencil | ( | uint16 | value | ) | 
Set the viewport clear stencil value (defaults to 0)
| uint16 Ogre::CompositionPass::getClearStencil | ( | ) | const | 
Get the viewport clear stencil value (defaults to 0)
| void Ogre::CompositionPass::setStencilCheck | ( | bool | value | ) | 
Set stencil check on or off.
| bool Ogre::CompositionPass::getStencilCheck | ( | ) | const | 
Get stencil check enable.
| void Ogre::CompositionPass::setStencilFunc | ( | CompareFunction | value | ) | 
Set stencil compare function.
| CompareFunction Ogre::CompositionPass::getStencilFunc | ( | ) | const | 
Get stencil compare function.
| void Ogre::CompositionPass::setStencilRefValue | ( | uint32 | value | ) | 
Set stencil reference value.
| uint32 Ogre::CompositionPass::getStencilRefValue | ( | ) | const | 
Get stencil reference value.
| void Ogre::CompositionPass::setStencilMask | ( | uint32 | value | ) | 
Set stencil mask.
| uint32 Ogre::CompositionPass::getStencilMask | ( | ) | const | 
Get stencil mask.
| void Ogre::CompositionPass::setStencilFailOp | ( | StencilOperation | value | ) | 
Set stencil fail operation.
| StencilOperation Ogre::CompositionPass::getStencilFailOp | ( | ) | const | 
Get stencil fail operation.
| void Ogre::CompositionPass::setStencilDepthFailOp | ( | StencilOperation | value | ) | 
Set stencil depth fail operation.
| StencilOperation Ogre::CompositionPass::getStencilDepthFailOp | ( | ) | const | 
Get stencil depth fail operation.
| void Ogre::CompositionPass::setStencilPassOp | ( | StencilOperation | value | ) | 
Set stencil pass operation.
| StencilOperation Ogre::CompositionPass::getStencilPassOp | ( | ) | const | 
Get stencil pass operation.
| void Ogre::CompositionPass::setStencilTwoSidedOperation | ( | bool | value | ) | 
Set two sided stencil operation.
| bool Ogre::CompositionPass::getStencilTwoSidedOperation | ( | ) | const | 
Get two sided stencil operation.
| 
 | inline | 
| void Ogre::CompositionPass::setInput | ( | size_t | id, | 
| const String & | input = BLANKSTRING, | ||
| 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 | 
References Ogre::BLANKSTRING.
| 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. | 
| size_t Ogre::CompositionPass::getNumInputs | ( | ) | const | 
Get the number of inputs used.
| void Ogre::CompositionPass::clearAllInputs | ( | ) | 
Clear all inputs.
| CompositionTargetPass * Ogre::CompositionPass::getParent | ( | ) | 
Get parent object.
| bool Ogre::CompositionPass::_isSupported | ( | void | ) | 
Determine if this target pass is supported on the current rendering device.
| 
 | inline | 
Set quad normalised positions [-1;1]x[-1;1].
| 
 | inline | 
Get 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.
| 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.
| void Ogre::CompositionPass::setCustomType | ( | const String & | customType | ) | 
Set the type name of this custom composition pass.
| const String & Ogre::CompositionPass::getCustomType | ( | ) | const | 
Get the type name of this custom composition pass.
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline | 
| 
 | inline |