summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorlucy96chen <47800040+lucy96chen@users.noreply.github.com>2021-10-26 16:30:59 -0700
committerGitHub <noreply@github.com>2021-10-26 16:30:59 -0700
commitdcc2b854a64b3e4e890215ff21cf4b219724f524 (patch)
treefe958a184f46f4a1bbf10f6c7174d31283df76dc /docs
parentfe6d5f1cf8865567e08cf210a2639ffde2886fc3 (diff)
Expanded gfx::Format to include additional formats (#1982)
* Format list updated with additional formats supported by both D3D and Vulkan; D3DUtil::getMapFormat() and VkUtil::getVkFormat() updated to include additional formats; GFX_FORMAT() updated with all additional formats (BC compression unfinished) * Finished updating GFX_FORMAT with newly added formats and sizes; Pixel size is now tracked using the FormatPixelSize struct containing the values for bytes per block and pixels per block to accomodate BC formats; Updated gfxGetFormatSize and associated sub-calls to return FormatPixelSize instead of uint8_t; Most calls to gfxGetFormatSize() updated to reflect changes, a couple calls still unupdated * Changes to accommodate new formats finished, debugging slang-literal unit test * First format unit test working * One test added for BC1Unorm and RGBA8Unorm_SRGB, both passing * Refactored format testing code to merge BC1Unorm and RGBA8Unorm SRGB into a single file * All unit tests added for BC and Srgb formats * Most tests added and working; Added five additional formats (still need tests) and made the appropriate changes to support these; createTextureView() modified for D3D11, D3D12, and Vulkan to take into account the format specified in the texture view desc when the texture's format is typeless * Format enums renamed to more closely match their D3D counterparts; Added a universal float and uint buffer and buffer view for use across all Format tests * Remaining tests added; D3D12 tests pass, but Vulkan crashes in BC1_UNORM and D3D11 spits out a bunch of D3D11 Errors (but supposedly passes) * re-run premake * Added Sint versions of test shaders; Vulkan and D3D11 tests also pass * Size struct for format unit tests no longer use initializer lists * Fixed a Size struct missed in the previous pass * Fixed minor bugs causing tests to fail * Added documentation detailing all currently unsupported formats * Skip tests causing unsupported format warnings due to swiftshader * updated several test using old Format enum names * Revert change to compareComputeResult() that was added for debugging purposes * DEBUGGING: Added prints to identify which formats are failing on CI * Reverted attempted debugging changes; Fixed texture2d-gather.hlsl to use updated Format enums * Fixed incorrect array sizes in d3d11 _initSrvDesc() * Commented out further tests that produce unexpected results when tested for Vulkan with swiftshader * Revert "Merge branch 'expanded-format-support' of https://github.com/lucy96chen/slang into expanded-format-support" This reverts commit 20008f0d3ecc3b1405ecac8c138edaa3cd37ed6b, reversing changes made to 6081e95827315fee50e18409394d5abd62fac787. * Added a fuzzy comparison function for use with floats * submodule update * Revert messed up changes caused by previous revert after automatically merging on github
Diffstat (limited to 'docs')
-rw-r--r--docs/gfx-user-guide/unsupported-formats.md264
1 files changed, 264 insertions, 0 deletions
diff --git a/docs/gfx-user-guide/unsupported-formats.md b/docs/gfx-user-guide/unsupported-formats.md
new file mode 100644
index 000000000..a7a51e20d
--- /dev/null
+++ b/docs/gfx-user-guide/unsupported-formats.md
@@ -0,0 +1,264 @@
+Unsupported Formats
+======================
+GFX currently does not support the following listed D3D and Vulkan formats. With the exception of D24_UNORM_S8_UINT, these formats have been omitted as their counterpart API does not have a corresponding format. D24_UNORM_S8_UINT has been omitted as it is only supported by Nvidia.
+
+DXGI_FORMAT_R32G8X24_TYPELESS \
+DXGI_FORMAT_D32_FLOAT_S8X24_UINT \
+DXGI_FORMAT_R32_FLOAT_X8X24_TYPELESS \
+DXGI_FORMAT_X32_TYPELESS_G8X24_UINT \
+DXGI_FORMAT_R24G8_TYPELESS \
+DXGI_FORMAT_D24_UNORM_S8_UINT \
+DXGI_FORMAT_R24_UNORM_X8_TYPELESS \
+DXGI_FORMAT_X24_TYPELESS_G8_UINT \
+DXGI_FORMAT_A8_UNORM \
+DXGI_FORMAT_R1_UNORM \
+DXGI_FORMAT_R8G8_B8G8_UNORM \
+DXGI_FORMAT_G8R8_G8B8_UNORM \
+DXGI_FORMAT_BC1_TYPELESS \
+DXGI_FORMAT_BC2_TYPELESS \
+DXGI_FORMAT_BC3_TYPELESS \
+DXGI_FORMAT_BC4_TYPELESS \
+DXGI_FORMAT_BC5_TYPELESS \
+DXGI_FORMAT_B8G8R8X8_UNORM \
+DXGI_FORMAT_R10G10B10_XR_BIAS_A2_UNORM \
+DXGI_FORMAT_B8G8R8X8_TYPELESS \
+DXGI_FORMAT_B8G8R8X8_UNORM_SRGB \
+DXGI_FORMAT_BC6H_TYPELESS \
+DXGI_FORMAT_BC7_TYPELESS \
+DXGI_FORMAT_AYUV \
+DXGI_FORMAT_Y410 \
+DXGI_FORMAT_Y416 \
+DXGI_FORMAT_NV12 \
+DXGI_FORMAT_P010 \
+DXGI_FORMAT_P016 \
+DXGI_FORMAT_420_OPAQUE \
+DXGI_FORMAT_YUY2 \
+DXGI_FORMAT_Y210 \
+DXGI_FORMAT_Y216 \
+DXGI_FORMAT_NV11 \
+DXGI_FORMAT_AI44 \
+DXGI_FORMAT_IA44 \
+DXGI_FORMAT_P8 \
+DXGI_FORMAT_A8P8 \
+DXGI_FORMAT_P208 \
+DXGI_FORMAT_V208 \
+DXGI_FORMAT_V408 \
+DXGI_FORMAT_SAMPLER_FEEDBACK_MIN_MIP_OPAQUE \
+DXGI_FORMAT_SAMPLER_FEEDBACK_MIP_REGION_USED_OPAQUE \
+
+VK_FORMAT_R4G4_UNORM_PACK8 \
+VK_FORMAT_R4G4B4A4_UNORM_PACK16 \
+VK_FORMAT_B4G4R4A4_UNORM_PACK16 \
+VK_FORMAT_B5G6R5_UNORM_PACK16 \
+VK_FORMAT_R5G5B5A1_UNORM_PACK16 \
+VK_FORMAT_B5G5R5A1_UNORM_PACK16 \
+VK_FORMAT_R8_USCALED \
+VK_FORMAT_R8_SSCALED \
+VK_FORMAT_R8_SRGB \
+VK_FORMAT_R8G8_USCALED \
+VK_FORMAT_R8G8_SSCALED \
+VK_FORMAT_R8G8_SRGB \
+VK_FORMAT_R8G8B8_UNORM \
+VK_FORMAT_R8G8B8_SNORM \
+VK_FORMAT_R8G8B8_USCALED \
+VK_FORMAT_R8G8B8_SSCALED \
+VK_FORMAT_R8G8B8_UINT \
+VK_FORMAT_R8G8B8_SINT \
+VK_FORMAT_R8G8B8_SRGB \
+VK_FORMAT_B8G8R8_UNORM \
+VK_FORMAT_B8G8R8_SNORM \
+VK_FORMAT_B8G8R8_USCALED \
+VK_FORMAT_B8G8R8_SSCALED \
+VK_FORMAT_B8G8R8_UINT \
+VK_FORMAT_B8G8R8_SINT \
+VK_FORMAT_B8G8R8_SRGB \
+VK_FORMAT_R8G8B8A8_USCALED \
+VK_FORMAT_R8G8B8A8_SSCALED \
+VK_FORMAT_B8G8R8A8_SNORM \
+VK_FORMAT_B8G8R8A8_USCALED \
+VK_FORMAT_B8G8R8A8_SSCALED \
+VK_FORMAT_B8G8R8A8_UINT \
+VK_FORMAT_B8G8R8A8_SINT \
+VK_FORMAT_B8G8R8A8_SRGB \
+VK_FORMAT_A8B8G8R8_UNORM_PACK32 \
+VK_FORMAT_A8B8G8R8_SNORM_PACK32 \
+VK_FORMAT_A8B8G8R8_USCALED_PACK32 \
+VK_FORMAT_A8B8G8R8_SSCALED_PACK32 \
+VK_FORMAT_A8B8G8R8_UINT_PACK32 \
+VK_FORMAT_A8B8G8R8_SINT_PACK32 \
+VK_FORMAT_A8B8G8R8_SRGB_PACK32 \
+VK_FORMAT_A2R10G10B10_UNORM_PACK32 \
+VK_FORMAT_A2R10G10B10_SNORM_PACK32 \
+VK_FORMAT_A2R10G10B10_USCALED_PACK32 \
+VK_FORMAT_A2R10G10B10_SSCALED_PACK32 \
+VK_FORMAT_A2R10G10B10_UINT_PACK32 \
+VK_FORMAT_A2R10G10B10_SINT_PACK32 \
+VK_FORMAT_A2B10G10R10_SNORM_PACK32 \
+VK_FORMAT_A2B10G10R10_USCALED_PACK32 \
+VK_FORMAT_A2B10G10R10_SSCALED_PACK32 \
+VK_FORMAT_A2B10G10R10_SINT_PACK32 \
+VK_FORMAT_R16_USCALED \
+VK_FORMAT_R16_SSCALED \
+VK_FORMAT_R16G16_USCALED \
+VK_FORMAT_R16G16_SSCALED \
+VK_FORMAT_R16G16B16_UNORM \
+VK_FORMAT_R16G16B16_SNORM \
+VK_FORMAT_R16G16B16_USCALED \
+VK_FORMAT_R16G16B16_SSCALED \
+VK_FORMAT_R16G16B16_UINT \
+VK_FORMAT_R16G16B16_SINT \
+VK_FORMAT_R16G16B16_SFLOAT \
+VK_FORMAT_R16G16B16A16_USCALED \
+VK_FORMAT_R16G16B16A16_SSCALED \
+VK_FORMAT_R64_UINT \
+VK_FORMAT_R64_SINT \
+VK_FORMAT_R64_SFLOAT \
+VK_FORMAT_R64G64_UINT \
+VK_FORMAT_R64G64_SINT \
+VK_FORMAT_R64G64_SFLOAT \
+VK_FORMAT_R64G64B64_UINT \
+VK_FORMAT_R64G64B64_SINT \
+VK_FORMAT_R64G64B64_SFLOAT \
+VK_FORMAT_R64G64B64A64_UINT \
+VK_FORMAT_R64G64B64A64_SINT \
+VK_FORMAT_R64G64B64A64_SFLOAT \
+VK_FORMAT_X8_D24_UNORM_PACK32 \
+VK_FORMAT_S8_UINT \
+VK_FORMAT_D16_UNORM_S8_UINT \
+VK_FORMAT_D24_UNORM_S8_UINT \
+VK_FORMAT_D32_SFLOAT_S8_UINT \
+VK_FORMAT_BC1_RGB_UNORM_BLOCK \
+VK_FORMAT_BC1_RGB_SRGB_BLOCK \
+VK_FORMAT_ETC2_R8G8B8_UNORM_BLOCK \
+VK_FORMAT_ETC2_R8G8B8_SRGB_BLOCK \
+VK_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK \
+VK_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK \
+VK_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK \
+VK_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK \
+VK_FORMAT_EAC_R11_UNORM_BLOCK \
+VK_FORMAT_EAC_R11_SNORM_BLOCK \
+VK_FORMAT_EAC_R11G11_UNORM_BLOCK \
+VK_FORMAT_EAC_R11G11_SNORM_BLOCK \
+VK_FORMAT_ASTC_4x4_UNORM_BLOCK \
+VK_FORMAT_ASTC_4x4_SRGB_BLOCK \
+VK_FORMAT_ASTC_5x4_UNORM_BLOCK \
+VK_FORMAT_ASTC_5x4_SRGB_BLOCK \
+VK_FORMAT_ASTC_5x5_UNORM_BLOCK \
+VK_FORMAT_ASTC_5x5_SRGB_BLOCK \
+VK_FORMAT_ASTC_6x5_UNORM_BLOCK \
+VK_FORMAT_ASTC_6x5_SRGB_BLOCK \
+VK_FORMAT_ASTC_6x6_UNORM_BLOCK \
+VK_FORMAT_ASTC_6x6_SRGB_BLOCK \
+VK_FORMAT_ASTC_8x5_UNORM_BLOCK \
+VK_FORMAT_ASTC_8x5_SRGB_BLOCK \
+VK_FORMAT_ASTC_8x6_UNORM_BLOCK \
+VK_FORMAT_ASTC_8x6_SRGB_BLOCK \
+VK_FORMAT_ASTC_8x8_UNORM_BLOCK \
+VK_FORMAT_ASTC_8x8_SRGB_BLOCK \
+VK_FORMAT_ASTC_10x5_UNORM_BLOCK \
+VK_FORMAT_ASTC_10x5_SRGB_BLOCK \
+VK_FORMAT_ASTC_10x6_UNORM_BLOCK \
+VK_FORMAT_ASTC_10x6_SRGB_BLOCK \
+VK_FORMAT_ASTC_10x8_UNORM_BLOCK \
+VK_FORMAT_ASTC_10x8_SRGB_BLOCK \
+VK_FORMAT_ASTC_10x10_UNORM_BLOCK \
+VK_FORMAT_ASTC_10x10_SRGB_BLOCK \
+VK_FORMAT_ASTC_12x10_UNORM_BLOCK \
+VK_FORMAT_ASTC_12x10_SRGB_BLOCK \
+VK_FORMAT_ASTC_12x12_UNORM_BLOCK \
+VK_FORMAT_ASTC_12x12_SRGB_BLOCK \
+VK_FORMAT_G8B8G8R8_422_UNORM \
+VK_FORMAT_B8G8R8G8_422_UNORM \
+VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM \
+VK_FORMAT_G8_B8R8_2PLANE_420_UNORM \
+VK_FORMAT_G8_B8_R8_3PLANE_422_UNORM \
+VK_FORMAT_G8_B8R8_2PLANE_422_UNORM \
+VK_FORMAT_G8_B8_R8_3PLANE_444_UNORM \
+VK_FORMAT_R10X6_UNORM_PACK16 \
+VK_FORMAT_R10X6G10X6_UNORM_2PACK16 \
+VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16 \
+VK_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16 \
+VK_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16 \
+VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16 \
+VK_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16 \
+VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16 \
+VK_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16 \
+VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16 \
+VK_FORMAT_R12X4_UNORM_PACK16 \
+VK_FORMAT_R12X4G12X4_UNORM_2PACK16 \
+VK_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16 \
+VK_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16 \
+VK_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16 \
+VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16 \
+VK_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16 \
+VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16 \
+VK_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16 \
+VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16 \
+VK_FORMAT_G16B16G16R16_422_UNORM \
+VK_FORMAT_B16G16R16G16_422_UNORM \
+VK_FORMAT_G16_B16_R16_3PLANE_420_UNORM \
+VK_FORMAT_G16_B16R16_2PLANE_420_UNORM \
+VK_FORMAT_G16_B16_R16_3PLANE_422_UNORM \
+VK_FORMAT_G16_B16R16_2PLANE_422_UNORM \
+VK_FORMAT_G16_B16_R16_3PLANE_444_UNORM \
+VK_FORMAT_PVRTC1_2BPP_UNORM_BLOCK_IMG \
+VK_FORMAT_PVRTC1_4BPP_UNORM_BLOCK_IMG \
+VK_FORMAT_PVRTC2_2BPP_UNORM_BLOCK_IMG \
+VK_FORMAT_PVRTC2_4BPP_UNORM_BLOCK_IMG \
+VK_FORMAT_PVRTC1_2BPP_SRGB_BLOCK_IMG \
+VK_FORMAT_PVRTC1_4BPP_SRGB_BLOCK_IMG \
+VK_FORMAT_PVRTC2_2BPP_SRGB_BLOCK_IMG \
+VK_FORMAT_PVRTC2_4BPP_SRGB_BLOCK_IMG \
+VK_FORMAT_ASTC_4x4_SFLOAT_BLOCK_EXT \
+VK_FORMAT_ASTC_5x4_SFLOAT_BLOCK_EXT \
+VK_FORMAT_ASTC_5x5_SFLOAT_BLOCK_EXT \
+VK_FORMAT_ASTC_6x5_SFLOAT_BLOCK_EXT \
+VK_FORMAT_ASTC_6x6_SFLOAT_BLOCK_EXT \
+VK_FORMAT_ASTC_8x5_SFLOAT_BLOCK_EXT \
+VK_FORMAT_ASTC_8x6_SFLOAT_BLOCK_EXT \
+VK_FORMAT_ASTC_8x8_SFLOAT_BLOCK_EXT \
+VK_FORMAT_ASTC_10x5_SFLOAT_BLOCK_EXT \
+VK_FORMAT_ASTC_10x6_SFLOAT_BLOCK_EXT \
+VK_FORMAT_ASTC_10x8_SFLOAT_BLOCK_EXT \
+VK_FORMAT_ASTC_10x10_SFLOAT_BLOCK_EXT \
+VK_FORMAT_ASTC_12x10_SFLOAT_BLOCK_EXT \
+VK_FORMAT_ASTC_12x12_SFLOAT_BLOCK_EXT \
+VK_FORMAT_G8_B8R8_2PLANE_444_UNORM_EXT \
+VK_FORMAT_G10X6_B10X6R10X6_2PLANE_444_UNORM_3PACK16_EXT \
+VK_FORMAT_G12X4_B12X4R12X4_2PLANE_444_UNORM_3PACK16_EXT \
+VK_FORMAT_G16_B16R16_2PLANE_444_UNORM_EXT \
+VK_FORMAT_A4B4G4R4_UNORM_PACK16_EXT \
+VK_FORMAT_G8B8G8R8_422_UNORM_KHR \
+VK_FORMAT_B8G8R8G8_422_UNORM_KHR \
+VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM_KHR \
+VK_FORMAT_G8_B8R8_2PLANE_420_UNORM_KHR \
+VK_FORMAT_G8_B8_R8_3PLANE_422_UNORM_KHR \
+VK_FORMAT_G8_B8R8_2PLANE_422_UNORM_KHR \
+VK_FORMAT_G8_B8_R8_3PLANE_444_UNORM_KHR \
+VK_FORMAT_R10X6_UNORM_PACK16_KHR \
+VK_FORMAT_R10X6G10X6_UNORM_2PACK16_KHR \
+VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16_KHR \
+VK_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16_KHR \
+VK_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16_KHR \
+VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16_KHR \
+VK_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16_KHR \
+VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16_KHR \
+VK_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16_KHR \
+VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16_KHR \
+VK_FORMAT_R12X4_UNORM_PACK16_KHR \
+VK_FORMAT_R12X4G12X4_UNORM_2PACK16_KHR \
+VK_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16_KHR \
+VK_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16_KHR \
+VK_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16_KHR \
+VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16_KHR \
+VK_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16_KHR \
+VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16_KHR \
+VK_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16_KHR \
+VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16_KHR \
+VK_FORMAT_G16B16G16R16_422_UNORM_KHR \
+VK_FORMAT_B16G16R16G16_422_UNORM_KHR \
+VK_FORMAT_G16_B16_R16_3PLANE_420_UNORM_KHR \
+VK_FORMAT_G16_B16R16_2PLANE_420_UNORM_KHR \
+VK_FORMAT_G16_B16_R16_3PLANE_422_UNORM_KHR \
+VK_FORMAT_G16_B16R16_2PLANE_422_UNORM_KHR \
+VK_FORMAT_G16_B16_R16_3PLANE_444_UNORM_KHR \ No newline at end of file