DataFormat.h

Go to the documentation of this file.

#pragma once
 
#include "Flags.h"
 
namespace Cogs
{
  class StringView;
 
  enum struct FormatFlags : uint32_t
  {
      None         = 0,
      Alpha        = 1 << 0,
      VertexFormat = 1 << 1,
      Depth        = 1 << 2,
      Typeless     = 1 << 3,
      Integer      = 1 << 4,
      Unsigned     = 1 << 5
  };
  COGS_RENDERING_ENABLE_ENUM_FLAGS(FormatFlags);
 
  enum class Format : uint16_t
  {
    Unknown = 0,
 
    // Unsigned normalized byte formats
 
    R8_UNORM,
    R8G8_UNORM,
    R8G8B8_UNORM,
    R8G8B8A8_UNORM,
 
    // Unsigned 16 bit normalized integer formats
 
    R16_UNORM,
    R16G16_UNORM,
    R16G16B16_UNORM,
    R16G16B16A16_UNORM,
 
    // Signed normalized byte formats
 
    R8_SNORM,
    R8G8_SNORM,
    R8G8B8_SNORM,
    R8G8B8A8_SNORM,
 
    // Signed 16 bit normalized integer formats
 
    R16_SNORM,
    R16G16_SNORM,
    R16G16B16_SNORM,
    R16G16B16A16_SNORM,
 
    // Unsigned byte formats
 
    R8_UINT,
    R8G8_UINT,
    R8G8B8_UINT,
    R8G8B8A8_UINT,
 
    // Unsigned 16 bit integer formats
 
    R16_UINT,
    R16G16_UINT,
    R16G16B16_UINT,
    R16G16B16A16_UINT,
 
    // Unsigned 32 bit integer formats
 
    R32_UINT,
    R32G32_UINT,
    R32G32B32_UINT,
    R32G32B32A32_UINT,
 
    // Signed byte formats
 
    R8_SINT,
    R8G8_SINT,
    R8G8B8_SINT,
    R8G8B8A8_SINT,
 
    // Signed 16 bit integer formats
 
    R16_SINT,
    R16G16_SINT,
    R16G16B16_SINT,
    R16G16B16A16_SINT,
 
    // Signed 32 bit integer formats
 
    R32_SINT,
    R32G32_SINT,
    R32G32B32_SINT,
    R32G32B32A32_SINT,
 
    // 16 bit floating point formats
 
    R16_FLOAT,
    R16G16_FLOAT,
    R16G16B16_FLOAT,
    R16G16B16A16_FLOAT,
 
    // 32 bit floating point formats
 
    R32_FLOAT,
    R32G32_FLOAT,
    R32G32B32_FLOAT,
    R32G32B32A32_FLOAT,
 
    // Depth buffer formats
 
    D16_UNORM,
    D24_UNORM,
    D24S8_UNORM,
    D32_FLOAT,
    R32_TYPELESS,
    R16_TYPELESS,
 
    // 8 bit typeless formats
 
    R8T,
    R8G8T,
    R8G8B8T,
    R8G8B8A8T,
 
    // Reverse component order formats.
 
    B8G8R8,
    B8G8R8A8,
 
    // Alpha formats
 
    A8_UNORM,
 
    // Compressed formats
 
    BC1_TYPELESS,
    BC1_UNORM,
    BC1_UNORM_SRGB,
    BC2_TYPELESS,
    BC2_UNORM,
    BC2_UNORM_SRGB,
    BC3_TYPELESS,
    BC3_UNORM,
    BC3_UNORM_SRGB,
    BC4_TYPELESS,
    BC4_UNORM,
    BC4_SNORM,
    BC5_TYPELESS,
    BC5_UNORM,
    BC5_SNORM,
 
    // BC7
    
    BC6H_SIGNED_FLOAT_RGB,
    BC6H_UNSIGNED_FLOAT_RGB,
    BC7_UNORM_RGBA,
    BC7_UNORM_SRGBA,
 
    // PRTVC_V1
    PVRTC1_2BPP_UNORM_RGB,
    PVRTC1_4BPP_UNORM_RGB,
    PVRTC1_2BPP_UNORM_RGBA,
    PVRTC1_4BPP_UNORM_RGBA,
    
    // ETC
    EAC_BLOCK8_UNSIGNED_FLOAT_R,
    EAC_BLOCK8_SIGNED_FLOAT_R, 
    EAC_BLOCK16_UNSIGNED_FLOAT_RG, 
    EAC_BLOCK16_SIGNED_FLOAT_RG,
 
    ETC2_BLOCK8_UNORM_RGB,
    ETC2_BLOCK8_UNORM_SRGB,
    ETC2_BLOCK16_UNORM_RGBA,
    ETC2_BLOCK16_UNORM_SRGBA,
 
    // ASTC
    ASTC_4x4_UNORM_RGBA,
    ASTC_5x4_UNORM_RGBA,
    ASTC_5x5_UNORM_RGBA,
    ASTC_6x5_UNORM_RGBA,
    ASTC_6x6_UNORM_RGBA,
    ASTC_8x5_UNORM_RGBA,
    ASTC_8x6_UNORM_RGBA,
    ASTC_8x8_UNORM_RGBA,
    ASTC_10x5_UNORM_RGBA,
    ASTC_10x6_UNORM_RGBA,
    ASTC_10x8_UNORM_RGBA,
    ASTC_10x10_UNORM_RGBA,
    ASTC_12x10_UNORM_RGBA,
    ASTC_12x12_UNORM_RGBA,
    // ASTC SRGBA
    ASTC_4x4_UNORM_SRGBA,
    ASTC_5x4_UNORM_SRGBA,
    ASTC_5x5_UNORM_SRGBA,
    ASTC_6x5_UNORM_SRGBA,
    ASTC_6x6_UNORM_SRGBA,
    ASTC_8x5_UNORM_SRGBA,
    ASTC_8x6_UNORM_SRGBA,
    ASTC_8x8_UNORM_SRGBA,
    ASTC_10x5_UNORM_SRGBA,
    ASTC_10x6_UNORM_SRGBA,
    ASTC_10x8_UNORM_SRGBA,
    ASTC_10x10_UNORM_SRGBA,
    ASTC_12x10_UNORM_SRGBA,
    ASTC_12x12_UNORM_SRGBA,
 
    // SRGB formats
 
    R8G8B8_UNORM_SRGB,
    R8G8B8A8_UNORM_SRGB,
 
    // Packed formats
 
    R10G10B10A2_TYPELESS,
    R10G10B10A2_UNORM,
    R10G10B10A2_UINT,
    R11G11B10_FLOAT,
    R5G6B5_UNORM,
    R5G5B5A1_UNORM,
    R4G4B4A4_UNORM,
    R9G9B9E5_FLOAT,
 
    // Matrix format for instancing
 
    MAT4X4_FLOAT,
 
    // Utility
 
    Format_Size,
    TextureFormat_Size = Format_Size,
 
    // Format aliases
 
    X16_FLOAT = R16_FLOAT,
    X16Y16_FLOAT = R16G16_FLOAT,
    X16Y16Z16_FLOAT = R16G16B16_FLOAT,
    X16Y16Z16W16_FLOAT = R16G16B16A16_FLOAT,
 
    X32_FLOAT = R32_FLOAT,
    X32Y32_FLOAT = R32G32_FLOAT,
    X32Y32Z32_FLOAT = R32G32B32_FLOAT,
    X32Y32Z32W32_FLOAT = R32G32B32A32_FLOAT,
  };
 
  using DataFormat = Format;
  using TextureFormat = Format;
 
  struct TextureExtent
  {
    uint32_t width = 0;
    uint32_t height = 0;
    uint32_t depth = 0;
  };
 
  struct FormatInfo
  {
    uint8_t blockSize = 0;          
    TextureExtent blockExtent;      
    uint16_t elements = 0;          
    const char * name = nullptr;    
    const char * vName = nullptr;   
    FormatFlags flags = FormatFlags::None;  
  };
 
  COGSRENDERING_DLL_API const FormatInfo * getFormatInfo(Format format);
 
  COGSRENDERING_DLL_API DataFormat parseDataFormat(const StringView& format);
 
}