1 // Copyright 2019 The Android Open Source Project
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either expresso or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 #pragma once
15
16 #include <vulkan/vulkan_core.h>
17
18 #include <vector>
19
20 #include "host-common/logging.h"
21 #include "vulkan/vk_enum_string_helper.h"
22
23 namespace gfxstream {
24 namespace vk {
25
26 // Header library that captures common patterns when working with
27 // Vulkan formats:
28 // - Macros to iterate over categories of formats
29 // - Add often-used parameters like the bytes per pixel and ASTC block size
30
31 #define LIST_VK_FORMATS_LINEAR(f) \
32 f(VK_FORMAT_R4G4_UNORM_PACK8, 1) \
33 f(VK_FORMAT_R4G4B4A4_UNORM_PACK16, 2) \
34 f(VK_FORMAT_B4G4R4A4_UNORM_PACK16, 2) \
35 f(VK_FORMAT_R5G6B5_UNORM_PACK16, 2) \
36 f(VK_FORMAT_B5G6R5_UNORM_PACK16, 2) \
37 f(VK_FORMAT_R5G5B5A1_UNORM_PACK16, 2) \
38 f(VK_FORMAT_B5G5R5A1_UNORM_PACK16, 2) \
39 f(VK_FORMAT_A1R5G5B5_UNORM_PACK16, 2) \
40 f(VK_FORMAT_R8_UNORM, 1) \
41 f(VK_FORMAT_R8_SNORM, 1) \
42 f(VK_FORMAT_R8_USCALED, 1) \
43 f(VK_FORMAT_R8_SSCALED, 1) \
44 f(VK_FORMAT_R8_UINT, 1) \
45 f(VK_FORMAT_R8_SINT, 1) \
46 f(VK_FORMAT_R8_SRGB, 1) \
47 f(VK_FORMAT_R8G8_UNORM, 2) \
48 f(VK_FORMAT_R8G8_SNORM, 2) \
49 f(VK_FORMAT_R8G8_USCALED, 2) \
50 f(VK_FORMAT_R8G8_SSCALED, 2) \
51 f(VK_FORMAT_R8G8_UINT, 2) \
52 f(VK_FORMAT_R8G8_SINT, 2) \
53 f(VK_FORMAT_R8G8_SRGB, 2) \
54 f(VK_FORMAT_R8G8B8_UNORM, 3) \
55 f(VK_FORMAT_R8G8B8_SNORM, 3) \
56 f(VK_FORMAT_R8G8B8_USCALED, 3) \
57 f(VK_FORMAT_R8G8B8_SSCALED, 3) \
58 f(VK_FORMAT_R8G8B8_UINT, 3) \
59 f(VK_FORMAT_R8G8B8_SINT, 3) \
60 f(VK_FORMAT_R8G8B8_SRGB, 3) \
61 f(VK_FORMAT_B8G8R8_UNORM, 3) \
62 f(VK_FORMAT_B8G8R8_SNORM, 3) \
63 f(VK_FORMAT_B8G8R8_USCALED, 3) \
64 f(VK_FORMAT_B8G8R8_SSCALED, 3) \
65 f(VK_FORMAT_B8G8R8_UINT, 3) \
66 f(VK_FORMAT_B8G8R8_SINT, 3) \
67 f(VK_FORMAT_B8G8R8_SRGB, 3) \
68 f(VK_FORMAT_R8G8B8A8_UNORM, 4) \
69 f(VK_FORMAT_R8G8B8A8_SNORM, 4) \
70 f(VK_FORMAT_R8G8B8A8_USCALED, 4) \
71 f(VK_FORMAT_R8G8B8A8_SSCALED, 4) \
72 f(VK_FORMAT_R8G8B8A8_UINT, 4) \
73 f(VK_FORMAT_R8G8B8A8_SINT, 4) \
74 f(VK_FORMAT_R8G8B8A8_SRGB, 4) \
75 f(VK_FORMAT_B8G8R8A8_UNORM, 4) \
76 f(VK_FORMAT_B8G8R8A8_SNORM, 4) \
77 f(VK_FORMAT_B8G8R8A8_USCALED, 4) \
78 f(VK_FORMAT_B8G8R8A8_SSCALED, 4) \
79 f(VK_FORMAT_B8G8R8A8_UINT, 4) \
80 f(VK_FORMAT_B8G8R8A8_SINT, 4) \
81 f(VK_FORMAT_B8G8R8A8_SRGB, 4) \
82 f(VK_FORMAT_A8B8G8R8_UNORM_PACK32, 4) \
83 f(VK_FORMAT_A8B8G8R8_SNORM_PACK32, 4) \
84 f(VK_FORMAT_A8B8G8R8_USCALED_PACK32, 4) \
85 f(VK_FORMAT_A8B8G8R8_SSCALED_PACK32, 4) \
86 f(VK_FORMAT_A8B8G8R8_UINT_PACK32, 4) \
87 f(VK_FORMAT_A8B8G8R8_SINT_PACK32, 4) \
88 f(VK_FORMAT_A8B8G8R8_SRGB_PACK32, 4) \
89 f(VK_FORMAT_A2R10G10B10_UNORM_PACK32, 4) \
90 f(VK_FORMAT_A2R10G10B10_SNORM_PACK32, 4) \
91 f(VK_FORMAT_A2R10G10B10_USCALED_PACK32, 4) \
92 f(VK_FORMAT_A2R10G10B10_SSCALED_PACK32, 4) \
93 f(VK_FORMAT_A2R10G10B10_UINT_PACK32, 4) \
94 f(VK_FORMAT_A2R10G10B10_SINT_PACK32, 4) \
95 f(VK_FORMAT_A2B10G10R10_UNORM_PACK32, 4) \
96 f(VK_FORMAT_A2B10G10R10_SNORM_PACK32, 4) \
97 f(VK_FORMAT_A2B10G10R10_USCALED_PACK32, 4) \
98 f(VK_FORMAT_A2B10G10R10_SSCALED_PACK32, 4) \
99 f(VK_FORMAT_A2B10G10R10_UINT_PACK32, 4) \
100 f(VK_FORMAT_A2B10G10R10_SINT_PACK32, 4) \
101 f(VK_FORMAT_R16_UNORM, 2) \
102 f(VK_FORMAT_R16_SNORM, 2) \
103 f(VK_FORMAT_R16_USCALED, 2) \
104 f(VK_FORMAT_R16_SSCALED, 2) \
105 f(VK_FORMAT_R16_UINT, 2) \
106 f(VK_FORMAT_R16_SINT, 2) \
107 f(VK_FORMAT_R16_SFLOAT, 2) \
108 f(VK_FORMAT_R16G16_UNORM, 4) \
109 f(VK_FORMAT_R16G16_SNORM, 4) \
110 f(VK_FORMAT_R16G16_USCALED, 4) \
111 f(VK_FORMAT_R16G16_SSCALED, 4) \
112 f(VK_FORMAT_R16G16_UINT, 4) \
113 f(VK_FORMAT_R16G16_SINT, 4) \
114 f(VK_FORMAT_R16G16_SFLOAT, 4) \
115 f(VK_FORMAT_R16G16B16_UNORM, 6) \
116 f(VK_FORMAT_R16G16B16_SNORM, 6) \
117 f(VK_FORMAT_R16G16B16_USCALED, 6) \
118 f(VK_FORMAT_R16G16B16_SSCALED, 6) \
119 f(VK_FORMAT_R16G16B16_UINT, 6) \
120 f(VK_FORMAT_R16G16B16_SINT, 6) \
121 f(VK_FORMAT_R16G16B16_SFLOAT, 6) \
122 f(VK_FORMAT_R16G16B16A16_UNORM, 8) \
123 f(VK_FORMAT_R16G16B16A16_SNORM, 8) \
124 f(VK_FORMAT_R16G16B16A16_USCALED, 8) \
125 f(VK_FORMAT_R16G16B16A16_SSCALED, 8) \
126 f(VK_FORMAT_R16G16B16A16_UINT, 8) \
127 f(VK_FORMAT_R16G16B16A16_SINT, 8) \
128 f(VK_FORMAT_R16G16B16A16_SFLOAT, 8) \
129 f(VK_FORMAT_R32_UINT, 4) \
130 f(VK_FORMAT_R32_SINT, 4) \
131 f(VK_FORMAT_R32_SFLOAT, 4) \
132 f(VK_FORMAT_R32G32_UINT, 8) \
133 f(VK_FORMAT_R32G32_SINT, 8) \
134 f(VK_FORMAT_R32G32_SFLOAT, 8) \
135 f(VK_FORMAT_R32G32B32_UINT, 8) \
136 f(VK_FORMAT_R32G32B32_SINT, 8) \
137 f(VK_FORMAT_R32G32B32_SFLOAT, 8) \
138 f(VK_FORMAT_R32G32B32A32_UINT, 16) \
139 f(VK_FORMAT_R32G32B32A32_SINT, 16) \
140 f(VK_FORMAT_R32G32B32A32_SFLOAT, 16) \
141 f(VK_FORMAT_R64_UINT, 8) \
142 f(VK_FORMAT_R64_SINT, 8) \
143 f(VK_FORMAT_R64_SFLOAT, 8) \
144 f(VK_FORMAT_R64G64_UINT, 16) \
145 f(VK_FORMAT_R64G64_SINT, 16) \
146 f(VK_FORMAT_R64G64_SFLOAT, 16) \
147 f(VK_FORMAT_R64G64B64_UINT, 24) \
148 f(VK_FORMAT_R64G64B64_SINT, 24) \
149 f(VK_FORMAT_R64G64B64_SFLOAT, 24) \
150 f(VK_FORMAT_R64G64B64A64_UINT, 32) \
151 f(VK_FORMAT_R64G64B64A64_SINT, 32) \
152 f(VK_FORMAT_R64G64B64A64_SFLOAT, 32) \
153 f(VK_FORMAT_B10G11R11_UFLOAT_PACK32, 4) \
154 f(VK_FORMAT_E5B9G9R9_UFLOAT_PACK32, 4) \
155 f(VK_FORMAT_D16_UNORM, 2) \
156 f(VK_FORMAT_X8_D24_UNORM_PACK32, 4) \
157 f(VK_FORMAT_D32_SFLOAT, 4) \
158 f(VK_FORMAT_S8_UINT, 1) \
159 f(VK_FORMAT_D16_UNORM_S8_UINT, 3) \
160 f(VK_FORMAT_D24_UNORM_S8_UINT, 4) \
161 f(VK_FORMAT_D32_SFLOAT_S8_UINT, 5) \
162 f(VK_FORMAT_R10X6_UNORM_PACK16, 2) \
163 f(VK_FORMAT_R10X6G10X6_UNORM_2PACK16, 4) \
164 f(VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16, 8) \
165 f(VK_FORMAT_R12X4_UNORM_PACK16, 2) \
166 f(VK_FORMAT_R12X4G12X4_UNORM_2PACK16, 4) \
167 f(VK_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16, 8)
168
169 // TODO: BC formats
170 #define LIST_VK_FORMATS_COMPRESSED_BC(f) \
171 f(VK_FORMAT_BC1_RGB_UNORM_BLOCK, 0) \
172 f(VK_FORMAT_BC1_RGB_SRGB_BLOCK, 0) \
173 f(VK_FORMAT_BC1_RGBA_UNORM_BLOCK, 0) \
174 f(VK_FORMAT_BC1_RGBA_SRGB_BLOCK, 0) \
175 f(VK_FORMAT_BC2_UNORM_BLOCK, 0) \
176 f(VK_FORMAT_BC2_SRGB_BLOCK, 0) \
177 f(VK_FORMAT_BC3_UNORM_BLOCK, 0) \
178 f(VK_FORMAT_BC3_SRGB_BLOCK, 0) \
179 f(VK_FORMAT_BC4_UNORM_BLOCK, 0) \
180 f(VK_FORMAT_BC4_SNORM_BLOCK, 0) \
181 f(VK_FORMAT_BC5_UNORM_BLOCK, 0) \
182 f(VK_FORMAT_BC5_SNORM_BLOCK, 0) \
183 f(VK_FORMAT_BC6H_UFLOAT_BLOCK, 0) \
184 f(VK_FORMAT_BC6H_SFLOAT_BLOCK, 0) \
185 f(VK_FORMAT_BC7_UNORM_BLOCK, 0) \
186 f(VK_FORMAT_BC7_SRGB_BLOCK, 0)
187
188 // TODO: ETC2 format parameters
189 #define LIST_VK_FORMATS_COMPRESSED_ETC2(f) \
190 f(VK_FORMAT_ETC2_R8G8B8_UNORM_BLOCK, 0) \
191 f(VK_FORMAT_ETC2_R8G8B8_SRGB_BLOCK, 0) \
192 f(VK_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK, 0) \
193 f(VK_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK, 0) \
194 f(VK_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK, 0) \
195 f(VK_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK, 0)
196
197 // TODO: EAC format parameters
198 #define LIST_VK_FORMATS_COMPRESSED_EAC(f) \
199 f(VK_FORMAT_EAC_R11_UNORM_BLOCK, 0) \
200 f(VK_FORMAT_EAC_R11_SNORM_BLOCK, 0) \
201 f(VK_FORMAT_EAC_R11G11_UNORM_BLOCK, 0) \
202 f(VK_FORMAT_EAC_R11G11_SNORM_BLOCK, 0)
203
204 // ASTC: block dimensions, then whether it is SRGB
205 #define LIST_VK_FORMATS_COMPRESSED_ASTC(f) \
206 f(VK_FORMAT_ASTC_4x4_UNORM_BLOCK, 4, 4, 0) \
207 f(VK_FORMAT_ASTC_4x4_SRGB_BLOCK, 4, 4, 1) \
208 f(VK_FORMAT_ASTC_5x4_UNORM_BLOCK, 5, 4, 0) \
209 f(VK_FORMAT_ASTC_5x4_SRGB_BLOCK, 5, 4, 1) \
210 f(VK_FORMAT_ASTC_5x5_UNORM_BLOCK, 5, 5, 0) \
211 f(VK_FORMAT_ASTC_5x5_SRGB_BLOCK, 5, 5, 1) \
212 f(VK_FORMAT_ASTC_6x5_UNORM_BLOCK, 6, 5, 0) \
213 f(VK_FORMAT_ASTC_6x5_SRGB_BLOCK, 6, 5, 1) \
214 f(VK_FORMAT_ASTC_6x6_UNORM_BLOCK, 6, 6, 0) \
215 f(VK_FORMAT_ASTC_6x6_SRGB_BLOCK, 6, 6, 1) \
216 f(VK_FORMAT_ASTC_8x5_UNORM_BLOCK, 8, 5, 0) \
217 f(VK_FORMAT_ASTC_8x5_SRGB_BLOCK, 8, 5, 1) \
218 f(VK_FORMAT_ASTC_8x6_UNORM_BLOCK, 8, 6, 0) \
219 f(VK_FORMAT_ASTC_8x6_SRGB_BLOCK, 8, 6, 1) \
220 f(VK_FORMAT_ASTC_8x8_UNORM_BLOCK, 8, 8, 0) \
221 f(VK_FORMAT_ASTC_8x8_SRGB_BLOCK, 8, 8, 1) \
222 f(VK_FORMAT_ASTC_10x5_UNORM_BLOCK, 10, 5, 0) \
223 f(VK_FORMAT_ASTC_10x5_SRGB_BLOCK, 10, 5, 1) \
224 f(VK_FORMAT_ASTC_10x6_UNORM_BLOCK, 10, 6, 0) \
225 f(VK_FORMAT_ASTC_10x6_SRGB_BLOCK, 10, 6, 1) \
226 f(VK_FORMAT_ASTC_10x8_UNORM_BLOCK, 10, 8, 0) \
227 f(VK_FORMAT_ASTC_10x8_SRGB_BLOCK, 10, 8, 1) \
228 f(VK_FORMAT_ASTC_10x10_UNORM_BLOCK, 10, 10, 0) \
229 f(VK_FORMAT_ASTC_10x10_SRGB_BLOCK, 10, 10, 1) \
230 f(VK_FORMAT_ASTC_12x10_UNORM_BLOCK, 12, 10, 0) \
231 f(VK_FORMAT_ASTC_12x10_SRGB_BLOCK, 12, 10, 1) \
232 f(VK_FORMAT_ASTC_12x12_UNORM_BLOCK, 12, 12, 0) \
233 f(VK_FORMAT_ASTC_12x12_SRGB_BLOCK, 12, 12, 1)
234
235 // TODO: Come up with parameters to describe multiplane formats
236 #define LIST_VK_FORMATS_MULTIPLANE(f) \
237 f(VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM, 0) \
238 f(VK_FORMAT_G8_B8R8_2PLANE_420_UNORM, 0) \
239 f(VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16, 0) \
240 f(VK_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16, 0) \
241 f(VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16, 0) \
242 f(VK_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16, 0) \
243 f(VK_FORMAT_G16_B16_R16_3PLANE_420_UNORM, 0) \
244 f(VK_FORMAT_G16_B16R16_2PLANE_420_UNORM, 0) \
245 f(VK_FORMAT_G8B8G8R8_422_UNORM, 0) \
246 f(VK_FORMAT_B8G8R8G8_422_UNORM, 0) \
247 f(VK_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16, 0) \
248 f(VK_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16, 0) \
249 f(VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16, 0) \
250 f(VK_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16, 0) \
251 f(VK_FORMAT_G8_B8_R8_3PLANE_422_UNORM, 0) \
252 f(VK_FORMAT_G8_B8R8_2PLANE_422_UNORM, 0) \
253 f(VK_FORMAT_G16B16G16R16_422_UNORM, 0) \
254 f(VK_FORMAT_B16G16R16G16_422_UNORM, 0) \
255 f(VK_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16, 0) \
256 f(VK_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16, 0) \
257 f(VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16, 0) \
258 f(VK_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16, 0) \
259 f(VK_FORMAT_G16_B16_R16_3PLANE_422_UNORM, 0) \
260 f(VK_FORMAT_G16_B16R16_2PLANE_422_UNORM, 0) \
261 f(VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16, 0) \
262 f(VK_FORMAT_G8_B8_R8_3PLANE_444_UNORM, 0) \
263 f(VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16, 0) \
264 f(VK_FORMAT_G16_B16_R16_3PLANE_444_UNORM, 0)
265
266 // TODO: Come up with parameters to describe PVRTC formats
267 #define LIST_VK_FORMATS_COMPRESSED_PVRTC(f) \
268 f(VK_FORMAT_PVRTC1_2BPP_UNORM_BLOCK_IMG, 0) \
269 f(VK_FORMAT_PVRTC1_4BPP_UNORM_BLOCK_IMG, 0) \
270 f(VK_FORMAT_PVRTC2_2BPP_UNORM_BLOCK_IMG, 0) \
271 f(VK_FORMAT_PVRTC2_4BPP_UNORM_BLOCK_IMG, 0) \
272 f(VK_FORMAT_PVRTC1_2BPP_SRGB_BLOCK_IMG, 0) \
273 f(VK_FORMAT_PVRTC1_4BPP_SRGB_BLOCK_IMG, 0) \
274 f(VK_FORMAT_PVRTC2_2BPP_SRGB_BLOCK_IMG, 0) \
275 f(VK_FORMAT_PVRTC2_4BPP_SRGB_BLOCK_IMG, 0)
276
getLinearFormatPixelSize(VkFormat format)277 static inline int getLinearFormatPixelSize(VkFormat format) {
278 #define VK_FORMATS_LINEAR_GET_PIXEL_SIZE(f, size) \
279 if (format == f) return size;
280
281 LIST_VK_FORMATS_LINEAR(VK_FORMATS_LINEAR_GET_PIXEL_SIZE)
282
283 ERR("Unhandled format: %s", string_VkFormat(format));
284 return 0;
285 }
286
formatIsUNorm(VkFormat format)287 constexpr bool formatIsUNorm(VkFormat format) {
288 switch (format) {
289 case VK_FORMAT_R4G4_UNORM_PACK8:
290 case VK_FORMAT_R4G4B4A4_UNORM_PACK16:
291 case VK_FORMAT_B4G4R4A4_UNORM_PACK16:
292 case VK_FORMAT_A4R4G4B4_UNORM_PACK16_EXT:
293 case VK_FORMAT_A4B4G4R4_UNORM_PACK16_EXT:
294 case VK_FORMAT_R5G6B5_UNORM_PACK16:
295 case VK_FORMAT_R5G5B5A1_UNORM_PACK16:
296 case VK_FORMAT_A1R5G5B5_UNORM_PACK16:
297 case VK_FORMAT_R8_UNORM:
298 case VK_FORMAT_R8G8_UNORM:
299 case VK_FORMAT_R8G8B8_UNORM:
300 case VK_FORMAT_R8G8B8A8_UNORM:
301 case VK_FORMAT_A8B8G8R8_UNORM_PACK32:
302 case VK_FORMAT_A2B10G10R10_UNORM_PACK32:
303 case VK_FORMAT_R16_UNORM:
304 case VK_FORMAT_R16G16_UNORM:
305 case VK_FORMAT_R16G16B16_UNORM:
306 case VK_FORMAT_R16G16B16A16_UNORM:
307 case VK_FORMAT_BC1_RGB_UNORM_BLOCK:
308 case VK_FORMAT_BC2_UNORM_BLOCK:
309 case VK_FORMAT_BC3_UNORM_BLOCK:
310 case VK_FORMAT_BC4_UNORM_BLOCK:
311 case VK_FORMAT_BC5_UNORM_BLOCK:
312 case VK_FORMAT_BC7_UNORM_BLOCK:
313 case VK_FORMAT_ETC2_R8G8B8_UNORM_BLOCK:
314 case VK_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK:
315 case VK_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK:
316 case VK_FORMAT_EAC_R11_UNORM_BLOCK:
317 case VK_FORMAT_EAC_R11G11_UNORM_BLOCK:
318 case VK_FORMAT_ASTC_4x4_UNORM_BLOCK:
319 case VK_FORMAT_ASTC_5x4_UNORM_BLOCK:
320 case VK_FORMAT_ASTC_5x5_UNORM_BLOCK:
321 case VK_FORMAT_ASTC_6x5_UNORM_BLOCK:
322 case VK_FORMAT_ASTC_6x6_UNORM_BLOCK:
323 case VK_FORMAT_ASTC_8x5_UNORM_BLOCK:
324 case VK_FORMAT_ASTC_8x6_UNORM_BLOCK:
325 case VK_FORMAT_ASTC_8x8_UNORM_BLOCK:
326 case VK_FORMAT_ASTC_10x5_UNORM_BLOCK:
327 case VK_FORMAT_ASTC_10x6_UNORM_BLOCK:
328 case VK_FORMAT_ASTC_10x8_UNORM_BLOCK:
329 case VK_FORMAT_ASTC_10x10_UNORM_BLOCK:
330 case VK_FORMAT_ASTC_12x10_UNORM_BLOCK:
331 case VK_FORMAT_ASTC_12x12_UNORM_BLOCK:
332 case VK_FORMAT_B5G6R5_UNORM_PACK16:
333 case VK_FORMAT_B8G8R8_UNORM:
334 case VK_FORMAT_B8G8R8A8_UNORM:
335 case VK_FORMAT_A2R10G10B10_UNORM_PACK32:
336 case VK_FORMAT_G8B8G8R8_422_UNORM:
337 case VK_FORMAT_B8G8R8G8_422_UNORM:
338 case VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM:
339 case VK_FORMAT_G8_B8R8_2PLANE_420_UNORM:
340 case VK_FORMAT_G8_B8_R8_3PLANE_422_UNORM:
341 case VK_FORMAT_G8_B8R8_2PLANE_422_UNORM:
342 case VK_FORMAT_G8_B8_R8_3PLANE_444_UNORM:
343 case VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16:
344 case VK_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16:
345 case VK_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16:
346 case VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16:
347 case VK_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16:
348 case VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16:
349 case VK_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16:
350 case VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16:
351 case VK_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16:
352 case VK_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16:
353 case VK_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16:
354 case VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16:
355 case VK_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16:
356 case VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16:
357 case VK_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16:
358 case VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16:
359 case VK_FORMAT_G16B16G16R16_422_UNORM:
360 case VK_FORMAT_B16G16R16G16_422_UNORM:
361 case VK_FORMAT_G16_B16_R16_3PLANE_420_UNORM:
362 case VK_FORMAT_G16_B16R16_2PLANE_420_UNORM:
363 case VK_FORMAT_G16_B16_R16_3PLANE_422_UNORM:
364 case VK_FORMAT_G16_B16R16_2PLANE_422_UNORM:
365 case VK_FORMAT_G16_B16_R16_3PLANE_444_UNORM:
366 case VK_FORMAT_B5G5R5A1_UNORM_PACK16:
367 case VK_FORMAT_BC1_RGBA_UNORM_BLOCK:
368 case VK_FORMAT_PVRTC1_2BPP_UNORM_BLOCK_IMG:
369 case VK_FORMAT_PVRTC1_4BPP_UNORM_BLOCK_IMG:
370 case VK_FORMAT_PVRTC2_2BPP_UNORM_BLOCK_IMG:
371 case VK_FORMAT_PVRTC2_4BPP_UNORM_BLOCK_IMG:
372 case VK_FORMAT_R10X6_UNORM_PACK16:
373 case VK_FORMAT_R10X6G10X6_UNORM_2PACK16:
374 case VK_FORMAT_R12X4_UNORM_PACK16:
375 case VK_FORMAT_R12X4G12X4_UNORM_2PACK16:
376 #ifdef VK_EXT_YCBCR_2PLANE_444_FORMATS_SPEC_VERSION
377 case VK_FORMAT_G8_B8R8_2PLANE_444_UNORM_EXT:
378 case VK_FORMAT_G10X6_B10X6R10X6_2PLANE_444_UNORM_3PACK16_EXT:
379 case VK_FORMAT_G12X4_B12X4R12X4_2PLANE_444_UNORM_3PACK16_EXT:
380 case VK_FORMAT_G16_B16R16_2PLANE_444_UNORM_EXT:
381 #endif
382 return true;
383 default:
384 return false;
385 }
386 }
387
formatIsSNorm(VkFormat format)388 constexpr bool formatIsSNorm(VkFormat format) {
389 switch (format) {
390 case VK_FORMAT_R8_SNORM:
391 case VK_FORMAT_R8G8_SNORM:
392 case VK_FORMAT_R8G8B8_SNORM:
393 case VK_FORMAT_R8G8B8A8_SNORM:
394 case VK_FORMAT_A8B8G8R8_SNORM_PACK32:
395 case VK_FORMAT_A2B10G10R10_SNORM_PACK32:
396 case VK_FORMAT_R16_SNORM:
397 case VK_FORMAT_R16G16_SNORM:
398 case VK_FORMAT_R16G16B16_SNORM:
399 case VK_FORMAT_R16G16B16A16_SNORM:
400 case VK_FORMAT_BC4_SNORM_BLOCK:
401 case VK_FORMAT_BC5_SNORM_BLOCK:
402 case VK_FORMAT_EAC_R11_SNORM_BLOCK:
403 case VK_FORMAT_EAC_R11G11_SNORM_BLOCK:
404 case VK_FORMAT_B8G8R8_SNORM:
405 case VK_FORMAT_B8G8R8A8_SNORM:
406 case VK_FORMAT_A2R10G10B10_SNORM_PACK32:
407 return true;
408 default:
409 return false;
410 }
411 }
412
formatIsUScaled(VkFormat format)413 constexpr bool formatIsUScaled(VkFormat format) {
414 switch (format) {
415 case VK_FORMAT_R8_USCALED:
416 case VK_FORMAT_R8G8_USCALED:
417 case VK_FORMAT_R8G8B8_USCALED:
418 case VK_FORMAT_B8G8R8_USCALED:
419 case VK_FORMAT_R8G8B8A8_USCALED:
420 case VK_FORMAT_B8G8R8A8_USCALED:
421 case VK_FORMAT_A8B8G8R8_USCALED_PACK32:
422 case VK_FORMAT_A2R10G10B10_USCALED_PACK32:
423 case VK_FORMAT_A2B10G10R10_USCALED_PACK32:
424 case VK_FORMAT_R16_USCALED:
425 case VK_FORMAT_R16G16_USCALED:
426 case VK_FORMAT_R16G16B16_USCALED:
427 case VK_FORMAT_R16G16B16A16_USCALED:
428 return true;
429 default:
430 return false;
431 }
432 }
433
formatIsSScaled(VkFormat format)434 constexpr bool formatIsSScaled(VkFormat format) {
435 switch (format) {
436 case VK_FORMAT_R8_SSCALED:
437 case VK_FORMAT_R8G8_SSCALED:
438 case VK_FORMAT_R8G8B8_SSCALED:
439 case VK_FORMAT_B8G8R8_SSCALED:
440 case VK_FORMAT_R8G8B8A8_SSCALED:
441 case VK_FORMAT_B8G8R8A8_SSCALED:
442 case VK_FORMAT_A8B8G8R8_SSCALED_PACK32:
443 case VK_FORMAT_A2R10G10B10_SSCALED_PACK32:
444 case VK_FORMAT_A2B10G10R10_SSCALED_PACK32:
445 case VK_FORMAT_R16_SSCALED:
446 case VK_FORMAT_R16G16_SSCALED:
447 case VK_FORMAT_R16G16B16_SSCALED:
448 case VK_FORMAT_R16G16B16A16_SSCALED:
449 return true;
450 default:
451 return false;
452 }
453 }
454
formatIsUInt(VkFormat format)455 constexpr bool formatIsUInt(VkFormat format) {
456 switch (format) {
457 case VK_FORMAT_R8_UINT:
458 case VK_FORMAT_S8_UINT:
459 case VK_FORMAT_R8G8_UINT:
460 case VK_FORMAT_R8G8B8_UINT:
461 case VK_FORMAT_R8G8B8A8_UINT:
462 case VK_FORMAT_A8B8G8R8_UINT_PACK32:
463 case VK_FORMAT_A2B10G10R10_UINT_PACK32:
464 case VK_FORMAT_R16_UINT:
465 case VK_FORMAT_R16G16_UINT:
466 case VK_FORMAT_R16G16B16_UINT:
467 case VK_FORMAT_R16G16B16A16_UINT:
468 case VK_FORMAT_R32_UINT:
469 case VK_FORMAT_R32G32_UINT:
470 case VK_FORMAT_R32G32B32_UINT:
471 case VK_FORMAT_R32G32B32A32_UINT:
472 case VK_FORMAT_R64_UINT:
473 case VK_FORMAT_R64G64_UINT:
474 case VK_FORMAT_R64G64B64_UINT:
475 case VK_FORMAT_R64G64B64A64_UINT:
476 case VK_FORMAT_B8G8R8_UINT:
477 case VK_FORMAT_B8G8R8A8_UINT:
478 case VK_FORMAT_A2R10G10B10_UINT_PACK32:
479 return true;
480 default:
481 return false;
482 }
483 }
484
formatIsSInt(VkFormat format)485 constexpr bool formatIsSInt(VkFormat format) {
486 switch (format) {
487 case VK_FORMAT_R8_SINT:
488 case VK_FORMAT_R8G8_SINT:
489 case VK_FORMAT_R8G8B8_SINT:
490 case VK_FORMAT_R8G8B8A8_SINT:
491 case VK_FORMAT_A8B8G8R8_SINT_PACK32:
492 case VK_FORMAT_A2B10G10R10_SINT_PACK32:
493 case VK_FORMAT_R16_SINT:
494 case VK_FORMAT_R16G16_SINT:
495 case VK_FORMAT_R16G16B16_SINT:
496 case VK_FORMAT_R16G16B16A16_SINT:
497 case VK_FORMAT_R32_SINT:
498 case VK_FORMAT_R32G32_SINT:
499 case VK_FORMAT_R32G32B32_SINT:
500 case VK_FORMAT_R32G32B32A32_SINT:
501 case VK_FORMAT_R64_SINT:
502 case VK_FORMAT_R64G64_SINT:
503 case VK_FORMAT_R64G64B64_SINT:
504 case VK_FORMAT_R64G64B64A64_SINT:
505 case VK_FORMAT_B8G8R8_SINT:
506 case VK_FORMAT_B8G8R8A8_SINT:
507 case VK_FORMAT_A2R10G10B10_SINT_PACK32:
508 return true;
509 default:
510 return false;
511 }
512 }
513
formatIsUFloat(VkFormat format)514 constexpr bool formatIsUFloat(VkFormat format) {
515 switch (format) {
516 case VK_FORMAT_R16_SFLOAT:
517 case VK_FORMAT_R16G16_SFLOAT:
518 case VK_FORMAT_R16G16B16_SFLOAT:
519 case VK_FORMAT_R16G16B16A16_SFLOAT:
520 case VK_FORMAT_R32_SFLOAT:
521 case VK_FORMAT_R32G32_SFLOAT:
522 case VK_FORMAT_R32G32B32_SFLOAT:
523 case VK_FORMAT_R32G32B32A32_SFLOAT:
524 case VK_FORMAT_R64_SFLOAT:
525 case VK_FORMAT_R64G64_SFLOAT:
526 case VK_FORMAT_R64G64B64_SFLOAT:
527 case VK_FORMAT_R64G64B64A64_SFLOAT:
528 case VK_FORMAT_BC6H_SFLOAT_BLOCK:
529 return true;
530 default:
531 return false;
532 }
533 }
534
formatIsSFloat(VkFormat format)535 constexpr bool formatIsSFloat(VkFormat format) {
536 switch (format) {
537 case VK_FORMAT_B10G11R11_UFLOAT_PACK32:
538 case VK_FORMAT_E5B9G9R9_UFLOAT_PACK32:
539 case VK_FORMAT_BC6H_UFLOAT_BLOCK:
540 return true;
541 default:
542 return false;
543 }
544 }
545
formatIsSrgb(VkFormat format)546 constexpr bool formatIsSrgb(VkFormat format) {
547 switch (format) {
548 case VK_FORMAT_R8_SRGB:
549 case VK_FORMAT_R8G8_SRGB:
550 case VK_FORMAT_R8G8B8_SRGB:
551 case VK_FORMAT_R8G8B8A8_SRGB:
552 case VK_FORMAT_A8B8G8R8_SRGB_PACK32:
553 case VK_FORMAT_BC1_RGB_SRGB_BLOCK:
554 case VK_FORMAT_BC2_SRGB_BLOCK:
555 case VK_FORMAT_BC3_SRGB_BLOCK:
556 case VK_FORMAT_BC7_SRGB_BLOCK:
557 case VK_FORMAT_ETC2_R8G8B8_SRGB_BLOCK:
558 case VK_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK:
559 case VK_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK:
560 case VK_FORMAT_ASTC_4x4_SRGB_BLOCK:
561 case VK_FORMAT_ASTC_5x4_SRGB_BLOCK:
562 case VK_FORMAT_ASTC_5x5_SRGB_BLOCK:
563 case VK_FORMAT_ASTC_6x5_SRGB_BLOCK:
564 case VK_FORMAT_ASTC_6x6_SRGB_BLOCK:
565 case VK_FORMAT_ASTC_8x5_SRGB_BLOCK:
566 case VK_FORMAT_ASTC_8x6_SRGB_BLOCK:
567 case VK_FORMAT_ASTC_8x8_SRGB_BLOCK:
568 case VK_FORMAT_ASTC_10x5_SRGB_BLOCK:
569 case VK_FORMAT_ASTC_10x6_SRGB_BLOCK:
570 case VK_FORMAT_ASTC_10x8_SRGB_BLOCK:
571 case VK_FORMAT_ASTC_10x10_SRGB_BLOCK:
572 case VK_FORMAT_ASTC_12x10_SRGB_BLOCK:
573 case VK_FORMAT_ASTC_12x12_SRGB_BLOCK:
574 case VK_FORMAT_B8G8R8_SRGB:
575 case VK_FORMAT_B8G8R8A8_SRGB:
576 return true;
577 default:
578 return false;
579 }
580 }
581
formatIsDepthAndStencil(VkFormat format)582 constexpr bool formatIsDepthAndStencil(VkFormat format) {
583 switch (format) {
584 case VK_FORMAT_D16_UNORM_S8_UINT:
585 case VK_FORMAT_D24_UNORM_S8_UINT:
586 case VK_FORMAT_D32_SFLOAT_S8_UINT:
587 return true;
588 default:
589 return false;
590 }
591 }
592
formatIsDepthOnly(VkFormat format)593 constexpr bool formatIsDepthOnly(VkFormat format) {
594 switch (format) {
595 case VK_FORMAT_D16_UNORM:
596 case VK_FORMAT_X8_D24_UNORM_PACK32:
597 case VK_FORMAT_D32_SFLOAT:
598 return true;
599 default:
600 return false;
601 }
602 }
603
formatIsStencilOnly(VkFormat format)604 constexpr bool formatIsStencilOnly(VkFormat format) { return format == VK_FORMAT_S8_UINT; }
605
formatIsDepthOrStencil(VkFormat format)606 constexpr bool formatIsDepthOrStencil(VkFormat format) {
607 return (formatIsDepthAndStencil(format) || formatIsDepthOnly(format) ||
608 formatIsStencilOnly(format));
609 }
610
formatRequiresSamplerYcbcrConversion(VkFormat format)611 constexpr bool formatRequiresSamplerYcbcrConversion(VkFormat format) {
612 switch (format) {
613 case VK_FORMAT_G8B8G8R8_422_UNORM:
614 case VK_FORMAT_B8G8R8G8_422_UNORM:
615 case VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM:
616 case VK_FORMAT_G8_B8R8_2PLANE_420_UNORM:
617 case VK_FORMAT_G8_B8_R8_3PLANE_422_UNORM:
618 case VK_FORMAT_G8_B8R8_2PLANE_422_UNORM:
619 case VK_FORMAT_G8_B8_R8_3PLANE_444_UNORM:
620 case VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16:
621 case VK_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16:
622 case VK_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16:
623 case VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16:
624 case VK_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16:
625 case VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16:
626 case VK_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16:
627 case VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16:
628 case VK_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16:
629 case VK_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16:
630 case VK_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16:
631 case VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16:
632 case VK_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16:
633 case VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16:
634 case VK_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16:
635 case VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16:
636 case VK_FORMAT_G16B16G16R16_422_UNORM:
637 case VK_FORMAT_B16G16R16G16_422_UNORM:
638 case VK_FORMAT_G16_B16_R16_3PLANE_420_UNORM:
639 case VK_FORMAT_G16_B16R16_2PLANE_420_UNORM:
640 case VK_FORMAT_G16_B16_R16_3PLANE_422_UNORM:
641 case VK_FORMAT_G16_B16R16_2PLANE_422_UNORM:
642 case VK_FORMAT_G16_B16_R16_3PLANE_444_UNORM:
643 #ifdef VK_EXT_YCBCR_2PLANE_444_FORMATS_SPEC_VERSION
644 case VK_FORMAT_G8_B8R8_2PLANE_444_UNORM_EXT:
645 case VK_FORMAT_G10X6_B10X6R10X6_2PLANE_444_UNORM_3PACK16_EXT:
646 case VK_FORMAT_G12X4_B12X4R12X4_2PLANE_444_UNORM_3PACK16_EXT:
647 case VK_FORMAT_G16_B16R16_2PLANE_444_UNORM_EXT:
648 #endif
649 return true;
650 default:
651 return false;
652 }
653 }
654
655 // Returns the size in bytes needed to copy an image with the given format,
656 // width, and height to a staging buffer and the VkBufferImageCopy-s needed
657 // to copy from a staging buffer to destination VkImage.
658 bool getFormatTransferInfo(VkFormat format, uint32_t width, uint32_t height,
659 VkDeviceSize* outStagingBufferCopySize,
660 std::vector<VkBufferImageCopy>* outBufferImageCopies);
661
662 } // namespace vk
663 } // namespace gfxstream
664