GfxEnv.h

/*
* Copyright (C) TES Electronic Solutions GmbH,
* All Rights Reserved.
* Contact: info@guiliani.de
*
* This file is part of the Guiliani HMI framework
* for the development of graphical user interfaces on embedded systems.
*/
 
#ifndef __GFXENV_H__
#define __GFXENV_H__
 
#include "eC_Types.h"
#include "eC_String.h"
 
#include "GUICommonEnums.h"
#include "eC_TList_doubleLinked.h"
 
#include "GUIRect.h"
 
#include "GUILayerConfig.h"
 
#include "GUIComponentManager.h"
 
#define GETGFXENV CGUIComponentManager::GetInstance().GetGfxEnv()
 
class CGfxWrap;
 
class CGfxEnv
{
    // for calling destructor
    friend class CGUIComponentManager;
 
public:
    enum SurfaceMode_t
    {
        SM_OPENGL, 
        SM_FRAMEBUFFER, 
        SM_VULKAN, 
    };
 
public:
    static eC_Bool CreateInstance(
        const SurfaceMode_t& eSurfaceMode,
        const CGUICommonEnums::ImageType_t& eScreenFormat,
        const eC_UInt& uiWidth,
        const eC_UInt& uiHeight,
        const eC_UInt& uiBufferCount = 1,
        void** ppkBuffers = NULL,
        const eC_Bool& bResizable = false);
 
    static void DeleteInstance();
 
    virtual void SetScreenPosition(const eC_UInt& uiX, const eC_UInt& uiY);
 
    virtual void SetScreenSize(const eC_UInt& uiWidth, const eC_UInt& uiHeight);
 
    virtual void SetVSyncEnabled(const eC_Bool& bVSyncEnabled);
 
    virtual eC_Bool IsCreated() const;
 
    virtual SurfaceMode_t GetSurfaceMode() const;
 
    virtual CGUICommonEnums::ImageType_t GetColorFormat() const;
 
    virtual eC_UInt GetXPos() const;
 
    virtual eC_UInt GetYPos() const;
 
    virtual eC_UInt GetWidth() const;
 
    virtual eC_UInt GetHeight() const;
 
    virtual eC_UByte GetBPP() const;
 
    virtual eC_Bool IsResizable() const;
 
    virtual eC_Bool NeedsManualMerge() const;
 
    virtual eC_Bool SupportsCopy() const;
 
    virtual eC_UInt GetBufferCount() const;
 
    virtual eC_String GetName() const;
 
    virtual void** GetFrameBuffers() const { return m_ppkBuffers; }
 
    virtual eC_Bool IsVSyncEnabled() const { return m_bVSyncEnabled; }
 
    virtual eC_Bool RefreshScreen(const CGUIRect& rkInvalidatedArea) { return false; }
 
    virtual eC_Bool RefreshScreen(const eC_TListDoubleLinked<CGUIRect>& kInvalidatedRectList);
 
    virtual void SetCliprect(const CGUIRect& rkNewClipRect) {}
 
    virtual void SetWindowCaption(const eC_String& kCaption) {}
 
    virtual eC_Bool SwapBuffers() { return false; }
 
    virtual eC_UInt InitDisplay() { return 1; }
 
    virtual void DeInitDisplay() {}
 
    eC_Bool GetLayerIndexForID(const eC_UInt& uiLayerID, eC_UInt& ruiLayerIndex) const;
 
    eC_Bool SetActiveLayerID(const eC_UInt& uiLayerID, const eC_Bool& bMarkAsModified = false);
 
    eC_UInt GetActiveLayerID() const;
 
    eC_Bool IsLayerModified(const eC_UInt& uiLayerID) const;
 
    virtual eC_Bool UpdateLayerBuffers(const eC_UInt& uiLayerID, void* pkRenderBuffer, void* pkDisplayBuffer, const eC_UInt& uiWidth, const eC_UInt& uiHeight);
 
    void AddMainLayer(const eC_UInt& uiLayerID = 0, const eC_Bool& bCached = false);
 
    void SetMainLayerProperties(const eC_UInt& uiLayerID, const eC_Bool& bCached);
 
    eC_Bool AddLayer(const LayerConfiguration_t& kLayerConfig);
 
    void InitLayers();
 
    eC_UInt GetNumberOfLayers() const;
 
    eC_Bool GetLayerConfig(const eC_UInt& uiLayerIndex, LayerConfiguration_t& rkLayerConfig) const;
 
    eC_Bool GetLayerConfigForID(const eC_UInt& uiLayerID, LayerConfiguration_t& rkLayerConfig) const;
 
    eC_Bool GetLayerConfigForMainLayer(LayerConfiguration_t& rkLayerConfig) const;
 
    eC_Bool SetLayerVisible(const eC_UInt& uiLayerID, const eC_Bool& bVisible);
 
    eC_Bool IsLayerVisible(const eC_UInt& uiLayerID) const;
 
    eC_Bool SetLayerPosition(const eC_UInt& uiLayerID, const eC_Int& iXPos, const eC_Int& iYPos);
 
    eC_Bool GetLayerPosition(const eC_UInt& uiLayerID, eC_Int& iXPos, eC_Int& iYPos);
 
    eC_Bool SetLayerVisibleSize(const eC_UInt& uiLayerID, const eC_UInt& uiWidth, const eC_UInt& uiHeight);
 
    eC_Bool GetLayerVisibleSize(const eC_UInt& uiLayerID, eC_UInt& uiWidth, eC_UInt& uiHeight);
 
    eC_Bool SetLayerVisiblePos(const eC_UInt& uiLayerID, const eC_Int& iXPos, const eC_Int& iYPos);
 
    eC_Bool SetLayerAlpha(const eC_UInt& uiLayerID, const eC_UByte& ubAlpha);
 
    eC_UByte GetLayerAlpha(const eC_UInt& uiLayerID) const;
 
    eC_Bool SetLayerChromaKey(const eC_UInt& uiLayerID, const eC_Bool& bChromaKeyActive, const eC_UInt& uiChromaKey, const eC_UByte& ubAlpha);
 
    eC_Bool GetLayerChromaKey(const eC_UInt& uiLayerID, eC_Bool& bChromaKeyActive, eC_UInt& uiChromaKey, eC_UByte& ubAlpha) const;
 
    eC_Bool GetLayerBufferSize(const eC_UInt& uiLayerID, eC_UInt& uiWidth, eC_UInt& uiHeight, eC_UByte& ubBPP);
 
    virtual void UpdateLayer(const LayerConfiguration_t& kLayerConfig, const LayerUpdate_t& eUpdateReason) {}
 
    void* GetRenderBuffer(const eC_UInt& uiLayerID) const;
 
    void* GetDisplayBuffer(const eC_UInt& uiLayerID) const;
 
    void InvalidateLayer(const eC_UInt& uiLayerID);
 
    void UpdateLayerPositions();
 
    void SetObjectForLayerID(const eC_UInt& uiLayerID, CGUIObject* pkObject);
 
    void SetGlobalAlpha(const eC_UByte& ubGlobalAlpha);
 
    eC_UByte GetGlobalAlpha() const;
 
    eC_UByte ApplyGlobalAlpha(const eC_UByte& ubAlpha) const;
 
    virtual void StartOfRefresh() {}
 
    virtual void EndOfRefresh() {}
 
    void SetMainLayerID(const eC_UInt& uiLayerID);
 
    eC_UInt GetMainLayerID() const;
 
    eC_Bool IsMainLayer(const eC_UInt& uiLayerID) const;
 
    virtual eC_Bool IsNull() { return false; }
 
    void SetGfxWrap(CGfxWrap* pkGfxWrap) { m_pkGfxWrap = pkGfxWrap; }
 
    eC_UByte GetBytesPerPixel(const CGUICommonEnums::ImageType_t& ePixFormat) const;
 
    virtual void SetDevice(void* pkDevice) {}
 
    virtual void* GetMergeBuffer() const { return NULL; }
 
    virtual void* GetDisplayHandle() const { return NULL; }
 
    virtual void* GetWindowHandle() const { return NULL; }
 
protected:
    CGfxEnv(
        const SurfaceMode_t& eSurfaceMode,
        const CGUICommonEnums::ImageType_t& eScreenFormat,
        const eC_UInt& uiWidth,
        const eC_UInt& uiHeight,
        const eC_UInt& uiBufferCount = 1,
        void** ppkBuffers = NULL,
        const eC_Bool& bResizable = false);
 
    virtual ~CGfxEnv();
 
    eC_UByte GetBPPFromScreenFormat() const;
 
    virtual void InitLayer(const LayerConfiguration_t& kLayerConfig) {}
 
    void UpdateMainLayer(
        const CGUICommonEnums::ImageType_t& eColorFormat,
        const eC_UInt& uiWidth, const eC_UInt& uiHeight,
        const eC_UInt& uiBufferCount,
        void** ppkBuffers);
 
protected:
    SurfaceMode_t m_eSurfaceMode; 
    CGUICommonEnums::ImageType_t m_eColorFormat; 
    eC_UInt m_uiWidth; 
    eC_UInt m_uiHeight; 
    eC_UByte m_ubBPP; 
    eC_UInt m_uiBufferCount; 
    void** m_ppkBuffers; 
    eC_Bool m_bResizable; 
    eC_Bool m_bNeedsManualMerge; 
    eC_Bool m_bSupportsCopy; 
    eC_String m_kName; 
 
protected:
    eC_TArray<LayerConfiguration_t> m_akLayers; 
    eC_UInt m_uiActiveLayerID; 
    eC_UInt m_uiActiveLayerIndex; 
 
    CGfxWrap* m_pkGfxWrap; 
 
    eC_Int m_iMainLayerID; 
    eC_UByte m_ubGlobalAlpha; 
    eC_Bool m_bVSyncEnabled; 
};
#endif