2 * Mesa 3-D graphics library
4 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
5 * Copyright (c) 2008-2009 VMware, Inc.
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:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
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.
46 * OpenGL doesn't have GL_UNSIGNED_BYTE_4_4, so we must define our own type
47 * for GL_LUMINANCE4_ALPHA4.
49 #define MESA_UNSIGNED_BYTE_4_4 (GL_UNSIGNED_BYTE<<1)
53 * Max number of bytes for any non-compressed pixel format below, or for
54 * intermediate pixel storage in Mesa. This should never be less than
55 * 16. Maybe 32 someday?
57 #define MAX_PIXEL_BYTES 16
60 * Specifies the layout of a pixel format. See the MESA_FORMAT
61 * documentation below.
63 enum mesa_format_layout
{
64 MESA_FORMAT_LAYOUT_ARRAY
,
65 MESA_FORMAT_LAYOUT_PACKED
,
66 MESA_FORMAT_LAYOUT_OTHER
,
70 * An enum representing different possible swizzling values. This is used
71 * to interpret the output of _mesa_get_format_swizzle
74 MESA_FORMAT_SWIZZLE_X
= 0,
75 MESA_FORMAT_SWIZZLE_Y
= 1,
76 MESA_FORMAT_SWIZZLE_Z
= 2,
77 MESA_FORMAT_SWIZZLE_W
= 3,
78 MESA_FORMAT_SWIZZLE_ZERO
= 4,
79 MESA_FORMAT_SWIZZLE_ONE
= 5,
80 MESA_FORMAT_SWIZZLE_NONE
= 6,
84 * Mesa texture/renderbuffer image formats.
91 * \name Basic hardware formats
93 * The mesa format name specification is as follows:
95 * There shall be 3 naming format base types: those for component array
96 * formats (type A); those for compressed formats (type C); and those for
97 * packed component formats (type P). With type A formats, color component
98 * order does not change with endianess. Each format name shall begin with
99 * MESA_FORMAT_, followed by a component label (from the Component Label
100 * list below) for each component in the order that the component(s) occur
101 * in the format, except for non-linear color formats where the first
102 * letter shall be 'S'. For type P formats, each component label is
103 * followed by the number of bits that represent it in the fundamental
104 * data type used by the format.
106 * Following the listing of the component labels shall be an underscore; a
107 * compression type followed by an underscore for Type C formats only; a
108 * storage type from the list below; and a bit with for type A formats,
109 * which is the bit width for each array element.
112 * ---------- Format Base Type A: Array ----------
113 * MESA_FORMAT_[component list]_[storage type][array element bit width]
116 * MESA_FORMAT_A_SNORM8 - uchar[i] = A
117 * MESA_FORMAT_RGBA_16 - ushort[i * 4 + 0] = R, ushort[i * 4 + 1] = G,
118 * ushort[i * 4 + 2] = B, ushort[i * 4 + 3] = A
119 * MESA_FORMAT_Z_UNORM32 - float[i] = Z
123 * ---------- Format Base Type C: Compressed ----------
124 * MESA_FORMAT_[component list*][_*][compression type][storage type*]
128 * MESA_FORMAT_RGB_ETC1
129 * MESA_FORMAT_RGBA_ETC2
130 * MESA_FORMAT_LATC1_UNORM
131 * MESA_FORMAT_RGBA_FXT1
135 * ---------- Format Base Type P: Packed ----------
136 * MESA_FORMAT_[[component list,bit width][storage type*][_]][_][storage type**]
137 * * when type differs between component
138 * ** when type applies to all components
140 * examples: msb <------ TEXEL BITS -----------> lsb
141 * MESA_FORMAT_A8B8G8R8_UNORM, AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR
142 * MESA_FORMAT_R5G6B5_UNORM RRRR RGGG GGGB BBBB
143 * MESA_FORMAT_B4G4R4X4_UNORM BBBB GGGG RRRR XXXX
144 * MESA_FORMAT_Z32_FLOAT_S8X24_UINT
145 * MESA_FORMAT_R10G10B10A2_UINT
146 * MESA_FORMAT_R9G9B9E5_FLOAT
150 * ---------- Component Labels: ----------
155 * E - Shared Exponent
160 * S - Stencil (when not followed by RGB or RGBA)
169 * ---------- Type C Compression Types: ----------
170 * DXT1 - Color component labels shall be given
171 * DXT3 - Color component labels shall be given
172 * DXT5 - Color component labels shall be given
173 * ETC1 - No other information required
174 * ETC2 - No other information required
175 * FXT1 - Color component labels shall be given
176 * FXT3 - Color component labels shall be given
177 * LATC1 - Fundamental data type shall be given
178 * LATC2 - Fundamental data type shall be given
179 * RGTC1 - Color component labels and data type shall be given
180 * RGTC2 - Color component labels and data type shall be given
184 * ---------- Storage Types: ----------
190 * SRGB - RGB components, or L are UNORMs in sRGB color space.
191 * Alpha, if present is linear.
195 /* Packed unorm formats */ /* msb <------ TEXEL BITS -----------> lsb */
196 /* ---- ---- ---- ---- ---- ---- ---- ---- */
197 MESA_FORMAT_A8B8G8R8_UNORM
, /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
198 MESA_FORMAT_X8B8G8R8_UNORM
, /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
199 MESA_FORMAT_R8G8B8A8_UNORM
, /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
200 MESA_FORMAT_R8G8B8X8_UNORM
, /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
201 MESA_FORMAT_B8G8R8A8_UNORM
, /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
202 MESA_FORMAT_B8G8R8X8_UNORM
, /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
203 MESA_FORMAT_A8R8G8B8_UNORM
, /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
204 MESA_FORMAT_X8R8G8B8_UNORM
, /* BBBB BBBB GGGG GGGG RRRR RRRR xxxx xxxx */
205 MESA_FORMAT_L16A16_UNORM
, /* AAAA AAAA AAAA AAAA LLLL LLLL LLLL LLLL */
206 MESA_FORMAT_A16L16_UNORM
, /* LLLL LLLL LLLL LLLL AAAA AAAA AAAA AAAA */
207 MESA_FORMAT_B5G6R5_UNORM
, /* RRRR RGGG GGGB BBBB */
208 MESA_FORMAT_R5G6B5_UNORM
, /* BBBB BGGG GGGR RRRR */
209 MESA_FORMAT_B4G4R4A4_UNORM
, /* AAAA RRRR GGGG BBBB */
210 MESA_FORMAT_B4G4R4X4_UNORM
, /* xxxx RRRR GGGG BBBB */
211 MESA_FORMAT_A4R4G4B4_UNORM
, /* BBBB GGGG RRRR AAAA */
212 MESA_FORMAT_A1B5G5R5_UNORM
, /* RRRR RGGG GGBB BBBA */
213 MESA_FORMAT_B5G5R5A1_UNORM
, /* ARRR RRGG GGGB BBBB */
214 MESA_FORMAT_B5G5R5X1_UNORM
, /* xRRR RRGG GGGB BBBB */
215 MESA_FORMAT_A1R5G5B5_UNORM
, /* BBBB BGGG GGRR RRRA */
216 MESA_FORMAT_L8A8_UNORM
, /* AAAA AAAA LLLL LLLL */
217 MESA_FORMAT_A8L8_UNORM
, /* LLLL LLLL AAAA AAAA */
218 MESA_FORMAT_R8G8_UNORM
, /* GGGG GGGG RRRR RRRR */
219 MESA_FORMAT_G8R8_UNORM
, /* RRRR RRRR GGGG GGGG */
220 MESA_FORMAT_L4A4_UNORM
, /* AAAA LLLL */
221 MESA_FORMAT_B2G3R3_UNORM
, /* RRRG GGBB */
223 MESA_FORMAT_R16G16_UNORM
, /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
224 MESA_FORMAT_G16R16_UNORM
, /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
225 MESA_FORMAT_B10G10R10A2_UNORM
,/* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
226 MESA_FORMAT_B10G10R10X2_UNORM
,/* xxRR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
227 MESA_FORMAT_R10G10B10A2_UNORM
,/* AABB BBBB BBBB GGGG GGGG GGRR RRRR RRRR */
229 MESA_FORMAT_S8_UINT_Z24_UNORM
,/* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ SSSS SSSS */
230 MESA_FORMAT_X8_UINT_Z24_UNORM
,/* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ xxxx xxxx */
231 MESA_FORMAT_Z24_UNORM_S8_UINT
,/* SSSS SSSS ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
232 MESA_FORMAT_Z24_UNORM_X8_UINT
,/* xxxx xxxx ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
234 MESA_FORMAT_YCBCR
, /* YYYY YYYY UorV UorV */
235 MESA_FORMAT_YCBCR_REV
, /* UorV UorV YYYY YYYY */
237 /* Array unorm formats */
238 MESA_FORMAT_A_UNORM8
, /* ubyte[i] = A */
239 MESA_FORMAT_A_UNORM16
, /* ushort[i] = A */
240 MESA_FORMAT_L_UNORM8
, /* ubyte[i] = L */
241 MESA_FORMAT_L_UNORM16
, /* ushort[i] = L */
242 MESA_FORMAT_I_UNORM8
, /* ubyte[i] = I */
243 MESA_FORMAT_I_UNORM16
, /* ushort[i] = I */
244 MESA_FORMAT_R_UNORM8
, /* ubyte[i] = R */
245 MESA_FORMAT_R_UNORM16
, /* ushort[i] = R */
246 MESA_FORMAT_BGR_UNORM8
, /* ubyte[i*3] = B, [i*3+1] = G, [i*3+2] = R */
247 MESA_FORMAT_RGB_UNORM8
, /* ubyte[i*3] = R, [i*3+1] = G, [i*3+2] = B */
248 MESA_FORMAT_RGBA_UNORM16
, /* ushort[i] = R, [1] = G, [2] = B, [3] = A */
249 MESA_FORMAT_RGBX_UNORM16
,
251 MESA_FORMAT_Z_UNORM16
, /* ushort[i] = Z */
252 MESA_FORMAT_Z_UNORM32
, /* uint[i] = Z */
253 MESA_FORMAT_S_UINT8
, /* ubyte[i] = S */
255 /* Packed signed/normalized formats */
256 /* msb <------ TEXEL BITS -----------> lsb */
257 /* ---- ---- ---- ---- ---- ---- ---- ---- */
258 MESA_FORMAT_A8B8G8R8_SNORM
, /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
259 MESA_FORMAT_X8B8G8R8_SNORM
, /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
260 MESA_FORMAT_R8G8B8A8_SNORM
, /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
261 MESA_FORMAT_R8G8B8X8_SNORM
, /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
262 MESA_FORMAT_R16G16_SNORM
, /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
263 MESA_FORMAT_G16R16_SNORM
, /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
264 MESA_FORMAT_R8G8_SNORM
, /* GGGG GGGG RRRR RRRR */
265 MESA_FORMAT_G8R8_SNORM
, /* RRRR RRRR GGGG GGGG */
266 MESA_FORMAT_L8A8_SNORM
, /* AAAA AAAA LLLL LLLL */
268 /* Array signed/normalized formats */
269 MESA_FORMAT_A_SNORM8
, /* byte[i] = A */
270 MESA_FORMAT_A_SNORM16
, /* short[i] = A */
271 MESA_FORMAT_L_SNORM8
, /* byte[i] = L */
272 MESA_FORMAT_L_SNORM16
, /* short[i] = L */
273 MESA_FORMAT_I_SNORM8
, /* byte[i] = I */
274 MESA_FORMAT_I_SNORM16
, /* short[i] = I */
275 MESA_FORMAT_R_SNORM8
, /* byte[i] = R */
276 MESA_FORMAT_R_SNORM16
, /* short[i] = R */
277 MESA_FORMAT_LA_SNORM16
, /* short[i * 2] = L, [i * 2 + 1] = A */
278 MESA_FORMAT_RGB_SNORM16
, /* short[i*3] = R, [i*3+1] = G, [i*3+2] = B */
279 MESA_FORMAT_RGBA_SNORM16
, /* ... */
280 MESA_FORMAT_RGBX_SNORM16
, /* ... */
282 /* Packed sRGB formats */
283 MESA_FORMAT_A8B8G8R8_SRGB
, /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
284 MESA_FORMAT_B8G8R8A8_SRGB
, /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
285 MESA_FORMAT_B8G8R8X8_SRGB
, /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
286 MESA_FORMAT_R8G8B8A8_SRGB
, /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
287 MESA_FORMAT_R8G8B8X8_SRGB
, /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
288 MESA_FORMAT_L8A8_SRGB
, /* AAAA AAAA LLLL LLLL */
290 /* Array sRGB formats */
291 MESA_FORMAT_L_SRGB8
, /* ubyte[i] = L */
292 MESA_FORMAT_BGR_SRGB8
, /* ubyte[i*3] = B, [i*3+1] = G, [i*3+2] = R */
294 /* Packed float formats */
295 MESA_FORMAT_R9G9B9E5_FLOAT
,
296 MESA_FORMAT_R11G11B10_FLOAT
, /* BBBB BBBB BBGG GGGG GGGG GRRR RRRR RRRR */
297 MESA_FORMAT_Z32_FLOAT_S8X24_UINT
, /* (float, x24s8) */
299 /* Array float formats */
300 MESA_FORMAT_A_FLOAT16
,
301 MESA_FORMAT_A_FLOAT32
,
302 MESA_FORMAT_L_FLOAT16
,
303 MESA_FORMAT_L_FLOAT32
,
304 MESA_FORMAT_LA_FLOAT16
,
305 MESA_FORMAT_LA_FLOAT32
,
306 MESA_FORMAT_I_FLOAT16
,
307 MESA_FORMAT_I_FLOAT32
,
308 MESA_FORMAT_R_FLOAT16
,
309 MESA_FORMAT_R_FLOAT32
,
310 MESA_FORMAT_RG_FLOAT16
,
311 MESA_FORMAT_RG_FLOAT32
,
312 MESA_FORMAT_RGB_FLOAT16
,
313 MESA_FORMAT_RGB_FLOAT32
,
314 MESA_FORMAT_RGBA_FLOAT16
,
315 MESA_FORMAT_RGBA_FLOAT32
, /* float[0] = R, [1] = G, [2] = B, [3] = A */
316 MESA_FORMAT_RGBX_FLOAT16
,
317 MESA_FORMAT_RGBX_FLOAT32
,
318 MESA_FORMAT_Z_FLOAT32
,
320 /* Packed signed/unsigned non-normalized integer formats */
321 MESA_FORMAT_B10G10R10A2_UINT
, /* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
322 MESA_FORMAT_R10G10B10A2_UINT
, /* AABB BBBB BBBB GGGG GGGG GGRR RRRR RRRR */
324 /* Array signed/unsigned non-normalized integer formats */
326 MESA_FORMAT_A_UINT16
,
327 MESA_FORMAT_A_UINT32
,
329 MESA_FORMAT_A_SINT16
,
330 MESA_FORMAT_A_SINT32
,
333 MESA_FORMAT_I_UINT16
,
334 MESA_FORMAT_I_UINT32
,
336 MESA_FORMAT_I_SINT16
,
337 MESA_FORMAT_I_SINT32
,
340 MESA_FORMAT_L_UINT16
,
341 MESA_FORMAT_L_UINT32
,
343 MESA_FORMAT_L_SINT16
,
344 MESA_FORMAT_L_SINT32
,
346 MESA_FORMAT_LA_UINT8
,
347 MESA_FORMAT_LA_UINT16
,
348 MESA_FORMAT_LA_UINT32
,
349 MESA_FORMAT_LA_SINT8
,
350 MESA_FORMAT_LA_SINT16
,
351 MESA_FORMAT_LA_SINT32
,
354 MESA_FORMAT_R_UINT16
,
355 MESA_FORMAT_R_UINT32
,
357 MESA_FORMAT_R_SINT16
,
358 MESA_FORMAT_R_SINT32
,
360 MESA_FORMAT_RG_UINT8
,
361 MESA_FORMAT_RG_UINT16
,
362 MESA_FORMAT_RG_UINT32
,
363 MESA_FORMAT_RG_SINT8
,
364 MESA_FORMAT_RG_SINT16
,
365 MESA_FORMAT_RG_SINT32
,
367 MESA_FORMAT_RGB_UINT8
,
368 MESA_FORMAT_RGB_UINT16
,
369 MESA_FORMAT_RGB_UINT32
,
370 MESA_FORMAT_RGB_SINT8
,
371 MESA_FORMAT_RGB_SINT16
,
372 MESA_FORMAT_RGB_SINT32
,
374 MESA_FORMAT_RGBA_UINT8
,
375 MESA_FORMAT_RGBA_UINT16
,
376 MESA_FORMAT_RGBA_UINT32
,
377 MESA_FORMAT_RGBA_SINT8
,
378 MESA_FORMAT_RGBA_SINT16
,
379 MESA_FORMAT_RGBA_SINT32
,
381 MESA_FORMAT_RGBX_UINT8
,
382 MESA_FORMAT_RGBX_UINT16
,
383 MESA_FORMAT_RGBX_UINT32
,
384 MESA_FORMAT_RGBX_SINT8
,
385 MESA_FORMAT_RGBX_SINT16
,
386 MESA_FORMAT_RGBX_SINT32
,
388 /* DXT compressed formats */
389 MESA_FORMAT_RGB_DXT1
,
390 MESA_FORMAT_RGBA_DXT1
,
391 MESA_FORMAT_RGBA_DXT3
,
392 MESA_FORMAT_RGBA_DXT5
,
394 /* DXT sRGB compressed formats */
395 MESA_FORMAT_SRGB_DXT1
,
396 MESA_FORMAT_SRGBA_DXT1
,
397 MESA_FORMAT_SRGBA_DXT3
,
398 MESA_FORMAT_SRGBA_DXT5
,
400 /* FXT1 compressed formats */
401 MESA_FORMAT_RGB_FXT1
,
402 MESA_FORMAT_RGBA_FXT1
,
404 /* RGTC compressed formats */
405 MESA_FORMAT_R_RGTC1_UNORM
,
406 MESA_FORMAT_R_RGTC1_SNORM
,
407 MESA_FORMAT_RG_RGTC2_UNORM
,
408 MESA_FORMAT_RG_RGTC2_SNORM
,
410 /* LATC1/2 compressed formats */
411 MESA_FORMAT_L_LATC1_UNORM
,
412 MESA_FORMAT_L_LATC1_SNORM
,
413 MESA_FORMAT_LA_LATC2_UNORM
,
414 MESA_FORMAT_LA_LATC2_SNORM
,
416 /* ETC1/2 compressed formats */
417 MESA_FORMAT_ETC1_RGB8
,
418 MESA_FORMAT_ETC2_RGB8
,
419 MESA_FORMAT_ETC2_SRGB8
,
420 MESA_FORMAT_ETC2_RGBA8_EAC
,
421 MESA_FORMAT_ETC2_SRGB8_ALPHA8_EAC
,
422 MESA_FORMAT_ETC2_R11_EAC
,
423 MESA_FORMAT_ETC2_RG11_EAC
,
424 MESA_FORMAT_ETC2_SIGNED_R11_EAC
,
425 MESA_FORMAT_ETC2_SIGNED_RG11_EAC
,
426 MESA_FORMAT_ETC2_RGB8_PUNCHTHROUGH_ALPHA1
,
427 MESA_FORMAT_ETC2_SRGB8_PUNCHTHROUGH_ALPHA1
,
434 _mesa_get_format_name(mesa_format format
);
437 _mesa_get_format_bytes(mesa_format format
);
440 _mesa_get_format_bits(mesa_format format
, GLenum pname
);
443 _mesa_get_format_max_bits(mesa_format format
);
445 extern enum mesa_format_layout
446 _mesa_get_format_layout(mesa_format format
);
449 _mesa_get_format_datatype(mesa_format format
);
452 _mesa_get_format_base_format(mesa_format format
);
455 _mesa_get_format_block_size(mesa_format format
, GLuint
*bw
, GLuint
*bh
);
458 _mesa_get_format_swizzle(mesa_format format
, uint8_t swizzle_out
[4]);
461 _mesa_is_format_compressed(mesa_format format
);
464 _mesa_is_format_packed_depth_stencil(mesa_format format
);
467 _mesa_is_format_integer_color(mesa_format format
);
470 _mesa_is_format_unsigned(mesa_format format
);
473 _mesa_is_format_signed(mesa_format format
);
476 _mesa_is_format_integer(mesa_format format
);
479 _mesa_get_format_color_encoding(mesa_format format
);
482 _mesa_format_image_size(mesa_format format
, GLsizei width
,
483 GLsizei height
, GLsizei depth
);
486 _mesa_format_image_size64(mesa_format format
, GLsizei width
,
487 GLsizei height
, GLsizei depth
);
490 _mesa_format_row_stride(mesa_format format
, GLsizei width
);
493 _mesa_format_to_type_and_comps(mesa_format format
,
494 GLenum
*datatype
, GLuint
*comps
);
497 _mesa_test_formats(void);
500 _mesa_get_srgb_format_linear(mesa_format format
);
503 _mesa_get_uncompressed_format(mesa_format format
);
506 _mesa_format_num_components(mesa_format format
);
509 _mesa_format_has_color_component(mesa_format format
, int component
);
512 _mesa_format_matches_format_and_type(mesa_format mesa_format
,
513 GLenum format
, GLenum type
,
514 GLboolean swapBytes
);
520 #endif /* FORMATS_H */