eden-emu/Vulkan-Utility-Libraries
14
0
Fork 0
mirror of https://github.com/KhronosGroup/Vulkan-Utility-Libraries.git synced 2025-05-15 01:08:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

format: Add note for Multi-planar

Browse source
This commit is contained in:
spencer-lunarg 2025-01-15 12:07:30 -05:00 • committed by Spencer Fricke
parent 5a88b6042e
commit 2fe3a7791d
2 changed files with 13 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

8
include/vulkan/utility/vk_format_utils.h
View file

@ -1,8 +1,8 @@
// *** THIS FILE IS GENERATED - DO NOT EDIT *** // *** THIS FILE IS GENERATED - DO NOT EDIT ***
// See format_utils_generator.py for modifications // See format_utils_generator.py for modifications
// Copyright 2023 The Khronos Group Inc. // Copyright 2023-2025 The Khronos Group Inc.
// Copyright 2023 Valve Corporation // Copyright 2023-2025 Valve Corporation
// Copyright 2023 LunarG, Inc. // Copyright 2023-2025 LunarG, Inc.
// //
// SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: Apache-2.0
@ -249,6 +249,8 @@ inline bool vkuFormatIsSinglePlane_422(VkFormat format);
inline uint32_t vkuFormatPlaneCount(VkFormat format); inline uint32_t vkuFormatPlaneCount(VkFormat format);
// Returns whether a VkFormat is multiplane // Returns whether a VkFormat is multiplane
// Note - Formats like VK_FORMAT_G8B8G8R8_422_UNORM are NOT multi-planar, they require a
// VkSamplerYcbcrConversion and you should use vkuFormatRequiresYcbcrConversion instead
inline bool vkuFormatIsMultiplane(VkFormat format) { return ((vkuFormatPlaneCount(format)) > 1u); } inline bool vkuFormatIsMultiplane(VkFormat format) { return ((vkuFormatPlaneCount(format)) > 1u); }
// Returns a VkFormat that is compatible with a given plane of a multiplane format // Returns a VkFormat that is compatible with a given plane of a multiplane format

14
scripts/generators/format_utils_generator.py
View file

@ -1,8 +1,8 @@
#!/usr/bin/python3 -i #!/usr/bin/python3 -i
# #
# Copyright 2023 The Khronos Group Inc. # Copyright 2023-2025 The Khronos Group Inc.
# Copyright 2023 Valve Corporation # Copyright 2023-2025 Valve Corporation
# Copyright 2023 LunarG, Inc. # Copyright 2023-2025 LunarG, Inc.
# #
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
@ -71,9 +71,9 @@ class FormatUtilsOutputGenerator(BaseGenerator):
out = [] out = []
out.append(f'''// *** THIS FILE IS GENERATED - DO NOT EDIT *** out.append(f'''// *** THIS FILE IS GENERATED - DO NOT EDIT ***
// See {os.path.basename(__file__)} for modifications // See {os.path.basename(__file__)} for modifications
// Copyright 2023 The Khronos Group Inc. // Copyright 2023-2025 The Khronos Group Inc.
// Copyright 2023 Valve Corporation // Copyright 2023-2025 Valve Corporation
// Copyright 2023 LunarG, Inc. // Copyright 2023-2025 LunarG, Inc.
// //
// SPDX-License-Identifier: Apache-2.0 // SPDX-License-Identifier: Apache-2.0
''') ''')
@ -195,6 +195,8 @@ inline bool vkuFormatIsSinglePlane_422(VkFormat format);
inline uint32_t vkuFormatPlaneCount(VkFormat format); inline uint32_t vkuFormatPlaneCount(VkFormat format);
// Returns whether a VkFormat is multiplane // Returns whether a VkFormat is multiplane
// Note - Formats like VK_FORMAT_G8B8G8R8_422_UNORM are NOT multi-planar, they require a
// VkSamplerYcbcrConversion and you should use vkuFormatRequiresYcbcrConversion instead
inline bool vkuFormatIsMultiplane(VkFormat format) { return ((vkuFormatPlaneCount(format)) > 1u); } inline bool vkuFormatIsMultiplane(VkFormat format) { return ((vkuFormatPlaneCount(format)) > 1u); }
// Returns a VkFormat that is compatible with a given plane of a multiplane format // Returns a VkFormat that is compatible with a given plane of a multiplane format