1 /**************************************************************************
3 * Copyright 2009-2010 Vmware, Inc.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 **************************************************************************/
33 #include "pipe/p_format.h"
34 #include "pipe/p_defines.h"
35 #include "util/u_debug.h"
37 union pipe_color_union
;
46 * Describe how to pack/unpack pixels into/from the prescribed format.
48 * XXX: This could be renamed to something like util_format_pack, or broke down
49 * in flags inside util_format_block that said exactly what we want.
51 enum util_format_layout
{
53 * Formats with util_format_block::width == util_format_block::height == 1
54 * that can be described as an ordinary data structure.
56 UTIL_FORMAT_LAYOUT_PLAIN
= 0,
59 * Formats with sub-sampled channels.
61 * This is for formats like YVYU where there is less than one sample per
64 UTIL_FORMAT_LAYOUT_SUBSAMPLED
= 3,
67 * S3 Texture Compression formats.
69 UTIL_FORMAT_LAYOUT_S3TC
= 4,
72 * Red-Green Texture Compression formats.
74 UTIL_FORMAT_LAYOUT_RGTC
= 5,
77 * Ericsson Texture Compression
79 UTIL_FORMAT_LAYOUT_ETC
= 6,
82 * BC6/7 Texture Compression
84 UTIL_FORMAT_LAYOUT_BPTC
= 7,
89 UTIL_FORMAT_LAYOUT_ASTC
= 8,
92 * Everything else that doesn't fit in any of the above layouts.
94 UTIL_FORMAT_LAYOUT_OTHER
= 9
98 struct util_format_block
100 /** Block width in pixels */
103 /** Block height in pixels */
106 /** Block size in bits */
111 enum util_format_type
{
112 UTIL_FORMAT_TYPE_VOID
= 0,
113 UTIL_FORMAT_TYPE_UNSIGNED
= 1,
114 UTIL_FORMAT_TYPE_SIGNED
= 2,
115 UTIL_FORMAT_TYPE_FIXED
= 3,
116 UTIL_FORMAT_TYPE_FLOAT
= 4
120 enum util_format_colorspace
{
121 UTIL_FORMAT_COLORSPACE_RGB
= 0,
122 UTIL_FORMAT_COLORSPACE_SRGB
= 1,
123 UTIL_FORMAT_COLORSPACE_YUV
= 2,
124 UTIL_FORMAT_COLORSPACE_ZS
= 3
128 struct util_format_channel_description
130 unsigned type
:5; /**< UTIL_FORMAT_TYPE_x */
131 unsigned normalized
:1;
132 unsigned pure_integer
:1;
133 unsigned size
:9; /**< bits per channel */
134 unsigned shift
:16; /** number of bits from lsb */
138 struct util_format_description
140 enum pipe_format format
;
145 * Short name, striped of the prefix, lower case.
147 const char *short_name
;
150 * Pixel block dimensions.
152 struct util_format_block block
;
154 enum util_format_layout layout
;
157 * The number of channels.
159 unsigned nr_channels
:3;
162 * Whether all channels have the same number of (whole) bytes and type.
167 * Whether the pixel format can be described as a bitfield structure.
170 * - pixel depth must be 8, 16, or 32 bits;
171 * - all channels must be unsigned, signed, or void
173 unsigned is_bitmask
:1;
176 * Whether channels have mixed types (ignoring UTIL_FORMAT_TYPE_VOID).
181 * Input channel description, in the order XYZW.
183 * Only valid for UTIL_FORMAT_LAYOUT_PLAIN formats.
185 * If each channel is accessed as an individual N-byte value, X is always
186 * at the lowest address in memory, Y is always next, and so on. For all
187 * currently-defined formats, the N-byte value has native endianness.
189 * If instead a group of channels is accessed as a single N-byte value,
190 * the order of the channels within that value depends on endianness.
191 * For big-endian targets, X is the most significant subvalue,
192 * otherwise it is the least significant one.
194 * For example, if X is 8 bits and Y is 24 bits, the memory order is:
197 * little-endian: X Yl Ym Yu (l = lower, m = middle, u = upper)
198 * big-endian: X Yu Ym Yl
200 * If X is 5 bits, Y is 5 bits, Z is 5 bits and W is 1 bit, the layout is:
204 * little-endian: YYYXXXXX WZZZZZYY
205 * big-endian: XXXXXYYY YYZZZZZW
207 struct util_format_channel_description channel
[4];
210 * Output channel swizzle.
212 * The order is either:
216 * depending on the colorspace.
218 unsigned char swizzle
[4];
221 * Colorspace transformation.
223 enum util_format_colorspace colorspace
;
226 * Unpack pixel blocks to R8G8B8A8_UNORM.
227 * Note: strides are in bytes.
229 * Only defined for non-depth-stencil formats.
232 (*unpack_rgba_8unorm
)(uint8_t *dst
, unsigned dst_stride
,
233 const uint8_t *src
, unsigned src_stride
,
234 unsigned width
, unsigned height
);
237 * Pack pixel blocks from R8G8B8A8_UNORM.
238 * Note: strides are in bytes.
240 * Only defined for non-depth-stencil formats.
243 (*pack_rgba_8unorm
)(uint8_t *dst
, unsigned dst_stride
,
244 const uint8_t *src
, unsigned src_stride
,
245 unsigned width
, unsigned height
);
248 * Fetch a single pixel (i, j) from a block.
250 * XXX: Only defined for a very few select formats.
253 (*fetch_rgba_8unorm
)(uint8_t *dst
,
255 unsigned i
, unsigned j
);
258 * Unpack pixel blocks to R32G32B32A32_FLOAT.
259 * Note: strides are in bytes.
261 * Only defined for non-depth-stencil formats.
264 (*unpack_rgba_float
)(float *dst
, unsigned dst_stride
,
265 const uint8_t *src
, unsigned src_stride
,
266 unsigned width
, unsigned height
);
269 * Pack pixel blocks from R32G32B32A32_FLOAT.
270 * Note: strides are in bytes.
272 * Only defined for non-depth-stencil formats.
275 (*pack_rgba_float
)(uint8_t *dst
, unsigned dst_stride
,
276 const float *src
, unsigned src_stride
,
277 unsigned width
, unsigned height
);
280 * Fetch a single pixel (i, j) from a block.
282 * Only defined for non-depth-stencil and non-integer formats.
285 (*fetch_rgba_float
)(float *dst
,
287 unsigned i
, unsigned j
);
290 * Unpack pixels to Z32_UNORM.
291 * Note: strides are in bytes.
293 * Only defined for depth formats.
296 (*unpack_z_32unorm
)(uint32_t *dst
, unsigned dst_stride
,
297 const uint8_t *src
, unsigned src_stride
,
298 unsigned width
, unsigned height
);
301 * Pack pixels from Z32_FLOAT.
302 * Note: strides are in bytes.
304 * Only defined for depth formats.
307 (*pack_z_32unorm
)(uint8_t *dst
, unsigned dst_stride
,
308 const uint32_t *src
, unsigned src_stride
,
309 unsigned width
, unsigned height
);
312 * Unpack pixels to Z32_FLOAT.
313 * Note: strides are in bytes.
315 * Only defined for depth formats.
318 (*unpack_z_float
)(float *dst
, unsigned dst_stride
,
319 const uint8_t *src
, unsigned src_stride
,
320 unsigned width
, unsigned height
);
323 * Pack pixels from Z32_FLOAT.
324 * Note: strides are in bytes.
326 * Only defined for depth formats.
329 (*pack_z_float
)(uint8_t *dst
, unsigned dst_stride
,
330 const float *src
, unsigned src_stride
,
331 unsigned width
, unsigned height
);
334 * Unpack pixels to S8_UINT.
335 * Note: strides are in bytes.
337 * Only defined for stencil formats.
340 (*unpack_s_8uint
)(uint8_t *dst
, unsigned dst_stride
,
341 const uint8_t *src
, unsigned src_stride
,
342 unsigned width
, unsigned height
);
345 * Pack pixels from S8_UINT.
346 * Note: strides are in bytes.
348 * Only defined for stencil formats.
351 (*pack_s_8uint
)(uint8_t *dst
, unsigned dst_stride
,
352 const uint8_t *src
, unsigned src_stride
,
353 unsigned width
, unsigned height
);
356 * Unpack pixel blocks to R32G32B32A32_UINT.
357 * Note: strides are in bytes.
359 * Only defined for INT formats.
362 (*unpack_rgba_uint
)(uint32_t *dst
, unsigned dst_stride
,
363 const uint8_t *src
, unsigned src_stride
,
364 unsigned width
, unsigned height
);
367 (*pack_rgba_uint
)(uint8_t *dst
, unsigned dst_stride
,
368 const uint32_t *src
, unsigned src_stride
,
369 unsigned width
, unsigned height
);
372 * Unpack pixel blocks to R32G32B32A32_SINT.
373 * Note: strides are in bytes.
375 * Only defined for INT formats.
378 (*unpack_rgba_sint
)(int32_t *dst
, unsigned dst_stride
,
379 const uint8_t *src
, unsigned src_stride
,
380 unsigned width
, unsigned height
);
383 (*pack_rgba_sint
)(uint8_t *dst
, unsigned dst_stride
,
384 const int32_t *src
, unsigned src_stride
,
385 unsigned width
, unsigned height
);
388 * Fetch a single pixel (i, j) from a block.
390 * Only defined for unsigned (pure) integer formats.
393 (*fetch_rgba_uint
)(uint32_t *dst
,
395 unsigned i
, unsigned j
);
398 * Fetch a single pixel (i, j) from a block.
400 * Only defined for signed (pure) integer formats.
403 (*fetch_rgba_sint
)(int32_t *dst
,
405 unsigned i
, unsigned j
);
409 extern const struct util_format_description
410 util_format_description_table
[];
413 const struct util_format_description
*
414 util_format_description(enum pipe_format format
);
418 * Format query functions.
421 static inline const char *
422 util_format_name(enum pipe_format format
)
424 const struct util_format_description
*desc
= util_format_description(format
);
428 return "PIPE_FORMAT_???";
434 static inline const char *
435 util_format_short_name(enum pipe_format format
)
437 const struct util_format_description
*desc
= util_format_description(format
);
444 return desc
->short_name
;
448 * Whether this format is plain, see UTIL_FORMAT_LAYOUT_PLAIN for more info.
450 static inline boolean
451 util_format_is_plain(enum pipe_format format
)
453 const struct util_format_description
*desc
= util_format_description(format
);
459 return desc
->layout
== UTIL_FORMAT_LAYOUT_PLAIN
? TRUE
: FALSE
;
462 static inline boolean
463 util_format_is_compressed(enum pipe_format format
)
465 const struct util_format_description
*desc
= util_format_description(format
);
472 switch (desc
->layout
) {
473 case UTIL_FORMAT_LAYOUT_S3TC
:
474 case UTIL_FORMAT_LAYOUT_RGTC
:
475 case UTIL_FORMAT_LAYOUT_ETC
:
476 case UTIL_FORMAT_LAYOUT_BPTC
:
477 case UTIL_FORMAT_LAYOUT_ASTC
:
478 /* XXX add other formats in the future */
485 static inline boolean
486 util_format_is_s3tc(enum pipe_format format
)
488 const struct util_format_description
*desc
= util_format_description(format
);
495 return desc
->layout
== UTIL_FORMAT_LAYOUT_S3TC
? TRUE
: FALSE
;
498 static inline boolean
499 util_format_is_etc(enum pipe_format format
)
501 const struct util_format_description
*desc
= util_format_description(format
);
508 return desc
->layout
== UTIL_FORMAT_LAYOUT_ETC
? TRUE
: FALSE
;
511 static inline boolean
512 util_format_is_srgb(enum pipe_format format
)
514 const struct util_format_description
*desc
= util_format_description(format
);
515 return desc
->colorspace
== UTIL_FORMAT_COLORSPACE_SRGB
;
518 static inline boolean
519 util_format_has_depth(const struct util_format_description
*desc
)
521 return desc
->colorspace
== UTIL_FORMAT_COLORSPACE_ZS
&&
522 desc
->swizzle
[0] != PIPE_SWIZZLE_NONE
;
525 static inline boolean
526 util_format_has_stencil(const struct util_format_description
*desc
)
528 return desc
->colorspace
== UTIL_FORMAT_COLORSPACE_ZS
&&
529 desc
->swizzle
[1] != PIPE_SWIZZLE_NONE
;
532 static inline boolean
533 util_format_is_depth_or_stencil(enum pipe_format format
)
535 const struct util_format_description
*desc
= util_format_description(format
);
542 return util_format_has_depth(desc
) ||
543 util_format_has_stencil(desc
);
546 static inline boolean
547 util_format_is_depth_and_stencil(enum pipe_format format
)
549 const struct util_format_description
*desc
= util_format_description(format
);
556 return util_format_has_depth(desc
) &&
557 util_format_has_stencil(desc
);
562 * Calculates the depth format type based upon the incoming format description.
564 static inline unsigned
565 util_get_depth_format_type(const struct util_format_description
*desc
)
567 unsigned depth_channel
= desc
->swizzle
[0];
568 if (desc
->colorspace
== UTIL_FORMAT_COLORSPACE_ZS
&&
569 depth_channel
!= PIPE_SWIZZLE_NONE
) {
570 return desc
->channel
[depth_channel
].type
;
572 return UTIL_FORMAT_TYPE_VOID
;
578 * Calculates the MRD for the depth format. MRD is used in depth bias
579 * for UNORM and unbound depth buffers. When the depth buffer is floating
580 * point, the depth bias calculation does not use the MRD. However, the
581 * default MRD will be 1.0 / ((1 << 24) - 1).
584 util_get_depth_format_mrd(const struct util_format_description
*desc
);
588 * Return whether this is an RGBA, Z, S, or combined ZS format.
589 * Useful for initializing pipe_blit_info::mask.
591 static inline unsigned
592 util_format_get_mask(enum pipe_format format
)
594 const struct util_format_description
*desc
=
595 util_format_description(format
);
600 if (util_format_has_depth(desc
)) {
601 if (util_format_has_stencil(desc
)) {
607 if (util_format_has_stencil(desc
)) {
610 return PIPE_MASK_RGBA
;
616 * Give the RGBA colormask of the channels that can be represented in this
619 * That is, the channels whose values are preserved.
621 static inline unsigned
622 util_format_colormask(const struct util_format_description
*desc
)
627 switch (desc
->colorspace
) {
628 case UTIL_FORMAT_COLORSPACE_RGB
:
629 case UTIL_FORMAT_COLORSPACE_SRGB
:
630 case UTIL_FORMAT_COLORSPACE_YUV
:
632 for (chan
= 0; chan
< 4; ++chan
) {
633 if (desc
->swizzle
[chan
] < 4) {
634 colormask
|= (1 << chan
);
638 case UTIL_FORMAT_COLORSPACE_ZS
:
648 * Checks if color mask covers every channel for the specified format
650 * @param desc a format description to check colormask with
651 * @param colormask a bit mask for channels, matches format of PIPE_MASK_RGBA
653 static inline boolean
654 util_format_colormask_full(const struct util_format_description
*desc
, unsigned colormask
)
656 return (~colormask
& util_format_colormask(desc
)) == 0;
661 util_format_is_float(enum pipe_format format
);
665 util_format_has_alpha(enum pipe_format format
);
669 util_format_is_luminance(enum pipe_format format
);
672 util_format_is_alpha(enum pipe_format format
);
675 util_format_is_luminance_alpha(enum pipe_format format
);
679 util_format_is_intensity(enum pipe_format format
);
682 util_format_is_subsampled_422(enum pipe_format format
);
685 util_format_is_pure_integer(enum pipe_format format
);
688 util_format_is_pure_sint(enum pipe_format format
);
691 util_format_is_pure_uint(enum pipe_format format
);
694 util_format_is_snorm(enum pipe_format format
);
697 util_format_is_snorm8(enum pipe_format format
);
700 * Check if the src format can be blitted to the destination format with
701 * a simple memcpy. For example, blitting from RGBA to RGBx is OK, but not
705 util_is_format_compatible(const struct util_format_description
*src_desc
,
706 const struct util_format_description
*dst_desc
);
709 * Whether the format is supported by Gallium for the given bindings.
710 * This covers S3TC textures and floating-point render targets.
713 util_format_is_supported(enum pipe_format format
, unsigned bind
);
716 * Whether this format is a rgab8 variant.
718 * That is, any format that matches the
720 * PIPE_FORMAT_?8?8?8?8_UNORM
722 static inline boolean
723 util_format_is_rgba8_variant(const struct util_format_description
*desc
)
727 if(desc
->block
.width
!= 1 ||
728 desc
->block
.height
!= 1 ||
729 desc
->block
.bits
!= 32)
732 for(chan
= 0; chan
< 4; ++chan
) {
733 if(desc
->channel
[chan
].type
!= UTIL_FORMAT_TYPE_UNSIGNED
&&
734 desc
->channel
[chan
].type
!= UTIL_FORMAT_TYPE_VOID
)
736 if(desc
->channel
[chan
].type
== UTIL_FORMAT_TYPE_UNSIGNED
&&
737 !desc
->channel
[chan
].normalized
)
739 if(desc
->channel
[chan
].size
!= 8)
748 * Return total bits needed for the pixel format per block.
751 util_format_get_blocksizebits(enum pipe_format format
)
753 const struct util_format_description
*desc
= util_format_description(format
);
760 return desc
->block
.bits
;
764 * Return bytes per block (not pixel) for the given format.
767 util_format_get_blocksize(enum pipe_format format
)
769 uint bits
= util_format_get_blocksizebits(format
);
770 uint bytes
= bits
/ 8;
772 assert(bits
% 8 == 0);
782 util_format_get_blockwidth(enum pipe_format format
)
784 const struct util_format_description
*desc
= util_format_description(format
);
791 return desc
->block
.width
;
795 util_format_get_blockheight(enum pipe_format format
)
797 const struct util_format_description
*desc
= util_format_description(format
);
804 return desc
->block
.height
;
807 static inline unsigned
808 util_format_get_nblocksx(enum pipe_format format
,
811 unsigned blockwidth
= util_format_get_blockwidth(format
);
812 return (x
+ blockwidth
- 1) / blockwidth
;
815 static inline unsigned
816 util_format_get_nblocksy(enum pipe_format format
,
819 unsigned blockheight
= util_format_get_blockheight(format
);
820 return (y
+ blockheight
- 1) / blockheight
;
823 static inline unsigned
824 util_format_get_nblocks(enum pipe_format format
,
828 return util_format_get_nblocksx(format
, width
) * util_format_get_nblocksy(format
, height
);
832 util_format_get_stride(enum pipe_format format
,
835 return util_format_get_nblocksx(format
, width
) * util_format_get_blocksize(format
);
839 util_format_get_2d_size(enum pipe_format format
,
843 return util_format_get_nblocksy(format
, height
) * stride
;
847 util_format_get_component_bits(enum pipe_format format
,
848 enum util_format_colorspace colorspace
,
851 const struct util_format_description
*desc
= util_format_description(format
);
852 enum util_format_colorspace desc_colorspace
;
859 assert(component
< 4);
861 /* Treat RGB and SRGB as equivalent. */
862 if (colorspace
== UTIL_FORMAT_COLORSPACE_SRGB
) {
863 colorspace
= UTIL_FORMAT_COLORSPACE_RGB
;
865 if (desc
->colorspace
== UTIL_FORMAT_COLORSPACE_SRGB
) {
866 desc_colorspace
= UTIL_FORMAT_COLORSPACE_RGB
;
868 desc_colorspace
= desc
->colorspace
;
871 if (desc_colorspace
!= colorspace
) {
875 switch (desc
->swizzle
[component
]) {
877 return desc
->channel
[0].size
;
879 return desc
->channel
[1].size
;
881 return desc
->channel
[2].size
;
883 return desc
->channel
[3].size
;
890 * Given a linear RGB colorspace format, return the corresponding SRGB
891 * format, or PIPE_FORMAT_NONE if none.
893 static inline enum pipe_format
894 util_format_srgb(enum pipe_format format
)
896 if (util_format_is_srgb(format
))
900 case PIPE_FORMAT_L8_UNORM
:
901 return PIPE_FORMAT_L8_SRGB
;
902 case PIPE_FORMAT_L8A8_UNORM
:
903 return PIPE_FORMAT_L8A8_SRGB
;
904 case PIPE_FORMAT_R8G8B8_UNORM
:
905 return PIPE_FORMAT_R8G8B8_SRGB
;
906 case PIPE_FORMAT_A8B8G8R8_UNORM
:
907 return PIPE_FORMAT_A8B8G8R8_SRGB
;
908 case PIPE_FORMAT_X8B8G8R8_UNORM
:
909 return PIPE_FORMAT_X8B8G8R8_SRGB
;
910 case PIPE_FORMAT_B8G8R8A8_UNORM
:
911 return PIPE_FORMAT_B8G8R8A8_SRGB
;
912 case PIPE_FORMAT_B8G8R8X8_UNORM
:
913 return PIPE_FORMAT_B8G8R8X8_SRGB
;
914 case PIPE_FORMAT_A8R8G8B8_UNORM
:
915 return PIPE_FORMAT_A8R8G8B8_SRGB
;
916 case PIPE_FORMAT_X8R8G8B8_UNORM
:
917 return PIPE_FORMAT_X8R8G8B8_SRGB
;
918 case PIPE_FORMAT_R8G8B8A8_UNORM
:
919 return PIPE_FORMAT_R8G8B8A8_SRGB
;
920 case PIPE_FORMAT_R8G8B8X8_UNORM
:
921 return PIPE_FORMAT_R8G8B8X8_SRGB
;
922 case PIPE_FORMAT_DXT1_RGB
:
923 return PIPE_FORMAT_DXT1_SRGB
;
924 case PIPE_FORMAT_DXT1_RGBA
:
925 return PIPE_FORMAT_DXT1_SRGBA
;
926 case PIPE_FORMAT_DXT3_RGBA
:
927 return PIPE_FORMAT_DXT3_SRGBA
;
928 case PIPE_FORMAT_DXT5_RGBA
:
929 return PIPE_FORMAT_DXT5_SRGBA
;
930 case PIPE_FORMAT_B5G6R5_UNORM
:
931 return PIPE_FORMAT_B5G6R5_SRGB
;
932 case PIPE_FORMAT_BPTC_RGBA_UNORM
:
933 return PIPE_FORMAT_BPTC_SRGBA
;
934 case PIPE_FORMAT_ASTC_4x4
:
935 return PIPE_FORMAT_ASTC_4x4_SRGB
;
936 case PIPE_FORMAT_ASTC_5x4
:
937 return PIPE_FORMAT_ASTC_5x4_SRGB
;
938 case PIPE_FORMAT_ASTC_5x5
:
939 return PIPE_FORMAT_ASTC_5x5_SRGB
;
940 case PIPE_FORMAT_ASTC_6x5
:
941 return PIPE_FORMAT_ASTC_6x5_SRGB
;
942 case PIPE_FORMAT_ASTC_6x6
:
943 return PIPE_FORMAT_ASTC_6x6_SRGB
;
944 case PIPE_FORMAT_ASTC_8x5
:
945 return PIPE_FORMAT_ASTC_8x5_SRGB
;
946 case PIPE_FORMAT_ASTC_8x6
:
947 return PIPE_FORMAT_ASTC_8x6_SRGB
;
948 case PIPE_FORMAT_ASTC_8x8
:
949 return PIPE_FORMAT_ASTC_8x8_SRGB
;
950 case PIPE_FORMAT_ASTC_10x5
:
951 return PIPE_FORMAT_ASTC_10x5_SRGB
;
952 case PIPE_FORMAT_ASTC_10x6
:
953 return PIPE_FORMAT_ASTC_10x6_SRGB
;
954 case PIPE_FORMAT_ASTC_10x8
:
955 return PIPE_FORMAT_ASTC_10x8_SRGB
;
956 case PIPE_FORMAT_ASTC_10x10
:
957 return PIPE_FORMAT_ASTC_10x10_SRGB
;
958 case PIPE_FORMAT_ASTC_12x10
:
959 return PIPE_FORMAT_ASTC_12x10_SRGB
;
960 case PIPE_FORMAT_ASTC_12x12
:
961 return PIPE_FORMAT_ASTC_12x12_SRGB
;
964 return PIPE_FORMAT_NONE
;
969 * Given an sRGB format, return the corresponding linear colorspace format.
970 * For non sRGB formats, return the format unchanged.
972 static inline enum pipe_format
973 util_format_linear(enum pipe_format format
)
976 case PIPE_FORMAT_L8_SRGB
:
977 return PIPE_FORMAT_L8_UNORM
;
978 case PIPE_FORMAT_L8A8_SRGB
:
979 return PIPE_FORMAT_L8A8_UNORM
;
980 case PIPE_FORMAT_R8G8B8_SRGB
:
981 return PIPE_FORMAT_R8G8B8_UNORM
;
982 case PIPE_FORMAT_A8B8G8R8_SRGB
:
983 return PIPE_FORMAT_A8B8G8R8_UNORM
;
984 case PIPE_FORMAT_X8B8G8R8_SRGB
:
985 return PIPE_FORMAT_X8B8G8R8_UNORM
;
986 case PIPE_FORMAT_B8G8R8A8_SRGB
:
987 return PIPE_FORMAT_B8G8R8A8_UNORM
;
988 case PIPE_FORMAT_B8G8R8X8_SRGB
:
989 return PIPE_FORMAT_B8G8R8X8_UNORM
;
990 case PIPE_FORMAT_A8R8G8B8_SRGB
:
991 return PIPE_FORMAT_A8R8G8B8_UNORM
;
992 case PIPE_FORMAT_X8R8G8B8_SRGB
:
993 return PIPE_FORMAT_X8R8G8B8_UNORM
;
994 case PIPE_FORMAT_R8G8B8A8_SRGB
:
995 return PIPE_FORMAT_R8G8B8A8_UNORM
;
996 case PIPE_FORMAT_R8G8B8X8_SRGB
:
997 return PIPE_FORMAT_R8G8B8X8_UNORM
;
998 case PIPE_FORMAT_DXT1_SRGB
:
999 return PIPE_FORMAT_DXT1_RGB
;
1000 case PIPE_FORMAT_DXT1_SRGBA
:
1001 return PIPE_FORMAT_DXT1_RGBA
;
1002 case PIPE_FORMAT_DXT3_SRGBA
:
1003 return PIPE_FORMAT_DXT3_RGBA
;
1004 case PIPE_FORMAT_DXT5_SRGBA
:
1005 return PIPE_FORMAT_DXT5_RGBA
;
1006 case PIPE_FORMAT_B5G6R5_SRGB
:
1007 return PIPE_FORMAT_B5G6R5_UNORM
;
1008 case PIPE_FORMAT_BPTC_SRGBA
:
1009 return PIPE_FORMAT_BPTC_RGBA_UNORM
;
1010 case PIPE_FORMAT_ASTC_4x4_SRGB
:
1011 return PIPE_FORMAT_ASTC_4x4
;
1012 case PIPE_FORMAT_ASTC_5x4_SRGB
:
1013 return PIPE_FORMAT_ASTC_5x4
;
1014 case PIPE_FORMAT_ASTC_5x5_SRGB
:
1015 return PIPE_FORMAT_ASTC_5x5
;
1016 case PIPE_FORMAT_ASTC_6x5_SRGB
:
1017 return PIPE_FORMAT_ASTC_6x5
;
1018 case PIPE_FORMAT_ASTC_6x6_SRGB
:
1019 return PIPE_FORMAT_ASTC_6x6
;
1020 case PIPE_FORMAT_ASTC_8x5_SRGB
:
1021 return PIPE_FORMAT_ASTC_8x5
;
1022 case PIPE_FORMAT_ASTC_8x6_SRGB
:
1023 return PIPE_FORMAT_ASTC_8x6
;
1024 case PIPE_FORMAT_ASTC_8x8_SRGB
:
1025 return PIPE_FORMAT_ASTC_8x8
;
1026 case PIPE_FORMAT_ASTC_10x5_SRGB
:
1027 return PIPE_FORMAT_ASTC_10x5
;
1028 case PIPE_FORMAT_ASTC_10x6_SRGB
:
1029 return PIPE_FORMAT_ASTC_10x6
;
1030 case PIPE_FORMAT_ASTC_10x8_SRGB
:
1031 return PIPE_FORMAT_ASTC_10x8
;
1032 case PIPE_FORMAT_ASTC_10x10_SRGB
:
1033 return PIPE_FORMAT_ASTC_10x10
;
1034 case PIPE_FORMAT_ASTC_12x10_SRGB
:
1035 return PIPE_FORMAT_ASTC_12x10
;
1036 case PIPE_FORMAT_ASTC_12x12_SRGB
:
1037 return PIPE_FORMAT_ASTC_12x12
;
1044 * Given a depth-stencil format, return the corresponding stencil-only format.
1045 * For stencil-only formats, return the format unchanged.
1047 static inline enum pipe_format
1048 util_format_stencil_only(enum pipe_format format
)
1051 /* mask out the depth component */
1052 case PIPE_FORMAT_Z24_UNORM_S8_UINT
:
1053 return PIPE_FORMAT_X24S8_UINT
;
1054 case PIPE_FORMAT_S8_UINT_Z24_UNORM
:
1055 return PIPE_FORMAT_S8X24_UINT
;
1056 case PIPE_FORMAT_Z32_FLOAT_S8X24_UINT
:
1057 return PIPE_FORMAT_X32_S8X24_UINT
;
1059 /* stencil only formats */
1060 case PIPE_FORMAT_X24S8_UINT
:
1061 case PIPE_FORMAT_S8X24_UINT
:
1062 case PIPE_FORMAT_X32_S8X24_UINT
:
1063 case PIPE_FORMAT_S8_UINT
:
1068 return PIPE_FORMAT_NONE
;
1073 * Converts PIPE_FORMAT_*I* to PIPE_FORMAT_*R*.
1074 * This is identity for non-intensity formats.
1076 static inline enum pipe_format
1077 util_format_intensity_to_red(enum pipe_format format
)
1080 case PIPE_FORMAT_I8_UNORM
:
1081 return PIPE_FORMAT_R8_UNORM
;
1082 case PIPE_FORMAT_I8_SNORM
:
1083 return PIPE_FORMAT_R8_SNORM
;
1084 case PIPE_FORMAT_I16_UNORM
:
1085 return PIPE_FORMAT_R16_UNORM
;
1086 case PIPE_FORMAT_I16_SNORM
:
1087 return PIPE_FORMAT_R16_SNORM
;
1088 case PIPE_FORMAT_I16_FLOAT
:
1089 return PIPE_FORMAT_R16_FLOAT
;
1090 case PIPE_FORMAT_I32_FLOAT
:
1091 return PIPE_FORMAT_R32_FLOAT
;
1092 case PIPE_FORMAT_I8_UINT
:
1093 return PIPE_FORMAT_R8_UINT
;
1094 case PIPE_FORMAT_I8_SINT
:
1095 return PIPE_FORMAT_R8_SINT
;
1096 case PIPE_FORMAT_I16_UINT
:
1097 return PIPE_FORMAT_R16_UINT
;
1098 case PIPE_FORMAT_I16_SINT
:
1099 return PIPE_FORMAT_R16_SINT
;
1100 case PIPE_FORMAT_I32_UINT
:
1101 return PIPE_FORMAT_R32_UINT
;
1102 case PIPE_FORMAT_I32_SINT
:
1103 return PIPE_FORMAT_R32_SINT
;
1105 assert(!util_format_is_intensity(format
));
1111 * Converts PIPE_FORMAT_*L* to PIPE_FORMAT_*R*.
1112 * This is identity for non-luminance formats.
1114 static inline enum pipe_format
1115 util_format_luminance_to_red(enum pipe_format format
)
1118 case PIPE_FORMAT_L8_UNORM
:
1119 return PIPE_FORMAT_R8_UNORM
;
1120 case PIPE_FORMAT_L8_SNORM
:
1121 return PIPE_FORMAT_R8_SNORM
;
1122 case PIPE_FORMAT_L16_UNORM
:
1123 return PIPE_FORMAT_R16_UNORM
;
1124 case PIPE_FORMAT_L16_SNORM
:
1125 return PIPE_FORMAT_R16_SNORM
;
1126 case PIPE_FORMAT_L16_FLOAT
:
1127 return PIPE_FORMAT_R16_FLOAT
;
1128 case PIPE_FORMAT_L32_FLOAT
:
1129 return PIPE_FORMAT_R32_FLOAT
;
1130 case PIPE_FORMAT_L8_UINT
:
1131 return PIPE_FORMAT_R8_UINT
;
1132 case PIPE_FORMAT_L8_SINT
:
1133 return PIPE_FORMAT_R8_SINT
;
1134 case PIPE_FORMAT_L16_UINT
:
1135 return PIPE_FORMAT_R16_UINT
;
1136 case PIPE_FORMAT_L16_SINT
:
1137 return PIPE_FORMAT_R16_SINT
;
1138 case PIPE_FORMAT_L32_UINT
:
1139 return PIPE_FORMAT_R32_UINT
;
1140 case PIPE_FORMAT_L32_SINT
:
1141 return PIPE_FORMAT_R32_SINT
;
1143 case PIPE_FORMAT_LATC1_UNORM
:
1144 return PIPE_FORMAT_RGTC1_UNORM
;
1145 case PIPE_FORMAT_LATC1_SNORM
:
1146 return PIPE_FORMAT_RGTC1_SNORM
;
1148 case PIPE_FORMAT_L4A4_UNORM
:
1149 return PIPE_FORMAT_R4A4_UNORM
;
1151 case PIPE_FORMAT_L8A8_UNORM
:
1152 return PIPE_FORMAT_R8A8_UNORM
;
1153 case PIPE_FORMAT_L8A8_SNORM
:
1154 return PIPE_FORMAT_R8A8_SNORM
;
1155 case PIPE_FORMAT_L16A16_UNORM
:
1156 return PIPE_FORMAT_R16A16_UNORM
;
1157 case PIPE_FORMAT_L16A16_SNORM
:
1158 return PIPE_FORMAT_R16A16_SNORM
;
1159 case PIPE_FORMAT_L16A16_FLOAT
:
1160 return PIPE_FORMAT_R16A16_FLOAT
;
1161 case PIPE_FORMAT_L32A32_FLOAT
:
1162 return PIPE_FORMAT_R32A32_FLOAT
;
1163 case PIPE_FORMAT_L8A8_UINT
:
1164 return PIPE_FORMAT_R8A8_UINT
;
1165 case PIPE_FORMAT_L8A8_SINT
:
1166 return PIPE_FORMAT_R8A8_SINT
;
1167 case PIPE_FORMAT_L16A16_UINT
:
1168 return PIPE_FORMAT_R16A16_UINT
;
1169 case PIPE_FORMAT_L16A16_SINT
:
1170 return PIPE_FORMAT_R16A16_SINT
;
1171 case PIPE_FORMAT_L32A32_UINT
:
1172 return PIPE_FORMAT_R32A32_UINT
;
1173 case PIPE_FORMAT_L32A32_SINT
:
1174 return PIPE_FORMAT_R32A32_SINT
;
1176 /* We don't have compressed red-alpha variants for these. */
1177 case PIPE_FORMAT_LATC2_UNORM
:
1178 case PIPE_FORMAT_LATC2_SNORM
:
1179 return PIPE_FORMAT_NONE
;
1182 assert(!util_format_is_luminance(format
) &&
1183 !util_format_is_luminance_alpha(format
));
1189 * Return the number of components stored.
1190 * Formats with block size != 1x1 will always have 1 component (the block).
1192 static inline unsigned
1193 util_format_get_nr_components(enum pipe_format format
)
1195 const struct util_format_description
*desc
= util_format_description(format
);
1196 return desc
->nr_channels
;
1200 * Return the index of the first non-void channel
1201 * -1 if no non-void channels
1204 util_format_get_first_non_void_channel(enum pipe_format format
)
1206 const struct util_format_description
*desc
= util_format_description(format
);
1209 for (i
= 0; i
< 4; i
++)
1210 if (desc
->channel
[i
].type
!= UTIL_FORMAT_TYPE_VOID
)
1220 * Format access functions.
1224 util_format_read_4f(enum pipe_format format
,
1225 float *dst
, unsigned dst_stride
,
1226 const void *src
, unsigned src_stride
,
1227 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1230 util_format_write_4f(enum pipe_format format
,
1231 const float *src
, unsigned src_stride
,
1232 void *dst
, unsigned dst_stride
,
1233 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1236 util_format_read_4ub(enum pipe_format format
,
1237 uint8_t *dst
, unsigned dst_stride
,
1238 const void *src
, unsigned src_stride
,
1239 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1242 util_format_write_4ub(enum pipe_format format
,
1243 const uint8_t *src
, unsigned src_stride
,
1244 void *dst
, unsigned dst_stride
,
1245 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1248 util_format_read_4ui(enum pipe_format format
,
1249 unsigned *dst
, unsigned dst_stride
,
1250 const void *src
, unsigned src_stride
,
1251 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1254 util_format_write_4ui(enum pipe_format format
,
1255 const unsigned int *src
, unsigned src_stride
,
1256 void *dst
, unsigned dst_stride
,
1257 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1260 util_format_read_4i(enum pipe_format format
,
1261 int *dst
, unsigned dst_stride
,
1262 const void *src
, unsigned src_stride
,
1263 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1266 util_format_write_4i(enum pipe_format format
,
1267 const int *src
, unsigned src_stride
,
1268 void *dst
, unsigned dst_stride
,
1269 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1272 * Generic format conversion;
1276 util_format_fits_8unorm(const struct util_format_description
*format_desc
);
1279 util_format_translate(enum pipe_format dst_format
,
1280 void *dst
, unsigned dst_stride
,
1281 unsigned dst_x
, unsigned dst_y
,
1282 enum pipe_format src_format
,
1283 const void *src
, unsigned src_stride
,
1284 unsigned src_x
, unsigned src_y
,
1285 unsigned width
, unsigned height
);
1288 util_format_translate_3d(enum pipe_format dst_format
,
1289 void *dst
, unsigned dst_stride
,
1290 unsigned dst_slice_stride
,
1291 unsigned dst_x
, unsigned dst_y
,
1293 enum pipe_format src_format
,
1294 const void *src
, unsigned src_stride
,
1295 unsigned src_slice_stride
,
1296 unsigned src_x
, unsigned src_y
,
1297 unsigned src_z
, unsigned width
,
1298 unsigned height
, unsigned depth
);
1301 * Swizzle operations.
1304 /* Compose two sets of swizzles.
1305 * If V is a 4D vector and the function parameters represent functions that
1306 * swizzle vector components, this holds:
1307 * swz2(swz1(V)) = dst(V)
1309 void util_format_compose_swizzles(const unsigned char swz1
[4],
1310 const unsigned char swz2
[4],
1311 unsigned char dst
[4]);
1313 /* Apply the swizzle provided in \param swz (which is one of PIPE_SWIZZLE_x)
1314 * to \param src and store the result in \param dst.
1315 * \param is_integer determines the value written for PIPE_SWIZZLE_1.
1317 void util_format_apply_color_swizzle(union pipe_color_union
*dst
,
1318 const union pipe_color_union
*src
,
1319 const unsigned char swz
[4],
1320 const boolean is_integer
);
1322 void pipe_swizzle_4f(float *dst
, const float *src
,
1323 const unsigned char swz
[4]);
1325 void util_format_unswizzle_4f(float *dst
, const float *src
,
1326 const unsigned char swz
[4]);
1332 #endif /* ! U_FORMAT_H */