RendererSceneControl.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2020 BMW AG
//  -------------------------------------------------------------------------
//  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_RENDERERSCENECONTROL_H
#define RAMSES_RENDERERSCENECONTROL_H
 
#include "ramses-framework-api/StatusObject.h"
#include "ramses-framework-api/RendererSceneState.h"
#include "ramses-framework-api/APIExport.h"
 
namespace ramses
{
    class IRendererSceneControlEventHandler;
 
    class RAMSES_API RendererSceneControl : public StatusObject
    {
    public:
        status_t setSceneState(sceneId_t sceneId, RendererSceneState state);
 
        status_t setSceneMapping(sceneId_t sceneId, displayId_t displayId);
 
        status_t setSceneDisplayBufferAssignment(sceneId_t sceneId, displayBufferId_t displayBuffer, int32_t sceneRenderOrder = 0);
 
        status_t linkOffscreenBuffer(displayBufferId_t offscreenBufferId, sceneId_t consumerSceneId, dataConsumerId_t consumerDataSlotId);
 
        status_t linkExternalBuffer(externalBufferId_t externalBufferId, sceneId_t consumerSceneId, dataConsumerId_t consumerDataSlotId);
 
        status_t linkData(sceneId_t providerSceneId, dataProviderId_t providerId, sceneId_t consumerSceneId, dataConsumerId_t consumerId);
 
        status_t unlinkData(sceneId_t consumerSceneId, dataConsumerId_t consumerId);
 
        status_t handlePickEvent(sceneId_t sceneId, float bufferNormalizedCoordX, float bufferNormalizedCoordY);
 
        status_t flush();
 
        status_t dispatchEvents(IRendererSceneControlEventHandler& eventHandler);
 
        RendererSceneControl() = delete;
 
        RendererSceneControl(const RendererSceneControl&) = delete;
 
        RendererSceneControl& operator=(const RendererSceneControl& other) = delete;
 
        class RendererSceneControlImpl& impl;
 
    private:
        friend class RamsesRendererImpl;
 
        explicit RendererSceneControl(RendererSceneControlImpl&);
 
        virtual ~RendererSceneControl();
    };
}
 
#endif