RAMSES Documentation  27.0.130
Information for RAMSES users and developers
Public Member Functions | List of all members
RendererEventHandler Class Reference
Inheritance diagram for RendererEventHandler:
[legend]
Collaboration diagram for RendererEventHandler:
[legend]

Public Member Functions

void windowClosed (ramses::displayId_t) override
 This method will be called when a display's window has been closed. More...
 
bool isWindowClosed () const
 
void windowClosed (ramses::displayId_t) override
 This method will be called when a display's window has been closed. More...
 
bool isWindowClosed () const
 
void windowClosed (ramses::displayId_t) override
 This method will be called when a display's window has been closed. More...
 
bool isWindowClosed () const
 
void windowClosed (ramses::displayId_t) override
 This method will be called when a display's window has been closed. More...
 
bool isWindowClosed () const
 
void windowClosed (ramses::displayId_t) override
 This method will be called when a display's window has been closed. More...
 
bool isWindowClosed () const
 
void windowClosed (ramses::displayId_t) override
 This method will be called when a display's window has been closed. More...
 
bool isWindowClosed () const
 
- Public Member Functions inherited from ramses::RendererEventHandlerEmpty
virtual void offscreenBufferCreated (displayId_t displayId, displayBufferId_t offscreenBufferId, ERendererEventResult result) override
 This method will be called after an offscreen buffer is created (or failed to be created) as a result of RamsesRenderer API createOffscreenBuffer call. More...
 
virtual void offscreenBufferDestroyed (displayId_t displayId, displayBufferId_t offscreenBufferId, ERendererEventResult result) override
 This method will be called after an offscreen buffer is destroyed (or failed to be destroyed) as a result of RamsesRenderer API destroyOffscreenBuffer call. More...
 
virtual void framebufferPixelsRead (const uint8_t *pixelData, const uint32_t pixelDataSize, displayId_t displayId, displayBufferId_t displayBuffer, ERendererEventResult result) override
 This method will be called when a read back of pixels from display buffer was finished. This is the result of RamsesRenderer::readPixels call which triggers an asynchronous read back from the internal device. More...
 
virtual void warpingMeshDataUpdated (displayId_t displayId, ERendererEventResult result) override
 This method will be called when update of warping mesh data was finished. This is the result of RamsesRenderer::updateWarpingMeshData call which triggers an asynchronous update of warping data used by internal display. More...
 
virtual void displayCreated (displayId_t displayId, ERendererEventResult result) override
 This method will be called after a display was created (or failed to create) as a result of RamsesRenderer API createDisplay call. More...
 
virtual void displayDestroyed (displayId_t displayId, ERendererEventResult result) override
 This method will be called after a display was destroyed (or failed to destroy) as a result of RamsesRenderer API destroyDisplay call. More...
 
virtual void keyEvent (displayId_t displayId, EKeyEvent eventType, uint32_t keyModifiers, EKeyCode keyCode) override
 This method will be called when a key has been pressed while a display's window was focused. More...
 
virtual void mouseEvent (displayId_t displayId, EMouseEvent eventType, int32_t mousePosX, int32_t mousePosY) override
 This method will be called when a mouse event action has occured while a display's window was focused. More...
 
virtual void windowResized (displayId_t displayId, uint32_t width, uint32_t height) override
 This method will be called when a display's window has been resized. More...
 
virtual void windowMoved (displayId_t displayId, int32_t windowPosX, int32_t windowPosY) override
 This method will be called when a display's window has been moved, if the renderer uses WGL/Windows or X11/Linux as a window system. More...
 
virtual void renderThreadLoopTimings (std::chrono::microseconds maximumLoopTime, std::chrono::microseconds averageLooptime) override
 This method will be called in period given to renderer config (ramses::RendererConfig::setRenderThreadLoopTimingReportingPeriod) and provides rough performance indicators - maximum and average loop (frame) time within that measure period. It only reports timings for first display. More...
 
- Public Member Functions inherited from ramses::IRendererEventHandler
virtual ~IRendererEventHandler ()=default
 Empty destructor. More...
 

Detailed Description

Examples
ramses-example-local-client/src/main.cpp, ramses-example-local-datalink/src/main.cpp, ramses-example-local-displays/src/main.cpp, ramses-example-local-geometry-shaders/src/main.cpp, ramses-example-local-scene-referencing/src/main.cpp, and ramses-example-local-viewport-link/src/main.cpp.

Member Function Documentation

◆ isWindowClosed() [1/6]

bool RendererEventHandler::isWindowClosed ( ) const
inline

◆ isWindowClosed() [2/6]

bool RendererEventHandler::isWindowClosed ( ) const
inline

◆ isWindowClosed() [3/6]

bool RendererEventHandler::isWindowClosed ( ) const
inline

◆ isWindowClosed() [4/6]

bool RendererEventHandler::isWindowClosed ( ) const
inline

◆ isWindowClosed() [5/6]

bool RendererEventHandler::isWindowClosed ( ) const
inline

◆ isWindowClosed() [6/6]

bool RendererEventHandler::isWindowClosed ( ) const
inline

◆ windowClosed() [1/6]

void RendererEventHandler::windowClosed ( ramses::displayId_t  displayId)
inlineoverridevirtual

◆ windowClosed() [2/6]

void RendererEventHandler::windowClosed ( ramses::displayId_t  displayId)
inlineoverridevirtual

This method will be called when a display's window has been closed.

Parameters
displayIdThe display on which the event occurred

Reimplemented from ramses::RendererEventHandlerEmpty.

◆ windowClosed() [3/6]

void RendererEventHandler::windowClosed ( ramses::displayId_t  displayId)
inlineoverridevirtual

This method will be called when a display's window has been closed.

Parameters
displayIdThe display on which the event occurred

Reimplemented from ramses::RendererEventHandlerEmpty.

◆ windowClosed() [4/6]

void RendererEventHandler::windowClosed ( ramses::displayId_t  displayId)
inlineoverridevirtual

This method will be called when a display's window has been closed.

Parameters
displayIdThe display on which the event occurred

Reimplemented from ramses::RendererEventHandlerEmpty.

◆ windowClosed() [5/6]

void RendererEventHandler::windowClosed ( ramses::displayId_t  displayId)
inlineoverridevirtual

This method will be called when a display's window has been closed.

Parameters
displayIdThe display on which the event occurred

Reimplemented from ramses::RendererEventHandlerEmpty.

◆ windowClosed() [6/6]

void RendererEventHandler::windowClosed ( ramses::displayId_t  displayId)
inlineoverridevirtual

This method will be called when a display's window has been closed.

Parameters
displayIdThe display on which the event occurred

Reimplemented from ramses::RendererEventHandlerEmpty.


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