Ogre::CompositorChain::RQListener Class Reference

Render queue listener used to set up rendering events. More...

`#include <OgreCompositorChain.h>`

Inheritance diagram for Ogre::CompositorChain::RQListener:
[legend]

## Public Member Functions

| RQListener ()
void | flushUpTo (uint8 id)
| Flush remaining render system operations. More...
void | notifyViewport (Viewport *vp)
| Notify current destination viewport. More...
virtual void | postRenderQueues ()
| Event raised after all render queues are processed. More...
virtual void | preRenderQueues ()
| Event raised before all render queues are processed. More...
virtual void | renderQueueEnded (uint8 queueGroupId, const String &invocation, bool &repeatThisInvocation)
| Event raised after a queue group is rendered. More...
virtual void | renderQueueStarted (uint8 queueGroupId, const String &invocation, bool &skipThisInvocation)
| Event raised before a queue group is rendered. More...
void | setOperation (CompositorInstance::TargetOperation *op, SceneManager *sm, RenderSystem *rs)
| Set current operation and target. More...

## Private Attributes

CompositorInstance::RenderSystemOpPairs::iterator | currentOp
CompositorInstance::RenderSystemOpPairs::iterator | lastOp
CompositorInstance::TargetOperation * | mOperation
RenderSystem * | mRenderSystem
SceneManager * | mSceneManager
Viewport * | mViewport

## Detailed Description

Render queue listener used to set up rendering events.

Definition at line 202 of file OgreCompositorChain.h.

## Constructor & Destructor Documentation

## RQListener()

Ogre::CompositorChain::RQListener::RQListener | ( |  | ) |

Definition at line 205 of file OgreCompositorChain.h.

## Member Function Documentation

## flushUpTo()

void Ogre::CompositorChain::RQListener::flushUpTo | ( | uint8 | id | ) |

Flush remaining render system operations.

## notifyViewport()

void Ogre::CompositorChain::RQListener::notifyViewport | ( | Viewport * | vp | ) |

Notify current destination viewport.

Definition at line 218 of file OgreCompositorChain.h.

## postRenderQueues()

virtual void Ogre::RenderQueueListener::postRenderQueues | ( |  | ) |

virtual inherited

Event raised after all render queues are processed.

Definition at line 66 of file OgreRenderQueueListener.h.

## preRenderQueues()

virtual void Ogre::RenderQueueListener::preRenderQueues | ( |  | ) |

virtual inherited

Event raised before all render queues are processed.

Definition at line 63 of file OgreRenderQueueListener.h.

## renderQueueEnded()

virtual void Ogre::CompositorChain::RQListener::renderQueueEnded | ( | uint8 | queueGroupId,
|  | const String & | invocation,
|  | bool & | repeatThisInvocation
| ) |  |

virtual

Event raised after a queue group is rendered.

Remarks
  This method is called by the SceneManager after each queue group is rendered.

Parameters

  queueGroupId | The id of the queue group which has just been rendered
  invocation | Name of the invocation which is causing this to be called (

See also
  RenderQueueInvocation)

Parameters

  repeatThisInvocation | A boolean passed by reference which is by default set to false. If the event sets this to true, the queue which has just been rendered will be repeated, and the renderQueueStarted and renderQueueEnded events will also be fired for it again.

Reimplemented from Ogre::RenderQueueListener.

## renderQueueStarted()

virtual void Ogre::CompositorChain::RQListener::renderQueueStarted | ( | uint8 | queueGroupId,
|  | const String & | invocation,
|  | bool & | skipThisInvocation
| ) |  |

virtual

Event raised before a queue group is rendered.

Remarks
  This method is called by the SceneManager before each queue group is rendered.

Parameters

  queueGroupId | The id of the queue group which is about to be rendered
  invocation | Name of the invocation which is causing this to be called (

See also
  RenderQueueInvocation)

Parameters

  skipThisInvocation | A boolean passed by reference which is by default set to false. If the event sets this to true, the queue will be skipped and not rendered. Note that in this case the renderQueueEnded event will not be raised for this queue group.

Reimplemented from Ogre::RenderQueueListener.

## setOperation()

void Ogre::CompositorChain::RQListener::setOperation | ( | CompositorInstance::TargetOperation * | op,
|  | SceneManager * | sm,
|  | RenderSystem * | rs
| ) |  |

Set current operation and target.

## Member Data Documentation

## currentOp

CompositorInstance::RenderSystemOpPairs::iterator Ogre::CompositorChain::RQListener::currentOp

private

Definition at line 227 of file OgreCompositorChain.h.

## lastOp

CompositorInstance::RenderSystemOpPairs::iterator Ogre::CompositorChain::RQListener::lastOp

private

Definition at line 227 of file OgreCompositorChain.h.

## mOperation

CompositorInstance::TargetOperation* Ogre::CompositorChain::RQListener::mOperation

private

Definition at line 223 of file OgreCompositorChain.h.

## mRenderSystem

RenderSystem* Ogre::CompositorChain::RQListener::mRenderSystem

private

Definition at line 225 of file OgreCompositorChain.h.

## mSceneManager

SceneManager* Ogre::CompositorChain::RQListener::mSceneManager

private

Definition at line 224 of file OgreCompositorChain.h.

## mViewport

Viewport* Ogre::CompositorChain::RQListener::mViewport

private

Definition at line 226 of file OgreCompositorChain.h.

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

- OgreCompositorChain.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.