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
61 * Mesa texture/renderbuffer image formats.
68 * \name Basic hardware formats
70 * The mesa format name specification is as follows:
72 * There shall be 3 naming format base types: those for component array
73 * formats (type A); those for compressed formats (type C); and those for
74 * packed component formats (type P). With type A formats, color component
75 * order does not change with endianess. Each format name shall begin with
76 * MESA_FORMAT_, followed by a component label (from the Component Label
77 * list below) for each component in the order that the component(s) occur
78 * in the format, except for non-linear color formats where the first
79 * letter shall be 'S'. For type P formats, each component label is
80 * followed by the number of bits that represent it in the fundamental
81 * data type used by the format.
83 * Following the listing of the component labels shall be an underscore; a
84 * compression type followed by an underscore for Type C formats only; a
85 * storage type from the list below; and a bit with for type A formats,
86 * which is the bit width for each array element.
89 * ---------- Format Base Type A: Array ----------
90 * MESA_FORMAT_[component list]_[storage type][array element bit width]
93 * MESA_FORMAT_A_SNORM8 - uchar[i] = A
94 * MESA_FORMAT_RGBA_16 - ushort[i * 4 + 0] = R, ushort[i * 4 + 1] = G,
95 * ushort[i * 4 + 2] = B, ushort[i * 4 + 3] = A
96 * MESA_FORMAT_Z_UNORM32 - float[i] = Z
100 * ---------- Format Base Type C: Compressed ----------
101 * MESA_FORMAT_[component list*][_*][compression type][storage type*]
105 * MESA_FORMAT_RGB_ETC1
106 * MESA_FORMAT_RGBA_ETC2
107 * MESA_FORMAT_LATC1_UNORM
108 * MESA_FORMAT_RGBA_FXT1
112 * ---------- Format Base Type P: Packed ----------
113 * MESA_FORMAT_[[component list,bit width][storage type*][_]][_][storage type**]
114 * * when type differs between component
115 * ** when type applies to all components
117 * examples: msb <------ TEXEL BITS -----------> lsb
118 * MESA_FORMAT_A8B8G8R8_UNORM, AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR
119 * MESA_FORMAT_R5G6B5_UNORM RRRR RGGG GGGB BBBB
120 * MESA_FORMAT_B4G4R4X4_UNORM BBBB GGGG RRRR XXXX
121 * MESA_FORMAT_Z32_FLOAT_S8X24_UINT
122 * MESA_FORMAT_R10G10B10A2_UINT
123 * MESA_FORMAT_R9G9B9E5_FLOAT
127 * ---------- Component Labels: ----------
132 * E - Shared Exponent
137 * S - Stencil (when not followed by RGB or RGBA)
146 * ---------- Type C Compression Types: ----------
147 * DXT1 - Color component labels shall be given
148 * DXT3 - Color component labels shall be given
149 * DXT5 - Color component labels shall be given
150 * ETC1 - No other information required
151 * ETC2 - No other information required
152 * FXT1 - Color component labels shall be given
153 * FXT3 - Color component labels shall be given
154 * LATC1 - Fundamental data type shall be given
155 * LATC2 - Fundamental data type shall be given
156 * RGTC1 - Color component labels and data type shall be given
157 * RGTC2 - Color component labels and data type shall be given
161 * ---------- Storage Types: ----------
167 * SRGB - RGB components, or L are UNORMs in sRGB color space.
168 * Alpha, if present is linear.
172 /* Packed unorm formats */ /* msb <------ TEXEL BITS -----------> lsb */
173 /* ---- ---- ---- ---- ---- ---- ---- ---- */
174 MESA_FORMAT_A8B8G8R8_UNORM
, /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
175 MESA_FORMAT_X8B8G8R8_UNORM
, /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
176 MESA_FORMAT_R8G8B8A8_UNORM
, /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
177 MESA_FORMAT_R8G8B8X8_UNORM
, /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
178 MESA_FORMAT_B8G8R8A8_UNORM
, /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
179 MESA_FORMAT_B8G8R8X8_UNORM
, /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
180 MESA_FORMAT_A8R8G8B8_UNORM
, /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
181 MESA_FORMAT_X8R8G8B8_UNORM
, /* BBBB BBBB GGGG GGGG RRRR RRRR xxxx xxxx */
182 MESA_FORMAT_L16A16_UNORM
, /* AAAA AAAA AAAA AAAA LLLL LLLL LLLL LLLL */
183 MESA_FORMAT_A16L16_UNORM
, /* LLLL LLLL LLLL LLLL AAAA AAAA AAAA AAAA */
184 MESA_FORMAT_B5G6R5_UNORM
, /* RRRR RGGG GGGB BBBB */
185 MESA_FORMAT_R5G6B5_UNORM
, /* BBBB BGGG GGGR RRRR */
186 MESA_FORMAT_B4G4R4A4_UNORM
, /* AAAA RRRR GGGG BBBB */
187 MESA_FORMAT_B4G4R4X4_UNORM
, /* xxxx RRRR GGGG BBBB */
188 MESA_FORMAT_A4R4G4B4_UNORM
, /* BBBB GGGG RRRR AAAA */
189 MESA_FORMAT_A1B5G5R5_UNORM
, /* RRRR RGGG GGBB BBBA */
190 MESA_FORMAT_B5G5R5A1_UNORM
, /* ARRR RRGG GGGB BBBB */
191 MESA_FORMAT_B5G5R5X1_UNORM
, /* xRRR RRGG GGGB BBBB */
192 MESA_FORMAT_A1R5G5B5_UNORM
, /* BBBB BGGG GGRR RRRA */
193 MESA_FORMAT_L8A8_UNORM
, /* AAAA AAAA LLLL LLLL */
194 MESA_FORMAT_A8L8_UNORM
, /* LLLL LLLL AAAA AAAA */
195 MESA_FORMAT_R8G8_UNORM
, /* GGGG GGGG RRRR RRRR */
196 MESA_FORMAT_G8R8_UNORM
, /* RRRR RRRR GGGG GGGG */
197 MESA_FORMAT_L4A4_UNORM
, /* AAAA LLLL */
198 MESA_FORMAT_B2G3R3_UNORM
, /* RRRG GGBB */
200 MESA_FORMAT_R16G16_UNORM
, /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
201 MESA_FORMAT_G16R16_UNORM
, /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
202 MESA_FORMAT_B10G10R10A2_UNORM
,/* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
203 MESA_FORMAT_B10G10R10X2_UNORM
,/* xxRR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
204 MESA_FORMAT_R10G10B10A2_UNORM
,/* AABB BBBB BBBB GGGG GGGG GGRR RRRR RRRR */
206 MESA_FORMAT_S8_UINT_Z24_UNORM
,/* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ SSSS SSSS */
207 MESA_FORMAT_X8_UINT_Z24_UNORM
,/* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ xxxx xxxx */
208 MESA_FORMAT_Z24_UNORM_S8_UINT
,/* SSSS SSSS ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
209 MESA_FORMAT_Z24_UNORM_X8_UINT
,/* xxxx xxxx ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
211 MESA_FORMAT_YCBCR
, /* YYYY YYYY UorV UorV */
212 MESA_FORMAT_YCBCR_REV
, /* UorV UorV YYYY YYYY */
214 MESA_FORMAT_DUDV8
, /* DUDU DUDU DVDV DVDV */
216 /* Array unorm formats */
217 MESA_FORMAT_A_UNORM8
, /* ubyte[i] = A */
218 MESA_FORMAT_A_UNORM16
, /* ushort[i] = A */
219 MESA_FORMAT_L_UNORM8
, /* ubyte[i] = L */
220 MESA_FORMAT_L_UNORM16
, /* ushort[i] = L */
221 MESA_FORMAT_I_UNORM8
, /* ubyte[i] = I */
222 MESA_FORMAT_I_UNORM16
, /* ushort[i] = I */
223 MESA_FORMAT_R_UNORM8
, /* ubyte[i] = R */
224 MESA_FORMAT_R_UNORM16
, /* ushort[i] = R */
225 MESA_FORMAT_BGR_UNORM8
, /* ubyte[i*3] = B, [i*3+1] = G, [i*3+2] = R */
226 MESA_FORMAT_RGB_UNORM8
, /* ubyte[i*3] = R, [i*3+1] = G, [i*3+2] = B */
227 MESA_FORMAT_RGBA_UNORM16
, /* ushort[i] = R, [1] = G, [2] = B, [3] = A */
228 MESA_FORMAT_RGBX_UNORM16
,
230 MESA_FORMAT_Z_UNORM16
, /* ushort[i] = Z */
231 MESA_FORMAT_Z_UNORM32
, /* uint[i] = Z */
232 MESA_FORMAT_S_UINT8
, /* ubyte[i] = S */
234 /* Packed signed/normalized formats */
235 /* msb <------ TEXEL BITS -----------> lsb */
236 /* ---- ---- ---- ---- ---- ---- ---- ---- */
237 MESA_FORMAT_A8B8G8R8_SNORM
, /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
238 MESA_FORMAT_X8B8G8R8_SNORM
, /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
239 MESA_FORMAT_R8G8B8A8_SNORM
, /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
240 MESA_FORMAT_R8G8B8X8_SNORM
, /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
241 MESA_FORMAT_R16G16_SNORM
, /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
242 MESA_FORMAT_G16R16_SNORM
, /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
243 MESA_FORMAT_R8G8_SNORM
, /* GGGG GGGG RRRR RRRR */
244 MESA_FORMAT_G8R8_SNORM
, /* RRRR RRRR GGGG GGGG */
245 MESA_FORMAT_L8A8_SNORM
, /* AAAA AAAA LLLL LLLL */
247 /* Array signed/normalized formats */
248 MESA_FORMAT_A_SNORM8
, /* byte[i] = A */
249 MESA_FORMAT_A_SNORM16
, /* short[i] = A */
250 MESA_FORMAT_L_SNORM8
, /* byte[i] = L */
251 MESA_FORMAT_L_SNORM16
, /* short[i] = L */
252 MESA_FORMAT_I_SNORM8
, /* byte[i] = I */
253 MESA_FORMAT_I_SNORM16
, /* short[i] = I */
254 MESA_FORMAT_R_SNORM8
, /* byte[i] = R */
255 MESA_FORMAT_R_SNORM16
, /* short[i] = R */
256 MESA_FORMAT_LA_SNORM16
, /* short[i * 2] = L, [i * 2 + 1] = A */
257 MESA_FORMAT_RGB_SNORM16
, /* short[i*3] = R, [i*3+1] = G, [i*3+2] = B */
258 MESA_FORMAT_RGBA_SNORM16
, /* ... */
259 MESA_FORMAT_RGBX_SNORM16
, /* ... */
261 /* Packed sRGB formats */
262 MESA_FORMAT_A8B8G8R8_SRGB
, /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
263 MESA_FORMAT_B8G8R8A8_SRGB
, /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
264 MESA_FORMAT_B8G8R8X8_SRGB
, /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
265 MESA_FORMAT_R8G8B8A8_SRGB
, /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
266 MESA_FORMAT_R8G8B8X8_SRGB
, /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
267 MESA_FORMAT_L8A8_SRGB
, /* AAAA AAAA LLLL LLLL */
269 /* Array sRGB formats */
270 MESA_FORMAT_L_SRGB8
, /* ubyte[i] = L */
271 MESA_FORMAT_BGR_SRGB8
, /* ubyte[i*3] = B, [i*3+1] = G, [i*3+2] = R */
273 /* Packed float formats */
274 MESA_FORMAT_R9G9B9E5_FLOAT
,
275 MESA_FORMAT_R11G11B10_FLOAT
, /* BBBB BBBB BBGG GGGG GGGG GRRR RRRR RRRR */
276 MESA_FORMAT_Z32_FLOAT_S8X24_UINT
, /* (float, x24s8) */
278 /* Array float formats */
279 MESA_FORMAT_A_FLOAT16
,
280 MESA_FORMAT_A_FLOAT32
,
281 MESA_FORMAT_L_FLOAT16
,
282 MESA_FORMAT_L_FLOAT32
,
283 MESA_FORMAT_LA_FLOAT16
,
284 MESA_FORMAT_LA_FLOAT32
,
285 MESA_FORMAT_I_FLOAT16
,
286 MESA_FORMAT_I_FLOAT32
,
287 MESA_FORMAT_R_FLOAT16
,
288 MESA_FORMAT_R_FLOAT32
,
289 MESA_FORMAT_RG_FLOAT16
,
290 MESA_FORMAT_RG_FLOAT32
,
291 MESA_FORMAT_RGB_FLOAT16
,
292 MESA_FORMAT_RGB_FLOAT32
,
293 MESA_FORMAT_RGBA_FLOAT16
,
294 MESA_FORMAT_RGBA_FLOAT32
, /* float[0] = R, [1] = G, [2] = B, [3] = A */
295 MESA_FORMAT_RGBX_FLOAT16
,
296 MESA_FORMAT_RGBX_FLOAT32
,
297 MESA_FORMAT_Z_FLOAT32
,
299 /* Packed signed/unsigned non-normalized integer formats */
300 MESA_FORMAT_B10G10R10A2_UINT
, /* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
301 MESA_FORMAT_R10G10B10A2_UINT
, /* AABB BBBB BBBB GGGG GGGG GGRR RRRR RRRR */
303 /* Array signed/unsigned non-normalized integer formats */
305 MESA_FORMAT_A_UINT16
,
306 MESA_FORMAT_A_UINT32
,
308 MESA_FORMAT_A_SINT16
,
309 MESA_FORMAT_A_SINT32
,
312 MESA_FORMAT_I_UINT16
,
313 MESA_FORMAT_I_UINT32
,
315 MESA_FORMAT_I_SINT16
,
316 MESA_FORMAT_I_SINT32
,
319 MESA_FORMAT_L_UINT16
,
320 MESA_FORMAT_L_UINT32
,
322 MESA_FORMAT_L_SINT16
,
323 MESA_FORMAT_L_SINT32
,
325 MESA_FORMAT_LA_UINT8
,
326 MESA_FORMAT_LA_UINT16
,
327 MESA_FORMAT_LA_UINT32
,
328 MESA_FORMAT_LA_SINT8
,
329 MESA_FORMAT_LA_SINT16
,
330 MESA_FORMAT_LA_SINT32
,
333 MESA_FORMAT_R_UINT16
,
334 MESA_FORMAT_R_UINT32
,
336 MESA_FORMAT_R_SINT16
,
337 MESA_FORMAT_R_SINT32
,
339 MESA_FORMAT_RG_UINT8
,
340 MESA_FORMAT_RG_UINT16
,
341 MESA_FORMAT_RG_UINT32
,
342 MESA_FORMAT_RG_SINT8
,
343 MESA_FORMAT_RG_SINT16
,
344 MESA_FORMAT_RG_SINT32
,
346 MESA_FORMAT_RGB_UINT8
,
347 MESA_FORMAT_RGB_UINT16
,
348 MESA_FORMAT_RGB_UINT32
,
349 MESA_FORMAT_RGB_SINT8
,
350 MESA_FORMAT_RGB_SINT16
,
351 MESA_FORMAT_RGB_SINT32
,
353 MESA_FORMAT_RGBA_UINT8
,
354 MESA_FORMAT_RGBA_UINT16
,
355 MESA_FORMAT_RGBA_UINT32
,
356 MESA_FORMAT_RGBA_SINT8
,
357 MESA_FORMAT_RGBA_SINT16
,
358 MESA_FORMAT_RGBA_SINT32
,
360 MESA_FORMAT_RGBX_UINT8
,
361 MESA_FORMAT_RGBX_UINT16
,
362 MESA_FORMAT_RGBX_UINT32
,
363 MESA_FORMAT_RGBX_SINT8
,
364 MESA_FORMAT_RGBX_SINT16
,
365 MESA_FORMAT_RGBX_SINT32
,
367 /* DXT compressed formats */
368 MESA_FORMAT_RGB_DXT1
,
369 MESA_FORMAT_RGBA_DXT1
,
370 MESA_FORMAT_RGBA_DXT3
,
371 MESA_FORMAT_RGBA_DXT5
,
373 /* DXT sRGB compressed formats */
374 MESA_FORMAT_SRGB_DXT1
,
375 MESA_FORMAT_SRGBA_DXT1
,
376 MESA_FORMAT_SRGBA_DXT3
,
377 MESA_FORMAT_SRGBA_DXT5
,
379 /* FXT1 compressed formats */
380 MESA_FORMAT_RGB_FXT1
,
381 MESA_FORMAT_RGBA_FXT1
,
383 /* RGTC compressed formats */
384 MESA_FORMAT_R_RGTC1_UNORM
,
385 MESA_FORMAT_R_RGTC1_SNORM
,
386 MESA_FORMAT_RG_RGTC2_UNORM
,
387 MESA_FORMAT_RG_RGTC2_SNORM
,
389 /* LATC1/2 compressed formats */
390 MESA_FORMAT_L_LATC1_UNORM
,
391 MESA_FORMAT_L_LATC1_SNORM
,
392 MESA_FORMAT_LA_LATC2_UNORM
,
393 MESA_FORMAT_LA_LATC2_SNORM
,
395 /* ETC1/2 compressed formats */
396 MESA_FORMAT_ETC1_RGB8
,
397 MESA_FORMAT_ETC2_RGB8
,
398 MESA_FORMAT_ETC2_SRGB8
,
399 MESA_FORMAT_ETC2_RGBA8_EAC
,
400 MESA_FORMAT_ETC2_SRGB8_ALPHA8_EAC
,
401 MESA_FORMAT_ETC2_R11_EAC
,
402 MESA_FORMAT_ETC2_RG11_EAC
,
403 MESA_FORMAT_ETC2_SIGNED_R11_EAC
,
404 MESA_FORMAT_ETC2_SIGNED_RG11_EAC
,
405 MESA_FORMAT_ETC2_RGB8_PUNCHTHROUGH_ALPHA1
,
406 MESA_FORMAT_ETC2_SRGB8_PUNCHTHROUGH_ALPHA1
,
413 _mesa_get_format_name(mesa_format format
);
416 _mesa_get_format_bytes(mesa_format format
);
419 _mesa_get_format_bits(mesa_format format
, GLenum pname
);
422 _mesa_get_format_max_bits(mesa_format format
);
425 _mesa_get_format_datatype(mesa_format format
);
428 _mesa_get_format_base_format(mesa_format format
);
431 _mesa_get_format_block_size(mesa_format format
, GLuint
*bw
, GLuint
*bh
);
434 _mesa_is_format_compressed(mesa_format format
);
437 _mesa_is_format_packed_depth_stencil(mesa_format format
);
440 _mesa_is_format_integer_color(mesa_format format
);
443 _mesa_is_format_unsigned(mesa_format format
);
446 _mesa_is_format_signed(mesa_format format
);
449 _mesa_get_format_color_encoding(mesa_format format
);
452 _mesa_format_image_size(mesa_format format
, GLsizei width
,
453 GLsizei height
, GLsizei depth
);
456 _mesa_format_image_size64(mesa_format format
, GLsizei width
,
457 GLsizei height
, GLsizei depth
);
460 _mesa_format_row_stride(mesa_format format
, GLsizei width
);
463 _mesa_format_to_type_and_comps(mesa_format format
,
464 GLenum
*datatype
, GLuint
*comps
);
467 _mesa_test_formats(void);
470 _mesa_get_srgb_format_linear(mesa_format format
);
473 _mesa_get_uncompressed_format(mesa_format format
);
476 _mesa_format_num_components(mesa_format format
);
479 _mesa_format_has_color_component(mesa_format format
, int component
);
482 _mesa_format_matches_format_and_type(mesa_format mesa_format
,
483 GLenum format
, GLenum type
,
484 GLboolean swapBytes
);
490 #endif /* FORMATS_H */