• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright © 2016 Intel Corporation
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21  * IN THE SOFTWARE.
22  */
23 
24 #ifndef VK_FORMAT_INFO_H
25 #define VK_FORMAT_INFO_H
26 
27 #include <stdbool.h>
28 #include <vulkan/vulkan.h>
29 
30 static inline VkImageAspectFlags
vk_format_aspects(VkFormat format)31 vk_format_aspects(VkFormat format)
32 {
33    switch (format) {
34    case VK_FORMAT_UNDEFINED:
35       return 0;
36 
37    case VK_FORMAT_S8_UINT:
38       return VK_IMAGE_ASPECT_STENCIL_BIT;
39 
40    case VK_FORMAT_D16_UNORM_S8_UINT:
41    case VK_FORMAT_D24_UNORM_S8_UINT:
42    case VK_FORMAT_D32_SFLOAT_S8_UINT:
43       return VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT;
44 
45    case VK_FORMAT_D16_UNORM:
46    case VK_FORMAT_X8_D24_UNORM_PACK32:
47    case VK_FORMAT_D32_SFLOAT:
48       return VK_IMAGE_ASPECT_DEPTH_BIT;
49 
50    case VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM_KHR:
51    case VK_FORMAT_G8_B8_R8_3PLANE_422_UNORM_KHR:
52    case VK_FORMAT_G8_B8_R8_3PLANE_444_UNORM_KHR:
53    case VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16_KHR:
54    case VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16_KHR:
55    case VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16_KHR:
56    case VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16_KHR:
57    case VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16_KHR:
58    case VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16_KHR:
59    case VK_FORMAT_G16_B16_R16_3PLANE_420_UNORM_KHR:
60    case VK_FORMAT_G16_B16_R16_3PLANE_422_UNORM_KHR:
61    case VK_FORMAT_G16_B16_R16_3PLANE_444_UNORM_KHR:
62       return (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR |
63               VK_IMAGE_ASPECT_PLANE_1_BIT_KHR |
64               VK_IMAGE_ASPECT_PLANE_2_BIT_KHR);
65 
66    case VK_FORMAT_G8_B8R8_2PLANE_420_UNORM_KHR:
67    case VK_FORMAT_G8_B8R8_2PLANE_422_UNORM_KHR:
68    case VK_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16_KHR:
69    case VK_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16_KHR:
70    case VK_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16_KHR:
71    case VK_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16_KHR:
72    case VK_FORMAT_G16_B16R16_2PLANE_420_UNORM_KHR:
73    case VK_FORMAT_G16_B16R16_2PLANE_422_UNORM_KHR:
74       return (VK_IMAGE_ASPECT_PLANE_0_BIT_KHR |
75               VK_IMAGE_ASPECT_PLANE_1_BIT_KHR);
76 
77    default:
78       return VK_IMAGE_ASPECT_COLOR_BIT;
79    }
80 }
81 
82 static inline bool
vk_format_is_color(VkFormat format)83 vk_format_is_color(VkFormat format)
84 {
85    return vk_format_aspects(format) == VK_IMAGE_ASPECT_COLOR_BIT;
86 }
87 
88 static inline bool
vk_format_is_depth_or_stencil(VkFormat format)89 vk_format_is_depth_or_stencil(VkFormat format)
90 {
91    const VkImageAspectFlags aspects = vk_format_aspects(format);
92    return aspects & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT);
93 }
94 
95 static inline bool
vk_format_has_depth(VkFormat format)96 vk_format_has_depth(VkFormat format)
97 {
98    const VkImageAspectFlags aspects = vk_format_aspects(format);
99    return aspects & VK_IMAGE_ASPECT_DEPTH_BIT;
100 }
101 
102 #endif /* VK_FORMAT_INFO_H */
103