1 /**************************************************************************
3 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
4 * Copyright (c) 2008 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
9 * "Software"), to deal in the Software without restriction, including
10 * without limitation the rights to use, copy, modify, merge, publish,
11 * distribute, sub license, and/or sell copies of the Software, and to
12 * permit persons to whom the Software is furnished to do so, subject to
13 * the following conditions:
15 * The above copyright notice and this permission notice (including the
16 * next paragraph) shall be included in all copies or substantial portions
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
22 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
23 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
24 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
25 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 **************************************************************************/
32 #include "p_compiler.h"
34 /* FIXME: remove these header dependencies */
35 #include "util/u_debug.h"
36 #include "util/u_string.h"
43 * The pipe_format enum is a 32-bit wide bitfield that encodes all the
44 * information needed to uniquely describe a pixel format.
48 * Possible format layouts are encoded in the first 2 bits.
49 * The interpretation of the remaining 30 bits depends on a particular
52 #define PIPE_FORMAT_LAYOUT_RGBAZS 0
53 #define PIPE_FORMAT_LAYOUT_YCBCR 1
54 #define PIPE_FORMAT_LAYOUT_DXT 2 /**< XXX temporary? */
55 #define PIPE_FORMAT_LAYOUT_MIXED 3
57 static INLINE uint
pf_layout(uint f
) /**< PIPE_FORMAT_LAYOUT_ */
63 * RGBAZS Format Layout.
67 * Format component selectors for RGBAZS & MIXED layout.
69 #define PIPE_FORMAT_COMP_R 0
70 #define PIPE_FORMAT_COMP_G 1
71 #define PIPE_FORMAT_COMP_B 2
72 #define PIPE_FORMAT_COMP_A 3
73 #define PIPE_FORMAT_COMP_0 4
74 #define PIPE_FORMAT_COMP_1 5
75 #define PIPE_FORMAT_COMP_Z 6
76 #define PIPE_FORMAT_COMP_S 7
79 * Format types for RGBAZS layout.
81 #define PIPE_FORMAT_TYPE_UNKNOWN 0
82 #define PIPE_FORMAT_TYPE_FLOAT 1 /**< 16/32/64-bit/channel formats */
83 #define PIPE_FORMAT_TYPE_UNORM 2 /**< uints, normalized to [0,1] */
84 #define PIPE_FORMAT_TYPE_SNORM 3 /**< ints, normalized to [-1,1] */
85 #define PIPE_FORMAT_TYPE_USCALED 4 /**< uints, not normalized */
86 #define PIPE_FORMAT_TYPE_SSCALED 5 /**< ints, not normalized */
87 #define PIPE_FORMAT_TYPE_SRGB 6 /**< sRGB colorspace */
88 #define PIPE_FORMAT_TYPE_FIXED 7 /**< 16.16 fixed point */
92 * Because the destination vector is assumed to be RGBA FLOAT, we
93 * need to know how to swizzle and expand components from the source
95 * Let's take U_A1_R5_G5_B5 as an example. X swizzle is A, X size
96 * is 1 bit and type is UNORM. So we take the most significant bit
97 * from source vector, convert 0 to 0.0 and 1 to 1.0 and save it
98 * in the last component of the destination RGBA component.
99 * Next, Y swizzle is R, Y size is 5 and type is UNORM. We normalize
100 * those 5 bits into [0.0; 1.0] range and put it into second
101 * component of the destination vector. Rinse and repeat for
102 * components Z and W.
103 * If any of size fields is zero, it means the source format contains
104 * less than four components.
105 * If any swizzle is 0 or 1, the corresponding destination component
106 * should be filled with 0.0 and 1.0, respectively.
108 typedef uint pipe_format_rgbazs_t
;
110 static INLINE uint
pf_get(pipe_format_rgbazs_t f
, uint shift
, uint mask
)
112 return (f
>> shift
) & mask
;
115 #define pf_swizzle_x(f) pf_get(f, 2, 0x7) /**< PIPE_FORMAT_COMP_ */
116 #define pf_swizzle_y(f) pf_get(f, 5, 0x7) /**< PIPE_FORMAT_COMP_ */
117 #define pf_swizzle_z(f) pf_get(f, 8, 0x7) /**< PIPE_FORMAT_COMP_ */
118 #define pf_swizzle_w(f) pf_get(f, 11, 0x7) /**< PIPE_FORMAT_COMP_ */
119 #define pf_swizzle_xyzw(f,i) pf_get(f, 2+((i)*3), 0x7)
120 #define pf_size_x(f) pf_get(f, 14, 0x7) /**< Size of X */
121 #define pf_size_y(f) pf_get(f, 17, 0x7) /**< Size of Y */
122 #define pf_size_z(f) pf_get(f, 20, 0x7) /**< Size of Z */
123 #define pf_size_w(f) pf_get(f, 23, 0x7) /**< Size of W */
124 #define pf_size_xyzw(f,i) pf_get(f, 14+((i)*3), 0x7)
125 #define pf_exp2(f) pf_get(f, 26, 0x7) /**< Scale size by 2 ^ exp2 */
126 #define pf_type(f) pf_get(f, 29, 0x7) /**< PIPE_FORMAT_TYPE_ */
129 * Helper macro to encode the above structure into a 32-bit value.
131 #define _PIPE_FORMAT_RGBAZS( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, EXP2, TYPE ) (\
132 (PIPE_FORMAT_LAYOUT_RGBAZS << 0) |\
142 * Helper macro to encode the swizzle part of the structure above.
144 #define _PIPE_FORMAT_SWZ( SWZX, SWZY, SWZZ, SWZW ) (((SWZX) << 0) | ((SWZY) << 3) | ((SWZZ) << 6) | ((SWZW) << 9))
147 * Shorthand macro for RGBAZS layout with component sizes in 1-bit units.
149 #define _PIPE_FORMAT_RGBAZS_1( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, TYPE )\
150 _PIPE_FORMAT_RGBAZS( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, 0, TYPE )
153 * Shorthand macro for RGBAZS layout with component sizes in 2-bit units.
155 #define _PIPE_FORMAT_RGBAZS_2( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, TYPE )\
156 _PIPE_FORMAT_RGBAZS( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, 1, TYPE )
159 * Shorthand macro for RGBAZS layout with component sizes in 8-bit units.
161 #define _PIPE_FORMAT_RGBAZS_8( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, TYPE )\
162 _PIPE_FORMAT_RGBAZS( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, 3, TYPE )
165 * Shorthand macro for RGBAZS layout with component sizes in 64-bit units.
167 #define _PIPE_FORMAT_RGBAZS_64( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, TYPE )\
168 _PIPE_FORMAT_RGBAZS( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, 6, TYPE )
170 typedef uint pipe_format_mixed_t
;
172 /* NOTE: Use pf_swizzle_* and pf_size_* macros for swizzles and sizes.
175 #define pf_mixed_sign_x(f) pf_get( f, 26, 0x1 ) /*< Sign of X */
176 #define pf_mixed_sign_y(f) pf_get( f, 27, 0x1 ) /*< Sign of Y */
177 #define pf_mixed_sign_z(f) pf_get( f, 28, 0x1 ) /*< Sign of Z */
178 #define pf_mixed_sign_w(f) pf_get( f, 29, 0x1 ) /*< Sign of W */
179 #define pf_mixed_sign_xyzw(f, i) pf_get( f, 26 + (i), 0x1 )
180 #define pf_mixed_normalized(f) pf_get( f, 30, 0x1 ) /*< Type is NORM (1) or SCALED (0) */
181 #define pf_mixed_scale8(f) pf_get( f, 31, 0x1 ) /*< Scale size by either one (0) or eight (1) */
184 * Helper macro to encode the above structure into a 32-bit value.
186 #define _PIPE_FORMAT_MIXED( SWZ, SIZEX, SIZEY, SIZEZ, SIZEW, SIGNX, SIGNY, SIGNZ, SIGNW, NORMALIZED, SCALE8 ) (\
187 (PIPE_FORMAT_LAYOUT_MIXED << 0) |\
197 ((NORMALIZED) << 30) |\
201 * Shorthand macro for common format swizzles.
203 #define _PIPE_FORMAT_R001 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_1 )
204 #define _PIPE_FORMAT_RG01 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_G, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_1 )
205 #define _PIPE_FORMAT_RGB1 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_G, PIPE_FORMAT_COMP_B, PIPE_FORMAT_COMP_1 )
206 #define _PIPE_FORMAT_RGBA _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_G, PIPE_FORMAT_COMP_B, PIPE_FORMAT_COMP_A )
207 #define _PIPE_FORMAT_ARGB _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_A, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_G, PIPE_FORMAT_COMP_B )
208 #define _PIPE_FORMAT_ABGR _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_A, PIPE_FORMAT_COMP_B, PIPE_FORMAT_COMP_G, PIPE_FORMAT_COMP_R )
209 #define _PIPE_FORMAT_BGRA _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_B, PIPE_FORMAT_COMP_G, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_A )
210 #define _PIPE_FORMAT_1RGB _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_1, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_G, PIPE_FORMAT_COMP_B )
211 #define _PIPE_FORMAT_1BGR _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_1, PIPE_FORMAT_COMP_B, PIPE_FORMAT_COMP_G, PIPE_FORMAT_COMP_R )
212 #define _PIPE_FORMAT_BGR1 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_B, PIPE_FORMAT_COMP_G, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_1 )
213 #define _PIPE_FORMAT_0000 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0 )
214 #define _PIPE_FORMAT_000R _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_R )
215 #define _PIPE_FORMAT_RRR1 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_1 )
216 #define _PIPE_FORMAT_RRRR _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_R )
217 #define _PIPE_FORMAT_RRRG _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_R, PIPE_FORMAT_COMP_G )
218 #define _PIPE_FORMAT_Z000 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_Z, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0 )
219 #define _PIPE_FORMAT_0Z00 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_Z, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0 )
220 #define _PIPE_FORMAT_SZ00 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_S, PIPE_FORMAT_COMP_Z, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0 )
221 #define _PIPE_FORMAT_ZS00 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_Z, PIPE_FORMAT_COMP_S, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0 )
222 #define _PIPE_FORMAT_S000 _PIPE_FORMAT_SWZ( PIPE_FORMAT_COMP_S, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0, PIPE_FORMAT_COMP_0 )
225 * YCBCR Format Layout.
229 * This only contains a flag that indicates whether the format is reversed or
232 typedef uint pipe_format_ycbcr_t
;
235 * Helper macro to encode the above structure into a 32-bit value.
237 #define _PIPE_FORMAT_YCBCR( REV ) (\
238 (PIPE_FORMAT_LAYOUT_YCBCR << 0) |\
241 static INLINE uint
pf_rev(pipe_format_ycbcr_t f
)
243 return (f
>> 2) & 0x1;
248 * Compresssed format layouts (this will probably change)
250 #define _PIPE_FORMAT_DXT( LEVEL, RSIZE, GSIZE, BSIZE, ASIZE, TYPE ) \
251 ((PIPE_FORMAT_LAYOUT_DXT << 0) | \
262 * Texture/surface image formats (preliminary)
265 /* KW: Added lots of surface formats to support vertex element layout
266 * definitions, and eventually render-to-vertex-buffer. Could
267 * consider making float/int/uint/scaled/normalized a separate
268 * parameter, but on the other hand there are special cases like
269 * z24s8, compressed textures, ycbcr, etc that won't fit that model.
273 PIPE_FORMAT_NONE
= _PIPE_FORMAT_RGBAZS_1 ( _PIPE_FORMAT_0000
, 0, 0, 0, 0, PIPE_FORMAT_TYPE_UNKNOWN
),
274 PIPE_FORMAT_A8R8G8B8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_ARGB
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_UNORM
),
275 PIPE_FORMAT_X8R8G8B8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_1RGB
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_UNORM
),
276 PIPE_FORMAT_B8G8R8A8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_BGRA
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_UNORM
),
277 PIPE_FORMAT_B8G8R8X8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_BGR1
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_UNORM
),
278 PIPE_FORMAT_A1R5G5B5_UNORM
= _PIPE_FORMAT_RGBAZS_1 ( _PIPE_FORMAT_ARGB
, 1, 5, 5, 5, PIPE_FORMAT_TYPE_UNORM
),
279 PIPE_FORMAT_A4R4G4B4_UNORM
= _PIPE_FORMAT_RGBAZS_1 ( _PIPE_FORMAT_ARGB
, 4, 4, 4, 4, PIPE_FORMAT_TYPE_UNORM
),
280 PIPE_FORMAT_R5G6B5_UNORM
= _PIPE_FORMAT_RGBAZS_1 ( _PIPE_FORMAT_RGB1
, 5, 6, 5, 0, PIPE_FORMAT_TYPE_UNORM
),
281 PIPE_FORMAT_A2B10G10R10_UNORM
= _PIPE_FORMAT_RGBAZS_2 ( _PIPE_FORMAT_ABGR
, 1, 5, 5, 5, PIPE_FORMAT_TYPE_UNORM
),
282 PIPE_FORMAT_L8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RRR1
, 1, 1, 1, 0, PIPE_FORMAT_TYPE_UNORM
), /**< ubyte luminance */
283 PIPE_FORMAT_A8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_000R
, 0, 0, 0, 1, PIPE_FORMAT_TYPE_UNORM
), /**< ubyte alpha */
284 PIPE_FORMAT_I8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RRRR
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_UNORM
), /**< ubyte intensity */
285 PIPE_FORMAT_A8L8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RRRG
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_UNORM
), /**< ubyte alpha, luminance */
286 PIPE_FORMAT_L16_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RRR1
, 2, 2, 2, 0, PIPE_FORMAT_TYPE_UNORM
), /**< ushort luminance */
287 PIPE_FORMAT_YCBCR
= _PIPE_FORMAT_YCBCR( 0 ),
288 PIPE_FORMAT_YCBCR_REV
= _PIPE_FORMAT_YCBCR( 1 ),
289 PIPE_FORMAT_Z16_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_Z000
, 2, 0, 0, 0, PIPE_FORMAT_TYPE_UNORM
),
290 PIPE_FORMAT_Z32_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_Z000
, 4, 0, 0, 0, PIPE_FORMAT_TYPE_UNORM
),
291 PIPE_FORMAT_Z32_FLOAT
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_Z000
, 4, 0, 0, 0, PIPE_FORMAT_TYPE_FLOAT
),
292 PIPE_FORMAT_S8Z24_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_SZ00
, 1, 3, 0, 0, PIPE_FORMAT_TYPE_UNORM
),
293 PIPE_FORMAT_Z24S8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_ZS00
, 3, 1, 0, 0, PIPE_FORMAT_TYPE_UNORM
),
294 PIPE_FORMAT_X8Z24_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_0Z00
, 1, 3, 0, 0, PIPE_FORMAT_TYPE_UNORM
),
295 PIPE_FORMAT_Z24X8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_Z000
, 3, 1, 0, 0, PIPE_FORMAT_TYPE_UNORM
),
296 PIPE_FORMAT_S8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_S000
, 1, 0, 0, 0, PIPE_FORMAT_TYPE_UNORM
), /**< ubyte stencil */
297 PIPE_FORMAT_R64_FLOAT
= _PIPE_FORMAT_RGBAZS_64( _PIPE_FORMAT_R001
, 1, 0, 0, 0, PIPE_FORMAT_TYPE_FLOAT
),
298 PIPE_FORMAT_R64G64_FLOAT
= _PIPE_FORMAT_RGBAZS_64( _PIPE_FORMAT_RG01
, 1, 1, 0, 0, PIPE_FORMAT_TYPE_FLOAT
),
299 PIPE_FORMAT_R64G64B64_FLOAT
= _PIPE_FORMAT_RGBAZS_64( _PIPE_FORMAT_RGB1
, 1, 1, 1, 0, PIPE_FORMAT_TYPE_FLOAT
),
300 PIPE_FORMAT_R64G64B64A64_FLOAT
= _PIPE_FORMAT_RGBAZS_64( _PIPE_FORMAT_RGBA
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_FLOAT
),
301 PIPE_FORMAT_R32_FLOAT
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R001
, 4, 0, 0, 0, PIPE_FORMAT_TYPE_FLOAT
),
302 PIPE_FORMAT_R32G32_FLOAT
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG01
, 4, 4, 0, 0, PIPE_FORMAT_TYPE_FLOAT
),
303 PIPE_FORMAT_R32G32B32_FLOAT
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 4, 4, 4, 0, PIPE_FORMAT_TYPE_FLOAT
),
304 PIPE_FORMAT_R32G32B32A32_FLOAT
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA
, 4, 4, 4, 4, PIPE_FORMAT_TYPE_FLOAT
),
305 PIPE_FORMAT_R32_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R001
, 4, 0, 0, 0, PIPE_FORMAT_TYPE_UNORM
),
306 PIPE_FORMAT_R32G32_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG01
, 4, 4, 0, 0, PIPE_FORMAT_TYPE_UNORM
),
307 PIPE_FORMAT_R32G32B32_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 4, 4, 4, 0, PIPE_FORMAT_TYPE_UNORM
),
308 PIPE_FORMAT_R32G32B32A32_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA
, 4, 4, 4, 4, PIPE_FORMAT_TYPE_UNORM
),
309 PIPE_FORMAT_R32_USCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R001
, 4, 0, 0, 0, PIPE_FORMAT_TYPE_USCALED
),
310 PIPE_FORMAT_R32G32_USCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG01
, 4, 4, 0, 0, PIPE_FORMAT_TYPE_USCALED
),
311 PIPE_FORMAT_R32G32B32_USCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 4, 4, 4, 0, PIPE_FORMAT_TYPE_USCALED
),
312 PIPE_FORMAT_R32G32B32A32_USCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA
, 4, 4, 4, 4, PIPE_FORMAT_TYPE_USCALED
),
313 PIPE_FORMAT_R32_SNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R001
, 4, 0, 0, 0, PIPE_FORMAT_TYPE_SNORM
),
314 PIPE_FORMAT_R32G32_SNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG01
, 4, 4, 0, 0, PIPE_FORMAT_TYPE_SNORM
),
315 PIPE_FORMAT_R32G32B32_SNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 4, 4, 4, 0, PIPE_FORMAT_TYPE_SNORM
),
316 PIPE_FORMAT_R32G32B32A32_SNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA
, 4, 4, 4, 4, PIPE_FORMAT_TYPE_SNORM
),
317 PIPE_FORMAT_R32_SSCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R001
, 4, 0, 0, 0, PIPE_FORMAT_TYPE_SSCALED
),
318 PIPE_FORMAT_R32G32_SSCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG01
, 4, 4, 0, 0, PIPE_FORMAT_TYPE_SSCALED
),
319 PIPE_FORMAT_R32G32B32_SSCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 4, 4, 4, 0, PIPE_FORMAT_TYPE_SSCALED
),
320 PIPE_FORMAT_R32G32B32A32_SSCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA
, 4, 4, 4, 4, PIPE_FORMAT_TYPE_SSCALED
),
321 PIPE_FORMAT_R16_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R001
, 2, 0, 0, 0, PIPE_FORMAT_TYPE_UNORM
),
322 PIPE_FORMAT_R16G16_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG01
, 2, 2, 0, 0, PIPE_FORMAT_TYPE_UNORM
),
323 PIPE_FORMAT_R16G16B16_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 2, 2, 2, 0, PIPE_FORMAT_TYPE_UNORM
),
324 PIPE_FORMAT_R16G16B16A16_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA
, 2, 2, 2, 2, PIPE_FORMAT_TYPE_UNORM
),
325 PIPE_FORMAT_R16_USCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R001
, 2, 0, 0, 0, PIPE_FORMAT_TYPE_USCALED
),
326 PIPE_FORMAT_R16G16_USCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG01
, 2, 2, 0, 0, PIPE_FORMAT_TYPE_USCALED
),
327 PIPE_FORMAT_R16G16B16_USCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 2, 2, 2, 0, PIPE_FORMAT_TYPE_USCALED
),
328 PIPE_FORMAT_R16G16B16A16_USCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA
, 2, 2, 2, 2, PIPE_FORMAT_TYPE_USCALED
),
329 PIPE_FORMAT_R16_SNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R001
, 2, 0, 0, 0, PIPE_FORMAT_TYPE_SNORM
),
330 PIPE_FORMAT_R16G16_SNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG01
, 2, 2, 0, 0, PIPE_FORMAT_TYPE_SNORM
),
331 PIPE_FORMAT_R16G16B16_SNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 2, 2, 2, 0, PIPE_FORMAT_TYPE_SNORM
),
332 PIPE_FORMAT_R16G16B16A16_SNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA
, 2, 2, 2, 2, PIPE_FORMAT_TYPE_SNORM
),
333 PIPE_FORMAT_R16_SSCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R001
, 2, 0, 0, 0, PIPE_FORMAT_TYPE_SSCALED
),
334 PIPE_FORMAT_R16G16_SSCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG01
, 2, 2, 0, 0, PIPE_FORMAT_TYPE_SSCALED
),
335 PIPE_FORMAT_R16G16B16_SSCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 2, 2, 2, 0, PIPE_FORMAT_TYPE_SSCALED
),
336 PIPE_FORMAT_R16G16B16A16_SSCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA
, 2, 2, 2, 2, PIPE_FORMAT_TYPE_SSCALED
),
337 PIPE_FORMAT_R8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R001
, 1, 0, 0, 0, PIPE_FORMAT_TYPE_UNORM
),
338 PIPE_FORMAT_R8G8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG01
, 1, 1, 0, 0, PIPE_FORMAT_TYPE_UNORM
),
339 PIPE_FORMAT_R8G8B8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 1, 1, 1, 0, PIPE_FORMAT_TYPE_UNORM
),
340 PIPE_FORMAT_R8G8B8A8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_UNORM
),
341 PIPE_FORMAT_R8G8B8X8_UNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_UNORM
),
342 PIPE_FORMAT_R8_USCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R001
, 1, 0, 0, 0, PIPE_FORMAT_TYPE_USCALED
),
343 PIPE_FORMAT_R8G8_USCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG01
, 1, 1, 0, 0, PIPE_FORMAT_TYPE_USCALED
),
344 PIPE_FORMAT_R8G8B8_USCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 1, 1, 1, 0, PIPE_FORMAT_TYPE_USCALED
),
345 PIPE_FORMAT_R8G8B8A8_USCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_USCALED
),
346 PIPE_FORMAT_R8G8B8X8_USCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_USCALED
),
347 PIPE_FORMAT_R8_SNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R001
, 1, 0, 0, 0, PIPE_FORMAT_TYPE_SNORM
),
348 PIPE_FORMAT_R8G8_SNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG01
, 1, 1, 0, 0, PIPE_FORMAT_TYPE_SNORM
),
349 PIPE_FORMAT_R8G8B8_SNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 1, 1, 1, 0, PIPE_FORMAT_TYPE_SNORM
),
350 PIPE_FORMAT_R8G8B8A8_SNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_SNORM
),
351 PIPE_FORMAT_R8G8B8X8_SNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_SNORM
),
352 PIPE_FORMAT_B6G5R5_SNORM
= _PIPE_FORMAT_RGBAZS_1 ( _PIPE_FORMAT_BGR1
, 6, 5, 5, 0, PIPE_FORMAT_TYPE_SNORM
),
353 PIPE_FORMAT_A8B8G8R8_SNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_BGRA
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_SNORM
),
354 PIPE_FORMAT_X8B8G8R8_SNORM
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_BGR1
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_SNORM
),
355 PIPE_FORMAT_R8_SSCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R001
, 1, 0, 0, 0, PIPE_FORMAT_TYPE_SSCALED
),
356 PIPE_FORMAT_R8G8_SSCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG01
, 1, 1, 0, 0, PIPE_FORMAT_TYPE_SSCALED
),
357 PIPE_FORMAT_R8G8B8_SSCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 1, 1, 1, 0, PIPE_FORMAT_TYPE_SSCALED
),
358 PIPE_FORMAT_R8G8B8A8_SSCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_SSCALED
),
359 PIPE_FORMAT_R8G8B8X8_SSCALED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_SSCALED
),
360 PIPE_FORMAT_R32_FIXED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_R001
, 4, 0, 0, 0, PIPE_FORMAT_TYPE_FIXED
),
361 PIPE_FORMAT_R32G32_FIXED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RG01
, 4, 4, 0, 0, PIPE_FORMAT_TYPE_FIXED
),
362 PIPE_FORMAT_R32G32B32_FIXED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 4, 4, 4, 0, PIPE_FORMAT_TYPE_FIXED
),
363 PIPE_FORMAT_R32G32B32A32_FIXED
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA
, 4, 4, 4, 4, PIPE_FORMAT_TYPE_FIXED
),
365 PIPE_FORMAT_L8_SRGB
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RRR1
, 1, 1, 1, 0, PIPE_FORMAT_TYPE_SRGB
),
366 PIPE_FORMAT_A8L8_SRGB
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RRRG
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_SRGB
),
367 PIPE_FORMAT_R8G8B8_SRGB
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 1, 1, 1, 0, PIPE_FORMAT_TYPE_SRGB
),
368 PIPE_FORMAT_R8G8B8A8_SRGB
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGBA
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_SRGB
),
369 PIPE_FORMAT_R8G8B8X8_SRGB
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_RGB1
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_SRGB
),
370 PIPE_FORMAT_A8R8G8B8_SRGB
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_ARGB
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_SRGB
),
371 PIPE_FORMAT_X8R8G8B8_SRGB
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_1RGB
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_SRGB
),
372 PIPE_FORMAT_B8G8R8A8_SRGB
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_BGRA
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_SRGB
),
373 PIPE_FORMAT_B8G8R8X8_SRGB
= _PIPE_FORMAT_RGBAZS_8 ( _PIPE_FORMAT_BGR1
, 1, 1, 1, 1, PIPE_FORMAT_TYPE_SRGB
),
376 PIPE_FORMAT_X8UB8UG8SR8S_NORM
= _PIPE_FORMAT_MIXED( _PIPE_FORMAT_1BGR
, 1, 1, 1, 1, 0, 0, 1, 1, 1, 1 ),
377 PIPE_FORMAT_B6UG5SR5S_NORM
= _PIPE_FORMAT_MIXED( _PIPE_FORMAT_BGR1
, 6, 5, 5, 0, 0, 1, 1, 0, 1, 0 ),
379 /* compressed formats */
380 PIPE_FORMAT_DXT1_RGB
= _PIPE_FORMAT_DXT( 1, 8, 8, 8, 0, PIPE_FORMAT_TYPE_UNORM
),
381 PIPE_FORMAT_DXT1_RGBA
= _PIPE_FORMAT_DXT( 1, 8, 8, 8, 8, PIPE_FORMAT_TYPE_UNORM
),
382 PIPE_FORMAT_DXT3_RGBA
= _PIPE_FORMAT_DXT( 3, 8, 8, 8, 8, PIPE_FORMAT_TYPE_UNORM
),
383 PIPE_FORMAT_DXT5_RGBA
= _PIPE_FORMAT_DXT( 5, 8, 8, 8, 8, PIPE_FORMAT_TYPE_UNORM
),
385 /* sRGB, compressed */
386 PIPE_FORMAT_DXT1_SRGB
= _PIPE_FORMAT_DXT( 1, 8, 8, 8, 0, PIPE_FORMAT_TYPE_SRGB
),
387 PIPE_FORMAT_DXT1_SRGBA
= _PIPE_FORMAT_DXT( 1, 8, 8, 8, 8, PIPE_FORMAT_TYPE_SRGB
),
388 PIPE_FORMAT_DXT3_SRGBA
= _PIPE_FORMAT_DXT( 3, 8, 8, 8, 8, PIPE_FORMAT_TYPE_SRGB
),
389 PIPE_FORMAT_DXT5_SRGBA
= _PIPE_FORMAT_DXT( 5, 8, 8, 8, 8, PIPE_FORMAT_TYPE_SRGB
)
393 * Builds pipe format name from format token.
395 extern const char *pf_name( enum pipe_format format
);
398 * Return bits for a particular component.
399 * \param comp component index, starting at 0
401 static INLINE uint
pf_get_component_bits( enum pipe_format format
, uint comp
)
405 if (pf_swizzle_x(format
) == comp
) {
406 size
= pf_size_x(format
);
408 else if (pf_swizzle_y(format
) == comp
) {
409 size
= pf_size_y(format
);
411 else if (pf_swizzle_z(format
) == comp
) {
412 size
= pf_size_z(format
);
414 else if (pf_swizzle_w(format
) == comp
) {
415 size
= pf_size_w(format
);
420 if (pf_layout( format
) == PIPE_FORMAT_LAYOUT_RGBAZS
)
421 return size
<< pf_exp2( format
);
422 return size
<< (pf_mixed_scale8( format
) * 3);
426 * Return total bits needed for the pixel format.
428 static INLINE uint
pf_get_bits( enum pipe_format format
)
430 switch (pf_layout(format
)) {
431 case PIPE_FORMAT_LAYOUT_RGBAZS
:
432 case PIPE_FORMAT_LAYOUT_MIXED
:
434 pf_get_component_bits( format
, PIPE_FORMAT_COMP_0
) +
435 pf_get_component_bits( format
, PIPE_FORMAT_COMP_1
) +
436 pf_get_component_bits( format
, PIPE_FORMAT_COMP_R
) +
437 pf_get_component_bits( format
, PIPE_FORMAT_COMP_G
) +
438 pf_get_component_bits( format
, PIPE_FORMAT_COMP_B
) +
439 pf_get_component_bits( format
, PIPE_FORMAT_COMP_A
) +
440 pf_get_component_bits( format
, PIPE_FORMAT_COMP_Z
) +
441 pf_get_component_bits( format
, PIPE_FORMAT_COMP_S
);
442 case PIPE_FORMAT_LAYOUT_YCBCR
:
443 assert( format
== PIPE_FORMAT_YCBCR
|| format
== PIPE_FORMAT_YCBCR_REV
);
444 /* return effective bits per pixel */
453 * Return bytes per pixel for the given format.
455 static INLINE uint
pf_get_size( enum pipe_format format
)
457 assert(pf_get_bits(format
) % 8 == 0);
458 return pf_get_bits(format
) / 8;
462 * Describe accurately the pixel format.
464 * The chars-per-pixel concept falls apart with compressed and yuv images, where
465 * more than one pixel are coded in a single data block. This structure
466 * describes that block.
468 * Simple pixel formats are effectively a 1x1xcpp block.
470 struct pipe_format_block
472 /** Block size in bytes */
475 /** Block width in pixels */
478 /** Block height in pixels */
483 * Describe pixel format's block.
485 * @sa http://msdn2.microsoft.com/en-us/library/ms796147.aspx
488 pf_get_block(enum pipe_format format
, struct pipe_format_block
*block
)
491 case PIPE_FORMAT_DXT1_RGBA
:
492 case PIPE_FORMAT_DXT1_RGB
:
493 case PIPE_FORMAT_DXT1_SRGBA
:
494 case PIPE_FORMAT_DXT1_SRGB
:
499 case PIPE_FORMAT_DXT3_RGBA
:
500 case PIPE_FORMAT_DXT5_RGBA
:
501 case PIPE_FORMAT_DXT3_SRGBA
:
502 case PIPE_FORMAT_DXT5_SRGBA
:
507 case PIPE_FORMAT_YCBCR
:
508 case PIPE_FORMAT_YCBCR_REV
:
509 block
->size
= 4; /* 2*cpp */
514 block
->size
= pf_get_size(format
);
521 static INLINE
unsigned
522 pf_get_nblocksx(const struct pipe_format_block
*block
, unsigned x
)
524 return (x
+ block
->width
- 1)/block
->width
;
527 static INLINE
unsigned
528 pf_get_nblocksy(const struct pipe_format_block
*block
, unsigned y
)
530 return (y
+ block
->height
- 1)/block
->height
;
533 static INLINE
unsigned
534 pf_get_nblocks(const struct pipe_format_block
*block
, unsigned width
, unsigned height
)
536 return pf_get_nblocksx(block
, width
)*pf_get_nblocksy(block
, height
);
540 pf_get_stride(const struct pipe_format_block
*block
, unsigned width
)
542 return pf_get_nblocksx(block
, width
)*block
->size
;
546 pf_get_2d_size(const struct pipe_format_block
*block
, size_t stride
, unsigned height
)
548 return pf_get_nblocksy(block
, height
)*stride
;
551 static INLINE boolean
552 pf_is_depth_or_stencil( enum pipe_format format
)
554 return (pf_get_component_bits( format
, PIPE_FORMAT_COMP_Z
) +
555 pf_get_component_bits( format
, PIPE_FORMAT_COMP_S
)) != 0;
558 static INLINE boolean
559 pf_is_depth_and_stencil( enum pipe_format format
)
561 return (pf_get_component_bits( format
, PIPE_FORMAT_COMP_Z
) != 0 &&
562 pf_get_component_bits( format
, PIPE_FORMAT_COMP_S
) != 0);
565 /** DEPRECATED: For backwards compatibility */
566 static INLINE boolean
567 pf_is_depth_stencil( enum pipe_format format
)
569 return pf_is_depth_or_stencil( format
);
572 static INLINE boolean
573 pf_is_compressed( enum pipe_format format
)
575 return pf_layout(format
) == PIPE_FORMAT_LAYOUT_DXT
? TRUE
: FALSE
;
578 enum pipe_video_chroma_format
580 PIPE_VIDEO_CHROMA_FORMAT_420
,
581 PIPE_VIDEO_CHROMA_FORMAT_422
,
582 PIPE_VIDEO_CHROMA_FORMAT_444
586 enum pipe_video_surface_format
588 PIPE_VIDEO_SURFACE_FORMAT_NV12
, /**< Planar; Y plane, UV plane */
589 PIPE_VIDEO_SURFACE_FORMAT_YV12
, /**< Planar; Y plane, U plane, V plane */
590 PIPE_VIDEO_SURFACE_FORMAT_YUYV
, /**< Interleaved; Y,U,Y,V,Y,U,Y,V */
591 PIPE_VIDEO_SURFACE_FORMAT_UYVY
, /**< Interleaved; U,Y,V,Y,U,Y,V,Y */
592 PIPE_VIDEO_SURFACE_FORMAT_VUYA
/**< Packed; A31-24|Y23-16|U15-8|V7-0 */