RamsesRenderer.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_RAMSESRENDERER_H
#define RAMSES_RAMSESRENDERER_H
 
#include "ramses-framework-api/StatusObject.h"
#include "ramses-renderer-api/RendererConfig.h"
#include "ramses-framework-api/RamsesFramework.h"
 
namespace ramses
{
    class SystemCompositorController;
    class DisplayConfig;
    class IRendererEventHandler;
    class WarpingMeshData;
    class RendererSceneControl;
    class DcsmContentControl;
 
    class RAMSES_API RamsesRenderer : public StatusObject
    {
    public:
        status_t doOneLoop();
 
        status_t startThread();
 
        status_t stopThread();
 
        bool isThreadRunning() const;
 
        status_t setMaximumFramerate(float maximumFramerate);
 
        static status_t setMaximumFramerate(RamsesRenderer& renderer, float maximumFramerate, displayId_t displayId);
 
        float getMaximumFramerate() const;
 
        status_t setLoopMode(ELoopMode loopMode);
 
        ELoopMode getLoopMode() const;
 
        status_t setFrameTimerLimits(uint64_t limitForSceneResourcesUpload, uint64_t limitForClientResourcesUpload, uint64_t limitForOffscreenBufferRender);
 
        status_t setPendingFlushLimits(uint32_t forceApplyFlushLimit, uint32_t forceUnsubscribeSceneLimit);
 
        status_t setSkippingOfUnmodifiedBuffers(bool enable = true);
 
        displayId_t createDisplay(const DisplayConfig& config);
 
        status_t destroyDisplay(displayId_t displayId);
 
        displayBufferId_t getDisplayFramebuffer(displayId_t displayId) const;
 
        displayBufferId_t createOffscreenBuffer(displayId_t display, uint32_t width, uint32_t height, uint32_t sampleCount = 0u);
 
        static displayBufferId_t createOffscreenBuffer(RamsesRenderer& renderer, displayId_t display, uint32_t width, uint32_t height, uint32_t sampleCount = 0u, EDepthBufferType depthBufferType = EDepthBufferType_DepthStencil);
 
        displayBufferId_t createInterruptibleOffscreenBuffer(displayId_t display, uint32_t width, uint32_t height);
 
        static displayBufferId_t createInterruptibleOffscreenBuffer(RamsesRenderer& renderer, displayId_t display, uint32_t width, uint32_t height, EDepthBufferType depthBufferType = EDepthBufferType_DepthStencil);
 
        displayBufferId_t createDmaOffscreenBuffer(displayId_t display, uint32_t width, uint32_t height, uint32_t bufferFourccFormat, uint32_t usageFlags, uint64_t modifier);
 
        status_t getDmaOffscreenBufferFDAndStride(displayId_t display, displayBufferId_t displayBufferId, int& fd, uint32_t& stride) const;
 
        status_t destroyOffscreenBuffer(displayId_t display, displayBufferId_t offscreenBuffer);
 
        externalBufferId_t createExternalBuffer(displayId_t display);
 
        status_t destroyExternalBuffer(displayId_t display, externalBufferId_t externalBuffer);
 
        bool getExternalBufferGlId(displayId_t display, externalBufferId_t externalBuffer, uint32_t& textureGlId) const;
 
        static status_t setDisplayBufferClearFlags(RamsesRenderer& renderer, displayId_t display, displayBufferId_t displayBuffer, uint32_t clearFlags);
 
        status_t setDisplayBufferClearColor(displayId_t display, displayBufferId_t displayBuffer, float r, float g, float b, float a);
 
        status_t setExternallyOwnedWindowSize(displayId_t display, uint32_t width, uint32_t height);
 
        status_t readPixels(displayId_t displayId, displayBufferId_t displayBuffer, uint32_t x, uint32_t y, uint32_t width, uint32_t height);
 
        RendererSceneControl* getSceneControlAPI();
 
        DcsmContentControl* createDcsmContentControl();
 
        //      System Compositor API
 
        status_t setSurfaceVisibility(uint32_t surfaceId, bool visibility);
 
        status_t setSurfaceOpacity(uint32_t surfaceId, float opacity);
 
        status_t setSurfaceRectangle(uint32_t surfaceId, int32_t x, int32_t y, int32_t width, int32_t height);
 
        status_t setLayerVisibility(uint32_t layerId, bool visibility);
 
        status_t takeSystemCompositorScreenshot(const char* fileName, int32_t screenIviId);
 
        //      End of System Compositor API
 
        status_t updateWarpingMeshData(displayId_t displayId, const WarpingMeshData& newWarpingMeshData);
 
        status_t dispatchEvents(IRendererEventHandler& rendererEventHandler);
 
        status_t flush();
 
        status_t logRendererInfo();
 
        class RamsesRendererImpl& impl;
 
        explicit RamsesRenderer(RamsesRendererImpl&);
 
        RamsesRenderer() = delete;
 
        RamsesRenderer(const RamsesRenderer& other) = delete;
 
        RamsesRenderer& operator=(const RamsesRenderer& other) = delete;
 
    private:
        friend class RendererFactory;
 
        virtual ~RamsesRenderer();
    };
}
 
#endif