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.
45 * OpenGL doesn't have GL_UNSIGNED_BYTE_4_4, so we must define our own type
46 * for GL_LUMINANCE4_ALPHA4.
48 #define MESA_UNSIGNED_BYTE_4_4 (GL_UNSIGNED_BYTE<<1)
52 * Max number of bytes for any non-compressed pixel format below, or for
53 * intermediate pixel storage in Mesa. This should never be less than
54 * 16. Maybe 32 someday?
56 #define MAX_PIXEL_BYTES 16
60 * Mesa texture/renderbuffer image formats.
67 * \name Basic hardware formats
69 * The mesa format name specification is as follows:
71 * There shall be 3 naming format base types: those for component array
72 * formats (type A); those for compressed formats (type C); and those for
73 * packed component formats (type P). With type A formats, color component
74 * order does not change with endianess. Each format name shall begin with
75 * MESA_FORMAT_, followed by a component label (from the Component Label
76 * list below) for each component in the order that the component(s) occur
77 * in the format, except for non-linear color formats where the first
78 * letter shall be 'S'. For type P formats, each component label is
79 * followed by the number of bits that represent it in the fundamental
80 * data type used by the format.
82 * Following the listing of the component labels shall be an underscore; a
83 * compression type followed by an underscore for Type C formats only; a
84 * storage type from the list below; and a bit with for type A formats,
85 * which is the bit width for each array element.
88 * ---------- Format Base Type A: Array ----------
89 * MESA_FORMAT_[component list]_[storage type][array element bit width]
92 * MESA_FORMAT_A_SNORM8 - uchar[i] = A
93 * MESA_FORMAT_RGBA_16 - ushort[i * 4 + 0] = R, ushort[i * 4 + 1] = G,
94 * ushort[i * 4 + 2] = B, ushort[i * 4 + 3] = A
95 * MESA_FORMAT_Z_UNORM32 - float[i] = Z
99 * ---------- Format Base Type C: Compressed ----------
100 * MESA_FORMAT_[component list*][_*][compression type][storage type*]
104 * MESA_FORMAT_RGB_ETC1
105 * MESA_FORMAT_RGBA_ETC2
106 * MESA_FORMAT_LATC1_UNORM
107 * MESA_FORMAT_RGBA_FXT1
111 * ---------- Format Base Type P: Packed ----------
112 * MESA_FORMAT_[[component list,bit width][storage type*][_]][_][storage type**]
113 * * when type differs between component
114 * ** when type applies to all components
116 * examples: msb <------ TEXEL BITS -----------> lsb
117 * MESA_FORMAT_A8B8G8R8_UNORM, AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR
118 * MESA_FORMAT_R5G6B5_UNORM RRRR RGGG GGGB BBBB
119 * MESA_FORMAT_B4G4R4X4_UNORM BBBB GGGG RRRR XXXX
120 * MESA_FORMAT_Z32_FLOAT_S8X24_UINT
121 * MESA_FORMAT_R10G10B10A2_UINT
122 * MESA_FORMAT_R9G9B9E5_FLOAT
126 * ---------- Component Labels: ----------
131 * E - Shared Exponent
136 * S - Stencil (when not followed by RGB or RGBA)
145 * ---------- Type C Compression Types: ----------
146 * DXT1 - Color component labels shall be given
147 * DXT3 - Color component labels shall be given
148 * DXT5 - Color component labels shall be given
149 * ETC1 - No other information required
150 * ETC2 - No other information required
151 * FXT1 - Color component labels shall be given
152 * FXT3 - Color component labels shall be given
153 * LATC1 - Fundamental data type shall be given
154 * LATC2 - Fundamental data type shall be given
155 * RGTC1 - Color component labels and data type shall be given
156 * RGTC2 - Color component labels and data type shall be given
160 * ---------- Storage Types: ----------
166 * SRGB - RGB components, or L are UNORMs in sRGB color space.
167 * Alpha, if present is linear.
171 /* Packed unorm formats */ /* msb <------ TEXEL BITS -----------> lsb */
172 /* ---- ---- ---- ---- ---- ---- ---- ---- */
173 MESA_FORMAT_A8B8G8R8_UNORM
, /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
174 MESA_FORMAT_X8B8G8R8_UNORM
, /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
175 MESA_FORMAT_R8G8B8A8_UNORM
, /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
176 MESA_FORMAT_R8G8B8X8_UNORM
, /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
177 MESA_FORMAT_B8G8R8A8_UNORM
, /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
178 MESA_FORMAT_B8G8R8X8_UNORM
, /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
179 MESA_FORMAT_A8R8G8B8_UNORM
, /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
180 MESA_FORMAT_X8R8G8B8_UNORM
, /* BBBB BBBB GGGG GGGG RRRR RRRR xxxx xxxx */
181 MESA_FORMAT_L16A16_UNORM
, /* AAAA AAAA AAAA AAAA LLLL LLLL LLLL LLLL */
182 MESA_FORMAT_A16L16_UNORM
, /* LLLL LLLL LLLL LLLL AAAA AAAA AAAA AAAA */
183 MESA_FORMAT_B5G6R5_UNORM
, /* RRRR RGGG GGGB BBBB */
184 MESA_FORMAT_R5G6B5_UNORM
, /* BBBB BGGG GGGR RRRR */
185 MESA_FORMAT_B4G4R4A4_UNORM
, /* AAAA RRRR GGGG BBBB */
186 MESA_FORMAT_B4G4R4X4_UNORM
, /* xxxx RRRR GGGG BBBB */
187 MESA_FORMAT_A4R4G4B4_UNORM
, /* BBBB GGGG RRRR AAAA */
188 MESA_FORMAT_A1B5G5R5_UNORM
, /* RRRR RGGG GGBB BBBA */
189 MESA_FORMAT_B5G5R5A1_UNORM
, /* ARRR RRGG GGGB BBBB */
190 MESA_FORMAT_B5G5R5X1_UNORM
, /* xRRR RRGG GGGB BBBB */
191 MESA_FORMAT_A1R5G5B5_UNORM
, /* BBBB BGGG GGRR RRRA */
192 MESA_FORMAT_L8A8_UNORM
, /* AAAA AAAA LLLL LLLL */
193 MESA_FORMAT_A8L8_UNORM
, /* LLLL LLLL AAAA AAAA */
194 MESA_FORMAT_R8G8_UNORM
, /* GGGG GGGG RRRR RRRR */
195 MESA_FORMAT_G8R8_UNORM
, /* RRRR RRRR GGGG GGGG */
196 MESA_FORMAT_L4A4_UNORM
, /* AAAA LLLL */
197 MESA_FORMAT_B2G3R3_UNORM
, /* RRRG GGBB */
199 MESA_FORMAT_R16G16_UNORM
, /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
200 MESA_FORMAT_G16R16_UNORM
, /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
201 MESA_FORMAT_B10G10R10A2_UNORM
,/* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
202 MESA_FORMAT_B10G10R10X2_UNORM
,/* xxRR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
203 MESA_FORMAT_R10G10B10A2_UNORM
,/* AABB BBBB BBBB GGGG GGGG GGRR RRRR RRRR */
205 MESA_FORMAT_S8_UINT_Z24_UNORM
,/* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ SSSS SSSS */
206 MESA_FORMAT_X8Z24_UNORM
, /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ xxxx xxxx */
207 MESA_FORMAT_Z24_UNORM_S8_UINT
,/* SSSS SSSS ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
208 MESA_FORMAT_Z24_UNORM_X8_UINT
,/* xxxx xxxx ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
210 MESA_FORMAT_YCBCR
, /* YYYY YYYY UorV UorV */
211 MESA_FORMAT_YCBCR_REV
, /* UorV UorV YYYY YYYY */
213 MESA_FORMAT_DUDV8
, /* DUDU DUDU DVDV DVDV */
215 /* Array unorm formats */
216 MESA_FORMAT_A_UNORM8
, /* ubyte[i] = A */
217 MESA_FORMAT_A_UNORM16
, /* ushort[i] = A */
218 MESA_FORMAT_L_UNORM8
, /* ubyte[i] = L */
219 MESA_FORMAT_L_UNORM16
, /* ushort[i] = L */
220 MESA_FORMAT_I_UNORM8
, /* ubyte[i] = I */
221 MESA_FORMAT_I_UNORM16
, /* ushort[i] = I */
222 MESA_FORMAT_R_UNORM8
, /* ubyte[i] = R */
223 MESA_FORMAT_R_UNORM16
, /* ushort[i] = R */
224 MESA_FORMAT_BGR_UNORM8
, /* ubyte[i*3] = B, [i*3+1] = G, [i*3+2] = R */
225 MESA_FORMAT_RGB_UNORM8
, /* ubyte[i*3] = R, [i*3+1] = G, [i*3+2] = B */
226 MESA_FORMAT_RGBA_UNORM16
, /* ushort[i] = R, [1] = G, [2] = B, [3] = A */
227 MESA_FORMAT_RGBX_UNORM16
,
229 MESA_FORMAT_Z_UNORM16
, /* ushort[i] = Z */
230 MESA_FORMAT_Z_UNORM32
, /* uint[i] = Z */
231 MESA_FORMAT_S_UINT8
, /* ubyte[i] = S */
233 /* Packed signed/normalized formats */
234 /* msb <------ TEXEL BITS -----------> lsb */
235 /* ---- ---- ---- ---- ---- ---- ---- ---- */
236 MESA_FORMAT_A8B8G8R8_SNORM
, /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
237 MESA_FORMAT_X8B8G8R8_SNORM
, /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
238 MESA_FORMAT_R8G8B8A8_SNORM
, /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
239 MESA_FORMAT_R8G8B8X8_SNORM
, /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
240 MESA_FORMAT_R16G16_SNORM
, /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
241 MESA_FORMAT_G16R16_SNORM
, /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
242 MESA_FORMAT_R8G8_SNORM
, /* GGGG GGGG RRRR RRRR */
243 MESA_FORMAT_G8R8_SNORM
, /* RRRR RRRR GGGG GGGG */
244 MESA_FORMAT_L8A8_SNORM
, /* AAAA AAAA LLLL LLLL */
246 /* Array signed/normalized formats */
247 MESA_FORMAT_A_SNORM8
, /* byte[i] = A */
248 MESA_FORMAT_A_SNORM16
, /* short[i] = A */
249 MESA_FORMAT_L_SNORM8
, /* byte[i] = L */
250 MESA_FORMAT_L_SNORM16
, /* short[i] = L */
251 MESA_FORMAT_I_SNORM8
, /* byte[i] = I */
252 MESA_FORMAT_I_SNORM16
, /* short[i] = I */
253 MESA_FORMAT_R_SNORM8
, /* byte[i] = R */
254 MESA_FORMAT_R_SNORM16
, /* short[i] = R */
255 MESA_FORMAT_LA_SNORM16
, /* short[i * 2] = L, [i * 2 + 1] = A */
256 MESA_FORMAT_RGB_SNORM16
, /* short[i*3] = R, [i*3+1] = G, [i*3+2] = B */
257 MESA_FORMAT_RGBA_SNORM16
, /* ... */
258 MESA_FORMAT_RGBX_SNORM16
, /* ... */
260 /* Packed sRGB formats */
261 MESA_FORMAT_A8B8G8R8_SRGB
, /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
262 MESA_FORMAT_B8G8R8A8_SRGB
, /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
263 MESA_FORMAT_B8G8R8X8_SRGB
, /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
264 MESA_FORMAT_R8G8B8A8_SRGB
, /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
265 MESA_FORMAT_R8G8B8X8_SRGB
, /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
266 MESA_FORMAT_L8A8_SRGB
, /* AAAA AAAA LLLL LLLL */
268 /* Array sRGB formats */
269 MESA_FORMAT_L_SRGB8
, /* ubyte[i] = L */
270 MESA_FORMAT_BGR_SRGB8
, /* ubyte[i*3] = B, [i*3+1] = G, [i*3+2] = R */
272 /* Packed float formats */
273 MESA_FORMAT_R9G9B9E5_FLOAT
,
274 MESA_FORMAT_R11G11B10_FLOAT
, /* BBBB BBBB BBGG GGGG GGGG GRRR RRRR RRRR */
275 MESA_FORMAT_Z32_FLOAT_S8X24_UINT
, /* (float, x24s8) */
277 /* Array float formats */
278 MESA_FORMAT_A_FLOAT16
,
279 MESA_FORMAT_A_FLOAT32
,
280 MESA_FORMAT_L_FLOAT16
,
281 MESA_FORMAT_L_FLOAT32
,
282 MESA_FORMAT_LA_FLOAT16
,
283 MESA_FORMAT_LA_FLOAT32
,
284 MESA_FORMAT_I_FLOAT16
,
285 MESA_FORMAT_I_FLOAT32
,
286 MESA_FORMAT_R_FLOAT16
,
287 MESA_FORMAT_R_FLOAT32
,
288 MESA_FORMAT_RG_FLOAT16
,
289 MESA_FORMAT_RG_FLOAT32
,
290 MESA_FORMAT_RGB_FLOAT16
,
291 MESA_FORMAT_RGB_FLOAT32
,
292 MESA_FORMAT_RGBA_FLOAT16
,
293 MESA_FORMAT_RGBA_FLOAT32
, /* float[0] = R, [1] = G, [2] = B, [3] = A */
294 MESA_FORMAT_RGBX_FLOAT16
,
295 MESA_FORMAT_RGBX_FLOAT32
,
296 MESA_FORMAT_Z_FLOAT32
,
298 /* Packed signed/unsigned non-normalized integer formats */
299 MESA_FORMAT_B10G10R10A2_UINT
, /* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
300 MESA_FORMAT_R10G10B10A2_UINT
, /* AABB BBBB BBBB GGGG GGGG GGRR RRRR RRRR */
302 /* Array signed/unsigned non-normalized integer formats */
304 MESA_FORMAT_A_UINT16
,
305 MESA_FORMAT_A_UINT32
,
307 MESA_FORMAT_A_SINT16
,
308 MESA_FORMAT_A_SINT32
,
311 MESA_FORMAT_I_UINT16
,
312 MESA_FORMAT_I_UINT32
,
314 MESA_FORMAT_I_SINT16
,
315 MESA_FORMAT_I_SINT32
,
318 MESA_FORMAT_L_UINT16
,
319 MESA_FORMAT_L_UINT32
,
321 MESA_FORMAT_L_SINT16
,
322 MESA_FORMAT_L_SINT32
,
324 MESA_FORMAT_LA_UINT8
,
325 MESA_FORMAT_LA_UINT16
,
326 MESA_FORMAT_LA_UINT32
,
327 MESA_FORMAT_LA_SINT8
,
328 MESA_FORMAT_LA_SINT16
,
329 MESA_FORMAT_LA_SINT32
,
332 MESA_FORMAT_R_UINT16
,
333 MESA_FORMAT_R_UINT32
,
335 MESA_FORMAT_R_SINT16
,
336 MESA_FORMAT_R_SINT32
,
338 MESA_FORMAT_RG_UINT8
,
339 MESA_FORMAT_RG_UINT16
,
340 MESA_FORMAT_RG_UINT32
,
341 MESA_FORMAT_RG_SINT8
,
342 MESA_FORMAT_RG_SINT16
,
343 MESA_FORMAT_RG_SINT32
,
345 MESA_FORMAT_RGB_UINT8
,
346 MESA_FORMAT_RGB_UINT16
,
347 MESA_FORMAT_RGB_UINT32
,
348 MESA_FORMAT_RGB_SINT8
,
349 MESA_FORMAT_RGB_SINT16
,
350 MESA_FORMAT_RGB_SINT32
,
352 MESA_FORMAT_RGBA_UINT8
,
353 MESA_FORMAT_RGBA_UINT16
,
354 MESA_FORMAT_RGBA_UINT32
,
355 MESA_FORMAT_RGBA_SINT8
,
356 MESA_FORMAT_RGBA_SINT16
,
357 MESA_FORMAT_RGBA_SINT32
,
359 MESA_FORMAT_RGBX_UINT8
,
360 MESA_FORMAT_RGBX_UINT16
,
361 MESA_FORMAT_RGBX_UINT32
,
362 MESA_FORMAT_RGBX_SINT8
,
363 MESA_FORMAT_RGBX_SINT16
,
364 MESA_FORMAT_RGBX_SINT32
,
366 /* DXT compressed formats */
367 MESA_FORMAT_RGB_DXT1
,
368 MESA_FORMAT_RGBA_DXT1
,
369 MESA_FORMAT_RGBA_DXT3
,
370 MESA_FORMAT_RGBA_DXT5
,
372 /* DXT sRGB compressed formats */
373 MESA_FORMAT_SRGB_DXT1
,
374 MESA_FORMAT_SRGBA_DXT1
,
375 MESA_FORMAT_SRGBA_DXT3
,
376 MESA_FORMAT_SRGBA_DXT5
,
378 /* FXT1 compressed formats */
379 MESA_FORMAT_RGB_FXT1
,
380 MESA_FORMAT_RGBA_FXT1
,
382 /* RGTC compressed formats */
383 MESA_FORMAT_R_RGTC1_UNORM
,
384 MESA_FORMAT_R_RGTC1_SNORM
,
385 MESA_FORMAT_RG_RGTC2_UNORM
,
386 MESA_FORMAT_RG_RGTC2_SNORM
,
388 /* LATC1/2 compressed formats */
389 MESA_FORMAT_L_LATC1_UNORM
,
390 MESA_FORMAT_L_LATC1_SNORM
,
391 MESA_FORMAT_LA_LATC2_UNORM
,
392 MESA_FORMAT_LA_LATC2_SNORM
,
394 /* ETC1/2 compressed formats */
395 MESA_FORMAT_ETC1_RGB8
,
396 MESA_FORMAT_ETC2_RGB8
,
397 MESA_FORMAT_ETC2_SRGB8
,
398 MESA_FORMAT_ETC2_RGBA8_EAC
,
399 MESA_FORMAT_ETC2_SRGB8_ALPHA8_EAC
,
400 MESA_FORMAT_ETC2_R11_EAC
,
401 MESA_FORMAT_ETC2_RG11_EAC
,
402 MESA_FORMAT_ETC2_SIGNED_R11_EAC
,
403 MESA_FORMAT_ETC2_SIGNED_RG11_EAC
,
404 MESA_FORMAT_ETC2_RGB8_PUNCHTHROUGH_ALPHA1
,
405 MESA_FORMAT_ETC2_SRGB8_PUNCHTHROUGH_ALPHA1
,
412 _mesa_get_format_name(mesa_format format
);
415 _mesa_get_format_bytes(mesa_format format
);
418 _mesa_get_format_bits(mesa_format format
, GLenum pname
);
421 _mesa_get_format_max_bits(mesa_format format
);
424 _mesa_get_format_datatype(mesa_format format
);
427 _mesa_get_format_base_format(mesa_format format
);
430 _mesa_get_format_block_size(mesa_format format
, GLuint
*bw
, GLuint
*bh
);
433 _mesa_is_format_compressed(mesa_format format
);
436 _mesa_is_format_packed_depth_stencil(mesa_format format
);
439 _mesa_is_format_integer_color(mesa_format format
);
442 _mesa_is_format_unsigned(mesa_format format
);
445 _mesa_is_format_signed(mesa_format format
);
448 _mesa_get_format_color_encoding(mesa_format format
);
451 _mesa_format_image_size(mesa_format format
, GLsizei width
,
452 GLsizei height
, GLsizei depth
);
455 _mesa_format_image_size64(mesa_format format
, GLsizei width
,
456 GLsizei height
, GLsizei depth
);
459 _mesa_format_row_stride(mesa_format format
, GLsizei width
);
462 _mesa_format_to_type_and_comps(mesa_format format
,
463 GLenum
*datatype
, GLuint
*comps
);
466 _mesa_test_formats(void);
469 _mesa_get_srgb_format_linear(mesa_format format
);
472 _mesa_get_uncompressed_format(mesa_format format
);
475 _mesa_format_num_components(mesa_format format
);
478 _mesa_format_matches_format_and_type(mesa_format mesa_format
,
479 GLenum format
, GLenum type
,
480 GLboolean swapBytes
);
486 #endif /* FORMATS_H */