ImageFormat.h

#pragma once
 
#include <Foundation/Types/Types.h>
#include <Texture/Image/ImageEnums.h>
#include <Texture/TextureDLL.h>
 
struct PL_TEXTURE_DLL plImageFormatType
{
  enum Enum
  {
    UNKNOWN,
    LINEAR,
    BLOCK_COMPRESSED,
    PLANAR
  };
};
 
struct PL_TEXTURE_DLL plImageFormatDataType
{
  enum Enum
  {
    FLOAT,
    UINT,
    SINT,
    UNORM,
    SNORM,
    DEPTH_STENCIL,
    GENERIC,
    NONE
  };
};
 
struct PL_TEXTURE_DLL plImageFormatChannel
{
  enum Enum
  {
    R = 0,
    G,
    B,
    A,
    D,
    S,
    COUNT
  };
};
 
struct PL_TEXTURE_DLL plImageFormat
{
  enum Enum : plUInt16
  {
    UNKNOWN,
 
    // 32b per component, 4 components
    R32G32B32A32_FLOAT,
    R32G32B32A32_UINT,
    R32G32B32A32_SINT,
 
    // 32b per component, 3 components
    R32G32B32_FLOAT,
    R32G32B32_UINT,
    R32G32B32_SINT,
 
    // 16b per component, 4 components
    R16G16B16A16_FLOAT,
    R16G16B16A16_UNORM,
    R16G16B16A16_UINT,
    R16G16B16A16_SNORM,
    R16G16B16A16_SINT,
 
    // 16b per component, 3 components
    R16G16B16_UNORM,
 
    // 32b per component, 2 components
    R32G32_FLOAT,
    R32G32_UINT,
    R32G32_SINT,
 
    // Pseudo depth-stencil formats
    D32_FLOAT_S8X24_UINT,
 
    // 10b and 11b per component
    R10G10B10A2_UNORM,
    R10G10B10A2_UINT,
    R11G11B10_FLOAT,
 
    // 8b per component, 4 components
    R8G8B8A8_UNORM,
    R8G8B8A8_UNORM_SRGB,
    R8G8B8A8_UINT,
    R8G8B8A8_SNORM,
    R8G8B8A8_SINT,
 
    B8G8R8A8_UNORM,
    B8G8R8A8_UNORM_SRGB,
    B8G8R8X8_UNORM,
    B8G8R8X8_UNORM_SRGB,
 
    // 16b per component, 2 components
    R16G16_FLOAT,
    R16G16_UNORM,
    R16G16_UINT,
    R16G16_SNORM,
    R16G16_SINT,
 
    // 32b per component, 1 component
    D32_FLOAT,
    R32_FLOAT,
    R32_UINT,
    R32_SINT,
 
    // Mixed 24b/8b formats
    D24_UNORM_S8_UINT,
 
    // 8b per component, three components
    R8G8B8_UNORM,
    R8G8B8_UNORM_SRGB,
    B8G8R8_UNORM,
    B8G8R8_UNORM_SRGB,
 
    // 8b per component, two components
    R8G8_UNORM,
    R8G8_UINT,
    R8G8_SNORM,
    R8G8_SINT,
 
    // 16b per component, one component
 
    R16_FLOAT,
    D16_UNORM,
    R16_UNORM,
    R16_UINT,
    R16_SNORM,
    R16_SINT,
 
    // 8b per component, one component
    R8_UNORM,
    R8_UINT,
    R8_SNORM,
    R8_SINT,
 
    // Block compression formats
    BC1_UNORM,
    BC1_UNORM_SRGB,
    BC2_UNORM,
    BC2_UNORM_SRGB,
    BC3_UNORM,
    BC3_UNORM_SRGB,
    BC4_UNORM,
    BC4_SNORM,
    BC5_UNORM,
    BC5_SNORM,
    BC6H_UF16,
    BC6H_SF16,
    BC7_UNORM,
    BC7_UNORM_SRGB,
 
    // ASTC formats
    ASTC_4x4_UNORM,
    ASTC_4x4_UNORM_SRGB,
    ASTC_5x4_UNORM,
    ASTC_5x4_UNORM_SRGB,
    ASTC_5x5_UNORM,
    ASTC_5x5_UNORM_SRGB,
    ASTC_6x5_UNORM,
    ASTC_6x5_UNORM_SRGB,
    ASTC_6x6_UNORM,
    ASTC_6x6_UNORM_SRGB,
    ASTC_8x5_UNORM,
    ASTC_8x5_UNORM_SRGB,
    ASTC_8x6_UNORM,
    ASTC_8x6_UNORM_SRGB,
    ASTC_10x5_UNORM,
    ASTC_10x5_UNORM_SRGB,
    ASTC_10x6_UNORM,
    ASTC_10x6_UNORM_SRGB,
    ASTC_8x8_UNORM,
    ASTC_8x8_UNORM_SRGB,
    ASTC_10x8_UNORM,
    ASTC_10x8_UNORM_SRGB,
    ASTC_10x10_UNORM,
    ASTC_10x10_UNORM_SRGB,
    ASTC_12x10_UNORM,
    ASTC_12x10_UNORM_SRGB,
    ASTC_12x12_UNORM,
    ASTC_12x12_UNORM_SRGB,
 
    // 16bpp formats
    B4G4R4A4_UNORM,
    B4G4R4A4_UNORM_SRGB,
    A4B4G4R4_UNORM,
    A4B4G4R4_UNORM_SRGB,
    B5G6R5_UNORM,
    B5G6R5_UNORM_SRGB,
    B5G5R5A1_UNORM,
    B5G5R5A1_UNORM_SRGB,
    B5G5R5X1_UNORM,
    B5G5R5X1_UNORM_SRGB,
    A1B5G5R5_UNORM,
    A1B5G5R5_UNORM_SRGB,
    X1B5G5R5_UNORM,
    X1B5G5R5_UNORM_SRGB,
 
    // Planar formats
    NV12,
 
    NUM_FORMATS,
 
    Default = UNKNOWN
  };
 
  using StorageType = plUInt16;
 
  static const char* GetName(Enum format);
 
  static plUInt32 GetPlaneCount(Enum format);
 
  static plUInt32 GetBitsPerPixel(Enum format, plUInt32 uiPlaneIndex = 0);
 
  static float GetExactBitsPerPixel(Enum format, plUInt32 uiPlaneIndex = 0);
 
  static plUInt32 GetBitsPerBlock(Enum format, plUInt32 uiPlaneIndex = 0);
 
  static plUInt32 GetNumChannels(Enum format);
 
  static plUInt32 GetChannelMask(Enum format, plImageFormatChannel::Enum c);
 
  static plUInt32 GetBitsPerChannel(Enum format, plImageFormatChannel::Enum c);
 
  static plUInt32 GetRedMask(Enum format);
 
  static plUInt32 GetGreenMask(Enum format);
 
  static plUInt32 GetBlueMask(Enum format);
 
  static plUInt32 GetAlphaMask(Enum format);
 
  static plUInt32 GetBlockWidth(Enum format, plUInt32 uiPlaneIndex = 0);
 
  static plUInt32 GetBlockHeight(Enum format, plUInt32 uiPlaneIndex = 0);
 
  static plUInt32 GetBlockDepth(Enum format, plUInt32 uiPlaneIndex = 0);
 
  static plImageFormatDataType::Enum GetDataType(Enum format);
 
  static bool IsCompressed(Enum format);
 
  static bool IsDepth(Enum format);
 
  static bool IsSrgb(Enum format);
 
  static bool IsStencil(Enum format);
 
  static Enum AsSrgb(Enum format);
 
  static Enum AsLinear(Enum format);
 
  static plUInt32 GetNumBlocksX(Enum format, plUInt32 uiWidth, plUInt32 uiPlaneIndex = 0);
 
  static plUInt32 GetNumBlocksY(Enum format, plUInt32 uiHeight, plUInt32 uiPlaneIndex = 0);
 
  static plUInt32 GetNumBlocksZ(Enum format, plUInt32 uiDepth, plUInt32 uiPlaneIndex = 0);
 
  static plUInt64 GetRowPitch(Enum format, plUInt32 uiWidth, plUInt32 uiPlaneIndex = 0);
 
  static plUInt64 GetDepthPitch(Enum format, plUInt32 uiWidth, plUInt32 uiHeight, plUInt32 uiPlaneIndex = 0);
 
  static plImageFormatType::Enum GetType(Enum format);
 
  static plImageFormat::Enum FromPixelMask(
    plUInt32 uiRedMask, plUInt32 uiGreenMask, plUInt32 uiBlueMask, plUInt32 uiAlphaMask, plUInt32 uiBitsPerPixel);
 
  static plImageFormat::Enum GetPlaneSubFormat(plImageFormat::Enum format, plUInt32 uiPlaneIndex);
 
  static bool IsCompatible(Enum left, Enum right);
 
  static bool RequiresFirstLevelBlockAlignment(Enum format);
};
 
PL_DEFINE_AS_POD_TYPE(plImageFormat::Enum);