Enumerations.h

#pragma once
 
#include <RendererFoundation/RendererFoundationDLL.h>
 
struct plGALShaderResourceType
{
  using StorageType = plUInt8;
  enum Enum : plUInt8
  {
    Unknown = 0,
    Sampler,
 
    ConstantBuffer,
    // Read-only struct. Set directly via plGALCommandEncoder::SetPushConstants. HLSL: Use macro BEGIN_PUSH_CONSTANTS, END_PUSH_CONSTANTS, GET_PUSH_CONSTANT
    PushConstants,
 
 
    Texture,
    TextureAndSampler,
    TexelBuffer,
    StructuredBuffer,
 
 
    TextureRW,
    TexelBufferRW,
    StructuredBufferRW,
 
 
    // #TODO_SHADER: Future work:
    // Not supported: PL does not support AppendStructuredBuffer, ConsumeStructuredBuffer yet so while the shader can be compiled, nothing can be bound to these resources. On Vulkan, will probably need yet another type to distinguish the data from the count resource (uav_counter_binding).
    // Not supported: tbuffer, TextureBuffer, these map to CBV on DX11 and to eStorageBuffer on Vulkan, requiring to use a constantBufferView or a UAV. Thus, it bleeds platform implementation details.
    // Not supported: (Vulkan) VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT, frame-buffer local read-only image view. Required for render passes on mobile.
    // Not supported: (Vulkan) VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK,Vulkan 1.3 addition, surpasses push-constants but not widely supported yet. May be able to abstract this via PushConstants and custom shader compiler / GAL implementations.
    // Not supported: (Vulkan) VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR, Vulkan extension for raytracing.
 
    Default = Unknown
  };
};
 
struct plGALShaderResourceCategory
{
  using StorageType = plUInt8;
  static constexpr int ENUM_COUNT = 4;
  enum Enum : plUInt8
  {
    Sampler = PL_BIT(0),        //< Sampler (plGALSamplerStateHandle).
    ConstantBuffer = PL_BIT(1), //< Constant Buffer (plGALBufferHandle)
    TextureSRV = PL_BIT(2),     //< Shader Resource Views (plGALTextureResourceViewHandle).
    BufferSRV = PL_BIT(3),      //< Shader Resource Views (plGALBufferResourceViewHandle).
    TextureUAV = PL_BIT(4),     //< Unordered Access Views (plGALTextureUnorderedAccessViewHandle).
    BufferUAV = PL_BIT(5),      //< Unordered Access Views (plGALBufferUnorderedAccessViewHandle).
    Default = 0
  };
 
  struct Bits
  {
    StorageType Sampler : 1;
    StorageType ConstantBuffer : 1;
    StorageType TextureSRV : 1;
    StorageType BufferSRV : 1;
    StorageType TextureUAV : 1;
    StorageType BufferUAV : 1;
  };
 
  static plBitflags<plGALShaderResourceCategory> MakeFromShaderDescriptorType(plGALShaderResourceType::Enum type);
};
 
PL_DECLARE_FLAGS_OPERATORS(plGALShaderResourceCategory);
 
struct plGALShaderTextureType
{
  using StorageType = plUInt8;
  enum Enum : plUInt8
  {
    Unknown = 0,
    Texture1D = 1,
    Texture1DArray = 2,
    Texture2D = 3,
    Texture2DArray = 4,
    Texture2DMS = 5,
    Texture2DMSArray = 6,
    Texture3D = 7,
    TextureCube = 8,
    TextureCubeArray = 9,
 
    Default = Unknown
  };
 
  static bool IsArray(plGALShaderTextureType::Enum format);
};
 
struct plGALPresentMode
{
  using StorageType = plUInt8;
 
  enum Enum
  {
    Immediate,
    VSync,
    ENUM_COUNT,
    Default = VSync
  };
};
 
struct plGALVertexAttributeSemantic
{
  using StorageType = plUInt8;
 
  enum Enum : plUInt8
  {
    Position,
    Normal,
    Tangent,
    Color0,
    Color1,
    Color2,
    Color3,
    Color4,
    Color5,
    Color6,
    Color7,
    TexCoord0,
    TexCoord1,
    TexCoord2,
    TexCoord3,
    TexCoord4,
    TexCoord5,
    TexCoord6,
    TexCoord7,
    TexCoord8,
    TexCoord9,
 
    BiTangent,
    BoneIndices0,
    BoneIndices1,
    BoneWeights0,
    BoneWeights1,
 
    ENUM_COUNT,
    Default = Position
  };
};
 
struct plGALBufferUsageFlags
{
  using StorageType = plUInt16;
 
  enum Enum
  {
    VertexBuffer = PL_BIT(0),      
    IndexBuffer = PL_BIT(1),       
    ConstantBuffer = PL_BIT(2),    
    TexelBuffer = PL_BIT(3),       
    StructuredBuffer = PL_BIT(4),  
    ByteAddressBuffer = PL_BIT(5), 
 
    ShaderResource = PL_BIT(6),    
    UnorderedAccess = PL_BIT(7),   
    DrawIndirect = PL_BIT(8),      
 
    Default = 0
  };
 
  struct Bits
  {
    StorageType VertexBuffer : 1;
    StorageType IndexBuffer : 1;
    StorageType ConstantBuffer : 1;
    StorageType TexelBuffer : 1;
    StorageType StructuredBuffer : 1;
    StorageType ByteAddressBuffer : 1;
    StorageType ShaderResource : 1;
    StorageType UnorderedAccess : 1;
    StorageType DrawIndirect : 1;
  };
};
PL_DECLARE_FLAGS_OPERATORS(plGALBufferUsageFlags);
 
struct plGALQueryType
{
  using StorageType = plUInt8;
 
  enum Enum
  {
    NumSamplesPassed,
    AnySamplesPassed,
 
    Default = NumSamplesPassed
  };
};
 
struct plGALSharedTextureType
{
  using StorageType = plUInt8;
 
  enum Enum : plUInt8
  {
    None,     
    Exported, 
    Imported, 
    Default = None
  };
};
 
#include <RendererFoundation/Descriptors/Implementation/Enumerations_inl.h>