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 // Header library that captures common patterns when working with
19 // Vulkan formats:
20 // - Macros to iterate over categories of formats
21 // - Add often-used parameters like the bytes per pixel and ASTC block size
22
23 #define LIST_VK_FORMATS_LINEAR(f) \
24 f(VK_FORMAT_UNDEFINED, 0) \
25 f(VK_FORMAT_R4G4_UNORM_PACK8, 1) \
26 f(VK_FORMAT_R4G4B4A4_UNORM_PACK16, 2) \
27 f(VK_FORMAT_B4G4R4A4_UNORM_PACK16, 2) \
28 f(VK_FORMAT_R5G6B5_UNORM_PACK16, 2) \
29 f(VK_FORMAT_B5G6R5_UNORM_PACK16, 2) \
30 f(VK_FORMAT_R5G5B5A1_UNORM_PACK16, 2) \
31 f(VK_FORMAT_B5G5R5A1_UNORM_PACK16, 2) \
32 f(VK_FORMAT_A1R5G5B5_UNORM_PACK16, 2) \
33 f(VK_FORMAT_R8_UNORM, 1) \
34 f(VK_FORMAT_R8_SNORM, 1) \
35 f(VK_FORMAT_R8_USCALED, 1) \
36 f(VK_FORMAT_R8_SSCALED, 1) \
37 f(VK_FORMAT_R8_UINT, 1) \
38 f(VK_FORMAT_R8_SINT, 1) \
39 f(VK_FORMAT_R8_SRGB, 1) \
40 f(VK_FORMAT_R8G8_UNORM, 2) \
41 f(VK_FORMAT_R8G8_SNORM, 2) \
42 f(VK_FORMAT_R8G8_USCALED, 2) \
43 f(VK_FORMAT_R8G8_SSCALED, 2) \
44 f(VK_FORMAT_R8G8_UINT, 2) \
45 f(VK_FORMAT_R8G8_SINT, 2) \
46 f(VK_FORMAT_R8G8_SRGB, 2) \
47 f(VK_FORMAT_R8G8B8_UNORM, 3) \
48 f(VK_FORMAT_R8G8B8_SNORM, 3) \
49 f(VK_FORMAT_R8G8B8_USCALED, 3) \
50 f(VK_FORMAT_R8G8B8_SSCALED, 3) \
51 f(VK_FORMAT_R8G8B8_UINT, 3) \
52 f(VK_FORMAT_R8G8B8_SINT, 3) \
53 f(VK_FORMAT_R8G8B8_SRGB, 3) \
54 f(VK_FORMAT_B8G8R8_UNORM, 3) \
55 f(VK_FORMAT_B8G8R8_SNORM, 3) \
56 f(VK_FORMAT_B8G8R8_USCALED, 3) \
57 f(VK_FORMAT_B8G8R8_SSCALED, 3) \
58 f(VK_FORMAT_B8G8R8_UINT, 3) \
59 f(VK_FORMAT_B8G8R8_SINT, 3) \
60 f(VK_FORMAT_B8G8R8_SRGB, 3) \
61 f(VK_FORMAT_R8G8B8A8_UNORM, 4) \
62 f(VK_FORMAT_R8G8B8A8_SNORM, 4) \
63 f(VK_FORMAT_R8G8B8A8_USCALED, 4) \
64 f(VK_FORMAT_R8G8B8A8_SSCALED, 4) \
65 f(VK_FORMAT_R8G8B8A8_UINT, 4) \
66 f(VK_FORMAT_R8G8B8A8_SINT, 4) \
67 f(VK_FORMAT_R8G8B8A8_SRGB, 4) \
68 f(VK_FORMAT_B8G8R8A8_UNORM, 4) \
69 f(VK_FORMAT_B8G8R8A8_SNORM, 4) \
70 f(VK_FORMAT_B8G8R8A8_USCALED, 4) \
71 f(VK_FORMAT_B8G8R8A8_SSCALED, 4) \
72 f(VK_FORMAT_B8G8R8A8_UINT, 4) \
73 f(VK_FORMAT_B8G8R8A8_SINT, 4) \
74 f(VK_FORMAT_B8G8R8A8_SRGB, 4) \
75 f(VK_FORMAT_A8B8G8R8_UNORM_PACK32, 4) \
76 f(VK_FORMAT_A8B8G8R8_SNORM_PACK32, 4) \
77 f(VK_FORMAT_A8B8G8R8_USCALED_PACK32, 4) \
78 f(VK_FORMAT_A8B8G8R8_SSCALED_PACK32, 4) \
79 f(VK_FORMAT_A8B8G8R8_UINT_PACK32, 4) \
80 f(VK_FORMAT_A8B8G8R8_SINT_PACK32, 4) \
81 f(VK_FORMAT_A8B8G8R8_SRGB_PACK32, 4) \
82 f(VK_FORMAT_A2R10G10B10_UNORM_PACK32, 4) \
83 f(VK_FORMAT_A2R10G10B10_SNORM_PACK32, 4) \
84 f(VK_FORMAT_A2R10G10B10_USCALED_PACK32, 4) \
85 f(VK_FORMAT_A2R10G10B10_SSCALED_PACK32, 4) \
86 f(VK_FORMAT_A2R10G10B10_UINT_PACK32, 4) \
87 f(VK_FORMAT_A2R10G10B10_SINT_PACK32, 4) \
88 f(VK_FORMAT_A2B10G10R10_UNORM_PACK32, 4) \
89 f(VK_FORMAT_A2B10G10R10_SNORM_PACK32, 4) \
90 f(VK_FORMAT_A2B10G10R10_USCALED_PACK32, 4) \
91 f(VK_FORMAT_A2B10G10R10_SSCALED_PACK32, 4) \
92 f(VK_FORMAT_A2B10G10R10_UINT_PACK32, 4) \
93 f(VK_FORMAT_A2B10G10R10_SINT_PACK32, 4) \
94 f(VK_FORMAT_R16_UNORM, 2) \
95 f(VK_FORMAT_R16_SNORM, 2) \
96 f(VK_FORMAT_R16_USCALED, 2) \
97 f(VK_FORMAT_R16_SSCALED, 2) \
98 f(VK_FORMAT_R16_UINT, 2) \
99 f(VK_FORMAT_R16_SINT, 2) \
100 f(VK_FORMAT_R16_SFLOAT, 2) \
101 f(VK_FORMAT_R16G16_UNORM, 4) \
102 f(VK_FORMAT_R16G16_SNORM, 4) \
103 f(VK_FORMAT_R16G16_USCALED, 4) \
104 f(VK_FORMAT_R16G16_SSCALED, 4) \
105 f(VK_FORMAT_R16G16_UINT, 4) \
106 f(VK_FORMAT_R16G16_SINT, 4) \
107 f(VK_FORMAT_R16G16_SFLOAT, 4) \
108 f(VK_FORMAT_R16G16B16_UNORM, 6) \
109 f(VK_FORMAT_R16G16B16_SNORM, 6) \
110 f(VK_FORMAT_R16G16B16_USCALED, 6) \
111 f(VK_FORMAT_R16G16B16_SSCALED, 6) \
112 f(VK_FORMAT_R16G16B16_UINT, 6) \
113 f(VK_FORMAT_R16G16B16_SINT, 6) \
114 f(VK_FORMAT_R16G16B16_SFLOAT, 6) \
115 f(VK_FORMAT_R16G16B16A16_UNORM, 8) \
116 f(VK_FORMAT_R16G16B16A16_SNORM, 8) \
117 f(VK_FORMAT_R16G16B16A16_USCALED, 8) \
118 f(VK_FORMAT_R16G16B16A16_SSCALED, 8) \
119 f(VK_FORMAT_R16G16B16A16_UINT, 8) \
120 f(VK_FORMAT_R16G16B16A16_SINT, 8) \
121 f(VK_FORMAT_R16G16B16A16_SFLOAT, 8) \
122 f(VK_FORMAT_R32_UINT, 4) \
123 f(VK_FORMAT_R32_SINT, 4) \
124 f(VK_FORMAT_R32_SFLOAT, 4) \
125 f(VK_FORMAT_R32G32_UINT, 8) \
126 f(VK_FORMAT_R32G32_SINT, 8) \
127 f(VK_FORMAT_R32G32_SFLOAT, 8) \
128 f(VK_FORMAT_R32G32B32_UINT, 8) \
129 f(VK_FORMAT_R32G32B32_SINT, 8) \
130 f(VK_FORMAT_R32G32B32_SFLOAT, 8) \
131 f(VK_FORMAT_R32G32B32A32_UINT, 16) \
132 f(VK_FORMAT_R32G32B32A32_SINT, 16) \
133 f(VK_FORMAT_R32G32B32A32_SFLOAT, 16) \
134 f(VK_FORMAT_R64_UINT, 8) \
135 f(VK_FORMAT_R64_SINT, 8) \
136 f(VK_FORMAT_R64_SFLOAT, 8) \
137 f(VK_FORMAT_R64G64_UINT, 16) \
138 f(VK_FORMAT_R64G64_SINT, 16) \
139 f(VK_FORMAT_R64G64_SFLOAT, 16) \
140 f(VK_FORMAT_R64G64B64_UINT, 24) \
141 f(VK_FORMAT_R64G64B64_SINT, 24) \
142 f(VK_FORMAT_R64G64B64_SFLOAT, 24) \
143 f(VK_FORMAT_R64G64B64A64_UINT, 32) \
144 f(VK_FORMAT_R64G64B64A64_SINT, 32) \
145 f(VK_FORMAT_R64G64B64A64_SFLOAT, 32) \
146 f(VK_FORMAT_B10G11R11_UFLOAT_PACK32, 4) \
147 f(VK_FORMAT_E5B9G9R9_UFLOAT_PACK32, 4) \
148 f(VK_FORMAT_D16_UNORM, 2) \
149 f(VK_FORMAT_X8_D24_UNORM_PACK32, 4) \
150 f(VK_FORMAT_D32_SFLOAT, 4) \
151 f(VK_FORMAT_S8_UINT, 1) \
152 f(VK_FORMAT_D16_UNORM_S8_UINT, 3) \
153 f(VK_FORMAT_D24_UNORM_S8_UINT, 4) \
154 f(VK_FORMAT_D32_SFLOAT_S8_UINT, 5) \
155 f(VK_FORMAT_R10X6_UNORM_PACK16, 2) \
156 f(VK_FORMAT_R10X6G10X6_UNORM_2PACK16, 4) \
157 f(VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16, 8) \
158 f(VK_FORMAT_R12X4_UNORM_PACK16, 2) \
159 f(VK_FORMAT_R12X4G12X4_UNORM_2PACK16, 4) \
160 f(VK_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16, 8) \
161
162 // TODO: BC formats
163 #define LIST_VK_FORMATS_COMPRESSED_BC(f) \
164 f(VK_FORMAT_BC1_RGB_UNORM_BLOCK, 0) \
165 f(VK_FORMAT_BC1_RGB_SRGB_BLOCK, 0) \
166 f(VK_FORMAT_BC1_RGBA_UNORM_BLOCK, 0) \
167 f(VK_FORMAT_BC1_RGBA_SRGB_BLOCK, 0) \
168 f(VK_FORMAT_BC2_UNORM_BLOCK, 0) \
169 f(VK_FORMAT_BC2_SRGB_BLOCK, 0) \
170 f(VK_FORMAT_BC3_UNORM_BLOCK, 0) \
171 f(VK_FORMAT_BC3_SRGB_BLOCK, 0) \
172 f(VK_FORMAT_BC4_UNORM_BLOCK, 0) \
173 f(VK_FORMAT_BC4_SNORM_BLOCK, 0) \
174 f(VK_FORMAT_BC5_UNORM_BLOCK, 0) \
175 f(VK_FORMAT_BC5_SNORM_BLOCK, 0) \
176 f(VK_FORMAT_BC6H_UFLOAT_BLOCK, 0) \
177 f(VK_FORMAT_BC6H_SFLOAT_BLOCK, 0) \
178 f(VK_FORMAT_BC7_UNORM_BLOCK, 0) \
179 f(VK_FORMAT_BC7_SRGB_BLOCK, 0) \
180
181 // TODO: ETC2 format parameters
182 #define LIST_VK_FORMATS_COMPRESSED_ETC2(f) \
183 f(VK_FORMAT_ETC2_R8G8B8_UNORM_BLOCK, 0) \
184 f(VK_FORMAT_ETC2_R8G8B8_SRGB_BLOCK, 0) \
185 f(VK_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK, 0) \
186 f(VK_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK, 0) \
187 f(VK_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK, 0) \
188 f(VK_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK, 0) \
189
190 // TODO: EAC format parameters
191 #define LIST_VK_FORMATS_COMPRESSED_EAC(f) \
192 f(VK_FORMAT_EAC_R11_UNORM_BLOCK, 0) \
193 f(VK_FORMAT_EAC_R11_SNORM_BLOCK, 0) \
194 f(VK_FORMAT_EAC_R11G11_UNORM_BLOCK, 0) \
195 f(VK_FORMAT_EAC_R11G11_SNORM_BLOCK, 0) \
196
197 // ASTC: block dimensions, then whether it is SRGB
198 #define LIST_VK_FORMATS_COMPRESSED_ASTC(f) \
199 f(VK_FORMAT_ASTC_4x4_UNORM_BLOCK, 4, 4, 0) \
200 f(VK_FORMAT_ASTC_4x4_SRGB_BLOCK, 4, 4, 1) \
201 f(VK_FORMAT_ASTC_5x4_UNORM_BLOCK, 5, 4, 0) \
202 f(VK_FORMAT_ASTC_5x4_SRGB_BLOCK, 5, 4, 1) \
203 f(VK_FORMAT_ASTC_5x5_UNORM_BLOCK, 5, 5, 0) \
204 f(VK_FORMAT_ASTC_5x5_SRGB_BLOCK, 5, 5, 1) \
205 f(VK_FORMAT_ASTC_6x5_UNORM_BLOCK, 6, 5, 0) \
206 f(VK_FORMAT_ASTC_6x5_SRGB_BLOCK, 6, 5, 1) \
207 f(VK_FORMAT_ASTC_6x6_UNORM_BLOCK, 6, 6, 0) \
208 f(VK_FORMAT_ASTC_6x6_SRGB_BLOCK, 6, 6, 1) \
209 f(VK_FORMAT_ASTC_8x5_UNORM_BLOCK, 8, 5, 0) \
210 f(VK_FORMAT_ASTC_8x5_SRGB_BLOCK, 8, 5, 1) \
211 f(VK_FORMAT_ASTC_8x6_UNORM_BLOCK, 8, 6, 0) \
212 f(VK_FORMAT_ASTC_8x6_SRGB_BLOCK, 8, 6, 1) \
213 f(VK_FORMAT_ASTC_8x8_UNORM_BLOCK, 8, 8, 0) \
214 f(VK_FORMAT_ASTC_8x8_SRGB_BLOCK, 8, 8, 1) \
215 f(VK_FORMAT_ASTC_10x5_UNORM_BLOCK, 10, 5, 0) \
216 f(VK_FORMAT_ASTC_10x5_SRGB_BLOCK, 10, 5, 1) \
217 f(VK_FORMAT_ASTC_10x6_UNORM_BLOCK, 10, 6, 0) \
218 f(VK_FORMAT_ASTC_10x6_SRGB_BLOCK, 10, 6, 1) \
219 f(VK_FORMAT_ASTC_10x8_UNORM_BLOCK, 10, 8, 0) \
220 f(VK_FORMAT_ASTC_10x8_SRGB_BLOCK, 10, 8, 1) \
221 f(VK_FORMAT_ASTC_10x10_UNORM_BLOCK, 10, 10, 0) \
222 f(VK_FORMAT_ASTC_10x10_SRGB_BLOCK, 10, 10, 1) \
223 f(VK_FORMAT_ASTC_12x10_UNORM_BLOCK, 12, 10, 0) \
224 f(VK_FORMAT_ASTC_12x10_SRGB_BLOCK, 12, 10, 1) \
225 f(VK_FORMAT_ASTC_12x12_UNORM_BLOCK, 12, 12, 0) \
226 f(VK_FORMAT_ASTC_12x12_SRGB_BLOCK, 12, 12, 1) \
227
228 // TODO: Come up with parameters to describe multiplane formats
229 #define LIST_VK_FORMATS_MULTIPLANE(f) \
230 f(VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM, 0) \
231 f(VK_FORMAT_G8_B8R8_2PLANE_420_UNORM, 0) \
232 f(VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16, 0) \
233 f(VK_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16, 0) \
234 f(VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16, 0) \
235 f(VK_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16, 0) \
236 f(VK_FORMAT_G16_B16_R16_3PLANE_420_UNORM, 0) \
237 f(VK_FORMAT_G16_B16R16_2PLANE_420_UNORM, 0) \
238 f(VK_FORMAT_G8B8G8R8_422_UNORM, 0) \
239 f(VK_FORMAT_B8G8R8G8_422_UNORM, 0) \
240 f(VK_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16, 0) \
241 f(VK_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16, 0) \
242 f(VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16, 0) \
243 f(VK_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16, 0) \
244 f(VK_FORMAT_G8_B8_R8_3PLANE_422_UNORM, 0) \
245 f(VK_FORMAT_G8_B8R8_2PLANE_422_UNORM, 0) \
246 f(VK_FORMAT_G16B16G16R16_422_UNORM, 0) \
247 f(VK_FORMAT_B16G16R16G16_422_UNORM, 0) \
248 f(VK_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16, 0) \
249 f(VK_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16, 0) \
250 f(VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16, 0) \
251 f(VK_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16, 0) \
252 f(VK_FORMAT_G16_B16_R16_3PLANE_422_UNORM, 0) \
253 f(VK_FORMAT_G16_B16R16_2PLANE_422_UNORM, 0) \
254 f(VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16, 0) \
255 f(VK_FORMAT_G8_B8_R8_3PLANE_444_UNORM, 0) \
256 f(VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16, 0) \
257 f(VK_FORMAT_G16_B16_R16_3PLANE_444_UNORM, 0) \
258
259 // TODO: Come up with parameters to describe PVRTC formats
260 #define LIST_VK_FORMATS_COMPRESSED_PVRTC(f) \
261 f(VK_FORMAT_PVRTC1_2BPP_UNORM_BLOCK_IMG, 0) \
262 f(VK_FORMAT_PVRTC1_4BPP_UNORM_BLOCK_IMG, 0) \
263 f(VK_FORMAT_PVRTC2_2BPP_UNORM_BLOCK_IMG, 0) \
264 f(VK_FORMAT_PVRTC2_4BPP_UNORM_BLOCK_IMG, 0) \
265 f(VK_FORMAT_PVRTC1_2BPP_SRGB_BLOCK_IMG, 0) \
266 f(VK_FORMAT_PVRTC1_4BPP_SRGB_BLOCK_IMG, 0) \
267 f(VK_FORMAT_PVRTC2_2BPP_SRGB_BLOCK_IMG, 0) \
268 f(VK_FORMAT_PVRTC2_4BPP_SRGB_BLOCK_IMG, 0) \
269
getLinearFormatPixelSize(VkFormat format)270 static inline int getLinearFormatPixelSize(VkFormat format) {
271
272 #define VK_FORMATS_LINEAR_GET_PIXEL_SIZE(f, size) \
273 if (format == f) return size;
274
275 LIST_VK_FORMATS_LINEAR(VK_FORMATS_LINEAR_GET_PIXEL_SIZE)
276
277 return 0;
278 }
279