Graphics: Improvements in BindGroupLayout and BindGroup, binding using IGraphicsBindableResource interface, handle UAV under D3D12.

Author: amerkoleci

src/Alimer/DisposableObject.cs

@@ -6,10 +6,21 @@
 
 namespace Alimer;
 
+/// <summary>
+/// Base interface for a <see cref="IDisposable"/> interface.
+/// </summary>
+public interface IDisposableObject : IDisposable
+{
+    /// <summary>
+    /// Gets <c>true</c> if the object has been disposed; otherwise, <c>false</c>.
+    /// </summary>
+    bool IsDisposed { get; }
+}
+
 /// <summary>
 /// Base class for a <see cref="IDisposable"/> interface.
 /// </summary>
-public abstract class DisposableObject : IDisposable
+public abstract class DisposableObject : IDisposableObject
 {
     private volatile uint _isDisposed = 0;
 
@@ -21,9 +32,7 @@ protected DisposableObject()
         _isDisposed = 0;
     }
 
-    /// <summary>
-    /// Gets <c>true</c> if the object has been disposed; otherwise, <c>false</c>.
-    /// </summary>
+    /// <inheritdoc />
     public bool IsDisposed => _isDisposed != 0;
 
     /// <summary>

src/Alimer/Graphics/AccelerationStructure.cs

@@ -3,7 +3,7 @@
 
 namespace Alimer.Graphics;
 
-public abstract class AccelerationStructure : GraphicsObject
+public abstract class AccelerationStructure : GraphicsObject, IGraphicsBindableResource
 {
     protected AccelerationStructure(in AccelerationStructureDescriptor descriptor)
         : base(descriptor.Label)

src/Alimer/Graphics/BindGroup.cs

@@ -22,5 +22,5 @@ protected BindGroup(in BindGroupDescriptor descriptor)
     /// A read-only span containing the bind group entries to apply. Each entry specifies a resource to bind; the span
     /// must not be empty.
     /// </param>
-    public abstract void Update(ReadOnlySpan<BindGroupEntry> entries);
+    public abstract void Update(Span<BindGroupEntry> entries);
 }

src/Alimer/Graphics/BindGroupDescriptor.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Amer Koleci and Contributors.
 // Licensed under the MIT License (MIT). See LICENSE in the repository root for more information.
 
+using System.Diagnostics.CodeAnalysis;
 using CommunityToolkit.Diagnostics;
 using static Alimer.Graphics.Constants;
 
@@ -17,70 +18,35 @@ public struct BindGroupEntry
     public uint Binding;
 
     /// <summary>
-    /// The <see cref="GraphicsBuffer"/> bound.
+    /// Specifies the index in a binding array.
     /// </summary>
-    public GraphicsBuffer? Buffer;
-
-    public ulong Offset = 0;
-    public ulong Size = WholeSize;
+    public uint ArrayElement = 0;
 
     /// <summary>
-    /// The <see cref="Graphics.TextureView"/> bound.
+    /// The <see cref="IGraphicsBindableResource"/> bound.
     /// </summary>
-    public TextureView? TextureView;
+    public IGraphicsBindableResource Resource;
 
     /// <summary>
-    /// The <see cref="Graphics.Sampler"/> bound.
+    /// If the binding is a buffer, this is the byte offset of the binding range, ignored otherwise.
     /// </summary>
-    public Sampler? Sampler;
+    public ulong Offset = 0;
 
     /// <summary>
-    /// The <see cref="Graphics.AccelerationStructure"/> bound.
+    /// If the binding is a buffer, this is the byte size of the binding range
+    /// (<see cref="WholeSize"/> means the binding ends at the end of the buffer), ignored otherwise.
     /// </summary>
-    public AccelerationStructure? AccelerationStructure;
+    public ulong Size = WholeSize; 
 
-    public BindGroupEntry(uint binding, GraphicsBuffer buffer, ulong offset = 0, ulong size = WholeSize)
+    public BindGroupEntry(uint binding, IGraphicsBindableResource resource, ulong offset = 0, ulong size = WholeSize)
     {
-        Guard.IsNotNull(buffer, nameof(buffer));
+        Guard.IsNotNull(resource, nameof(resource));
 
         Binding = binding;
-        Buffer = buffer;
+        Resource = resource;
         Offset = offset;
         Size = size;
     }
-
-    public BindGroupEntry(uint binding, Texture texture)
-    {
-        Guard.IsNotNull(texture, nameof(texture));
-        Guard.IsNotNull(texture.DefaultView, nameof(texture.DefaultView));
-
-        Binding = binding;
-        TextureView = texture.DefaultView;
-    }
-
-    public BindGroupEntry(uint binding, TextureView textureView)
-    {
-        Guard.IsNotNull(textureView, nameof(textureView));
-
-        Binding = binding;
-        TextureView = textureView;
-    }
-
-    public BindGroupEntry(uint binding, Sampler sampler)
-    {
-        Guard.IsNotNull(sampler, nameof(sampler));
-
-        Binding = binding;
-        Sampler = sampler;
-    }
-
-    public BindGroupEntry(uint binding, AccelerationStructure accelerationStructure)
-    {
-        Guard.IsNotNull(accelerationStructure, nameof(accelerationStructure));
-
-        Binding = binding;
-        AccelerationStructure = accelerationStructure;
-    }
 }
 
 /// <summary>
@@ -89,17 +55,18 @@ public BindGroupEntry(uint binding, AccelerationStructure accelerationStructure)
 public ref struct BindGroupDescriptor
 {
     // TODO: Separate per type (buffers/textures/samplers etc)
-    public ReadOnlySpan<BindGroupEntry> Entries;
+    public Span<BindGroupEntry> Entries;
 
     /// <summary>
     /// The label of <see cref="BindGroup"/>.
     /// </summary>
     public string? Label;
 
-    public BindGroupDescriptor(ReadOnlySpan<BindGroupEntry> entries, string? label = default)
+    public BindGroupDescriptor(Span<BindGroupEntry> entries,string? label = default)
     {
         Guard.IsGreaterThan(entries.Length, 0, nameof(entries));
 
+        //ConstantBufferEntries = constantBufferEntries;
         Entries = entries;
         Label = label;
     }

src/Alimer/Graphics/BindGroupLayout.cs

@@ -10,9 +10,12 @@ public abstract class BindGroupLayout : GraphicsObject
     protected BindGroupLayout(in BindGroupLayoutDescriptor descriptor)
         : base(descriptor.Label)
     {
+        Entries = descriptor.Entries.ToArray();
     }
 
-    public BindGroup CreateBindGroup(params ReadOnlySpan<BindGroupEntry> entries)
+    public BindGroupLayoutEntry[] Entries { get; }
+
+    public BindGroup CreateBindGroup(params Span<BindGroupEntry> entries)
     {
         return CreateBindGroup(new BindGroupDescriptor(entries));
     }

src/Alimer/Graphics/BindGroupLayoutDescriptor.cs

@@ -21,16 +21,11 @@ public BindGroupLayoutDescriptor()
     {
     }
 
-    public BindGroupLayoutDescriptor(Span<BindGroupLayoutEntry> entries)
+    public BindGroupLayoutDescriptor(Span<BindGroupLayoutEntry> entries, string? label = default)
     {
         Guard.IsGreaterThan(entries.Length, 0, nameof(entries));
 
         Entries = entries;
-    }
-
-    public BindGroupLayoutDescriptor(Span<BindGroupLayoutEntry> entries, string label)
-        : this(entries)
-    {
         Label = label;
     }
 }

src/Alimer/Graphics/BindGroupLayoutEntry.cs

@@ -5,64 +5,56 @@ namespace Alimer.Graphics;
 
 public readonly struct BufferBindingLayout
 {
-    public readonly BufferBindingType Type;
-    public readonly bool HasDynamicOffset;
-    public readonly ulong MinBindingSize;
+    public readonly BufferBindingType Type = BufferBindingType.Constant;
+    public readonly bool HasDynamicOffset = false;
 
     public BufferBindingLayout()
     {
-        Type = BufferBindingType.Constant;
-        HasDynamicOffset = false;
-        MinBindingSize = 0;
     }
 
-    public BufferBindingLayout(BufferBindingType type, bool hasDynamicOffset = false, ulong minBindingSize = 0)
+    public BufferBindingLayout(BufferBindingType type, bool hasDynamicOffset = false)
     {
         Type = type;
         HasDynamicOffset = hasDynamicOffset;
-        MinBindingSize = minBindingSize;
     }
 }
 
 public readonly struct SamplerBindingLayout
 {
-    public readonly SamplerBindingType Type;
+    public readonly SamplerBindingType Type = SamplerBindingType.Filtering;
 
     public SamplerBindingLayout()
     {
-        Type = SamplerBindingType.Filtering;
     }
 
-    public SamplerBindingLayout(SamplerBindingType type)
+    public SamplerBindingLayout(SamplerBindingType type = SamplerBindingType.Filtering)
     {
         Type = type;
     }
 }
 
 public readonly struct TextureBindingLayout
 {
-    public readonly TextureSampleType SampleType;
-    //public TextureViewDimension ViewDimension;
-    public readonly bool Multisampled;
+    public readonly TextureSampleType SampleType = TextureSampleType.Float;
+    public readonly TextureViewDimension ViewDimension = TextureViewDimension.View2D;
+    public readonly bool Multisampled = false;
 
     public TextureBindingLayout()
     {
-        SampleType = TextureSampleType.Float;
-        Multisampled = false;
     }
 
-    public TextureBindingLayout(TextureSampleType sampleType, bool multisampled = false)
+    public TextureBindingLayout(TextureSampleType sampleType = TextureSampleType.Float, bool multisampled = false)
     {
         SampleType = sampleType;
         Multisampled = multisampled;
     }
 }
 
-public struct StorageTextureBindingLayout
+public readonly struct StorageTextureBindingLayout
 {
-    public StorageTextureAccess Access = StorageTextureAccess.WriteOnly;
-    public PixelFormat Format = PixelFormat.Undefined;
-    //public TextureViewDimension viewDimension;
+    public readonly StorageTextureAccess Access = StorageTextureAccess.WriteOnly;
+    public readonly PixelFormat Format = PixelFormat.Undefined;
+    public readonly TextureViewDimension ViewDimension = TextureViewDimension.View2D;
 
     public StorageTextureBindingLayout()
     {
@@ -75,9 +67,9 @@ public StorageTextureBindingLayout(StorageTextureAccess access, PixelFormat form
     }
 }
 
-public struct AccelerationStructureBindingLayout
+public readonly struct AccelerationStructureBindingLayout
 {
-    public PixelFormat Format = PixelFormat.Undefined;
+    public readonly PixelFormat Format = PixelFormat.Undefined;
 
     public AccelerationStructureBindingLayout()
     {
@@ -89,34 +81,38 @@ public AccelerationStructureBindingLayout(PixelFormat format)
     }
 }
 
-
 /// <summary>
 /// Single entry for <see cref="BindGroupLayout"/>.
 /// </summary>
-public record struct BindGroupLayoutEntry
+public readonly struct BindGroupLayoutEntry
 {
     /// <summary>
     /// Register index to bind to (supplied in shader).
     /// </summary>
-    public uint Binding;
+    public readonly uint Binding;
 
     /// <summary>
     /// The shader stage the resources will be accessible to.
     /// </summary>
-    public ShaderStages Visibility;
+    public readonly ShaderStages Visibility;
+
+    /// <summary>
+    /// The number of descriptors contained in the binding, accessed in a shader as an array.
+    /// </summary>
+    public readonly uint Count = 1u;
 
     /// <summary>
     /// Gets the buffer binding.
     /// </summary>
-    public BufferBindingLayout Buffer;
+    public readonly BufferBindingLayout Buffer;
 
-    public SamplerBindingLayout Sampler;
+    public readonly SamplerBindingLayout Sampler;
 
-    public SamplerDescriptor? StaticSampler;
+    public readonly SamplerDescriptor? StaticSampler;
 
-    public TextureBindingLayout Texture;
-    public StorageTextureBindingLayout StorageTexture;
-    public AccelerationStructureBindingLayout AccelerationStructure;
+    public readonly TextureBindingLayout Texture;
+    public readonly StorageTextureBindingLayout StorageTexture;
+    public readonly AccelerationStructureBindingLayout AccelerationStructure;
 
     public BindGroupLayoutEntry(BufferBindingLayout buffer, uint binding, ShaderStages visibility = ShaderStages.All)
     {