DisplayConfig.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_RENDERERAPI_DISPLAYCONFIG_H
#define RAMSES_RENDERERAPI_DISPLAYCONFIG_H
 
#include "ramses-renderer-api/Types.h"
#include "ramses-framework-api/StatusObject.h"
#include "ramses-framework-api/RamsesFrameworkTypes.h"
 
namespace ramses
{
    class RAMSES_API DisplayConfig : public StatusObject
    {
    public:
        DisplayConfig();
 
        DisplayConfig(int32_t argc, char const* const* argv);
 
        DisplayConfig(const DisplayConfig& other);
 
        virtual ~DisplayConfig();
 
        status_t setWindowRectangle(int32_t x, int32_t y, uint32_t width, uint32_t height);
 
        status_t getWindowRectangle(int32_t& x, int32_t& y, uint32_t& width, uint32_t& height) const;
 
        status_t setWindowFullscreen(bool fullscreen);
 
        bool isWindowFullscreen() const;
 
        status_t setWindowBorderless(bool borderless);
 
        status_t setMultiSampling(uint32_t numSamples);
 
        status_t getMultiSamplingSamples(uint32_t& numSamples) const;
 
        status_t enableWarpingPostEffect();
 
        status_t setWaylandIviLayerID(waylandIviLayerId_t waylandIviLayerID);
 
        waylandIviLayerId_t getWaylandIviLayerID() const;
 
        status_t setWaylandIviSurfaceID(waylandIviSurfaceId_t waylandIviSurfaceID);
 
        waylandIviSurfaceId_t getWaylandIviSurfaceID() const;
 
        status_t setIntegrityRGLDeviceUnit(uint32_t rglDeviceUnit);
 
        uint32_t getIntegrityRGLDeviceUnit() const;
 
        void* getAndroidNativeWindow() const;
 
        status_t setAndroidNativeWindow(void* nativeWindowPtr);
 
        status_t setWindowIviVisible();
 
        status_t keepEffectsUploaded(bool enable);
 
        status_t setGPUMemoryCacheSize(uint64_t size);
 
        status_t setResizable(bool resizable);
 
        status_t setClearColor(float red, float green, float blue, float alpha);
 
        static status_t setDepthStencilBufferType(DisplayConfig& config, EDepthBufferType depthBufferType);
 
        status_t setX11WindowHandle(unsigned long x11WindowHandle);
 
        unsigned long getX11WindowHandle() const;
 
        status_t setWindowsWindowHandle(void* hwnd);
 
        void* getWindowsWindowHandle() const;
 
        status_t setWaylandDisplay(const char* waylandDisplay);
 
        const char* getWaylandDisplay() const;
 
        static status_t setAsyncEffectUploadEnabled(DisplayConfig& config, bool enabled);
 
        status_t setWaylandEmbeddedCompositingSocketName(const char* socketname);
 
        const char* getWaylandEmbeddedCompositingSocketName() const;
 
        status_t setWaylandEmbeddedCompositingSocketGroup(const char* groupname);
 
        status_t setWaylandEmbeddedCompositingSocketFD(int socketFileDescriptor);
 
        status_t setWaylandEmbeddedCompositingSocketPermissions(uint32_t permissions);
 
        status_t setSystemCompositorWaylandDisplay(const char* waylandDisplay);
 
        status_t setPlatformRenderNode(const char* renderNode);
 
        status_t setSwapInterval(int32_t interval);
 
        status_t setScenePriority(sceneId_t sceneId, int32_t priority);
 
        status_t setResourceUploadBatchSize(uint32_t batchSize);
 
        class DisplayConfigImpl& impl;
 
        DisplayConfig& operator=(const DisplayConfig& other) = delete;
    };
}
 
#endif