Files
glitchy-engine-beef/GlitchyEngine/src/Renderer/Format.bf
T

1039 lines
37 KiB
Beef

using System;
using System.Reflection;
namespace GlitchyEngine.Renderer;
struct PixelFormatInfoAttribute : Attribute
{
public FormatInfo Info;
public this(FormatInfo info)
{
Info = info;
}
}
struct GeneratePixelFormatInfoAttribute : Attribute
{
}
// Obvioulsy copy pasted from DirectX
/**
Resource data formats, including fully-typed and typeless formats.
*/
enum Format : uint32
{
/**
The format is not known.
*/
[PixelFormatInfo(default)]
case Unknown = 0,
/**
A four-component, 128-bit typeless format that supports 32 bits per channel including alpha.
*/
R32G32B32A32_Typeless = 1,
/**
A four-component, 128-bit floating-point format that supports 32 bits per channel including alpha.
*/
R32G32B32A32_Float = 2,
/**
A four-component, 128-bit unsigned-integer format that supports 32 bits per channel including alpha.
*/
R32G32B32A32_UInt = 3,
/**
A four-component, 128-bit signed-integer format that supports 32 bits per channel including alpha.
*/
R32G32B32A32_SInt = 4,
/**
A three-component, 96-bit typeless format that supports 32 bits per color channel.
*/
R32G32B32_Typeless = 5,
/**
A three-component, 96-bit floating-point format that supports 32 bits per color channel.
*/
R32G32B32_Float = 6,
/**
A three-component, 96-bit unsigned-integer format that supports 32 bits per color channel.
*/
R32G32B32_UInt = 7,
/**
A three-component, 96-bit signed-integer format that supports 32 bits per color channel.
*/
R32G32B32_SInt = 8,
/**
A four-component, 64-bit typeless format that supports 16 bits per channel including alpha.
*/
R16G16B16A16_Typeless = 9,
/**
A four-component, 64-bit floating-point format that supports 16 bits per channel including alpha.
*/
R16G16B16A16_Float = 10,
/**
A four-component, 64-bit unsigned-normalized-integer format that supports 16 bits per channel including alpha.
*/
R16G16B16A16_UNorm = 11,
/**
A four-component, 64-bit unsigned-integer format that supports 16 bits per channel including alpha.
*/
R16G16B16A16_UInt = 12,
/**
A four-component, 64-bit signed-normalized-integer format that supports 16 bits per channel including alpha.
*/
R16G16B16A16_SNorm = 13,
/**
A four-component, 64-bit signed-integer format that supports 16 bits per channel including alpha.
*/
R16G16B16A16_SInt = 14,
/**
A two-component, 64-bit typeless format that supports 32 bits for the red channel and 32 bits for the green channel.
*/
R32G32_Typeless = 15,
/**
A two-component, 64-bit floating-point format that supports 32 bits for the red channel and 32 bits for the green channel.
*/
R32G32_Float = 16,
/**
A two-component, 64-bit unsigned-integer format that supports 32 bits for the red channel and 32 bits for the green channel.
*/
R32G32_UInt = 17,
/**
A two-component, 64-bit signed-integer format that supports 32 bits for the red channel and 32 bits for the green channel.
*/
R32G32_SInt = 18,
/**
A two-component, 64-bit typeless format that supports 32 bits for the red channel, 8 bits for the green channel, and 24 bits are unused.
*/
R32G8X24_Typeless = 19,
/**
A 32-bit floating-point component, and two unsigned-integer components (with an additional 32 bits). This format supports 32-bit depth, 8-bit stencil, and 24 bits are unused.
*/
D32_Float_S8X24_UInt = 20,
/**
A 32-bit floating-point component, and two typeless components (with an additional 32 bits). This format supports 32-bit red channel, 8 bits are unused, and 24 bits are unused.
*/
R32_Float_X8X24_Typeless = 21,
/**
A 32-bit typeless component, and two unsigned-integer components (with an additional 32 bits). This format has 32 bits unused, 8 bits for green channel, and 24 bits are unused.
*/
X32_Typeless_G8X24_UInt = 22,
/**
A four-component, 32-bit typeless format that supports 10 bits for each color and 2 bits for alpha.
*/
R10G10B10A2_Typeless = 23,
/**
A four-component, 32-bit unsigned-normalized-integer format that supports 10 bits for each color and 2 bits for alpha.
*/
R10G10B10A2_UNorm = 24,
/**
A four-component, 32-bit unsigned-integer format that supports 10 bits for each color and 2 bits for alpha.
*/
R10G10B10A2_UInt = 25,
/**
Three partial-precision floating-point numbers encoded into a single 32-bit value (a variant of s10e5, which is sign bit, 10-bit mantissa, and 5-bit biased (15) exponent).
There are no sign bits, and there is a 5-bit biased (15) exponent for each channel, 6-bit mantissa for R and G, and a 5-bit mantissa for B,
as shown in the illustration: "https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/images/r11g11b10_float.png".
*/
R11G11B10_Float = 26,
/**
A four-component, 32-bit typeless format that supports 8 bits per channel including alpha.
*/
R8G8B8A8_Typeless = 27,
/**
A four-component, 32-bit unsigned-normalized-integer format that supports 8 bits per channel including alpha.
*/
R8G8B8A8_UNorm = 28,
/**
A four-component, 32-bit unsigned-normalized integer sRGB format that supports 8 bits per channel including alpha.
*/
R8G8B8A8_UNorm_SRGB = 29,
/**
A four-component, 32-bit unsigned-integer format that supports 8 bits per channel including alpha.
*/
R8G8B8A8_UInt = 30,
/**
A four-component, 32-bit signed-normalized-integer format that supports 8 bits per channel including alpha.
*/
R8G8B8A8_SNorm = 31,
/**
A four-component, 32-bit signed-integer format that supports 8 bits per channel including alpha.
*/
R8G8B8A8_SInt = 32,
/**
A two-component, 32-bit typeless format that supports 16 bits for the red channel and 16 bits for the green channel.
*/
R16G16_Typeless = 33,
/**
A two-component, 32-bit floating-point format that supports 16 bits for the red channel and 16 bits for the green channel.
*/
R16G16_Float = 34,
/**
A two-component, 32-bit unsigned-normalized-integer format that supports 16 bits each for the green and red channels.
*/
R16G16_UNorm = 35,
/**
A two-component, 32-bit unsigned-integer format that supports 16 bits for the red channel and 16 bits for the green channel.
*/
R16G16_UInt = 36,
/**
A two-component, 32-bit signed-normalized-integer format that supports 16 bits for the red channel and 16 bits for the green channel.
*/
R16G16_SNorm = 37,
/**
A two-component, 32-bit signed-integer format that supports 16 bits for the red channel and 16 bits for the green channel.
*/
R16G16_SInt = 38,
/**
A single-component, 32-bit typeless format that supports 32 bits for the red channel.
*/
R32_Typeless = 39,
/**
A single-component, 32-bit floating-point format that supports 32 bits for depth.
*/
D32_Float = 40,
/**
A single-component, 32-bit floating-point format that supports 32 bits for the red channel.
*/
R32_Float = 41,
/**
A single-component, 32-bit unsigned-integer format that supports 32 bits for the red channel.
*/
R32_UInt = 42,
/**
A single-component, 32-bit signed-integer format that supports 32 bits for the red channel.
*/
R32_SInt = 43,
/**
A two-component, 32-bit typeless format that supports 24 bits for the red channel and 8 bits for the green channel.
*/
R24G8_Typeless = 44,
/**
A 32-bit z-buffer format that supports 24 bits for depth and 8 bits for stencil.
*/
D24_UNorm_S8_UInt = 45,
/**
A 32-bit format, that contains a 24 bit, single-component, unsigned-normalized integer, with an additional typeless 8 bits.
This format has 24 bits red channel and 8 bits unused.
*/
R24_UNorm_X8_Typeless = 46,
/**
A 32-bit format, that contains a 24 bit, single-component, typeless format, with an additional 8 bit unsigned integer component.
This format has 24 bits unused and 8 bits green channel.
*/
X24_Typeless_G8_UInt = 47,
/**
A two-component, 16-bit typeless format that supports 8 bits for the red channel and 8 bits for the green channel.
*/
R8G8_Typeless = 48,
/**
A two-component, 16-bit unsigned-normalized-integer format that supports 8 bits for the red channel and 8 bits for the green channel.
*/
R8G8_UNorm = 49,
/**
A two-component, 16-bit unsigned-integer format that supports 8 bits for the red channel and 8 bits for the green channel.
*/
R8G8_UInt = 50,
/**
A two-component, 16-bit signed-normalized-integer format that supports 8 bits for the red channel and 8 bits for the green channel.
*/
R8G8_SNorm = 51,
/**
A two-component, 16-bit signed-integer format that supports 8 bits for the red channel and 8 bits for the green channel.
*/
R8G8_SInt = 52,
/**
A single-component, 16-bit typeless format that supports 16 bits for the red channel.
*/
R16_Typeless = 53,
/**
A single-component, 16-bit floating-point format that supports 16 bits for the red channel.
*/
R16_Float = 54,
/**
A single-component, 16-bit unsigned-normalized-integer format that supports 16 bits for depth.
*/
D16_UNorm = 55,
/**
A single-component, 16-bit unsigned-normalized-integer format that supports 16 bits for the red channel.
*/
R16_UNorm = 56,
/**
A single-component, 16-bit unsigned-integer format that supports 16 bits for the red channel.
*/
R16_UInt = 57,
/**
A single-component, 16-bit signed-normalized-integer format that supports 16 bits for the red channel.
*/
R16_SNorm = 58,
/**
A single-component, 16-bit signed-integer format that supports 16 bits for the red channel.
*/
R16_SInt = 59,
/**
A single-component, 8-bit typeless format that supports 8 bits for the red channel.
*/
R8_Typeless = 60,
/**
A single-component, 8-bit unsigned-normalized-integer format that supports 8 bits for the red channel.
*/
R8_UNorm = 61,
/**
A single-component, 8-bit unsigned-integer format that supports 8 bits for the red channel.
*/
R8_UInt = 62,
/**
A single-component, 8-bit signed-normalized-integer format that supports 8 bits for the red channel.
*/
R8_SNorm = 63,
/**
A single-component, 8-bit signed-integer format that supports 8 bits for the red channel.
*/
R8_SInt = 64,
/**
A single-component, 8-bit unsigned-normalized-integer format for alpha only.
*/
A8_UNorm = 65,
/**
A single-component, 1-bit unsigned-normalized integer format that supports 1 bit for the red channel.
R1_UNorm is designed specifically for text filtering, and must be used with a format-specific, configurable 8x8 filter mode.
When calling an HLSL sampling function using this format, the address offset parameter must be set to (0,0).
*/
R1_UNorm = 66,
/**
Three partial-precision floating-point numbers encoded into a single 32-bit value all sharing the same 5-bit exponent
(variant of s10e5, which is sign bit, 10-bit mantissa, and 5-bit biased (15) exponent).
There is no sign bit, and there is a shared 5-bit biased (15) exponent and a 9-bit mantissa for each channel,
as shown in the illustration (https://docs.microsoft.com/en-us/windows/win32/api/dxgiformat/images/rgbe.png).
*/
R9G9B9E5_SHAREDEXP = 67,
/**
A four-component, 32-bit unsigned-normalized-integer format.
This packed RGB format is analogous to the UYVY format. Each 32-bit block describes a pair of pixels:
(R8, G8, B8) and (R8, G8, B8) where the R8/B8 values are repeated, and the G8 values are unique to each pixel.
Width must be even.
*/
R8G8_B8G8_UNorm = 68,
/**
A four-component, 32-bit unsigned-normalized-integer format.
This packed RGB format is analogous to the YUY2 format. Each 32-bit block describes a pair of pixels:
(R8, G8, B8) and (R8, G8, B8) where the R8/B8 values are repeated, and the G8 values are unique to each pixel.
Width must be even.
*/
G8R8_G8B8_UNorm = 69,
/**
Four-component typeless block-compression format.
*/
BC1_Typeless = 70,
/**
Four-component block-compression format.
*/
BC1_UNorm = 71,
/**
Four-component block-compression format for sRGB data.
*/
BC1_UNorm_SRGB = 72,
/**
Four-component typeless block-compression format.
*/
BC2_Typeless = 73,
/**
Four-component block-compression format.
*/
BC2_UNorm = 74,
/**
Four-component block-compression format for sRGB data.
*/
BC2_UNorm_SRGB = 75,
/**
Four-component typeless block-compression format.
*/
BC3_Typeless = 76,
/**
Four-component block-compression format.
*/
BC3_UNorm = 77,
/**
Four-component block-compression format for sRGB data.
*/
BC3_UNorm_SRGB = 78,
/**
One-component typeless block-compression format.
*/
BC4_Typeless = 79,
/**
One-component block-compression format.
*/
BC4_UNorm = 80,
/**
One-component block-compression format.
*/
BC4_SNorm = 81,
/**
Two-component typeless block-compression format.
*/
BC5_Typeless = 82,
/**
Two-component block-compression format.
*/
BC5_UNorm = 83,
/**
Two-component block-compression format.
*/
BC5_SNorm = 84,
/**
A three-component, 16-bit unsigned-normalized-integer format that supports 5 bits for blue, 6 bits for green, and 5 bits for red.
Direct3D 10 through Direct3D 11: This value is defined for DXGI.
However, Direct3D 10, 10.1, or 11 devices do not support this format.
Direct3D 11.1: This value is not supported until Windows 8.
*/
B5G6R5_UNorm = 85,
/**
A four-component, 16-bit unsigned-normalized-integer format that supports 5 bits for each color channel and 1-bit alpha.
Direct3D 10 through Direct3D 11: This value is defined for DXGI.
However, Direct3D 10, 10.1, or 11 devices do not support this format.
Direct3D 11.1: This value is not supported until Windows 8.
*/
B5G5R5A1_UNorm = 86,
/**
A four-component, 32-bit unsigned-normalized-integer format that supports 8 bits for each color channel and 8-bit alpha.
*/
B8G8R8A8_UNorm = 87,
/**
A four-component, 32-bit unsigned-normalized-integer format that supports 8 bits for each color channel and 8 bits unused.
*/
B8G8R8X8_UNorm = 88,
/**
A four-component, 32-bit 2.8-biased fixed-point format that supports 10 bits for each color channel and 2-bit alpha.
*/
R10G10B10_XR_BIAS_A2_UNorm = 89,
/**
A four-component, 32-bit typeless format that supports 8 bits for each channel including alpha.
*/
B8G8R8A8_Typeless = 90,
/**
A four-component, 32-bit unsigned-normalized standard RGB format that supports 8 bits for each channel including alpha.
*/
B8G8R8A8_UNorm_SRGB = 91,
/**
A four-component, 32-bit typeless format that supports 8 bits for each color channel, and 8 bits are unused.
*/
B8G8R8X8_Typeless = 92,
/**
A four-component, 32-bit unsigned-normalized standard RGB format that supports 8 bits for each color channel, and 8 bits are unused.
*/
B8G8R8X8_UNorm_SRGB = 93,
/**
A typeless block-compression format.
*/
BC6H_Typeless = 94,
/**
A block-compression format.
*/
BC6H_UF16 = 95,
/**
A block-compression format.
*/
BC6H_SF16 = 96,
/**
A typeless block-compression format.
*/
BC7_Typeless = 97,
/**
A block-compression format.
*/
BC7_UNorm = 98,
/**
A block-compression format.
*/
BC7_UNorm_SRGB = 99,
/**
Most common YUV 4:4:4 video resource format. Valid view formats for this video resource format are DXGI_FORMAT_R8G8B8A8_UNORM
and DXGI_FORMAT_R8G8B8A8_UINT. For UAVs, an additional valid view format is DXGI_FORMAT_R32_UINT. By using DXGI_FORMAT_R32_UINT for UAVs, you can both read and write as opposed to just write for DXGI_FORMAT_R8G8B8A8_UNORM and DXGI_FORMAT_R8G8B8A8_UINT. Supported view types are SRV, RTV, and UAV. One view provides a straightforward mapping of the entire surface. The mapping to the view channel is V->R8,
U->G8,
Y->B8,
and A->A8.
Direct3D 11.1: This value is not supported until Windows 8.
*/
AYUV = 100,
/**
10-bit per channel packed YUV 4:4:4 video resource format. Valid view formats for this video resource format are
DXGI_FORMAT_R10G10B10A2_UNORM and DXGI_FORMAT_R10G10B10A2_UINT. For UAVs, an additional valid view format is DXGI_FORMAT_R32_UINT. By using DXGI_FORMAT_R32_UINT for UAVs, you can both read and write as opposed to just write for DXGI_FORMAT_R10G10B10A2_UNORM and DXGI_FORMAT_R10G10B10A2_UINT. Supported view types are SRV and UAV. One view provides a straightforward mapping of the entire surface. The mapping to the view channel is U->R10,
Y->G10,
V->B10,
and A->A2.
Direct3D 11.1: This value is not supported until Windows 8.
*/
Y410 = 101,
/**
16-bit per channel packed YUV 4:4:4 video resource format. Valid view formats for this video resource format are
DXGI_FORMAT_R16G16B16A16_UNORM and DXGI_FORMAT_R16G16B16A16_UINT. Supported view types are SRV and UAV.
One view provides a straightforward mapping of the entire surface. The mapping to the view channel is U->R16,
Y->G16,
V->B16,
and A->A16.
Direct3D 11.1: This value is not supported until Windows 8.
*/
Y416 = 102,
/**
Most common YUV 4:2:0 video resource format. Valid luminance data view formats for this video resource format are
DXGI_FORMAT_R8_UNORM and DXGI_FORMAT_R8_UINT. Valid chrominance data view formats
(width and height are each 1/2 of luminance view) for this video resource format are
DXGI_FORMAT_R8G8_UNORM and DXGI_FORMAT_R8G8_UINT. Supported view types are SRV, RTV, and UAV.
For luminance data view, the mapping to the view channel is Y->R8. For chrominance data view,
the mapping to the view channel is U->R8 and V->G8.
Width and height must be even. Direct3D 11 staging resources and initData parameters for this format use
(rowPitch * (height + (height / 2))) bytes. The first (SysMemPitch * height) bytes are the Y plane,
the remaining (SysMemPitch * (height / 2)) bytes are the UV plane.
An app using the YUY 4:2:0 formats must map the luma (Y) plane separately from the chroma (UV) planes.
Developers do this by calling ID3D12Device::CreateShaderResourceView twice for the same texture and passing in
1-channel and 2-channel formats. Passing in a 1-channel format compatible with the Y plane maps only the Y plane.
Passing in a 2-channel format compatible with the UV planes (together) maps only the U and V planes as a single resource view.
Direct3D 11.1: This value is not supported until Windows 8.
*/
NV12 = 103,
/**
10-bit per channel planar YUV 4:2:0 video resource format. Valid luminance data view formats for this video resource
format are DXGI_FORMAT_R16_UNORM and DXGI_FORMAT_R16_UINT. The runtime does not enforce whether the lowest 6 bits are 0
(given that this video resource format is a 10-bit format that uses 16 bits). If required, application shader code would
have to enforce this manually. From the runtime's point of view, DXGI_FORMAT_P010 is no different than DXGI_FORMAT_P016.
Valid chrominance data view formats (width and height are each 1/2 of luminance view) for this video resource format are
DXGI_FORMAT_R16G16_UNORM and DXGI_FORMAT_R16G16_UINT. For UAVs, an additional valid chrominance data view format is
DXGI_FORMAT_R32_UINT. By using DXGI_FORMAT_R32_UINT for UAVs, you can both read and write as opposed to just write for
DXGI_FORMAT_R16G16_UNORM and DXGI_FORMAT_R16G16_UINT. Supported view types are SRV, RTV, and UAV. For luminance data view,
the mapping to the view channel is Y->R16. For chrominance data view, the mapping to the view channel is U->R16 and V->G16.
Width and height must be even. Direct3D 11 staging resources and initData parameters for this format use
(rowPitch * (height + (height / 2))) bytes. The first (SysMemPitch * height) bytes are the Y plane, the remaining
(SysMemPitch * (height / 2)) bytes are the UV plane.
An app using the YUY 4:2:0 formats must map the luma (Y) plane separately from the chroma (UV) planes. Developers do
this by calling ID3D12Device::CreateShaderResourceView twice for the same texture and passing in 1-channel and 2-channel formats.
Passing in a 1-channel format compatible with the Y plane maps only the Y plane.
Passing in a 2-channel format compatible with the UV planes (together) maps only the U and V planes as a single resource view.
Direct3D 11.1: This value is not supported until Windows 8.
*/
P010 = 104,
/**
16-bit per channel planar YUV 4:2:0 video resource format. Valid luminance data view formats for this video resource
format are DXGI_FORMAT_R16_UNORM and DXGI_FORMAT_R16_UINT. Valid chrominance data view formats
(width and height are each 1/2 of luminance view) for this video resource format are DXGI_FORMAT_R16G16_UNORM and
DXGI_FORMAT_R16G16_UINT. For UAVs, an additional valid chrominance data view format is DXGI_FORMAT_R32_UINT.
By using DXGI_FORMAT_R32_UINT for UAVs, you can both read and write as opposed to just write for DXGI_FORMAT_R16G16_UNORM and
DXGI_FORMAT_R16G16_UINT. Supported view types are SRV, RTV, and UAV. For luminance data view, the mapping to the view channel
is Y->R16. For chrominance data view, the mapping to the view channel is U->R16 and V->G16.
Width and height must be even. Direct3D 11 staging resources and initData parameters for this format use
(rowPitch * (height + (height / 2))) bytes. The first (SysMemPitch * height) bytes are the Y plane, the
remaining (SysMemPitch * (height / 2)) bytes are the UV plane.
An app using the YUY 4:2:0 formats must map the luma (Y) plane separately from the chroma (UV) planes.
Developers do this by calling ID3D12Device::CreateShaderResourceView twice for the same texture and passing in
1-channel and 2-channel formats. Passing in a 1-channel format compatible with the Y plane maps only the Y plane.
Passing in a 2-channel format compatible with the UV planes (together) maps only the U and V planes as a single resource view.
Direct3D 11.1: This value is not supported until Windows 8.
*/
P016 = 105,
/**
8-bit per channel planar YUV 4:2:0 video resource format. This format is subsampled where each pixel has its own Y value,
but each 2x2 pixel block shares a single U and V value. The runtime requires that the width and height of all resources
that are created with this format are multiples of 2. The runtime also requires that the left, right, top, and bottom
members of any RECT that are used for this format are multiples of 2. This format differs from DXGI_FORMAT_NV12 in that
the layout of the data within the resource is completely opaque to applications. Applications cannot use the CPU to map
the resource and then access the data within the resource. You cannot use shaders with this format. Because of this behavior,
legacy hardware that supports a non-NV12 4:2:0 layout (for example, YV12, and so on) can be used. Also, new hardware that has
a 4:2:0 implementation better than NV12 can be used when the application does not need the data to be in a standard layout.
Width and height must be even. Direct3D 11 staging resources and initData parameters for this format use
(rowPitch * (height + (height / 2))) bytes.
An app using the YUY 4:2:0 formats must map the luma (Y) plane separately from the chroma (UV) planes.
Developers do this by calling ID3D12Device::CreateShaderResourceView twice for the same texture and passing
in 1-channel and 2-channel formats. Passing in a 1-channel format compatible with the Y plane maps only the Y plane.
Passing in a 2-channel format compatible with the UV planes (together) maps only the U and V planes as a single resource view.
Direct3D 11.1: This value is not supported until Windows 8.
*/
OPAQUE_420 = 106,
/**
Most common YUV 4:2:2 video resource format. Valid view formats for this video resource format are DXGI_FORMAT_R8G8B8A8_UNORM
and DXGI_FORMAT_R8G8B8A8_UINT. For UAVs, an additional valid view format is DXGI_FORMAT_R32_UINT. By using DXGI_FORMAT_R32_UINT
for UAVs, you can both read and write as opposed to just write for DXGI_FORMAT_R8G8B8A8_UNORM and DXGI_FORMAT_R8G8B8A8_UINT.
Supported view types are SRV and UAV. One view provides a straightforward mapping of the entire surface. The mapping to the
view channel is Y0->R8, U0->G8, Y1->B8, and V0->A8.
A unique valid view format for this video resource format is DXGI_FORMAT_R8G8_B8G8_UNORM. With this view format,
the width of the view appears to be twice what the DXGI_FORMAT_R8G8B8A8_UNORM or DXGI_FORMAT_R8G8B8A8_UINT
view would be when hardware reconstructs RGBA automatically on read and before filtering.
This Direct3D hardware behavior is legacy and is likely not useful any more. With this view format,
the mapping to the view channel is Y0->R8, U0->G8[0], Y1->B8, and V0->G8[1].
For more info about YUV formats for video rendering, see Recommended 8-Bit YUV Formats for Video Rendering.
Width must be even.
Direct3D 11.1: This value is not supported until Windows 8.
*/
YUY2 = 107,
/**
10-bit per channel packed YUV 4:2:2 video resource format. Valid view formats for this video resource format are
DXGI_FORMAT_R16G16B16A16_UNORM and DXGI_FORMAT_R16G16B16A16_UINT. The runtime does not enforce whether the lowest
6 bits are 0 (given that this video resource format is a 10-bit format that uses 16 bits). If required, application
shader code would have to enforce this manually. From the runtime's point of view, DXGI_FORMAT_Y210 is no different
than DXGI_FORMAT_Y216. Supported view types are SRV and UAV. One view provides a straightforward mapping of the entire
surface. The mapping to the view channel is Y0->R16, U->G16, Y1->B16, and V->A16.
Width must be even.
Direct3D 11.1: This value is not supported until Windows 8.
*/
Y210 = 108,
/**
16-bit per channel packed YUV 4:2:2 video resource format. Valid view formats for this video resource format are
DXGI_FORMAT_R16G16B16A16_UNORM and DXGI_FORMAT_R16G16B16A16_UINT. Supported view types are SRV and UAV.
One view provides a straightforward mapping of the entire surface. The mapping to the view channel is Y0->R16,
U->G16, Y1->B16, and V->A16.
Width must be even.
Direct3D 11.1: This value is not supported until Windows 8.
*/
Y216 = 109,
/**
Most common planar YUV 4:1:1 video resource format. Valid luminance data view formats for this video resource format are
DXGI_FORMAT_R8_UNORM and DXGI_FORMAT_R8_UINT. Valid chrominance data view formats
(width and height are each 1/4 of luminance view) for this video resource format are DXGI_FORMAT_R8G8_UNORM and
DXGI_FORMAT_R8G8_UINT. Supported view types are SRV, RTV, and UAV. For luminance data view, the mapping to the view
channel is Y->R8. For chrominance data view, the mapping to the view channel is U->R8 and V->G8.
Width must be a multiple of 4. Direct3D11 staging resources and initData parameters for this format use
(rowPitch * height * 2) bytes. The first (SysMemPitch * height) bytes are the Y plane, the next
((SysMemPitch / 2) * height) bytes are the UV plane, and the remainder is padding.
Direct3D 11.1: This value is not supported until Windows 8.
*/
NV11 = 110,
/**
4-bit palletized YUV format that is commonly used for DVD subpicture.
Direct3D 11.1: This value is not supported until Windows 8.
*/
AI44 = 111,
/**
4-bit palletized YUV format that is commonly used for DVD subpicture.
Direct3D 11.1: This value is not supported until Windows 8.
*/
IA44 = 112,
/**
8-bit palletized format that is used for palletized RGB data when the processor processes ISDB-T data and
for palletized YUV data when the processor processes BluRay data.
Direct3D 11.1: This value is not supported until Windows 8.
*/
P8 = 113,
/**
8-bit palletized format with 8 bits of alpha that is used for palletized YUV data when the processor processes BluRay data.
Direct3D 11.1: This value is not supported until Windows 8.
*/
A8P8 = 114,
/**
A four-component, 16-bit unsigned-normalized integer format that supports 4 bits for each channel including alpha.
Direct3D 11.1: This value is not supported until Windows 8.
*/
B4G4R4A4_UNORM = 115,
/**
A video format; an 8-bit version of a hybrid planar 4:2:2 format.
*/
P208 = 130,
/**
An 8 bit YCbCrA 4:4 rendering format.
*/
V208 = 131,
/**
An 8 bit YCbCrA 4:4:4:4 rendering format.
*/
V408 = 132,
/**
Forces this enumeration to compile to 32 bits in size.
Without this value, some compilers would allow this enumeration to compile to a
size other than 32 bits. This value is not used.
*/
FORCE_UInt = 0XFFFFFFFF;
public static implicit operator DirectX.DXGI.Format(Format format)
{
return (DirectX.DXGI.Format)(uint32)format;
}
public bool IsInt()
{
switch(this)
{
case R32G32B32A32_SInt, R32G32B32_SInt, R16G16B16A16_SInt, R32G32_SInt, R8G8B8A8_SInt, R16G16_SInt,
R32_SInt, R8G8_SInt, R16_SInt, R8_SInt:
return true;
default:
return false;
}
}
public bool IsUInt()
{
switch(this)
{
case R32G32B32A32_UInt, R32G32B32_UInt, R16G16B16A16_UInt, R32G32_UInt, R10G10B10A2_UInt, R8G8B8A8_UInt, R16G16_UInt,
R32_UInt, R8G8_UInt, R16_UInt, R8_UInt:
return true;
default:
return false;
}
}
public uint32 BitsPerPixel()
{
switch (this)
{
case .R32G32B32A32_Typeless,.R32G32B32A32_Float,.R32G32B32A32_UInt,.R32G32B32A32_SInt:
return 128;
case .R32G32B32_Typeless,.R32G32B32_Float,.R32G32B32_UInt,.R32G32B32_SInt:
return 96;
case .R16G16B16A16_Typeless,.R16G16B16A16_Float,.R16G16B16A16_UNorm,.R16G16B16A16_UInt,.R16G16B16A16_SNorm,.R16G16B16A16_SInt,.R32G32_Typeless,.R32G32_Float,.R32G32_UInt,.R32G32_SInt,.R32G8X24_Typeless,.D32_Float_S8X24_UInt,.R32_Float_X8X24_Typeless,.X32_Typeless_G8X24_UInt,.Y416,.Y210,.Y216:
return 64;
case .R10G10B10A2_Typeless,.R10G10B10A2_UNorm,.R10G10B10A2_UInt,.R11G11B10_Float,.R8G8B8A8_Typeless,.R8G8B8A8_UNorm,.R8G8B8A8_UNorm_SRGB,.R8G8B8A8_UInt,.R8G8B8A8_SNorm,.R8G8B8A8_SInt,.R16G16_Typeless,.R16G16_Float,.R16G16_UNorm,.R16G16_UInt,.R16G16_SNorm,.R16G16_SInt,.R32_Typeless,.D32_Float,.R32_Float,.R32_UInt,.R32_SInt,.R24G8_Typeless,.D24_UNorm_S8_UInt,.R24_UNorm_X8_Typeless,.X24_Typeless_G8_UInt,.R9G9B9E5_SHAREDEXP,.R8G8_B8G8_UNorm,.G8R8_G8B8_UNorm,.B8G8R8A8_UNorm,.B8G8R8X8_UNorm,.R10G10B10_XR_BIAS_A2_UNorm,.B8G8R8A8_Typeless,.B8G8R8A8_UNorm_SRGB,.B8G8R8X8_Typeless,.B8G8R8X8_UNorm_SRGB,.AYUV,.Y410,.YUY2:
//#if (defined(_XBOX_ONE) && defined(_TITLE)) || defined(_GAMING_XBOX)
//case .R10G10B10_7E3_A2_Float,.R10G10B10_6E4_A2_Float,.R10G10B10_SNorm_A2_UNorm:
//#endif
return 32;
case .P010,.P016, .V408:
/*#if (_WIN32_WINNT >= _WIN32_WINNT_WIN10)
case .V408:
#endif
#if (defined(_XBOX_ONE) && defined(_TITLE)) || defined(_GAMING_XBOX)
case .D16_UNorm_S8_UInt,.R16_UNorm_X8_Typeless,.X16_Typeless_G8_UInt:
#endif*/
return 24;
case .R8G8_Typeless,.R8G8_UNorm,.R8G8_UInt,.R8G8_SNorm,.R8G8_SInt,.R16_Typeless,.R16_Float,.D16_UNorm,.R16_UNorm,.R16_UInt,.R16_SNorm,.R16_SInt,.B5G6R5_UNorm,.B5G5R5A1_UNorm,.A8P8,.B4G4R4A4_UNORM, .P208,.V208:
/*#if (_WIN32_WINNT >= _WIN32_WINNT_WIN10)
case .P208,.V208:
#endif*/
return 16;
case .NV12,.OPAQUE_420,.NV11:
return 12;
case .R8_Typeless,.R8_UNorm,.R8_UInt,.R8_SNorm,.R8_SInt,.A8_UNorm,.BC2_Typeless,.BC2_UNorm,.BC2_UNorm_SRGB,.BC3_Typeless,.BC3_UNorm,.BC3_UNorm_SRGB,.BC5_Typeless,.BC5_UNorm,.BC5_SNorm,.BC6H_Typeless,.BC6H_UF16,.BC6H_SF16,.BC7_Typeless,.BC7_UNorm,.BC7_UNorm_SRGB,.AI44,.IA44,.P8:
/*#if (defined(_XBOX_ONE) && defined(_TITLE)) || defined(_GAMING_XBOX)
case .R4G4_UNorm:
#endif*/
return 8;
case .R1_UNorm:
return 1;
case .BC1_Typeless,.BC1_UNorm,.BC1_UNorm_SRGB,.BC4_Typeless,.BC4_UNorm,.BC4_SNorm:
return 4;
//case .Unknown,.FORCE_UInt:
default:
return 0;
}
}
/// Returns the SRGB-Format for the given Format, or the Format itself, if no SRGB-variant exists.
public Format GetSRGB()
{
switch (this)
{
case .BC1_UNorm:
return .BC1_UNorm_SRGB;
case .BC2_UNorm:
return .BC2_UNorm_SRGB;
case .BC3_UNorm:
return .BC3_UNorm_SRGB;
case .BC7_UNorm:
return .BC7_UNorm_SRGB;
case .R8G8B8A8_UNorm:
return .R8G8B8A8_UNorm_SRGB;
case .B8G8R8A8_UNorm:
return .B8G8R8A8_UNorm_SRGB;
case .B8G8R8X8_UNorm:
return .B8G8R8X8_UNorm_SRGB;
default:
return this;
}
}
/// Returns the non-SRGB-Format for the given Format.
public Format GetNonSRGB()
{
switch (this)
{
case .BC1_UNorm_SRGB:
return .BC1_UNorm;
case .BC2_UNorm_SRGB:
return .BC2_UNorm;
case .BC3_UNorm_SRGB:
return .BC3_UNorm;
case .BC7_UNorm_SRGB:
return .BC7_UNorm;
case .R8G8B8A8_UNorm_SRGB:
return .R8G8B8A8_UNorm;
case .B8G8R8A8_UNorm_SRGB:
return .B8G8R8A8_UNorm;
case .B8G8R8X8_UNorm_SRGB:
return .B8G8R8X8_UNorm;
default:
return this;
}
}
//[OnCompile(.TypeInit), Comptime]
/*
private static void GenerateGetFormatInfo()
{
Type type = typeof(Self);
String emit = new String();
emit.Append("""
public FormatInfo GetFormatInfo()
{
switch(this)
{
""");
for (FieldInfo field in type.GetFields())
{
if (!field.[Friend]mFieldData.mFlags.HasFlag(.EnumCase))
continue;
Result<FormatInfo> formatResult = GetInfoInternal(field.Name);
if (formatResult case .Err)
continue;
FormatInfo format = formatResult.Value;
emit.AppendF($"""
case .{field.Name}:
FormatInfo info{field.Name} = default;
info{field.Name}.ComponentCount = {format.ComponentCount};
""");
for (int i < format.ComponentCount)
{
ComponentInfo component = format.Components[i];
emit.AppendF($"""
info{field.Name}.Components[{i}] = .("{component.Name}", {component.BitSize}, ComponentDataType.{component.DataType}, {component.IsSrgb ? "true" : "false"}, {component.BitOffset});
""");
}
emit.AppendF($"""
return info{field.Name};
""");
}
emit.Append("""
default:
return default;
}
}
""");
Compiler.EmitTypeBody(typeof(Self), emit);
}
*/
[Comptime]
private static Result<FormatInfo> GetInfoInternal(StringView name)
{
FormatInfo info = default;
// 0->Name, 1->Size
int decodeState = 0;
StringView componentName = default;
StringView componentSize = default;
int contextStart = 0;
int totalBitSize = 0;
for (char8 c in name)
{
if (c.IsLetter)
{
if (decodeState != 0 || componentName.IsEmpty)
{
decodeState = 0;
if (!componentName.IsEmpty)
{
if (info.ComponentCount >= 4)
{
return .Err;
}
ComponentInfo componentInfo = .(componentName, Try!(int.Parse(componentSize)), .Typeless, false, totalBitSize);
info.Components[info.ComponentCount] = componentInfo;
info.ComponentCount++;
totalBitSize += componentInfo.BitSize;
componentName = default;
}
componentName = name.Substring(@c.Index, 1);
}
else
{
componentName.Length += 1;
}
if (componentName.Equals("srgb", true))
{
for (int i = contextStart; i < info.ComponentCount; i++)
{
info.Components[i].IsSrgb = true;
}
componentName = default;
}
else if (componentName.Equals("typeless", true))
{
for (int i = contextStart; i < info.ComponentCount; i++)
{
info.Components[i].DataType = .Typeless;
}
componentName = default;
}
else if (componentName.Equals("float", true))
{
for (int i = contextStart; i < info.ComponentCount; i++)
{
info.Components[i].DataType = .Float;
}
componentName = default;
}
else if (componentName.Equals("uint", true))
{
for (int i = contextStart; i < info.ComponentCount; i++)
{
info.Components[i].DataType = .UInt;
}
componentName = default;
}
else if (componentName.Equals("sint", true))
{
for (int i = contextStart; i < info.ComponentCount; i++)
{
info.Components[i].DataType = .SInt;
}
componentName = default;
}
else if (componentName.Equals("unorm", true))
{
for (int i = contextStart; i < info.ComponentCount; i++)
{
info.Components[i].DataType = .UNorm;
}
componentName = default;
}
else if (componentName.Equals("snorm", true))
{
for (int i = contextStart; i < info.ComponentCount; i++)
{
info.Components[i].DataType = .SNorm;
}
componentName = default;
}
}
else if (c.IsDigit)
{
if (decodeState == 0)
{
decodeState = 1;
componentSize = name.Substring(@c.Index, 1);
}
else
{
componentSize.Length += 1;
}
}
else if (c == '_')
{
decodeState = 2;
}
}
return info;
}
}
struct FormatInfo
{
public int ComponentCount;
public ComponentInfo[4] Components;
public this(int componentCount, ComponentInfo[4] components)
{
ComponentCount = componentCount;
Components = components;
}
}
struct ComponentInfo
{
public StringView Name;
public int BitSize;
public ComponentDataType DataType;
public bool IsSrgb;
public int BitOffset;
public this(StringView name, int bitSize, ComponentDataType dataType, bool isSrgb, int bitOffset)
{
Name = name;
BitSize = bitSize;
DataType = dataType;
IsSrgb = isSrgb;
BitOffset = bitOffset;
}
}
enum ComponentDataType
{
/// The type wasn't specified, just some bits.
Typeless,
Float,
UInt,
SInt,
UNorm,
SNorm
}