GhostEngine/Ghost.Graphics/RHI/Common.cs

using Ghost.Core;
using Ghost.Core.Graphics;
using Ghost.Graphics.Core;
using Misaki.HighPerformance.Mathematics;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;

namespace Ghost.Graphics.RHI;

public readonly struct ShaderVariant;
public readonly struct GraphicsPipeline;

public readonly struct PassPipelineHash : IEquatable<PassPipelineHash>
{
    public readonly UInt128 value;

    public PassPipelineHash(ReadOnlySpan<TextureFormat> rtvFormats, TextureFormat dsvFormat)
    {
        if (rtvFormats.Length > 8)
        {
            throw new ArgumentException($"RTV formats length exceeds maximum supported count of {8}.");
        }

        // layout:
        // 0..64 8 RTV formats (8 bits each)
        // 64..72 DSV format (8 bits)

        var rtvPart = 0UL;
        for (var i = 0; i < rtvFormats.Length; i++)
        {
            rtvPart |= ((ulong)(byte)rtvFormats[i]) << (i * 8);
        }

        value = new UInt128(rtvPart, (ulong)dsvFormat);
    }

    public bool Equals(PassPipelineHash other) => value == other.value;
    public override bool Equals(object? obj) => obj is PassPipelineHash other && Equals(other);
    public override int GetHashCode() => value.GetHashCode();

    public static bool operator ==(PassPipelineHash left, PassPipelineHash right) => left.Equals(right);
    public static bool operator !=(PassPipelineHash left, PassPipelineHash right) => !(left == right);
}

public ref struct GraphicsPSODescriptor
{
    public Key64<ShaderVariant> VariantKey
    {
        get; set;
    }

    public PipelineState PipelineOption
    {
        get; set;
    }

    public ReadOnlySpan<TextureFormat> RtvFormats
    {
        get; set;
    }

    public TextureFormat DsvFormat
    {
        get; set;
    }
}

public readonly struct CBufferPropertyInfo
{
    public string Name
    {
        get; init;
    }

    public uint StartOffset
    {
        get; init;
    }

    public uint Size
    {
        get; init;
    }
}

public readonly struct CBufferInfo
{
    public string Name
    {
        get; init;
    }

    public uint RegisterSlot
    {
        get; init;
    }

    public uint RegisterSpace
    {
        get; init;
    }

    public uint SizeInBytes
    {
        get; init;
    }

    public IReadOnlyList<CBufferPropertyInfo>? Properties
    {
        get; init;
    }
}

public struct RenderDesc
{
    public float4x4 ViewMatrix
    {
        get; set;
    }

    public float4x4 ProjectionMatrix
    {
        get; set;
    }

    public float4 CameraPosition
    {
        get; set;
    }

    // The "Target" (Where to write pixels)
    public Handle<Texture> Target
    {
        get; set;
    }

    public Handle<Texture> DepthTarget
    {
        get; set;
    }

    public RectDesc Viewport
    {
        get; set;
    }

    //public RenderPathID RenderPath;
    //public LayerMask CullingMask;
}

public struct ViewportDesc
{
    public float X
    {
        get; set;
    }

    public float Y
    {
        get; set;
    }

    public float Width
    {
        get; set;
    }

    public float Height
    {
        get; set;
    }

    public float MinDepth
    {
        get; set;
    }

    public float MaxDepth
    {
        get; set;
    }

}

public struct RectDesc
{
    public uint Left
    {
        get; set;
    }

    public uint Top
    {
        get; set;
    }

    public uint Right
    {
        get; set;
    }

    public uint Bottom
    {
        get; set;
    }
}

public struct SubResourceData
{
    public unsafe void* pData;
    public uint rowPitch;
    public uint slicePitch;
}

public struct PassRenderTargetDesc
{
    public Handle<Texture> Texture
    {
        get; set;
    }

    public Color128 ClearColor
    {
        get; set;
    }

    /// <summary>
    /// Specifies how to load the render target at the start of the render pass.
    /// </summary>
    public AttachmentLoadOp LoadOp
    {
        get; set;
    }

    /// <summary>
    /// Specifies how to store the render target at the end of the render pass.
    /// </summary>
    public AttachmentStoreOp StoreOp
    {
        get; set;
    }

}

public struct PassDepthStencilDesc
{
    public Handle<Texture> Texture
    {
        get; set;
    }

    public float ClearDepth
    {
        get; set;
    }

    public byte ClearStencil
    {
        get; set;
    }

    /// <summary>
    /// Specifies how to load the depth buffer at the start of the render pass.
    /// </summary>
    public AttachmentLoadOp DepthLoadOp
    {
        get; set;
    }

    /// <summary>
    /// Specifies how to store the depth buffer at the end of the render pass.
    /// </summary>
    public AttachmentStoreOp DepthStoreOp
    {
        get; set;
    }

    /// <summary>
    /// Specifies how to load the stencil buffer at the start of the render pass.
    /// </summary>
    public AttachmentLoadOp StencilLoadOp
    {
        get; set;
    }

    /// <summary>
    /// Specifies how to store the stencil buffer at the end of the render pass.
    /// </summary>
    public AttachmentStoreOp StencilStoreOp
    {
        get; set;
    }

}


public struct BarrierSubresourceRange
{
    public uint IndexOrFirstMipLevel
    {
        get; set;
    }

    public uint NumMipLevels
    {
        get; set;
    }

    public uint FirstArraySlice
    {
        get; set;
    }

    public uint NumArraySlices
    {
        get; set;
    }
}

public struct BarrierDesc
{
    public BarrierType Type
    {
        get; set;
    }

    public BarrierSync SyncBefore
    {
        get; set;
    }

    public BarrierSync SyncAfter
    {
        get; set;
    }

    public BarrierAccess AccessBefore
    {
        get; set;
    }

    public BarrierAccess AccessAfter
    {
        get; set;
    }

    public BarrierLayout LayoutBefore
    {
        get; set;
    }

    public BarrierLayout LayoutAfter
    {
        get; set;
    }

    public Handle<GPUResource> Resource
    {
        get; set;
    }

    public BarrierSubresourceRange Subresources
    {
        get; set;
    }

    public bool Discard
    {
        get; set;
    }

    public static BarrierDesc Global(BarrierSync syncBefore, BarrierSync syncAfter, BarrierAccess accessBefore, BarrierAccess accessAfter)
    {
        return new BarrierDesc
        {
            Type = BarrierType.Global,
            SyncBefore = syncBefore,
            SyncAfter = syncAfter,
            AccessBefore = accessBefore,
            AccessAfter = accessAfter
        };
    }

    public static BarrierDesc Buffer(Handle<GPUResource> resource, BarrierSync syncBefore, BarrierSync syncAfter, BarrierAccess accessBefore, BarrierAccess accessAfter)
    {
        return new BarrierDesc
        {
            Type = BarrierType.Buffer,
            Resource = resource,
            SyncBefore = syncBefore,
            SyncAfter = syncAfter,
            AccessBefore = accessBefore,
            AccessAfter = accessAfter
        };
    }

    public static BarrierDesc Texture(Handle<GPUResource> resource, BarrierSync syncBefore, BarrierSync syncAfter, BarrierAccess accessBefore, BarrierAccess accessAfter, BarrierLayout layoutBefore, BarrierLayout layoutAfter, BarrierSubresourceRange subresources = default, bool discard = false)
    {
        return new BarrierDesc
        {
            Type = BarrierType.Texture,
            Resource = resource,
            SyncBefore = syncBefore,
            SyncAfter = syncAfter,
            AccessBefore = accessBefore,
            AccessAfter = accessAfter,
            LayoutBefore = layoutBefore,
            LayoutAfter = layoutAfter,
            Subresources = subresources,
            Discard = discard
        };
    }
}

public struct ResourceDesc
{
    [StructLayout(LayoutKind.Explicit)]
    internal struct resource_union
    {
        [FieldOffset(0)]
        public TextureDesc textureDescription;
        [FieldOffset(0)]
        public BufferDesc bufferDescription;
    }

    internal resource_union _desc;

    public TextureDesc TextureDescription
    {
        readonly get => _desc.textureDescription;
        set => _desc.textureDescription = value;
    }

    public BufferDesc BufferDescription
    {
        readonly get => _desc.bufferDescription;
        set => _desc.bufferDescription = value;
    }

    public static ResourceDesc Buffer(BufferDesc desc)
    {
        return new ResourceDesc
        {
            BufferDescription = desc
        };
    }

    public static ResourceDesc Texture(TextureDesc desc)
    {
        return new ResourceDesc
        {
            TextureDescription = desc
        };
    }
}

/// <summary>
/// Render Target description
/// Supports either color OR depth rendering, not both
/// </summary>
public struct RenderTargetDesc
{
    /// <summary>
    /// Width of the render Target
    /// </summary>
    public uint Width
    {
        get; set;
    }

    /// <summary>
    /// Height of the render Target
    /// </summary>
    public uint Height
    {
        get; set;
    }

    /// <summary>
    /// Slice of the render Target
    /// </summary>
    public uint Slice
    {
        get; set;
    }

    /// <summary>
    /// Type of render Target
    /// </summary>
    public RenderTargetType Type
    {
        get; set;
    }

    /// <summary>
    /// Target texture Format
    /// </summary>
    public TextureFormat Format
    {
        get; set;
    }

    /// <summary>
    /// Texture dimension
    /// </summary>
    public TextureDimension Dimension
    {
        get; set;
    }

    /// <summary>
    /// Creation flags for the render Target
    /// </summary>
    public RenderTargetCreationFlags CreationFlags
    {
        get; set;
    }

    /// <summary>
    /// Number of mip levels. 0 to generate full mip chain
    /// </summary>
    public uint MipLevels
    {
        get; set;
    }

    /// <summary>
    /// Number of samples for MSAA
    /// </summary>
    public uint SampleCount
    {
        get; set;
    }

    /// <summary>
    /// Creates a color render Target
    /// </summary>
    public static RenderTargetDesc Color(uint width, uint height, uint slice = 1,
        TextureFormat format = TextureFormat.R8G8B8A8_UNorm, TextureDimension dimension = TextureDimension.Texture2D,
        RenderTargetCreationFlags creationFlags = RenderTargetCreationFlags.AllowUAV | RenderTargetCreationFlags.DynamicallyResolution | RenderTargetCreationFlags.GenerateMips,
        uint mipLevels = 0u, uint sampleCount = 1)
    {
        return new RenderTargetDesc
        {
            Width = width,
            Height = height,
            Slice = slice,
            Type = RenderTargetType.Color,
            Format = format,
            Dimension = dimension,
            CreationFlags = creationFlags,
            MipLevels = mipLevels,
            SampleCount = sampleCount
        };
    }

    /// <summary>
    /// Creates a depth render Target
    /// </summary>
    public static RenderTargetDesc Depth(uint width, uint height, uint slice = 1,
        TextureFormat format = TextureFormat.D24_UNorm_S8_UInt, TextureDimension dimension = TextureDimension.Texture2D,
        RenderTargetCreationFlags creationFlags = RenderTargetCreationFlags.AllowUAV | RenderTargetCreationFlags.DynamicallyResolution,
        uint mipLevels = 0u, uint sampleCount = 1)
    {
        return new RenderTargetDesc
        {
            Width = width,
            Height = height,
            Slice = slice,
            Type = RenderTargetType.Depth,
            Format = format,
            Dimension = dimension,
            CreationFlags = creationFlags,
            MipLevels = mipLevels,
            SampleCount = sampleCount
        };
    }

    [MethodImpl(MethodImplOptions.AggressiveInlining)]
    public TextureDesc ToTextureDescripton()
    {
        var usage = Type == RenderTargetType.Color ? TextureUsage.RenderTarget : TextureUsage.DepthStencil;
        if (CreationFlags.HasFlag(RenderTargetCreationFlags.AllowUAV))
        {
            usage |= TextureUsage.UnorderedAccess;
        }

        return new TextureDesc
        {
            Width = Width,
            Height = Height,
            Slice = Slice,
            Format = Format,
            Dimension = Dimension,
            MipLevels = MipLevels,
            Usage = usage,
        };
    }
}

/// <summary>
/// Texture description
/// </summary>
public struct TextureDesc
{
    /// <summary>
    /// Width of the texture
    /// </summary>
    public uint Width
    {
        get; set;
    }

    /// <summary>
    /// Height of the texture
    /// </summary>
    public uint Height
    {
        get; set;
    }

    /// <summary>
    /// Slice of the texture
    /// </summary>
    public uint Slice
    {
        get; set;
    }

    /// <summary>
    /// Texture Format
    /// </summary>
    public TextureFormat Format
    {
        get; set;
    }

    /// <summary>
    /// Texture dimension
    /// </summary>
    public TextureDimension Dimension
    {
        get;
        set;
    }

    /// <summary>
    /// Number of mip levels. 0 to generate full mip chain
    /// </summary>
    public uint MipLevels
    {
        get; set;
    }

    /// <summary>
    /// Texture usage flags
    /// </summary>
    public TextureUsage Usage
    {
        get; set;
    }
}

public record struct SamplerDesc
{
    public TextureFilterMode FilterMode
    {
        get; set;
    }

    public TextureAddressMode AddressU
    {
        get; set;
    }

    public TextureAddressMode AddressV
    {
        get; set;
    }

    public TextureAddressMode AddressW
    {
        get; set;
    }

    public ComparisonFunction ComparisonFunc
    {
        get; set;
    }

    public float MipLODBias
    {
        get; set;
    }

    public uint MaxAnisotropy
    {
        get; set;
    }

    public float MinLOD
    {
        get; set;
    }

    public float MaxLOD
    {
        get; set;
    }
}

public struct BufferDesc
{
    public ulong Size
    {
        get; set;
    }

    public uint Stride
    {
        get; set;
    }

    public BufferUsage Usage
    {
        get; set;
    }

    public ResourceMemoryType MemoryType
    {
        get; set;
    }
}

public struct CommandError
{
    public int CommandIndex
    {
        get; set;
    }

    public string CommandName
    {
        get; set;
    }

    public ErrorStatus Status
    {
        get; set;
    }
}

public struct SwapChainDesc
{
    public uint Width
    {
        get; set;
    }

    public uint Height
    {
        get; set;
    }

    public float ScaleX
    {
        get; set;
    }

    public float ScaleY
    {
        get; set;
    }

    public TextureFormat Format
    {
        get; set;
    }

    public SwapChainTarget Target
    {
        get; set;
    }
}

public struct SwapChainTarget
{
    public SwapChainTargetType Type
    {
        get; set;
    }

    public nint WindowHandle
    {
        get; set;
    }

    public object? CompositionSurface
    {
        get; set;
    }


    public static SwapChainTarget FromWindowHandle(nint hwnd)
    {
        return new SwapChainTarget
        {
            Type = SwapChainTargetType.WindowHandle,
            WindowHandle = hwnd,
            CompositionSurface = 0
        };
    }

    public static SwapChainTarget FromCompositionSurface(object surface)
    {
        return new SwapChainTarget
        {
            Type = SwapChainTargetType.Composition,
            WindowHandle = 0,
            CompositionSurface = surface
        };
    }
}

public enum SwapChainTargetType
{
    WindowHandle,
    Composition
}


public enum BarrierType
{
    Global,
    Texture,
    Buffer
}

[Flags]
public enum BarrierSync : uint
{
    None = 0x0,
    All = 0x0,
    Draw = 0x1,
    IndexInput = 0x2,
    VertexShading = 0x4,
    PixelShading = 0x8,
    DepthStencil = 0x10,
    RenderTarget = 0x20,
    ComputeShading = 0x40,
    Raytracing = 0x80,
    Copy = 0x100,
    Resolve = 0x200,
    ExecuteIndirect = 0x400,
    Predication = 0x800,
    AllShading = VertexShading | PixelShading | ComputeShading | Raytracing,
    NonPixelShading = VertexShading | ComputeShading | Raytracing,
    EmitRaytracingAccelerationStructurePostbuildInfo = 0x1000,
    ClearUnorderedAccessView = 0x2000,
    VideoDecode = 0x40000,
    VideoProcess = 0x80000,
    VideoEncode = 0x100000,
    BuildRaytracingAccelerationStructure = 0x200000,
    CopyRaytracingAccelerationStructure = 0x400000,
    Split = 0x800000
}

[Flags]
public enum BarrierAccess : uint
{
    Common = 0,
    VertexBuffer = 0x1,
    ConstantBuffer = 0x2,
    IndexBuffer = 0x4,
    RenderTarget = 0x8,
    UnorderedAccess = 0x10,
    DepthStencilWrite = 0x20,
    DepthStencilRead = 0x40,
    ShaderResource = 0x80,
    StreamOutput = 0x100,
    IndirectArgument = 0x200,
    CopyDest = 0x400,
    CopySource = 0x800,
    ResolveDest = 0x1000,
    ResolveSource = 0x2000,
    RaytracingAccelerationStructureRead = 0x4000,
    RaytracingAccelerationStructureWrite = 0x8000,
    ShadingRateSource = 0x10000,
    VideoDecodeRead = 0x20000,
    VideoDecodeWrite = 0x40000,
    VideoProcessRead = 0x80000,
    VideoProcessWrite = 0x100000,
    VideoEncodeRead = 0x200000,
    VideoEncodeWrite = 0x400000,
    NoAccess = 0x80000000
}

public enum BarrierLayout
{
    Undefined = -1,
    Common = 0,
    Present = 0,
    GenericRead = 1,
    RenderTarget = 2,
    UnorderedAccess = 3,
    DepthStencilWrite = 4,
    DepthStencilRead = 5,
    ShaderResource = 6,
    CopyDest = 7,
    CopySource = 8,
    ResolveDest = 9,
    ResolveSource = 10,
    ShadingRateSource = 11,
    VideoDecodeRead = 12,
    VideoDecodeWrite = 13,
    VideoProcessRead = 14,
    VideoProcessWrite = 15,
    VideoEncodeRead = 16,
    VideoEncodeWrite = 17,
    DirectQueueCommon = 18,
    ComputeQueueCommon = 19,
    VideoQueueCommon = 20
}

[Flags]
public enum ResourceState : int
{
    Auto = -1,
    Common = 0,
    VertexAndConstantBuffer = 1 << 0,
    IndexBuffer = 1 << 1,
    RenderTarget = 1 << 2,
    UnorderedAccess = 1 << 3,
    DepthWrite = 1 << 4,
    DepthRead = 1 << 5,
    PixelShaderResource = 1 << 6,
    CopyDest = 1 << 7,
    CopySource = 1 << 8,
    GenericRead = 1 << 9,
    IndirectArgument = 1 << 10,
    NonPixelShaderResource = 1 << 11,
    Present = 0,
}

public enum CommandQueueType
{
    Graphics,
    Compute,
    Copy
}

public enum CommandBufferType
{
    Graphics,
    Compute,
    Copy
}

public enum PipelineType
{
    Graphics,
    Compute
}

[Flags]
public enum RenderTargetCreationFlags
{
    None = 0,
    AllowUAV = 1 << 0,
    AllowMSAA = 1 << 1,
    DynamicallyResolution = 1 << 2,
    GenerateMips = 1 << 3
}

public enum ResourceMemoryType
{
    Default,    // GPU memory
    Upload,     // CPU-to-GPU memory
    Readback    // GPU-to-CPU memory
}

[Flags]
public enum TextureUsage
{
    None = 0,
    ShaderResource = 1 << 0,
    RenderTarget = 1 << 1,
    DepthStencil = 1 << 2,
    UnorderedAccess = 1 << 3
}

public enum TextureDimension
{
    Unknown = -1,
    None = 0,
    Texture2D = 1,
    Texture3D = 2,
    TextureCube = 3,
    Texture2DArray = 4,
    TextureCubeArray = 5
}

public enum RenderTargetType
{
    Color,
    Depth
}

// TODO: Support compressed formats (BCn, ASTC, ETC2, etc)
public enum TextureFormat
{
    Unknown,
    R8G8B8A8_UNorm,
    B8G8R8A8_UNorm,
    R16G16B16A16_Float,
    R32G32B32A32_Float,
    D24_UNorm_S8_UInt,
    D32_Float
}

[Flags]
public enum BufferUsage
{
    None = 0,
    Vertex = 1 << 0,
    Index = 1 << 1,
    IndirectArgument = 1 << 7,
    Constant = 1 << 2,
    ShaderResource = 1 << 3,
    UnorderedAccess = 1 << 4,
    Structured = 1 << 5,
    Raw = 1 << 6,
    Upload = 1 << 8,
    Readback = 1 << 9,
}

public enum IndexType
{
    UInt16,
    UInt32
}

public enum PrimitiveTopology
{
    Point,
    Line,
    Triangle,
}

public enum TextureFilterMode
{
    Point,
    Bilinear,
    Trilinear,
    Anisotropic
}

public enum TextureAddressMode
{
    Repeat,
    Mirror,
    Clamp,
    Border,
    MirrorOnce
}

public enum ComparisonFunction
{
    Never,
    Less,
    Equal,
    LessEqual,
    Greater,
    NotEqual,
    GreaterEqual,
    Always
}

public enum AttachmentLoadOp
{
    Load,
    Clear,
    DontCare
}

public enum AttachmentStoreOp
{
    Store,
    DontCare
}