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 * Everything else that doesn't fit in any of the above layouts.
84 UTIL_FORMAT_LAYOUT_OTHER
= 7
88 struct util_format_block
90 /** Block width in pixels */
93 /** Block height in pixels */
96 /** Block size in bits */
101 enum util_format_type
{
102 UTIL_FORMAT_TYPE_VOID
= 0,
103 UTIL_FORMAT_TYPE_UNSIGNED
= 1,
104 UTIL_FORMAT_TYPE_SIGNED
= 2,
105 UTIL_FORMAT_TYPE_FIXED
= 3,
106 UTIL_FORMAT_TYPE_FLOAT
= 4
110 enum util_format_swizzle
{
111 UTIL_FORMAT_SWIZZLE_X
= 0,
112 UTIL_FORMAT_SWIZZLE_Y
= 1,
113 UTIL_FORMAT_SWIZZLE_Z
= 2,
114 UTIL_FORMAT_SWIZZLE_W
= 3,
115 UTIL_FORMAT_SWIZZLE_0
= 4,
116 UTIL_FORMAT_SWIZZLE_1
= 5,
117 UTIL_FORMAT_SWIZZLE_NONE
= 6,
118 UTIL_FORMAT_SWIZZLE_MAX
= 7 /**< Number of enums counter (must be last) */
122 enum util_format_colorspace
{
123 UTIL_FORMAT_COLORSPACE_RGB
= 0,
124 UTIL_FORMAT_COLORSPACE_SRGB
= 1,
125 UTIL_FORMAT_COLORSPACE_YUV
= 2,
126 UTIL_FORMAT_COLORSPACE_ZS
= 3
130 struct util_format_channel_description
132 unsigned type
:5; /**< UTIL_FORMAT_TYPE_x */
133 unsigned normalized
:1;
134 unsigned pure_integer
:1;
135 unsigned size
:9; /**< bits per channel */
136 unsigned shift
:16; /** number of bits from lsb */
140 struct util_format_description
142 enum pipe_format format
;
147 * Short name, striped of the prefix, lower case.
149 const char *short_name
;
152 * Pixel block dimensions.
154 struct util_format_block block
;
156 enum util_format_layout layout
;
159 * The number of channels.
161 unsigned nr_channels
:3;
164 * Whether all channels have the same number of (whole) bytes and type.
169 * Whether the pixel format can be described as a bitfield structure.
172 * - pixel depth must be 8, 16, or 32 bits;
173 * - all channels must be unsigned, signed, or void
175 unsigned is_bitmask
:1;
178 * Whether channels have mixed types (ignoring UTIL_FORMAT_TYPE_VOID).
183 * Input channel description, in the order XYZW.
185 * Only valid for UTIL_FORMAT_LAYOUT_PLAIN formats.
187 * If each channel is accessed as an individual N-byte value, X is always
188 * at the lowest address in memory, Y is always next, and so on. For all
189 * currently-defined formats, the N-byte value has native endianness.
191 * If instead a group of channels is accessed as a single N-byte value,
192 * the order of the channels within that value depends on endianness.
193 * For big-endian targets, X is the most significant subvalue,
194 * otherwise it is the least significant one.
196 * For example, if X is 8 bits and Y is 24 bits, the memory order is:
199 * little-endian: X Yl Ym Yu (l = lower, m = middle, u = upper)
200 * big-endian: X Yu Ym Yl
202 * If X is 5 bits, Y is 5 bits, Z is 5 bits and W is 1 bit, the layout is:
206 * little-endian: YYYXXXXX WZZZZZYY
207 * big-endian: XXXXXYYY YYZZZZZW
209 struct util_format_channel_description channel
[4];
212 * Output channel swizzle.
214 * The order is either:
218 * depending on the colorspace.
220 unsigned char swizzle
[4];
223 * Colorspace transformation.
225 enum util_format_colorspace colorspace
;
228 * Unpack pixel blocks to R8G8B8A8_UNORM.
229 * Note: strides are in bytes.
231 * Only defined for non-depth-stencil formats.
234 (*unpack_rgba_8unorm
)(uint8_t *dst
, unsigned dst_stride
,
235 const uint8_t *src
, unsigned src_stride
,
236 unsigned width
, unsigned height
);
239 * Pack pixel blocks from R8G8B8A8_UNORM.
240 * Note: strides are in bytes.
242 * Only defined for non-depth-stencil formats.
245 (*pack_rgba_8unorm
)(uint8_t *dst
, unsigned dst_stride
,
246 const uint8_t *src
, unsigned src_stride
,
247 unsigned width
, unsigned height
);
250 * Fetch a single pixel (i, j) from a block.
252 * XXX: Only defined for a very few select formats.
255 (*fetch_rgba_8unorm
)(uint8_t *dst
,
257 unsigned i
, unsigned j
);
260 * Unpack pixel blocks to R32G32B32A32_FLOAT.
261 * Note: strides are in bytes.
263 * Only defined for non-depth-stencil formats.
266 (*unpack_rgba_float
)(float *dst
, unsigned dst_stride
,
267 const uint8_t *src
, unsigned src_stride
,
268 unsigned width
, unsigned height
);
271 * Pack pixel blocks from R32G32B32A32_FLOAT.
272 * Note: strides are in bytes.
274 * Only defined for non-depth-stencil formats.
277 (*pack_rgba_float
)(uint8_t *dst
, unsigned dst_stride
,
278 const float *src
, unsigned src_stride
,
279 unsigned width
, unsigned height
);
282 * Fetch a single pixel (i, j) from a block.
284 * Only defined for non-depth-stencil and non-integer formats.
287 (*fetch_rgba_float
)(float *dst
,
289 unsigned i
, unsigned j
);
292 * Unpack pixels to Z32_UNORM.
293 * Note: strides are in bytes.
295 * Only defined for depth formats.
298 (*unpack_z_32unorm
)(uint32_t *dst
, unsigned dst_stride
,
299 const uint8_t *src
, unsigned src_stride
,
300 unsigned width
, unsigned height
);
303 * Pack pixels from Z32_FLOAT.
304 * Note: strides are in bytes.
306 * Only defined for depth formats.
309 (*pack_z_32unorm
)(uint8_t *dst
, unsigned dst_stride
,
310 const uint32_t *src
, unsigned src_stride
,
311 unsigned width
, unsigned height
);
314 * Unpack pixels to Z32_FLOAT.
315 * Note: strides are in bytes.
317 * Only defined for depth formats.
320 (*unpack_z_float
)(float *dst
, unsigned dst_stride
,
321 const uint8_t *src
, unsigned src_stride
,
322 unsigned width
, unsigned height
);
325 * Pack pixels from Z32_FLOAT.
326 * Note: strides are in bytes.
328 * Only defined for depth formats.
331 (*pack_z_float
)(uint8_t *dst
, unsigned dst_stride
,
332 const float *src
, unsigned src_stride
,
333 unsigned width
, unsigned height
);
336 * Unpack pixels to S8_UINT.
337 * Note: strides are in bytes.
339 * Only defined for stencil formats.
342 (*unpack_s_8uint
)(uint8_t *dst
, unsigned dst_stride
,
343 const uint8_t *src
, unsigned src_stride
,
344 unsigned width
, unsigned height
);
347 * Pack pixels from S8_UINT.
348 * Note: strides are in bytes.
350 * Only defined for stencil formats.
353 (*pack_s_8uint
)(uint8_t *dst
, unsigned dst_stride
,
354 const uint8_t *src
, unsigned src_stride
,
355 unsigned width
, unsigned height
);
358 * Unpack pixel blocks to R32G32B32A32_UINT.
359 * Note: strides are in bytes.
361 * Only defined for INT formats.
364 (*unpack_rgba_uint
)(unsigned *dst
, unsigned dst_stride
,
365 const uint8_t *src
, unsigned src_stride
,
366 unsigned width
, unsigned height
);
369 (*pack_rgba_uint
)(uint8_t *dst
, unsigned dst_stride
,
370 const unsigned *src
, unsigned src_stride
,
371 unsigned width
, unsigned height
);
374 * Unpack pixel blocks to R32G32B32A32_SINT.
375 * Note: strides are in bytes.
377 * Only defined for INT formats.
380 (*unpack_rgba_sint
)(signed *dst
, unsigned dst_stride
,
381 const uint8_t *src
, unsigned src_stride
,
382 unsigned width
, unsigned height
);
385 (*pack_rgba_sint
)(uint8_t *dst
, unsigned dst_stride
,
386 const int *src
, unsigned src_stride
,
387 unsigned width
, unsigned height
);
390 * Fetch a single pixel (i, j) from a block.
392 * Only defined for unsigned (pure) integer formats.
395 (*fetch_rgba_uint
)(uint32_t *dst
,
397 unsigned i
, unsigned j
);
400 * Fetch a single pixel (i, j) from a block.
402 * Only defined for signed (pure) integer formats.
405 (*fetch_rgba_sint
)(int32_t *dst
,
407 unsigned i
, unsigned j
);
411 extern const struct util_format_description
412 util_format_description_table
[];
415 const struct util_format_description
*
416 util_format_description(enum pipe_format format
);
420 * Format query functions.
423 static INLINE
const char *
424 util_format_name(enum pipe_format format
)
426 const struct util_format_description
*desc
= util_format_description(format
);
430 return "PIPE_FORMAT_???";
436 static INLINE
const char *
437 util_format_short_name(enum pipe_format format
)
439 const struct util_format_description
*desc
= util_format_description(format
);
446 return desc
->short_name
;
450 * Whether this format is plain, see UTIL_FORMAT_LAYOUT_PLAIN for more info.
452 static INLINE boolean
453 util_format_is_plain(enum pipe_format format
)
455 const struct util_format_description
*desc
= util_format_description(format
);
461 return desc
->layout
== UTIL_FORMAT_LAYOUT_PLAIN
? TRUE
: FALSE
;
464 static INLINE boolean
465 util_format_is_compressed(enum pipe_format format
)
467 const struct util_format_description
*desc
= util_format_description(format
);
474 switch (desc
->layout
) {
475 case UTIL_FORMAT_LAYOUT_S3TC
:
476 case UTIL_FORMAT_LAYOUT_RGTC
:
477 case UTIL_FORMAT_LAYOUT_ETC
:
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_srgb(enum pipe_format format
)
501 const struct util_format_description
*desc
= util_format_description(format
);
502 return desc
->colorspace
== UTIL_FORMAT_COLORSPACE_SRGB
;
505 static INLINE boolean
506 util_format_has_depth(const struct util_format_description
*desc
)
508 return desc
->colorspace
== UTIL_FORMAT_COLORSPACE_ZS
&&
509 desc
->swizzle
[0] != UTIL_FORMAT_SWIZZLE_NONE
;
512 static INLINE boolean
513 util_format_has_stencil(const struct util_format_description
*desc
)
515 return desc
->colorspace
== UTIL_FORMAT_COLORSPACE_ZS
&&
516 desc
->swizzle
[1] != UTIL_FORMAT_SWIZZLE_NONE
;
519 static INLINE boolean
520 util_format_is_depth_or_stencil(enum pipe_format format
)
522 const struct util_format_description
*desc
= util_format_description(format
);
529 return util_format_has_depth(desc
) ||
530 util_format_has_stencil(desc
);
533 static INLINE boolean
534 util_format_is_depth_and_stencil(enum pipe_format format
)
536 const struct util_format_description
*desc
= util_format_description(format
);
543 return util_format_has_depth(desc
) &&
544 util_format_has_stencil(desc
);
548 * Return whether this is an RGBA, Z, S, or combined ZS format.
549 * Useful for initializing pipe_blit_info::mask.
551 static INLINE
unsigned
552 util_format_get_mask(enum pipe_format format
)
554 const struct util_format_description
*desc
=
555 util_format_description(format
);
560 if (util_format_has_depth(desc
)) {
561 if (util_format_has_stencil(desc
)) {
567 if (util_format_has_stencil(desc
)) {
570 return PIPE_MASK_RGBA
;
576 * Give the RGBA colormask of the channels that can be represented in this
579 * That is, the channels whose values are preserved.
581 static INLINE
unsigned
582 util_format_colormask(const struct util_format_description
*desc
)
587 switch (desc
->colorspace
) {
588 case UTIL_FORMAT_COLORSPACE_RGB
:
589 case UTIL_FORMAT_COLORSPACE_SRGB
:
590 case UTIL_FORMAT_COLORSPACE_YUV
:
592 for (chan
= 0; chan
< 4; ++chan
) {
593 if (desc
->swizzle
[chan
] < 4) {
594 colormask
|= (1 << chan
);
598 case UTIL_FORMAT_COLORSPACE_ZS
:
608 * Checks if color mask covers every channel for the specified format
610 * @param desc a format description to check colormask with
611 * @param colormask a bit mask for channels, matches format of PIPE_MASK_RGBA
613 static INLINE boolean
614 util_format_colormask_full(const struct util_format_description
*desc
, unsigned colormask
)
616 return (~colormask
& util_format_colormask(desc
)) == 0;
621 util_format_is_float(enum pipe_format format
);
625 util_format_has_alpha(enum pipe_format format
);
629 util_format_is_luminance(enum pipe_format format
);
633 util_format_is_luminance_alpha(enum pipe_format format
);
637 util_format_is_intensity(enum pipe_format format
);
640 util_format_is_pure_integer(enum pipe_format format
);
643 util_format_is_pure_sint(enum pipe_format format
);
646 util_format_is_pure_uint(enum pipe_format format
);
649 * Check if the src format can be blitted to the destination format with
650 * a simple memcpy. For example, blitting from RGBA to RGBx is OK, but not
654 util_is_format_compatible(const struct util_format_description
*src_desc
,
655 const struct util_format_description
*dst_desc
);
658 * Whether the format is supported by Gallium for the given bindings.
659 * This covers S3TC textures and floating-point render targets.
662 util_format_is_supported(enum pipe_format format
, unsigned bind
);
665 * Whether this format is a rgab8 variant.
667 * That is, any format that matches the
669 * PIPE_FORMAT_?8?8?8?8_UNORM
671 static INLINE boolean
672 util_format_is_rgba8_variant(const struct util_format_description
*desc
)
676 if(desc
->block
.width
!= 1 ||
677 desc
->block
.height
!= 1 ||
678 desc
->block
.bits
!= 32)
681 for(chan
= 0; chan
< 4; ++chan
) {
682 if(desc
->channel
[chan
].type
!= UTIL_FORMAT_TYPE_UNSIGNED
&&
683 desc
->channel
[chan
].type
!= UTIL_FORMAT_TYPE_VOID
)
685 if(desc
->channel
[chan
].size
!= 8)
694 * Return total bits needed for the pixel format per block.
697 util_format_get_blocksizebits(enum pipe_format format
)
699 const struct util_format_description
*desc
= util_format_description(format
);
706 return desc
->block
.bits
;
710 * Return bytes per block (not pixel) for the given format.
713 util_format_get_blocksize(enum pipe_format format
)
715 uint bits
= util_format_get_blocksizebits(format
);
717 assert(bits
% 8 == 0);
723 util_format_get_blockwidth(enum pipe_format format
)
725 const struct util_format_description
*desc
= util_format_description(format
);
732 return desc
->block
.width
;
736 util_format_get_blockheight(enum pipe_format format
)
738 const struct util_format_description
*desc
= util_format_description(format
);
745 return desc
->block
.height
;
748 static INLINE
unsigned
749 util_format_get_nblocksx(enum pipe_format format
,
752 unsigned blockwidth
= util_format_get_blockwidth(format
);
753 return (x
+ blockwidth
- 1) / blockwidth
;
756 static INLINE
unsigned
757 util_format_get_nblocksy(enum pipe_format format
,
760 unsigned blockheight
= util_format_get_blockheight(format
);
761 return (y
+ blockheight
- 1) / blockheight
;
764 static INLINE
unsigned
765 util_format_get_nblocks(enum pipe_format format
,
769 return util_format_get_nblocksx(format
, width
) * util_format_get_nblocksy(format
, height
);
773 util_format_get_stride(enum pipe_format format
,
776 return util_format_get_nblocksx(format
, width
) * util_format_get_blocksize(format
);
780 util_format_get_2d_size(enum pipe_format format
,
784 return util_format_get_nblocksy(format
, height
) * stride
;
788 util_format_get_component_bits(enum pipe_format format
,
789 enum util_format_colorspace colorspace
,
792 const struct util_format_description
*desc
= util_format_description(format
);
793 enum util_format_colorspace desc_colorspace
;
800 assert(component
< 4);
802 /* Treat RGB and SRGB as equivalent. */
803 if (colorspace
== UTIL_FORMAT_COLORSPACE_SRGB
) {
804 colorspace
= UTIL_FORMAT_COLORSPACE_RGB
;
806 if (desc
->colorspace
== UTIL_FORMAT_COLORSPACE_SRGB
) {
807 desc_colorspace
= UTIL_FORMAT_COLORSPACE_RGB
;
809 desc_colorspace
= desc
->colorspace
;
812 if (desc_colorspace
!= colorspace
) {
816 switch (desc
->swizzle
[component
]) {
817 case UTIL_FORMAT_SWIZZLE_X
:
818 return desc
->channel
[0].size
;
819 case UTIL_FORMAT_SWIZZLE_Y
:
820 return desc
->channel
[1].size
;
821 case UTIL_FORMAT_SWIZZLE_Z
:
822 return desc
->channel
[2].size
;
823 case UTIL_FORMAT_SWIZZLE_W
:
824 return desc
->channel
[3].size
;
831 * Given a linear RGB colorspace format, return the corresponding SRGB
832 * format, or PIPE_FORMAT_NONE if none.
834 static INLINE
enum pipe_format
835 util_format_srgb(enum pipe_format format
)
838 case PIPE_FORMAT_L8_UNORM
:
839 return PIPE_FORMAT_L8_SRGB
;
840 case PIPE_FORMAT_L8A8_UNORM
:
841 return PIPE_FORMAT_L8A8_SRGB
;
842 case PIPE_FORMAT_R8G8B8_UNORM
:
843 return PIPE_FORMAT_R8G8B8_SRGB
;
844 case PIPE_FORMAT_A8B8G8R8_UNORM
:
845 return PIPE_FORMAT_A8B8G8R8_SRGB
;
846 case PIPE_FORMAT_X8B8G8R8_UNORM
:
847 return PIPE_FORMAT_X8B8G8R8_SRGB
;
848 case PIPE_FORMAT_B8G8R8A8_UNORM
:
849 return PIPE_FORMAT_B8G8R8A8_SRGB
;
850 case PIPE_FORMAT_B8G8R8X8_UNORM
:
851 return PIPE_FORMAT_B8G8R8X8_SRGB
;
852 case PIPE_FORMAT_A8R8G8B8_UNORM
:
853 return PIPE_FORMAT_A8R8G8B8_SRGB
;
854 case PIPE_FORMAT_X8R8G8B8_UNORM
:
855 return PIPE_FORMAT_X8R8G8B8_SRGB
;
856 case PIPE_FORMAT_R8G8B8A8_UNORM
:
857 return PIPE_FORMAT_R8G8B8A8_SRGB
;
858 case PIPE_FORMAT_R8G8B8X8_UNORM
:
859 return PIPE_FORMAT_R8G8B8X8_SRGB
;
860 case PIPE_FORMAT_DXT1_RGB
:
861 return PIPE_FORMAT_DXT1_SRGB
;
862 case PIPE_FORMAT_DXT1_RGBA
:
863 return PIPE_FORMAT_DXT1_SRGBA
;
864 case PIPE_FORMAT_DXT3_RGBA
:
865 return PIPE_FORMAT_DXT3_SRGBA
;
866 case PIPE_FORMAT_DXT5_RGBA
:
867 return PIPE_FORMAT_DXT5_SRGBA
;
869 return PIPE_FORMAT_NONE
;
874 * Given an sRGB format, return the corresponding linear colorspace format.
875 * For non sRGB formats, return the format unchanged.
877 static INLINE
enum pipe_format
878 util_format_linear(enum pipe_format format
)
881 case PIPE_FORMAT_L8_SRGB
:
882 return PIPE_FORMAT_L8_UNORM
;
883 case PIPE_FORMAT_L8A8_SRGB
:
884 return PIPE_FORMAT_L8A8_UNORM
;
885 case PIPE_FORMAT_R8G8B8_SRGB
:
886 return PIPE_FORMAT_R8G8B8_UNORM
;
887 case PIPE_FORMAT_A8B8G8R8_SRGB
:
888 return PIPE_FORMAT_A8B8G8R8_UNORM
;
889 case PIPE_FORMAT_X8B8G8R8_SRGB
:
890 return PIPE_FORMAT_X8B8G8R8_UNORM
;
891 case PIPE_FORMAT_B8G8R8A8_SRGB
:
892 return PIPE_FORMAT_B8G8R8A8_UNORM
;
893 case PIPE_FORMAT_B8G8R8X8_SRGB
:
894 return PIPE_FORMAT_B8G8R8X8_UNORM
;
895 case PIPE_FORMAT_A8R8G8B8_SRGB
:
896 return PIPE_FORMAT_A8R8G8B8_UNORM
;
897 case PIPE_FORMAT_X8R8G8B8_SRGB
:
898 return PIPE_FORMAT_X8R8G8B8_UNORM
;
899 case PIPE_FORMAT_R8G8B8A8_SRGB
:
900 return PIPE_FORMAT_R8G8B8A8_UNORM
;
901 case PIPE_FORMAT_R8G8B8X8_SRGB
:
902 return PIPE_FORMAT_R8G8B8X8_UNORM
;
903 case PIPE_FORMAT_DXT1_SRGB
:
904 return PIPE_FORMAT_DXT1_RGB
;
905 case PIPE_FORMAT_DXT1_SRGBA
:
906 return PIPE_FORMAT_DXT1_RGBA
;
907 case PIPE_FORMAT_DXT3_SRGBA
:
908 return PIPE_FORMAT_DXT3_RGBA
;
909 case PIPE_FORMAT_DXT5_SRGBA
:
910 return PIPE_FORMAT_DXT5_RGBA
;
917 * Given a depth-stencil format, return the corresponding stencil-only format.
918 * For stencil-only formats, return the format unchanged.
920 static INLINE
enum pipe_format
921 util_format_stencil_only(enum pipe_format format
)
924 /* mask out the depth component */
925 case PIPE_FORMAT_Z24_UNORM_S8_UINT
:
926 return PIPE_FORMAT_X24S8_UINT
;
927 case PIPE_FORMAT_S8_UINT_Z24_UNORM
:
928 return PIPE_FORMAT_S8X24_UINT
;
929 case PIPE_FORMAT_Z32_FLOAT_S8X24_UINT
:
930 return PIPE_FORMAT_X32_S8X24_UINT
;
932 /* stencil only formats */
933 case PIPE_FORMAT_X24S8_UINT
:
934 case PIPE_FORMAT_S8X24_UINT
:
935 case PIPE_FORMAT_X32_S8X24_UINT
:
936 case PIPE_FORMAT_S8_UINT
:
941 return PIPE_FORMAT_NONE
;
946 * Converts PIPE_FORMAT_*I* to PIPE_FORMAT_*R*.
947 * This is identity for non-intensity formats.
949 static INLINE
enum pipe_format
950 util_format_intensity_to_red(enum pipe_format format
)
953 case PIPE_FORMAT_I8_UNORM
:
954 return PIPE_FORMAT_R8_UNORM
;
955 case PIPE_FORMAT_I8_SNORM
:
956 return PIPE_FORMAT_R8_SNORM
;
957 case PIPE_FORMAT_I16_UNORM
:
958 return PIPE_FORMAT_R16_UNORM
;
959 case PIPE_FORMAT_I16_SNORM
:
960 return PIPE_FORMAT_R16_SNORM
;
961 case PIPE_FORMAT_I16_FLOAT
:
962 return PIPE_FORMAT_R16_FLOAT
;
963 case PIPE_FORMAT_I32_FLOAT
:
964 return PIPE_FORMAT_R32_FLOAT
;
965 case PIPE_FORMAT_I8_UINT
:
966 return PIPE_FORMAT_R8_UINT
;
967 case PIPE_FORMAT_I8_SINT
:
968 return PIPE_FORMAT_R8_SINT
;
969 case PIPE_FORMAT_I16_UINT
:
970 return PIPE_FORMAT_R16_UINT
;
971 case PIPE_FORMAT_I16_SINT
:
972 return PIPE_FORMAT_R16_SINT
;
973 case PIPE_FORMAT_I32_UINT
:
974 return PIPE_FORMAT_R32_UINT
;
975 case PIPE_FORMAT_I32_SINT
:
976 return PIPE_FORMAT_R32_SINT
;
978 assert(!util_format_is_intensity(format
));
984 * Converts PIPE_FORMAT_*L* to PIPE_FORMAT_*R*.
985 * This is identity for non-luminance formats.
987 static INLINE
enum pipe_format
988 util_format_luminance_to_red(enum pipe_format format
)
991 case PIPE_FORMAT_L8_UNORM
:
992 return PIPE_FORMAT_R8_UNORM
;
993 case PIPE_FORMAT_L8_SNORM
:
994 return PIPE_FORMAT_R8_SNORM
;
995 case PIPE_FORMAT_L16_UNORM
:
996 return PIPE_FORMAT_R16_UNORM
;
997 case PIPE_FORMAT_L16_SNORM
:
998 return PIPE_FORMAT_R16_SNORM
;
999 case PIPE_FORMAT_L16_FLOAT
:
1000 return PIPE_FORMAT_R16_FLOAT
;
1001 case PIPE_FORMAT_L32_FLOAT
:
1002 return PIPE_FORMAT_R32_FLOAT
;
1003 case PIPE_FORMAT_L8_UINT
:
1004 return PIPE_FORMAT_R8_UINT
;
1005 case PIPE_FORMAT_L8_SINT
:
1006 return PIPE_FORMAT_R8_SINT
;
1007 case PIPE_FORMAT_L16_UINT
:
1008 return PIPE_FORMAT_R16_UINT
;
1009 case PIPE_FORMAT_L16_SINT
:
1010 return PIPE_FORMAT_R16_SINT
;
1011 case PIPE_FORMAT_L32_UINT
:
1012 return PIPE_FORMAT_R32_UINT
;
1013 case PIPE_FORMAT_L32_SINT
:
1014 return PIPE_FORMAT_R32_SINT
;
1016 case PIPE_FORMAT_LATC1_UNORM
:
1017 return PIPE_FORMAT_RGTC1_UNORM
;
1018 case PIPE_FORMAT_LATC1_SNORM
:
1019 return PIPE_FORMAT_RGTC1_SNORM
;
1021 case PIPE_FORMAT_L4A4_UNORM
:
1022 /* XXX A4R4 is defined as x00y in u_format.csv */
1023 return PIPE_FORMAT_A4R4_UNORM
;
1025 case PIPE_FORMAT_L8A8_UNORM
:
1026 return PIPE_FORMAT_R8A8_UNORM
;
1027 case PIPE_FORMAT_L8A8_SNORM
:
1028 return PIPE_FORMAT_R8A8_SNORM
;
1029 case PIPE_FORMAT_L16A16_UNORM
:
1030 return PIPE_FORMAT_R16A16_UNORM
;
1031 case PIPE_FORMAT_L16A16_SNORM
:
1032 return PIPE_FORMAT_R16A16_SNORM
;
1033 case PIPE_FORMAT_L16A16_FLOAT
:
1034 return PIPE_FORMAT_R16A16_FLOAT
;
1035 case PIPE_FORMAT_L32A32_FLOAT
:
1036 return PIPE_FORMAT_R32A32_FLOAT
;
1037 case PIPE_FORMAT_L8A8_UINT
:
1038 return PIPE_FORMAT_R8A8_UINT
;
1039 case PIPE_FORMAT_L8A8_SINT
:
1040 return PIPE_FORMAT_R8A8_SINT
;
1041 case PIPE_FORMAT_L16A16_UINT
:
1042 return PIPE_FORMAT_R16A16_UINT
;
1043 case PIPE_FORMAT_L16A16_SINT
:
1044 return PIPE_FORMAT_R16A16_SINT
;
1045 case PIPE_FORMAT_L32A32_UINT
:
1046 return PIPE_FORMAT_R32A32_UINT
;
1047 case PIPE_FORMAT_L32A32_SINT
:
1048 return PIPE_FORMAT_R32A32_SINT
;
1050 /* We don't have compressed red-alpha variants for these. */
1051 case PIPE_FORMAT_LATC2_UNORM
:
1052 case PIPE_FORMAT_LATC2_SNORM
:
1053 return PIPE_FORMAT_NONE
;
1056 assert(!util_format_is_luminance(format
) &&
1057 !util_format_is_luminance_alpha(format
));
1063 * Return the number of components stored.
1064 * Formats with block size != 1x1 will always have 1 component (the block).
1066 static INLINE
unsigned
1067 util_format_get_nr_components(enum pipe_format format
)
1069 const struct util_format_description
*desc
= util_format_description(format
);
1070 return desc
->nr_channels
;
1074 * Return the index of the first non-void channel
1075 * -1 if no non-void channels
1078 util_format_get_first_non_void_channel(enum pipe_format format
)
1080 const struct util_format_description
*desc
= util_format_description(format
);
1083 for (i
= 0; i
< 4; i
++)
1084 if (desc
->channel
[i
].type
!= UTIL_FORMAT_TYPE_VOID
)
1094 * Format access functions.
1098 util_format_read_4f(enum pipe_format format
,
1099 float *dst
, unsigned dst_stride
,
1100 const void *src
, unsigned src_stride
,
1101 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1104 util_format_write_4f(enum pipe_format format
,
1105 const float *src
, unsigned src_stride
,
1106 void *dst
, unsigned dst_stride
,
1107 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1110 util_format_read_4ub(enum pipe_format format
,
1111 uint8_t *dst
, unsigned dst_stride
,
1112 const void *src
, unsigned src_stride
,
1113 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1116 util_format_write_4ub(enum pipe_format format
,
1117 const uint8_t *src
, unsigned src_stride
,
1118 void *dst
, unsigned dst_stride
,
1119 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1122 util_format_read_4ui(enum pipe_format format
,
1123 unsigned *dst
, unsigned dst_stride
,
1124 const void *src
, unsigned src_stride
,
1125 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1128 util_format_write_4ui(enum pipe_format format
,
1129 const unsigned int *src
, unsigned src_stride
,
1130 void *dst
, unsigned dst_stride
,
1131 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1134 util_format_read_4i(enum pipe_format format
,
1135 int *dst
, unsigned dst_stride
,
1136 const void *src
, unsigned src_stride
,
1137 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1140 util_format_write_4i(enum pipe_format format
,
1141 const int *src
, unsigned src_stride
,
1142 void *dst
, unsigned dst_stride
,
1143 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1146 * Generic format conversion;
1150 util_format_fits_8unorm(const struct util_format_description
*format_desc
);
1153 util_format_translate(enum pipe_format dst_format
,
1154 void *dst
, unsigned dst_stride
,
1155 unsigned dst_x
, unsigned dst_y
,
1156 enum pipe_format src_format
,
1157 const void *src
, unsigned src_stride
,
1158 unsigned src_x
, unsigned src_y
,
1159 unsigned width
, unsigned height
);
1162 * Swizzle operations.
1165 /* Compose two sets of swizzles.
1166 * If V is a 4D vector and the function parameters represent functions that
1167 * swizzle vector components, this holds:
1168 * swz2(swz1(V)) = dst(V)
1170 void util_format_compose_swizzles(const unsigned char swz1
[4],
1171 const unsigned char swz2
[4],
1172 unsigned char dst
[4]);
1174 /* Apply the swizzle provided in \param swz (which is one of PIPE_SWIZZLE_x)
1175 * to \param src and store the result in \param dst.
1176 * \param is_integer determines the value written for PIPE_SWIZZLE_ONE.
1178 void util_format_apply_color_swizzle(union pipe_color_union
*dst
,
1179 const union pipe_color_union
*src
,
1180 const unsigned char swz
[4],
1181 const boolean is_integer
);
1183 void util_format_swizzle_4f(float *dst
, const float *src
,
1184 const unsigned char swz
[4]);
1186 void util_format_unswizzle_4f(float *dst
, const float *src
,
1187 const unsigned char swz
[4]);
1193 #endif /* ! U_FORMAT_H */