gui_graphics_context.h

Go to the documentation of this file.

#pragma once
 
#include <gui_core/gui_base_types.h>
#include <gui_core/gui_result.h>
 
#include <gui_core/graphics/gui_image.h>
#include <gui_core/memory/gui_allocation_hooks.h>
 
#include <gui_core/style/gui_style.h>
 
#include <gui_core/windows/gui_window_backend.h>     // OSWindowHandle (used in pure-virtual signatures)
 
#include <source_location>
#include <span>
#include <string_view>
#include <vector>
 
namespace tachyon
{
 
    enum class WindowFlags : uint32_t;
    enum class VisualColorStyleIndex : uint16_t;
 
    class GUIRenderer;
    class TextAtlasManager;
    class StyleManager;
    class GradientManager;
    class ImageSet;
    class Image;
    class Buffer;
    class VisualColorStyle;
    struct VisualBoxStyle;
    class ITextSystem;
    class GUIStateManager;
    class IWindowBackend;
    class IWindowContext;

    enum class DeviceScope
    {
        Frame,
        Application
    };

    enum class GraphicsAPI : uint8_t
    {
        None,       
        Vulkan,
    };

    class GraphicsContext
    {
    public:
        GUIRenderer* guiRenderer = nullptr;
 
    public:
        GraphicsContext() = default;
 
        virtual ~GraphicsContext() {}
 
    public:
        virtual GraphicsAPI GetAPI() const = 0;

        virtual void SetAllocationHooks(const AllocationHooks& hooks) = 0;
        virtual Result<void> Initialize(IWindowBackend* windowBackend) = 0;
        virtual bool DeviceLost() const { return false; }
        virtual Result<void> RecreateDevice(IWindowBackend*) { return Error{ ErrorCode::Unsupported, "this backend can't recreate its device" }; }
        virtual void Cleanup() = 0;
        virtual void BeginFrame() = 0;
        virtual void EndFrame() = 0;
 
    public:
        virtual Image*  CreateImage(void* data, uint2 size, ImageFormat format, Sampler sampler, bool mipmapped = false) = 0;
        virtual void    DestroyImageAtEnd(Image* img, DeviceScope scope, const std::source_location& loc = std::source_location::current()) = 0;
 
    public:
        virtual TextAtlasManager* CreateTextAtlasManager() = 0;
 
        // ---- Window-context lifecycle ----

        virtual IWindowContext* CreateWindowContext(void* nativeWindowHandle, OSWindowHandle osHandle, ID id, int2 size, WindowFlags windowFlags, OnGuiFunc onGui) = 0;
        virtual void DestroyWindowContext(IWindowContext* context) = 0;
 
    public:
        virtual ImageSet* GetImageSet() const = 0;
        virtual ImageIndex RegisterImage(Image* image) = 0;
        virtual void UnregisterImage(ImageIndex index) = 0;

        virtual void PrepareFrame(StyleManager& styleManager, GradientManager& gradientManager, float elapsedTimeSecs) = 0;

        virtual float GetLastFrameBuildSeconds() const { return 0.0f; }
 
    };

}