gui_renderer.h

Go to the documentation of this file.

#pragma once
 
#include <gui_core/gui_id.h>
#include <gui_core/gui_base_types.h>      // IntRect, int2, float2, color4b, color4f, float3x2
#include <gui_core/graphics/gui_image.h>  // ImageIndex (default args)
#include <gui_core/gui_enum_operators.h>
 
#include <stdint.h>
#include <span>
 
namespace tachyon
{
 
    enum class VisualBoxStyleIndex : uint16_t;
    enum class VisualColorStyleIndex : uint16_t;
    enum class ElementState : uint8_t;

    enum class TriangleEdges : uint8_t
    {
        None   = 0,
        Edge01 = 1 << 0,   
        Edge12 = 1 << 1,   
        Edge20 = 1 << 2,   
    };
    TACHYON_ENUM_OPERATORS(TriangleEdges)
 
    struct LineStyle
    {
        VisualColorStyleIndex colorStyleIndex {};
        float lineWidth       = 0;
        float dashSize        = 0;
        float dashOffset      = 0;
        float gradientOffset  = 0.0f; 
        float gradientScale   = 1.0f; 
    };
 
    class GUIRenderer
    {
    public:
        virtual ~GUIRenderer() {}
 
        virtual void Reset() = 0;
 
 
        virtual void SetTransform(tachyon::float3x2 transformation) = 0;
        virtual void SetOpacity(float /*opacity*/) {}

        virtual void RenderBox(tachyon::IntRect rect, tachyon::IntRect clipRect,
                               uint32_t fromStyleIndex, uint32_t toStyleIndex, float blendT,
                               tachyon::VisualColorStyleIndex colorStyleIndex = {},
                               tachyon::ImageIndex textureIndex = tachyon::ImageIndex::Invalid,
                               tachyon::IntRect snappedPx = {}) = 0;

        static uint32_t StyleIndex(VisualBoxStyleIndex boxStyleIndex, tachyon::ElementState state);
 
        void RenderBox(tachyon::IntRect rect, tachyon::IntRect clipRect, VisualBoxStyleIndex boxStyleIndex,
                       tachyon::ElementState state, tachyon::VisualColorStyleIndex colorStyleIndex = {},
                       tachyon::ImageIndex textureIndex = tachyon::ImageIndex::Invalid, tachyon::IntRect snappedPx = {});
 
        void RenderBox(tachyon::IntRect rect, tachyon::IntRect clipRect, VisualBoxStyleIndex boxStyleIndex,
                       tachyon::VisualColorStyleIndex colorStyleIndex = {},
                       tachyon::ImageIndex textureIndex = tachyon::ImageIndex::Invalid, tachyon::IntRect snappedPx = {});
 
        virtual void RenderLine(tachyon::int2 p0, tachyon::int2 p1, tachyon::int2 p2, tachyon::int2 p3, tachyon::IntRect clipRect, const LineStyle& lineStyle) = 0;
        void         RenderLine(tachyon::int2 p0, tachyon::int2 p1, tachyon::IntRect clipRect, const LineStyle& lineStyle) { RenderLine(p0, p0, p1, p1, clipRect, lineStyle); }

        virtual void RenderCircle(tachyon::float2 center, float radius, tachyon::IntRect clipRect, const LineStyle& lineStyle) = 0;
 
        virtual void RenderDot(tachyon::float2 pos, tachyon::IntRect clipRect, float size, tachyon::color4f color) = 0;
        virtual void RenderTriangle(tachyon::float2 p0, tachyon::float2 p1, tachyon::float2 p2, tachyon::IntRect clipRect, tachyon::VisualColorStyleIndex colorStyleIndex, tachyon::ImageIndex textureIndex = tachyon::ImageIndex::Invalid, TriangleEdges hardEdges = TriangleEdges::None) = 0;

        virtual void RenderQuad(tachyon::IntRect rect, tachyon::IntRect clipRect, tachyon::VisualColorStyleIndex colorStyleIndex, float cornerRadius = 0.0f, tachyon::ImageIndex textureIndex = tachyon::ImageIndex::Invalid) = 0;
        virtual void RenderShadow(tachyon::IntRect rect, tachyon::IntRect clipRect, tachyon::VisualColorStyleIndex colorStyleIndex, float cornerRadius, int blur) = 0;
        virtual void RenderOccluder(tachyon::IntRect /*rect*/, tachyon::IntRect /*clipRect*/) {}

        virtual void RenderGlyph(tachyon::float2 pos, tachyon::float2 size, tachyon::float2 uvMin, tachyon::float2 uvMax, float scale, int bpp, int mode, VisualColorStyleIndex textColorIndex, tachyon::IntRect clipRect, tachyon::ImageIndex textureIndex = tachyon::ImageIndex::Invalid, float shadowBlur = -1.0f) = 0;

        void RenderFilledPolygon(std::span<const tachyon::float2> points, tachyon::IntRect clipRect,
                                 VisualColorStyleIndex colorIndex,
                                 tachyon::ImageIndex textureIndex = tachyon::ImageIndex::Invalid);

        void RenderPolyline(std::span<const tachyon::int2> points, bool closed,
                            tachyon::IntRect clipRect, const LineStyle& style);
 
    public:
        virtual bool StartResizing(ID id) = 0;
        virtual void StopResizing() = 0;
 
        virtual bool BeginWindow(ID id) = 0;
        virtual void EndWindow() = 0;
 
        // Draw caching: a subtree's primitives are captured once and replayed translated.
        // Called between BeginWindow and EndWindow; the defaults do nothing.

        virtual void BeginScopeCapture(ID /*scopeId*/) {}
        virtual void EndScopeCapture(ID /*scopeId*/) {}
        virtual bool ReplayScopeCapture(ID /*scopeId*/, tachyon::int2 /*delta*/) { return false; }
        virtual bool HasScopeCapture(ID /*scopeId*/) const { return false; }
        virtual void InvalidateScopeCapture(ID /*scopeId*/) {}
        virtual void ClearScopeCaptures() {}
    };

}