projects / mesa.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
isl: Generate isl_format_layout.c
[mesa.git] / src / vulkan / isl.h
1 /*
2 * Copyright 2015 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 /**
25 * @file
26 * @brief Intel Surface Layout
27 */
28
29 #pragma once
30
31 #include <stdint.h>
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 /**
38 * Hardware enumeration SURFACE_FORMAT.
39 *
40 * For the official list, see Broadwell PRM: Volume 2b: Command Reference:
41 * Enumerations: SURFACE_FORMAT.
42 */
43 enum isl_format {
44 ISL_FORMAT_R32G32B32A32_FLOAT = 0,
45 ISL_FORMAT_R32G32B32A32_SINT = 1,
46 ISL_FORMAT_R32G32B32A32_UINT = 2,
47 ISL_FORMAT_R32G32B32A32_UNORM = 3,
48 ISL_FORMAT_R32G32B32A32_SNORM = 4,
49 ISL_FORMAT_R64G64_FLOAT = 5,
50 ISL_FORMAT_R32G32B32X32_FLOAT = 6,
51 ISL_FORMAT_R32G32B32A32_SSCALED = 7,
52 ISL_FORMAT_R32G32B32A32_USCALED = 8,
53 ISL_FORMAT_R32G32B32A32_SFIXED = 32,
54 ISL_FORMAT_R64G64_PASSTHRU = 33,
55 ISL_FORMAT_R32G32B32_FLOAT = 64,
56 ISL_FORMAT_R32G32B32_SINT = 65,
57 ISL_FORMAT_R32G32B32_UINT = 66,
58 ISL_FORMAT_R32G32B32_UNORM = 67,
59 ISL_FORMAT_R32G32B32_SNORM = 68,
60 ISL_FORMAT_R32G32B32_SSCALED = 69,
61 ISL_FORMAT_R32G32B32_USCALED = 70,
62 ISL_FORMAT_R32G32B32_SFIXED = 80,
63 ISL_FORMAT_R16G16B16A16_UNORM = 128,
64 ISL_FORMAT_R16G16B16A16_SNORM = 129,
65 ISL_FORMAT_R16G16B16A16_SINT = 130,
66 ISL_FORMAT_R16G16B16A16_UINT = 131,
67 ISL_FORMAT_R16G16B16A16_FLOAT = 132,
68 ISL_FORMAT_R32G32_FLOAT = 133,
69 ISL_FORMAT_R32G32_SINT = 134,
70 ISL_FORMAT_R32G32_UINT = 135,
71 ISL_FORMAT_R32_FLOAT_X8X24_TYPELESS = 136,
72 ISL_FORMAT_X32_TYPELESS_G8X24_UINT = 137,
73 ISL_FORMAT_L32A32_FLOAT = 138,
74 ISL_FORMAT_R32G32_UNORM = 139,
75 ISL_FORMAT_R32G32_SNORM = 140,
76 ISL_FORMAT_R64_FLOAT = 141,
77 ISL_FORMAT_R16G16B16X16_UNORM = 142,
78 ISL_FORMAT_R16G16B16X16_FLOAT = 143,
79 ISL_FORMAT_A32X32_FLOAT = 144,
80 ISL_FORMAT_L32X32_FLOAT = 145,
81 ISL_FORMAT_I32X32_FLOAT = 146,
82 ISL_FORMAT_R16G16B16A16_SSCALED = 147,
83 ISL_FORMAT_R16G16B16A16_USCALED = 148,
84 ISL_FORMAT_R32G32_SSCALED = 149,
85 ISL_FORMAT_R32G32_USCALED = 150,
86 ISL_FORMAT_R32G32_SFIXED = 160,
87 ISL_FORMAT_R64_PASSTHRU = 161,
88 ISL_FORMAT_B8G8R8A8_UNORM = 192,
89 ISL_FORMAT_B8G8R8A8_UNORM_SRGB = 193,
90 ISL_FORMAT_R10G10B10A2_UNORM = 194,
91 ISL_FORMAT_R10G10B10A2_UNORM_SRGB = 195,
92 ISL_FORMAT_R10G10B10A2_UINT = 196,
93 ISL_FORMAT_R10G10B10_SNORM_A2_UNORM = 197,
94 ISL_FORMAT_R8G8B8A8_UNORM = 199,
95 ISL_FORMAT_R8G8B8A8_UNORM_SRGB = 200,
96 ISL_FORMAT_R8G8B8A8_SNORM = 201,
97 ISL_FORMAT_R8G8B8A8_SINT = 202,
98 ISL_FORMAT_R8G8B8A8_UINT = 203,
99 ISL_FORMAT_R16G16_UNORM = 204,
100 ISL_FORMAT_R16G16_SNORM = 205,
101 ISL_FORMAT_R16G16_SINT = 206,
102 ISL_FORMAT_R16G16_UINT = 207,
103 ISL_FORMAT_R16G16_FLOAT = 208,
104 ISL_FORMAT_B10G10R10A2_UNORM = 209,
105 ISL_FORMAT_B10G10R10A2_UNORM_SRGB = 210,
106 ISL_FORMAT_R11G11B10_FLOAT = 211,
107 ISL_FORMAT_R32_SINT = 214,
108 ISL_FORMAT_R32_UINT = 215,
109 ISL_FORMAT_R32_FLOAT = 216,
110 ISL_FORMAT_R24_UNORM_X8_TYPELESS = 217,
111 ISL_FORMAT_X24_TYPELESS_G8_UINT = 218,
112 ISL_FORMAT_L32_UNORM = 221,
113 ISL_FORMAT_A32_UNORM = 222,
114 ISL_FORMAT_L16A16_UNORM = 223,
115 ISL_FORMAT_I24X8_UNORM = 224,
116 ISL_FORMAT_L24X8_UNORM = 225,
117 ISL_FORMAT_A24X8_UNORM = 226,
118 ISL_FORMAT_I32_FLOAT = 227,
119 ISL_FORMAT_L32_FLOAT = 228,
120 ISL_FORMAT_A32_FLOAT = 229,
121 ISL_FORMAT_X8B8_UNORM_G8R8_SNORM = 230,
122 ISL_FORMAT_A8X8_UNORM_G8R8_SNORM = 231,
123 ISL_FORMAT_B8X8_UNORM_G8R8_SNORM = 232,
124 ISL_FORMAT_B8G8R8X8_UNORM = 233,
125 ISL_FORMAT_B8G8R8X8_UNORM_SRGB = 234,
126 ISL_FORMAT_R8G8B8X8_UNORM = 235,
127 ISL_FORMAT_R8G8B8X8_UNORM_SRGB = 236,
128 ISL_FORMAT_R9G9B9E5_SHAREDEXP = 237,
129 ISL_FORMAT_B10G10R10X2_UNORM = 238,
130 ISL_FORMAT_L16A16_FLOAT = 240,
131 ISL_FORMAT_R32_UNORM = 241,
132 ISL_FORMAT_R32_SNORM = 242,
133 ISL_FORMAT_R10G10B10X2_USCALED = 243,
134 ISL_FORMAT_R8G8B8A8_SSCALED = 244,
135 ISL_FORMAT_R8G8B8A8_USCALED = 245,
136 ISL_FORMAT_R16G16_SSCALED = 246,
137 ISL_FORMAT_R16G16_USCALED = 247,
138 ISL_FORMAT_R32_SSCALED = 248,
139 ISL_FORMAT_R32_USCALED = 249,
140 ISL_FORMAT_B5G6R5_UNORM = 256,
141 ISL_FORMAT_B5G6R5_UNORM_SRGB = 257,
142 ISL_FORMAT_B5G5R5A1_UNORM = 258,
143 ISL_FORMAT_B5G5R5A1_UNORM_SRGB = 259,
144 ISL_FORMAT_B4G4R4A4_UNORM = 260,
145 ISL_FORMAT_B4G4R4A4_UNORM_SRGB = 261,
146 ISL_FORMAT_R8G8_UNORM = 262,
147 ISL_FORMAT_R8G8_SNORM = 263,
148 ISL_FORMAT_R8G8_SINT = 264,
149 ISL_FORMAT_R8G8_UINT = 265,
150 ISL_FORMAT_R16_UNORM = 266,
151 ISL_FORMAT_R16_SNORM = 267,
152 ISL_FORMAT_R16_SINT = 268,
153 ISL_FORMAT_R16_UINT = 269,
154 ISL_FORMAT_R16_FLOAT = 270,
155 ISL_FORMAT_A8P8_UNORM_PALETTE0 = 271,
156 ISL_FORMAT_A8P8_UNORM_PALETTE1 = 272,
157 ISL_FORMAT_I16_UNORM = 273,
158 ISL_FORMAT_L16_UNORM = 274,
159 ISL_FORMAT_A16_UNORM = 275,
160 ISL_FORMAT_L8A8_UNORM = 276,
161 ISL_FORMAT_I16_FLOAT = 277,
162 ISL_FORMAT_L16_FLOAT = 278,
163 ISL_FORMAT_A16_FLOAT = 279,
164 ISL_FORMAT_L8A8_UNORM_SRGB = 280,
165 ISL_FORMAT_R5G5_SNORM_B6_UNORM = 281,
166 ISL_FORMAT_B5G5R5X1_UNORM = 282,
167 ISL_FORMAT_B5G5R5X1_UNORM_SRGB = 283,
168 ISL_FORMAT_R8G8_SSCALED = 284,
169 ISL_FORMAT_R8G8_USCALED = 285,
170 ISL_FORMAT_R16_SSCALED = 286,
171 ISL_FORMAT_R16_USCALED = 287,
172 ISL_FORMAT_P8A8_UNORM_PALETTE0 = 290,
173 ISL_FORMAT_P8A8_UNORM_PALETTE1 = 291,
174 ISL_FORMAT_A1B5G5R5_UNORM = 292,
175 ISL_FORMAT_A4B4G4R4_UNORM = 293,
176 ISL_FORMAT_L8A8_UINT = 294,
177 ISL_FORMAT_L8A8_SINT = 295,
178 ISL_FORMAT_R8_UNORM = 320,
179 ISL_FORMAT_R8_SNORM = 321,
180 ISL_FORMAT_R8_SINT = 322,
181 ISL_FORMAT_R8_UINT = 323,
182 ISL_FORMAT_A8_UNORM = 324,
183 ISL_FORMAT_I8_UNORM = 325,
184 ISL_FORMAT_L8_UNORM = 326,
185 ISL_FORMAT_P4A4_UNORM_PALETTE0 = 327,
186 ISL_FORMAT_A4P4_UNORM_PALETTE0 = 328,
187 ISL_FORMAT_R8_SSCALED = 329,
188 ISL_FORMAT_R8_USCALED = 330,
189 ISL_FORMAT_P8_UNORM_PALETTE0 = 331,
190 ISL_FORMAT_L8_UNORM_SRGB = 332,
191 ISL_FORMAT_P8_UNORM_PALETTE1 = 333,
192 ISL_FORMAT_P4A4_UNORM_PALETTE1 = 334,
193 ISL_FORMAT_A4P4_UNORM_PALETTE1 = 335,
194 ISL_FORMAT_Y8_UNORM = 336,
195 ISL_FORMAT_L8_UINT = 338,
196 ISL_FORMAT_L8_SINT = 339,
197 ISL_FORMAT_I8_UINT = 340,
198 ISL_FORMAT_I8_SINT = 341,
199 ISL_FORMAT_DXT1_RGB_SRGB = 384,
200 ISL_FORMAT_R1_UNORM = 385,
201 ISL_FORMAT_YCRCB_NORMAL = 386,
202 ISL_FORMAT_YCRCB_SWAPUVY = 387,
203 ISL_FORMAT_P2_UNORM_PALETTE0 = 388,
204 ISL_FORMAT_P2_UNORM_PALETTE1 = 389,
205 ISL_FORMAT_BC1_UNORM = 390,
206 ISL_FORMAT_BC2_UNORM = 391,
207 ISL_FORMAT_BC3_UNORM = 392,
208 ISL_FORMAT_BC4_UNORM = 393,
209 ISL_FORMAT_BC5_UNORM = 394,
210 ISL_FORMAT_BC1_UNORM_SRGB = 395,
211 ISL_FORMAT_BC2_UNORM_SRGB = 396,
212 ISL_FORMAT_BC3_UNORM_SRGB = 397,
213 ISL_FORMAT_MONO8 = 398,
214 ISL_FORMAT_YCRCB_SWAPUV = 399,
215 ISL_FORMAT_YCRCB_SWAPY = 400,
216 ISL_FORMAT_DXT1_RGB = 401,
217 ISL_FORMAT_FXT1 = 402,
218 ISL_FORMAT_R8G8B8_UNORM = 403,
219 ISL_FORMAT_R8G8B8_SNORM = 404,
220 ISL_FORMAT_R8G8B8_SSCALED = 405,
221 ISL_FORMAT_R8G8B8_USCALED = 406,
222 ISL_FORMAT_R64G64B64A64_FLOAT = 407,
223 ISL_FORMAT_R64G64B64_FLOAT = 408,
224 ISL_FORMAT_BC4_SNORM = 409,
225 ISL_FORMAT_BC5_SNORM = 410,
226 ISL_FORMAT_R16G16B16_FLOAT = 411,
227 ISL_FORMAT_R16G16B16_UNORM = 412,
228 ISL_FORMAT_R16G16B16_SNORM = 413,
229 ISL_FORMAT_R16G16B16_SSCALED = 414,
230 ISL_FORMAT_R16G16B16_USCALED = 415,
231 ISL_FORMAT_BC6H_SF16 = 417,
232 ISL_FORMAT_BC7_UNORM = 418,
233 ISL_FORMAT_BC7_UNORM_SRGB = 419,
234 ISL_FORMAT_BC6H_UF16 = 420,
235 ISL_FORMAT_PLANAR_420_8 = 421,
236 ISL_FORMAT_R8G8B8_UNORM_SRGB = 424,
237 ISL_FORMAT_ETC1_RGB8 = 425,
238 ISL_FORMAT_ETC2_RGB8 = 426,
239 ISL_FORMAT_EAC_R11 = 427,
240 ISL_FORMAT_EAC_RG11 = 428,
241 ISL_FORMAT_EAC_SIGNED_R11 = 429,
242 ISL_FORMAT_EAC_SIGNED_RG11 = 430,
243 ISL_FORMAT_ETC2_SRGB8 = 431,
244 ISL_FORMAT_R16G16B16_UINT = 432,
245 ISL_FORMAT_R16G16B16_SINT = 433,
246 ISL_FORMAT_R32_SFIXED = 434,
247 ISL_FORMAT_R10G10B10A2_SNORM = 435,
248 ISL_FORMAT_R10G10B10A2_USCALED = 436,
249 ISL_FORMAT_R10G10B10A2_SSCALED = 437,
250 ISL_FORMAT_R10G10B10A2_SINT = 438,
251 ISL_FORMAT_B10G10R10A2_SNORM = 439,
252 ISL_FORMAT_B10G10R10A2_USCALED = 440,
253 ISL_FORMAT_B10G10R10A2_SSCALED = 441,
254 ISL_FORMAT_B10G10R10A2_UINT = 442,
255 ISL_FORMAT_B10G10R10A2_SINT = 443,
256 ISL_FORMAT_R64G64B64A64_PASSTHRU = 444,
257 ISL_FORMAT_R64G64B64_PASSTHRU = 445,
258 ISL_FORMAT_ETC2_RGB8_PTA = 448,
259 ISL_FORMAT_ETC2_SRGB8_PTA = 449,
260 ISL_FORMAT_ETC2_EAC_RGBA8 = 450,
261 ISL_FORMAT_ETC2_EAC_SRGB8_A8 = 451,
262 ISL_FORMAT_R8G8B8_UINT = 456,
263 ISL_FORMAT_R8G8B8_SINT = 457,
264 ISL_FORMAT_RAW = 511,
265
266 /* Hardware doesn't understand this out-of-band value */
267 ISL_FORMAT_UNSUPPORTED = UINT16_MAX,
268 };
269
270 enum isl_base_type {
271 ISL_VOID,
272 ISL_RAW,
273 ISL_UNORM,
274 ISL_SNORM,
275 ISL_UFLOAT,
276 ISL_SFLOAT,
277 ISL_UFIXED,
278 ISL_SFIXED,
279 ISL_UINT,
280 ISL_SINT,
281 ISL_USCALED,
282 ISL_SSCALED,
283 };
284
285 enum isl_colorspace {
286 ISL_COLORSPACE_NONE = 0,
287 ISL_COLORSPACE_LINEAR,
288 ISL_COLORSPACE_SRGB,
289 ISL_COLORSPACE_YUV,
290 };
291
292 /**
293 * Texture compression mode
294 */
295 enum isl_txc {
296 ISL_TXC_NONE = 0,
297 ISL_TXC_DXT1,
298 ISL_TXC_DXT3,
299 ISL_TXC_DXT5,
300 ISL_TXC_FXT1,
301 ISL_TXC_RGTC1,
302 ISL_TXC_RGTC2,
303 ISL_TXC_BPTC,
304 ISL_TXC_ETC1,
305 ISL_TXC_ETC2,
306 };
307
308 struct isl_channel_layout {
309 enum isl_base_type type;
310 uint8_t bits; /**< Size in bits */
311 };
312
313 struct isl_format_layout {
314 enum isl_format format;
315
316 uint16_t bpb; /**< Bits per block */
317 uint8_t bs; /**< Block size, in bytes, rounded towards 0 */
318 uint8_t bw; /**< Block width, in pixels */
319 uint8_t bh; /**< Block height, in pixels */
320 uint8_t bd; /**< Block depth, in pixels */
321
322 struct {
323 struct isl_channel_layout r; /**< Red channel */
324 struct isl_channel_layout g; /**< Green channel */
325 struct isl_channel_layout b; /**< Blue channel */
326 struct isl_channel_layout a; /**< Alpha channel */
327 struct isl_channel_layout l; /**< Luminance channel */
328 struct isl_channel_layout i; /**< Intensity channel */
329 struct isl_channel_layout p; /**< Palette channel */
330 } channels;
331
332 enum isl_colorspace colorspace;
333 enum isl_txc txc;
334 };
335
336 extern const struct isl_format_layout isl_format_layouts[];
337
338 #ifdef __cplusplus
339 }
340 #endif