projects / mesa.git / blob
? search:


4936fa0d482b3c1339c43a8377af5797904d9559
[mesa.git] / src / mesa / main / formats.h
1 /*
2 * Mesa 3-D graphics library
3 *
4 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
5 * Copyright (c) 2008-2009 VMware, Inc.
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
21 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
23 * OTHER DEALINGS IN THE SOFTWARE.
24 */
25
26 /*
27 * Authors:
28 * Brian Paul
29 */
30
31
32 #ifndef FORMATS_H
33 #define FORMATS_H
34
35
36 #include <GL/gl.h>
37 #include <stdbool.h>
38 #include <stdint.h>
39 #include "compiler.h"
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45
46 /**
47 * OpenGL doesn't have GL_UNSIGNED_BYTE_4_4, so we must define our own type
48 * for GL_LUMINANCE4_ALPHA4.
49 */
50 #define MESA_UNSIGNED_BYTE_4_4 (GL_UNSIGNED_BYTE<<1)
51
52
53 /**
54 * Max number of bytes for any non-compressed pixel format below, or for
55 * intermediate pixel storage in Mesa. This should never be less than
56 * 16. Maybe 32 someday?
57 */
58 #define MAX_PIXEL_BYTES 16
59
60 /**
61 * Specifies the layout of a pixel format. See the MESA_FORMAT
62 * documentation below.
63 */
64 enum mesa_format_layout {
65 MESA_FORMAT_LAYOUT_ARRAY,
66 MESA_FORMAT_LAYOUT_PACKED,
67 MESA_FORMAT_LAYOUT_S3TC,
68 MESA_FORMAT_LAYOUT_RGTC,
69 MESA_FORMAT_LAYOUT_FXT1,
70 MESA_FORMAT_LAYOUT_ETC1,
71 MESA_FORMAT_LAYOUT_ETC2,
72 MESA_FORMAT_LAYOUT_BPTC,
73 MESA_FORMAT_LAYOUT_OTHER,
74 };
75
76 /**
77 * An enum representing different possible swizzling values. This is used
78 * to interpret the output of _mesa_get_format_swizzle
79 */
80 enum {
81 MESA_FORMAT_SWIZZLE_X = 0,
82 MESA_FORMAT_SWIZZLE_Y = 1,
83 MESA_FORMAT_SWIZZLE_Z = 2,
84 MESA_FORMAT_SWIZZLE_W = 3,
85 MESA_FORMAT_SWIZZLE_ZERO = 4,
86 MESA_FORMAT_SWIZZLE_ONE = 5,
87 MESA_FORMAT_SWIZZLE_NONE = 6,
88 };
89
90 /**
91 * An uint32_t that encodes the information necessary to represent an
92 * array format
93 */
94 typedef uint32_t mesa_array_format;
95
96 /**
97 * Encoding for valid array format data types
98 */
99 enum mesa_array_format_datatype {
100 MESA_ARRAY_FORMAT_TYPE_UBYTE = 0x0,
101 MESA_ARRAY_FORMAT_TYPE_USHORT = 0x1,
102 MESA_ARRAY_FORMAT_TYPE_UINT = 0x2,
103 MESA_ARRAY_FORMAT_TYPE_BYTE = 0x4,
104 MESA_ARRAY_FORMAT_TYPE_SHORT = 0x5,
105 MESA_ARRAY_FORMAT_TYPE_INT = 0x6,
106 MESA_ARRAY_FORMAT_TYPE_HALF = 0xd,
107 MESA_ARRAY_FORMAT_TYPE_FLOAT = 0xe,
108 };
109
110 /**
111 * An enum useful to encode/decode information stored in a mesa_array_format
112 */
113 enum {
114 MESA_ARRAY_FORMAT_TYPE_IS_SIGNED = 0x4,
115 MESA_ARRAY_FORMAT_TYPE_IS_FLOAT = 0x8,
116 MESA_ARRAY_FORMAT_TYPE_NORMALIZED = 0x10,
117 MESA_ARRAY_FORMAT_DATATYPE_MASK = 0xf,
118 MESA_ARRAY_FORMAT_TYPE_MASK = 0x1f,
119 MESA_ARRAY_FORMAT_TYPE_SIZE_MASK = 0x3,
120 MESA_ARRAY_FORMAT_NUM_CHANS_MASK = 0xe0,
121 MESA_ARRAY_FORMAT_SWIZZLE_X_MASK = 0x00700,
122 MESA_ARRAY_FORMAT_SWIZZLE_Y_MASK = 0x03800,
123 MESA_ARRAY_FORMAT_SWIZZLE_Z_MASK = 0x1c000,
124 MESA_ARRAY_FORMAT_SWIZZLE_W_MASK = 0xe0000,
125 MESA_ARRAY_FORMAT_BIT = 0x80000000
126 };
127
128 #define MESA_ARRAY_FORMAT(SIZE, SIGNED, IS_FLOAT, NORM, NUM_CHANS, \
129 SWIZZLE_X, SWIZZLE_Y, SWIZZLE_Z, SWIZZLE_W) ( \
130 (((SIZE >> 1) ) & MESA_ARRAY_FORMAT_TYPE_SIZE_MASK) | \
131 (((SIGNED) << 2 ) & MESA_ARRAY_FORMAT_TYPE_IS_SIGNED) | \
132 (((IS_FLOAT) << 3 ) & MESA_ARRAY_FORMAT_TYPE_IS_FLOAT) | \
133 (((NORM) << 4 ) & MESA_ARRAY_FORMAT_TYPE_NORMALIZED) | \
134 (((NUM_CHANS) << 5 ) & MESA_ARRAY_FORMAT_NUM_CHANS_MASK) | \
135 (((SWIZZLE_X) << 8 ) & MESA_ARRAY_FORMAT_SWIZZLE_X_MASK) | \
136 (((SWIZZLE_Y) << 11) & MESA_ARRAY_FORMAT_SWIZZLE_Y_MASK) | \
137 (((SWIZZLE_Z) << 14) & MESA_ARRAY_FORMAT_SWIZZLE_Z_MASK) | \
138 (((SWIZZLE_W) << 17) & MESA_ARRAY_FORMAT_SWIZZLE_W_MASK) | \
139 MESA_ARRAY_FORMAT_BIT)
140
141 /**
142 * Various helpers to access the data encoded in a mesa_array_format
143 */
144 static inline bool
145 _mesa_array_format_is_signed(mesa_array_format f)
146 {
147 return (f & MESA_ARRAY_FORMAT_TYPE_IS_SIGNED) != 0;
148 }
149
150 static inline bool
151 _mesa_array_format_is_float(mesa_array_format f)
152 {
153 return (f & MESA_ARRAY_FORMAT_TYPE_IS_FLOAT) != 0;
154 }
155
156 static inline bool
157 _mesa_array_format_is_normalized(mesa_array_format f)
158 {
159 return (f & MESA_ARRAY_FORMAT_TYPE_NORMALIZED) !=0;
160 }
161
162 static inline enum mesa_array_format_datatype
163 _mesa_array_format_get_datatype(mesa_array_format f)
164 {
165 return (enum mesa_array_format_datatype)
166 (f & MESA_ARRAY_FORMAT_DATATYPE_MASK);
167 }
168
169 static inline int
170 _mesa_array_format_datatype_get_size(enum mesa_array_format_datatype type)
171 {
172 return 1 << (type & MESA_ARRAY_FORMAT_TYPE_SIZE_MASK);
173 }
174
175 static inline int
176 _mesa_array_format_get_type_size(mesa_array_format f)
177 {
178 return 1 << (f & MESA_ARRAY_FORMAT_TYPE_SIZE_MASK);
179 }
180
181 static inline int
182 _mesa_array_format_get_num_channels(mesa_array_format f)
183 {
184 return (f & MESA_ARRAY_FORMAT_NUM_CHANS_MASK) >> 5;
185 }
186
187 static inline void
188 _mesa_array_format_get_swizzle(mesa_array_format f, uint8_t *swizzle)
189 {
190 swizzle[0] = (f & MESA_ARRAY_FORMAT_SWIZZLE_X_MASK) >> 8;
191 swizzle[1] = (f & MESA_ARRAY_FORMAT_SWIZZLE_Y_MASK) >> 11;
192 swizzle[2] = (f & MESA_ARRAY_FORMAT_SWIZZLE_Z_MASK) >> 14;
193 swizzle[3] = (f & MESA_ARRAY_FORMAT_SWIZZLE_W_MASK) >> 17;
194 }
195
196 static inline void
197 _mesa_array_format_set_swizzle(mesa_array_format *f,
198 int32_t x, int32_t y, int32_t z, int32_t w)
199 {
200 *f &= ~(MESA_ARRAY_FORMAT_SWIZZLE_X_MASK |
201 MESA_ARRAY_FORMAT_SWIZZLE_Y_MASK |
202 MESA_ARRAY_FORMAT_SWIZZLE_Z_MASK |
203 MESA_ARRAY_FORMAT_SWIZZLE_W_MASK);
204
205 *f |= ((x << 8 ) & MESA_ARRAY_FORMAT_SWIZZLE_X_MASK) |
206 ((y << 11) & MESA_ARRAY_FORMAT_SWIZZLE_Y_MASK) |
207 ((z << 14) & MESA_ARRAY_FORMAT_SWIZZLE_Z_MASK) |
208 ((w << 17) & MESA_ARRAY_FORMAT_SWIZZLE_W_MASK);
209 }
210
211 /**
212 * A helper to know if the format stored in a uint32_t is a mesa_format
213 * or a mesa_array_format
214 */
215 static inline bool
216 _mesa_format_is_mesa_array_format(uint32_t f)
217 {
218 return (f & MESA_ARRAY_FORMAT_BIT) != 0;
219 }
220
221 /**
222 * Mesa texture/renderbuffer image formats.
223 */
224 typedef enum
225 {
226 MESA_FORMAT_NONE = 0,
227
228 /**
229 * \name Basic hardware formats
230 *
231 * The mesa format name specification is as follows:
232 *
233 * There shall be 3 naming format base types: those for component array
234 * formats (type A); those for compressed formats (type C); and those for
235 * packed component formats (type P). With type A formats, color component
236 * order does not change with endianess. Each format name shall begin with
237 * MESA_FORMAT_, followed by a component label (from the Component Label
238 * list below) for each component in the order that the component(s) occur
239 * in the format, except for non-linear color formats where the first
240 * letter shall be 'S'. For type P formats, each component label is
241 * followed by the number of bits that represent it in the fundamental
242 * data type used by the format.
243 *
244 * Following the listing of the component labels shall be an underscore; a
245 * compression type followed by an underscore for Type C formats only; a
246 * storage type from the list below; and a bit with for type A formats,
247 * which is the bit width for each array element.
248 *
249 *
250 * ---------- Format Base Type A: Array ----------
251 * MESA_FORMAT_[component list]_[storage type][array element bit width]
252 *
253 * examples:
254 * MESA_FORMAT_A_SNORM8 - uchar[i] = A
255 * MESA_FORMAT_RGBA_16 - ushort[i * 4 + 0] = R, ushort[i * 4 + 1] = G,
256 * ushort[i * 4 + 2] = B, ushort[i * 4 + 3] = A
257 * MESA_FORMAT_Z_UNORM32 - float[i] = Z
258 *
259 *
260 *
261 * ---------- Format Base Type C: Compressed ----------
262 * MESA_FORMAT_[component list*][_*][compression type][storage type*]
263 * * where required
264 *
265 * examples:
266 * MESA_FORMAT_RGB_ETC1
267 * MESA_FORMAT_RGBA_ETC2
268 * MESA_FORMAT_LATC1_UNORM
269 * MESA_FORMAT_RGBA_FXT1
270 *
271 *
272 *
273 * ---------- Format Base Type P: Packed ----------
274 * MESA_FORMAT_[[component list,bit width][storage type*][_]][_][storage type**]
275 * * when type differs between component
276 * ** when type applies to all components
277 *
278 * examples: msb <------ TEXEL BITS -----------> lsb
279 * MESA_FORMAT_A8B8G8R8_UNORM, RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA
280 * MESA_FORMAT_R5G6B5_UNORM BBBB BGGG GGGR RRRR
281 * MESA_FORMAT_B4G4R4X4_UNORM XXXX RRRR GGGG BBBB
282 * MESA_FORMAT_Z32_FLOAT_S8X24_UINT
283 * MESA_FORMAT_R10G10B10A2_UINT
284 * MESA_FORMAT_R9G9B9E5_FLOAT
285 *
286 *
287 *
288 * ---------- Component Labels: ----------
289 * A - Alpha
290 * B - Blue
291 * DU - Delta U
292 * DV - Delta V
293 * E - Shared Exponent
294 * G - Green
295 * I - Intensity
296 * L - Luminance
297 * R - Red
298 * S - Stencil (when not followed by RGB or RGBA)
299 * U - Chrominance
300 * V - Chrominance
301 * Y - Luma
302 * X - Packing bits
303 * Z - Depth
304 *
305 *
306 *
307 * ---------- Type C Compression Types: ----------
308 * DXT1 - Color component labels shall be given
309 * DXT3 - Color component labels shall be given
310 * DXT5 - Color component labels shall be given
311 * ETC1 - No other information required
312 * ETC2 - No other information required
313 * FXT1 - Color component labels shall be given
314 * FXT3 - Color component labels shall be given
315 * LATC1 - Fundamental data type shall be given
316 * LATC2 - Fundamental data type shall be given
317 * RGTC1 - Color component labels and data type shall be given
318 * RGTC2 - Color component labels and data type shall be given
319 *
320 *
321 *
322 * ---------- Storage Types: ----------
323 * FLOAT
324 * SINT
325 * UINT
326 * SNORM
327 * UNORM
328 * SRGB - RGB components, or L are UNORMs in sRGB color space.
329 * Alpha, if present is linear.
330 *
331 */
332
333 /* Packed unorm formats */ /* msb <------ TEXEL BITS -----------> lsb */
334 /* ---- ---- ---- ---- ---- ---- ---- ---- */
335 MESA_FORMAT_A8B8G8R8_UNORM, /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
336 MESA_FORMAT_X8B8G8R8_UNORM, /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
337 MESA_FORMAT_R8G8B8A8_UNORM, /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
338 MESA_FORMAT_R8G8B8X8_UNORM, /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
339 MESA_FORMAT_B8G8R8A8_UNORM, /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
340 MESA_FORMAT_B8G8R8X8_UNORM, /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
341 MESA_FORMAT_A8R8G8B8_UNORM, /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
342 MESA_FORMAT_X8R8G8B8_UNORM, /* BBBB BBBB GGGG GGGG RRRR RRRR xxxx xxxx */
343 MESA_FORMAT_L16A16_UNORM, /* AAAA AAAA AAAA AAAA LLLL LLLL LLLL LLLL */
344 MESA_FORMAT_A16L16_UNORM, /* LLLL LLLL LLLL LLLL AAAA AAAA AAAA AAAA */
345 MESA_FORMAT_B5G6R5_UNORM, /* RRRR RGGG GGGB BBBB */
346 MESA_FORMAT_R5G6B5_UNORM, /* BBBB BGGG GGGR RRRR */
347 MESA_FORMAT_B4G4R4A4_UNORM, /* AAAA RRRR GGGG BBBB */
348 MESA_FORMAT_B4G4R4X4_UNORM, /* xxxx RRRR GGGG BBBB */
349 MESA_FORMAT_A4R4G4B4_UNORM, /* BBBB GGGG RRRR AAAA */
350 MESA_FORMAT_A1B5G5R5_UNORM, /* RRRR RGGG GGBB BBBA */
351 MESA_FORMAT_B5G5R5A1_UNORM, /* ARRR RRGG GGGB BBBB */
352 MESA_FORMAT_B5G5R5X1_UNORM, /* xRRR RRGG GGGB BBBB */
353 MESA_FORMAT_A1R5G5B5_UNORM, /* BBBB BGGG GGRR RRRA */
354 MESA_FORMAT_L8A8_UNORM, /* AAAA AAAA LLLL LLLL */
355 MESA_FORMAT_A8L8_UNORM, /* LLLL LLLL AAAA AAAA */
356 MESA_FORMAT_R8G8_UNORM, /* GGGG GGGG RRRR RRRR */
357 MESA_FORMAT_G8R8_UNORM, /* RRRR RRRR GGGG GGGG */
358 MESA_FORMAT_L4A4_UNORM, /* AAAA LLLL */
359 MESA_FORMAT_B2G3R3_UNORM, /* RRRG GGBB */
360
361 MESA_FORMAT_R16G16_UNORM, /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
362 MESA_FORMAT_G16R16_UNORM, /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
363 MESA_FORMAT_B10G10R10A2_UNORM,/* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
364 MESA_FORMAT_B10G10R10X2_UNORM,/* xxRR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
365 MESA_FORMAT_R10G10B10A2_UNORM,/* AABB BBBB BBBB GGGG GGGG GGRR RRRR RRRR */
366 MESA_FORMAT_R10G10B10X2_UNORM,/* xxBB BBBB BBBB GGGG GGGG GGRR RRRR RRRR */
367
368 MESA_FORMAT_S8_UINT_Z24_UNORM,/* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ SSSS SSSS */
369 MESA_FORMAT_X8_UINT_Z24_UNORM,/* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ xxxx xxxx */
370 MESA_FORMAT_Z24_UNORM_S8_UINT,/* SSSS SSSS ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
371 MESA_FORMAT_Z24_UNORM_X8_UINT,/* xxxx xxxx ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
372
373 /* Other formats */
374 MESA_FORMAT_R3G3B2_UNORM, /* BBGG GRRR */
375 MESA_FORMAT_A4B4G4R4_UNORM, /* RRRR GGGG BBBB AAAA */
376 MESA_FORMAT_R4G4B4A4_UNORM, /* AAAA BBBB GGGG RRRR */
377 MESA_FORMAT_R5G5B5A1_UNORM, /* ABBB BBGG GGGR RRRR */
378 MESA_FORMAT_A2B10G10R10_UNORM,/* RRRR RRRR RRGG GGGG GGGG BBBB BBBB BBAA */
379 MESA_FORMAT_A2R10G10B10_UNORM,/* BBBB BBBB BBGG GGGG GGGG RRRR RRRR RRAA */
380
381 MESA_FORMAT_YCBCR, /* YYYY YYYY UorV UorV */
382 MESA_FORMAT_YCBCR_REV, /* UorV UorV YYYY YYYY */
383
384 /* Array unorm formats */
385 MESA_FORMAT_A_UNORM8, /* ubyte[i] = A */
386 MESA_FORMAT_A_UNORM16, /* ushort[i] = A */
387 MESA_FORMAT_L_UNORM8, /* ubyte[i] = L */
388 MESA_FORMAT_L_UNORM16, /* ushort[i] = L */
389 MESA_FORMAT_I_UNORM8, /* ubyte[i] = I */
390 MESA_FORMAT_I_UNORM16, /* ushort[i] = I */
391 MESA_FORMAT_R_UNORM8, /* ubyte[i] = R */
392 MESA_FORMAT_R_UNORM16, /* ushort[i] = R */
393 MESA_FORMAT_BGR_UNORM8, /* ubyte[i*3] = B, [i*3+1] = G, [i*3+2] = R */
394 MESA_FORMAT_RGB_UNORM8, /* ubyte[i*3] = R, [i*3+1] = G, [i*3+2] = B */
395 MESA_FORMAT_RGBA_UNORM16, /* ushort[i] = R, [1] = G, [2] = B, [3] = A */
396 MESA_FORMAT_RGBX_UNORM16,
397
398 MESA_FORMAT_Z_UNORM16, /* ushort[i] = Z */
399 MESA_FORMAT_Z_UNORM32, /* uint[i] = Z */
400 MESA_FORMAT_S_UINT8, /* ubyte[i] = S */
401
402 /* Packed signed/normalized formats */
403 /* msb <------ TEXEL BITS -----------> lsb */
404 /* ---- ---- ---- ---- ---- ---- ---- ---- */
405 MESA_FORMAT_A8B8G8R8_SNORM, /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
406 MESA_FORMAT_X8B8G8R8_SNORM, /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
407 MESA_FORMAT_R8G8B8A8_SNORM, /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
408 MESA_FORMAT_R8G8B8X8_SNORM, /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
409 MESA_FORMAT_R16G16_SNORM, /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
410 MESA_FORMAT_G16R16_SNORM, /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
411 MESA_FORMAT_R8G8_SNORM, /* GGGG GGGG RRRR RRRR */
412 MESA_FORMAT_G8R8_SNORM, /* RRRR RRRR GGGG GGGG */
413 MESA_FORMAT_L8A8_SNORM, /* AAAA AAAA LLLL LLLL */
414 MESA_FORMAT_A8L8_SNORM, /* LLLL LLLL AAAA AAAA */
415
416 /* Array signed/normalized formats */
417 MESA_FORMAT_A_SNORM8, /* byte[i] = A */
418 MESA_FORMAT_A_SNORM16, /* short[i] = A */
419 MESA_FORMAT_L_SNORM8, /* byte[i] = L */
420 MESA_FORMAT_L_SNORM16, /* short[i] = L */
421 MESA_FORMAT_I_SNORM8, /* byte[i] = I */
422 MESA_FORMAT_I_SNORM16, /* short[i] = I */
423 MESA_FORMAT_R_SNORM8, /* byte[i] = R */
424 MESA_FORMAT_R_SNORM16, /* short[i] = R */
425 MESA_FORMAT_LA_SNORM16, /* short[i * 2] = L, [i * 2 + 1] = A */
426 MESA_FORMAT_RGB_SNORM16, /* short[i*3] = R, [i*3+1] = G, [i*3+2] = B */
427 MESA_FORMAT_RGBA_SNORM16, /* ... */
428 MESA_FORMAT_RGBX_SNORM16, /* ... */
429
430 /* Packed sRGB formats */
431 MESA_FORMAT_A8B8G8R8_SRGB, /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
432 MESA_FORMAT_B8G8R8A8_SRGB, /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
433 MESA_FORMAT_A8R8G8B8_SRGB, /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
434 MESA_FORMAT_B8G8R8X8_SRGB, /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
435 MESA_FORMAT_X8R8G8B8_SRGB, /* BBBB BBBB GGGG GGGG RRRR RRRR xxxx xxxx */
436 MESA_FORMAT_R8G8B8A8_SRGB, /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
437 MESA_FORMAT_R8G8B8X8_SRGB, /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
438 MESA_FORMAT_X8B8G8R8_SRGB, /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
439 MESA_FORMAT_L8A8_SRGB, /* AAAA AAAA LLLL LLLL */
440 MESA_FORMAT_A8L8_SRGB, /* LLLL LLLL AAAA AAAA */
441
442 /* Array sRGB formats */
443 MESA_FORMAT_L_SRGB8, /* ubyte[i] = L */
444 MESA_FORMAT_BGR_SRGB8, /* ubyte[i*3] = B, [i*3+1] = G, [i*3+2] = R */
445
446 /* Packed float formats */
447 MESA_FORMAT_R9G9B9E5_FLOAT,
448 MESA_FORMAT_R11G11B10_FLOAT, /* BBBB BBBB BBGG GGGG GGGG GRRR RRRR RRRR */
449 MESA_FORMAT_Z32_FLOAT_S8X24_UINT, /* (float, x24s8) */
450
451 /* Array float formats */
452 MESA_FORMAT_A_FLOAT16,
453 MESA_FORMAT_A_FLOAT32,
454 MESA_FORMAT_L_FLOAT16,
455 MESA_FORMAT_L_FLOAT32,
456 MESA_FORMAT_LA_FLOAT16,
457 MESA_FORMAT_LA_FLOAT32,
458 MESA_FORMAT_I_FLOAT16,
459 MESA_FORMAT_I_FLOAT32,
460 MESA_FORMAT_R_FLOAT16,
461 MESA_FORMAT_R_FLOAT32,
462 MESA_FORMAT_RG_FLOAT16,
463 MESA_FORMAT_RG_FLOAT32,
464 MESA_FORMAT_RGB_FLOAT16,
465 MESA_FORMAT_RGB_FLOAT32,
466 MESA_FORMAT_RGBA_FLOAT16,
467 MESA_FORMAT_RGBA_FLOAT32, /* float[0] = R, [1] = G, [2] = B, [3] = A */
468 MESA_FORMAT_RGBX_FLOAT16,
469 MESA_FORMAT_RGBX_FLOAT32,
470 MESA_FORMAT_Z_FLOAT32,
471
472 /* Packed signed/unsigned non-normalized integer formats */
473 MESA_FORMAT_B10G10R10A2_UINT, /* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
474 MESA_FORMAT_R10G10B10A2_UINT, /* AABB BBBB BBBB GGGG GGGG GGRR RRRR RRRR */
475 MESA_FORMAT_A2B10G10R10_UINT, /* RRRR RRRR RRGG GGGG GGGG BBBB BBBB BBAA */
476 MESA_FORMAT_A2R10G10B10_UINT, /* BBBB BBBB BBGG GGGG GGGG RRRR RRRR RRAA */
477
478 /* Array signed/unsigned non-normalized integer formats */
479 MESA_FORMAT_A_UINT8,
480 MESA_FORMAT_A_UINT16,
481 MESA_FORMAT_A_UINT32,
482 MESA_FORMAT_A_SINT8,
483 MESA_FORMAT_A_SINT16,
484 MESA_FORMAT_A_SINT32,
485
486 MESA_FORMAT_I_UINT8,
487 MESA_FORMAT_I_UINT16,
488 MESA_FORMAT_I_UINT32,
489 MESA_FORMAT_I_SINT8,
490 MESA_FORMAT_I_SINT16,
491 MESA_FORMAT_I_SINT32,
492
493 MESA_FORMAT_L_UINT8,
494 MESA_FORMAT_L_UINT16,
495 MESA_FORMAT_L_UINT32,
496 MESA_FORMAT_L_SINT8,
497 MESA_FORMAT_L_SINT16,
498 MESA_FORMAT_L_SINT32,
499
500 MESA_FORMAT_LA_UINT8,
501 MESA_FORMAT_LA_UINT16,
502 MESA_FORMAT_LA_UINT32,
503 MESA_FORMAT_LA_SINT8,
504 MESA_FORMAT_LA_SINT16,
505 MESA_FORMAT_LA_SINT32,
506
507 MESA_FORMAT_R_UINT8,
508 MESA_FORMAT_R_UINT16,
509 MESA_FORMAT_R_UINT32,
510 MESA_FORMAT_R_SINT8,
511 MESA_FORMAT_R_SINT16,
512 MESA_FORMAT_R_SINT32,
513
514 MESA_FORMAT_RG_UINT8,
515 MESA_FORMAT_RG_UINT16,
516 MESA_FORMAT_RG_UINT32,
517 MESA_FORMAT_RG_SINT8,
518 MESA_FORMAT_RG_SINT16,
519 MESA_FORMAT_RG_SINT32,
520
521 MESA_FORMAT_RGB_UINT8,
522 MESA_FORMAT_RGB_UINT16,
523 MESA_FORMAT_RGB_UINT32,
524 MESA_FORMAT_RGB_SINT8,
525 MESA_FORMAT_RGB_SINT16,
526 MESA_FORMAT_RGB_SINT32,
527
528 MESA_FORMAT_RGBA_UINT8,
529 MESA_FORMAT_RGBA_UINT16,
530 MESA_FORMAT_RGBA_UINT32,
531 MESA_FORMAT_RGBA_SINT8,
532 MESA_FORMAT_RGBA_SINT16,
533 MESA_FORMAT_RGBA_SINT32,
534
535 MESA_FORMAT_RGBX_UINT8,
536 MESA_FORMAT_RGBX_UINT16,
537 MESA_FORMAT_RGBX_UINT32,
538 MESA_FORMAT_RGBX_SINT8,
539 MESA_FORMAT_RGBX_SINT16,
540 MESA_FORMAT_RGBX_SINT32,
541
542 /* DXT compressed formats */
543 MESA_FORMAT_RGB_DXT1,
544 MESA_FORMAT_RGBA_DXT1,
545 MESA_FORMAT_RGBA_DXT3,
546 MESA_FORMAT_RGBA_DXT5,
547
548 /* DXT sRGB compressed formats */
549 MESA_FORMAT_SRGB_DXT1,
550 MESA_FORMAT_SRGBA_DXT1,
551 MESA_FORMAT_SRGBA_DXT3,
552 MESA_FORMAT_SRGBA_DXT5,
553
554 /* FXT1 compressed formats */
555 MESA_FORMAT_RGB_FXT1,
556 MESA_FORMAT_RGBA_FXT1,
557
558 /* RGTC compressed formats */
559 MESA_FORMAT_R_RGTC1_UNORM,
560 MESA_FORMAT_R_RGTC1_SNORM,
561 MESA_FORMAT_RG_RGTC2_UNORM,
562 MESA_FORMAT_RG_RGTC2_SNORM,
563
564 /* LATC1/2 compressed formats */
565 MESA_FORMAT_L_LATC1_UNORM,
566 MESA_FORMAT_L_LATC1_SNORM,
567 MESA_FORMAT_LA_LATC2_UNORM,
568 MESA_FORMAT_LA_LATC2_SNORM,
569
570 /* ETC1/2 compressed formats */
571 MESA_FORMAT_ETC1_RGB8,
572 MESA_FORMAT_ETC2_RGB8,
573 MESA_FORMAT_ETC2_SRGB8,
574 MESA_FORMAT_ETC2_RGBA8_EAC,
575 MESA_FORMAT_ETC2_SRGB8_ALPHA8_EAC,
576 MESA_FORMAT_ETC2_R11_EAC,
577 MESA_FORMAT_ETC2_RG11_EAC,
578 MESA_FORMAT_ETC2_SIGNED_R11_EAC,
579 MESA_FORMAT_ETC2_SIGNED_RG11_EAC,
580 MESA_FORMAT_ETC2_RGB8_PUNCHTHROUGH_ALPHA1,
581 MESA_FORMAT_ETC2_SRGB8_PUNCHTHROUGH_ALPHA1,
582
583 /* BPTC compressed formats */
584 MESA_FORMAT_BPTC_RGBA_UNORM,
585 MESA_FORMAT_BPTC_SRGB_ALPHA_UNORM,
586 MESA_FORMAT_BPTC_RGB_SIGNED_FLOAT,
587 MESA_FORMAT_BPTC_RGB_UNSIGNED_FLOAT,
588
589 MESA_FORMAT_COUNT
590 } mesa_format;
591
592
593 extern const char *
594 _mesa_get_format_name(mesa_format format);
595
596 extern GLint
597 _mesa_get_format_bytes(mesa_format format);
598
599 extern GLint
600 _mesa_get_format_bits(mesa_format format, GLenum pname);
601
602 extern GLuint
603 _mesa_get_format_max_bits(mesa_format format);
604
605 extern enum mesa_format_layout
606 _mesa_get_format_layout(mesa_format format);
607
608 extern GLenum
609 _mesa_get_format_datatype(mesa_format format);
610
611 extern GLenum
612 _mesa_get_format_base_format(uint32_t format);
613
614 extern void
615 _mesa_get_format_block_size(mesa_format format, GLuint *bw, GLuint *bh);
616
617 extern mesa_array_format
618 _mesa_array_format_flip_channels(mesa_array_format format);
619
620 extern void
621 _mesa_get_format_swizzle(mesa_format format, uint8_t swizzle_out[4]);
622
623 extern uint32_t
624 _mesa_format_to_array_format(mesa_format format);
625
626 extern mesa_format
627 _mesa_format_from_array_format(uint32_t array_format);
628
629 extern GLboolean
630 _mesa_is_format_compressed(mesa_format format);
631
632 extern GLboolean
633 _mesa_is_format_packed_depth_stencil(mesa_format format);
634
635 extern GLboolean
636 _mesa_is_format_integer_color(mesa_format format);
637
638 extern GLboolean
639 _mesa_is_format_unsigned(mesa_format format);
640
641 extern GLboolean
642 _mesa_is_format_signed(mesa_format format);
643
644 extern GLboolean
645 _mesa_is_format_integer(mesa_format format);
646
647 extern bool
648 _mesa_is_format_etc2(mesa_format format);
649
650 GLenum
651 _mesa_is_format_color_format(mesa_format format);
652
653 extern GLenum
654 _mesa_get_format_color_encoding(mesa_format format);
655
656 extern GLuint
657 _mesa_format_image_size(mesa_format format, GLsizei width,
658 GLsizei height, GLsizei depth);
659
660 extern uint64_t
661 _mesa_format_image_size64(mesa_format format, GLsizei width,
662 GLsizei height, GLsizei depth);
663
664 extern GLint
665 _mesa_format_row_stride(mesa_format format, GLsizei width);
666
667 extern void
668 _mesa_uncompressed_format_to_type_and_comps(mesa_format format,
669 GLenum *datatype, GLuint *comps);
670
671 extern void
672 _mesa_test_formats(void);
673
674 extern mesa_format
675 _mesa_get_srgb_format_linear(mesa_format format);
676
677 extern mesa_format
678 _mesa_get_uncompressed_format(mesa_format format);
679
680 extern GLuint
681 _mesa_format_num_components(mesa_format format);
682
683 extern bool
684 _mesa_format_has_color_component(mesa_format format, int component);
685
686 GLboolean
687 _mesa_format_matches_format_and_type(mesa_format mesa_format,
688 GLenum format, GLenum type,
689 GLboolean swapBytes, GLenum *error);
690
691 #ifdef __cplusplus
692 }
693 #endif
694
695 #endif /* FORMATS_H */