readme

Author: 2A5F

Coplt.Graphics.Core/Core/ShaderLayout.cs

@@ -4,6 +4,14 @@
 
 namespace Coplt.Graphics.Core;
 
+public enum ResourceAccess : byte
+{
+    Unknown,
+    ReadOnly,
+    WriteOnly,
+    ReadWrite,
+}
+
 public enum ShaderLayoutItemView : byte
 {
     Cbv,
@@ -71,6 +79,7 @@ public unsafe record struct ShaderLayoutItemDefine
     public ShaderLayoutItemView View;
     public ShaderLayoutItemType Type;
     public ShaderLayoutItemUsage Usage;
+    public ResourceAccess UavAccess;
 
     static ShaderLayoutItemDefine()
     {

Coplt.Graphics.Core/Native/Native.cs

@@ -4122,6 +4122,15 @@ public partial struct __pad_e__FixedBuffer
         }
     }
 
+    [NativeTypeName("Coplt::u8")]
+    public enum FResourceAccess : byte
+    {
+        Unknown,
+        ReadOnly,
+        WriteOnly,
+        ReadWrite,
+    }
+
     [NativeTypeName("Coplt::u8")]
     public enum FShaderLayoutItemView : byte
     {
@@ -4202,6 +4211,9 @@ public partial struct FShaderLayoutItemDefine
 
         [NativeTypeName("Coplt::FShaderLayoutItemUsage")]
         public FShaderLayoutItemUsage Usage;
+
+        [NativeTypeName("Coplt::FResourceAccess")]
+        public FResourceAccess UavAccess;
     }
 
     [NativeTypeName("Coplt::u8")]

Coplt.Graphics.Native/Api/FFI/Layout.h

@@ -9,6 +9,14 @@
 
 namespace Coplt
 {
+    enum class FResourceAccess : u8
+    {
+        Unknown,
+        ReadOnly,
+        WriteOnly,
+        ReadWrite,
+    };
+
     enum class FShaderLayoutItemView : u8
     {
         Cbv,
@@ -94,6 +102,7 @@ namespace Coplt
         FShaderLayoutItemView View{};
         FShaderLayoutItemType Type{};
         FShaderLayoutItemUsage Usage{};
+        FResourceAccess UavAccess{};
 
         #ifdef FFI_SRC
         bool IsAllowBuffer() const

Examples/Colorful/Colorful.md

@@ -29,11 +29,17 @@ Layout = Device.CreateShaderLayout(
     [
         new()
         {
-            Slot = 0,
-            Stage = ShaderStage.Pixel,
-            View = ShaderLayoutItemView.Cbv,
-            Type = ShaderLayoutItemType.ConstantBuffer,
-            Usage = ShaderLayoutItemUsage.Persist,
+            Slot = 0,                                       // Dx: hlsl register; Vk: binding or push const offset when View is Constants
+            Stage = ShaderStage.Pixel,                      // Can only be bound to a single shader stage
+            View = ShaderLayoutItemView.Cbv,                // View type, Cbv Srv Uav Sampler Constants
+            Type = ShaderLayoutItemType.ConstantBuffer,     // Resource type, use hlsl style, ConstantBuffer StructureBuffer Texture2D etc
+            Usage = ShaderLayoutItemUsage.Persist,          // Resource binding change frequency
+            // Dynamic: may change every frame
+            // Persist：rarely changes, such as material parameters
+            // Instant：only buffer and sampler, when buffer mean may change every draw, when sampler it is static sampler
+            // View type is Constants will ignore Usage
+            UavAccess: ResourceAccess.Unknown,              // Unknown ReadOnly WriteOnly ReadWrite
+            // Not necessary, can optimize automatic barriers
         }
     ],
     Name: Name