IRendererEventHandler.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2015 BMW Car IT GmbH
//  -------------------------------------------------------------------------
//  This Source Code Form is subject to the terms of the Mozilla Public
//  License, v. 2.0. If a copy of the MPL was not distributed with this
//  file, You can obtain one at https://mozilla.org/MPL/2.0/.
//  -------------------------------------------------------------------------
 
#ifndef RAMSES_IRENDEREREVENTHANDLER_H
#define RAMSES_IRENDEREREVENTHANDLER_H
 
#include "Types.h"
#include "ramses-framework-api/APIExport.h"
#include <chrono>
 
namespace ramses
{
    class RAMSES_API IRendererEventHandler
    {
    public:
        virtual void offscreenBufferCreated(displayId_t displayId, displayBufferId_t offscreenBufferId, ERendererEventResult result) = 0;
 
        virtual void offscreenBufferDestroyed(displayId_t displayId, displayBufferId_t offscreenBufferId, ERendererEventResult result) = 0;
 
        virtual void framebufferPixelsRead(const uint8_t* pixelData, const uint32_t pixelDataSize, displayId_t displayId, displayBufferId_t displayBuffer, ERendererEventResult result) = 0;
 
        virtual void warpingMeshDataUpdated(displayId_t displayId, ERendererEventResult result) = 0;
 
        virtual void displayCreated(displayId_t displayId, ERendererEventResult result) = 0;
 
        virtual void displayDestroyed(displayId_t displayId, ERendererEventResult result) = 0;
 
        virtual void keyEvent(displayId_t displayId, EKeyEvent eventType, uint32_t keyModifiers, EKeyCode keyCode) = 0;
 
 
        virtual void mouseEvent(displayId_t displayId, EMouseEvent eventType, int32_t mousePosX, int32_t mousePosY) = 0;
 
        virtual void windowResized(displayId_t displayId, uint32_t width, uint32_t height) = 0;
 
        virtual void windowMoved(displayId_t displayId, int32_t windowPosX, int32_t windowPosY) = 0;
 
        virtual void windowClosed(displayId_t displayId) = 0;
 
        virtual void renderThreadLoopTimings(std::chrono::microseconds maximumLoopTime, std::chrono::microseconds averageLooptime) = 0;
 
#ifdef RAMSES_ENABLE_RENDER_LOOP_TIMINGS_PER_DISPLAY
        virtual void renderThreadLoopTimingsPerDisplay(displayId_t displayId, std::chrono::microseconds maximumLoopTime, std::chrono::microseconds averageLooptime)
        {
            (void)displayId;
            (void)maximumLoopTime;
            (void)averageLooptime;
        }
#endif
 
#ifdef RAMSES_ENABLE_EXTERNAL_BUFFER_EVENTS
        virtual void externalBufferCreated(displayId_t displayId, externalBufferId_t externalBufferId, uint32_t textureGlId, ERendererEventResult result) = 0;
 
        virtual void externalBufferDestroyed(displayId_t displayId, externalBufferId_t externalBufferId, ERendererEventResult result) = 0;
#endif
 
        virtual ~IRendererEventHandler() = default;
    };
 
    class RAMSES_API RendererEventHandlerEmpty : public IRendererEventHandler
    {
    public:
        virtual void offscreenBufferCreated(displayId_t displayId, displayBufferId_t offscreenBufferId, ERendererEventResult result) override
        {
            (void)displayId;
            (void)offscreenBufferId;
            (void)result;
        }
 
        virtual void offscreenBufferDestroyed(displayId_t displayId, displayBufferId_t offscreenBufferId, ERendererEventResult result) override
        {
            (void)displayId;
            (void)offscreenBufferId;
            (void)result;
        }
 
        virtual void framebufferPixelsRead(const uint8_t* pixelData, const uint32_t pixelDataSize, displayId_t displayId, displayBufferId_t displayBuffer, ERendererEventResult result) override
        {
            (void)pixelData;
            (void)pixelDataSize;
            (void)displayId;
            (void)displayBuffer;
            (void)result;
        }
 
        virtual void warpingMeshDataUpdated(displayId_t displayId, ERendererEventResult result) override
        {
            (void)displayId;
            (void)result;
        }
 
        virtual void displayCreated(displayId_t displayId, ERendererEventResult result) override
        {
            (void)displayId;
            (void)result;
        }
 
        virtual void displayDestroyed(displayId_t displayId, ERendererEventResult result) override
        {
            (void)displayId;
            (void)result;
        }
 
        virtual void keyEvent(displayId_t displayId, EKeyEvent eventType, uint32_t keyModifiers, EKeyCode keyCode) override
        {
            (void)displayId;
            (void)eventType;
            (void)keyModifiers;
            (void)keyCode;
        }
 
        virtual void mouseEvent(displayId_t displayId, EMouseEvent eventType, int32_t mousePosX, int32_t mousePosY) override
        {
            (void)displayId;
            (void)eventType;
            (void)mousePosX;
            (void)mousePosY;
        }
 
        virtual void windowResized(displayId_t displayId, uint32_t width, uint32_t height) override
        {
            (void)displayId;
            (void)width;
            (void)height;
        }
 
        virtual void windowMoved(displayId_t displayId, int32_t windowPosX, int32_t windowPosY) override
        {
            (void)displayId;
            (void)windowPosX;
            (void)windowPosY;
        }
 
        virtual void windowClosed(displayId_t displayId) override
        {
            (void)displayId;
        }
 
        virtual void renderThreadLoopTimings(std::chrono::microseconds maximumLoopTime, std::chrono::microseconds averageLooptime) override
        {
            (void)maximumLoopTime;
            (void)averageLooptime;
        }
 
#ifdef RAMSES_ENABLE_EXTERNAL_BUFFER_EVENTS
        virtual void externalBufferCreated(displayId_t displayId, externalBufferId_t externalBufferId, uint32_t textureGlId, ERendererEventResult result) override
        {
            (void)displayId;
            (void)externalBufferId;
            (void)textureGlId;
            (void)result;
        }
 
        virtual void externalBufferDestroyed(displayId_t displayId, externalBufferId_t externalBufferId, ERendererEventResult result) override
        {
            (void)displayId;
            (void)externalBufferId;
            (void)result;
        }
#endif
 
    };
}
 
#endif