OGRE-Next: Ogre::v1::OverlaySystem Class Reference

| OGRE-Next 3.0.0 Object-Oriented Graphics Rendering Engine

Loading...
Searching...
No Matches
Ogre::v1::OverlaySystem Class Reference
Core » Overlays

This class simplify initialization / finalization of the overlay system. More...

`#include <OgreOverlaySystem.h>`

Inheritance diagram for Ogre::v1::OverlaySystem:
[legend]

## Public Member Functions
| OverlaySystem ()
| ~OverlaySystem () override
void | eventOccurred (const String &eventName, const NameValuePairList *parameters) override
void | renderQueueStarted (RenderQueue *rq, uint8 queueGroupId, const String &invocation, bool &skipThisInvocation) override
Public Member Functions inherited from Ogre::RenderQueueListener
virtual | ~RenderQueueListener ()
virtual void | renderQueueEnded (uint8 queueGroupId, const String &invocation, bool &repeatThisInvocation)
| Event raised after a queue group is rendered.
Public Member Functions inherited from Ogre::RenderSystem::Listener
| Listener ()
virtual | ~Listener ()

## Detailed Description

This class simplify initialization / finalization of the overlay system.

OGRE root did this steps before the overlay system transformed into a component.

Remarks
  Before you create a concrete instance of the OverlaySystem the OGRE::Root must be created but not initialized. In the ctor all relevant systems are created and registered. The dtor must be called before you delete OGRE::Root. To make the overlays visible (= render into your viewports) you have to register this instance as a RenderQueueListener in your scenemanager(s).

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

- OgreOverlaySystem.h