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 "util/u_debug.h"
42 * Describe how to pack/unpack pixels into/from the prescribed format.
44 * XXX: This could be renamed to something like util_format_pack, or broke down
45 * in flags inside util_format_block that said exactly what we want.
47 enum util_format_layout
{
49 * Formats with util_format_block::width == util_format_block::height == 1
50 * that can be described as an ordinary data structure.
52 UTIL_FORMAT_LAYOUT_PLAIN
= 0,
55 * Formats with sub-sampled channels.
57 * This is for formats like YVYU where there is less than one sample per
60 UTIL_FORMAT_LAYOUT_SUBSAMPLED
= 3,
63 * S3 Texture Compression formats.
65 UTIL_FORMAT_LAYOUT_S3TC
= 4,
68 * Red-Green Texture Compression formats.
70 UTIL_FORMAT_LAYOUT_RGTC
= 5,
73 * Ericsson Texture Compression
75 UTIL_FORMAT_LAYOUT_ETC
= 6,
78 * Everything else that doesn't fit in any of the above layouts.
80 UTIL_FORMAT_LAYOUT_OTHER
= 7
84 struct util_format_block
86 /** Block width in pixels */
89 /** Block height in pixels */
92 /** Block size in bits */
97 enum util_format_type
{
98 UTIL_FORMAT_TYPE_VOID
= 0,
99 UTIL_FORMAT_TYPE_UNSIGNED
= 1,
100 UTIL_FORMAT_TYPE_SIGNED
= 2,
101 UTIL_FORMAT_TYPE_FIXED
= 3,
102 UTIL_FORMAT_TYPE_FLOAT
= 4
106 enum util_format_swizzle
{
107 UTIL_FORMAT_SWIZZLE_X
= 0,
108 UTIL_FORMAT_SWIZZLE_Y
= 1,
109 UTIL_FORMAT_SWIZZLE_Z
= 2,
110 UTIL_FORMAT_SWIZZLE_W
= 3,
111 UTIL_FORMAT_SWIZZLE_0
= 4,
112 UTIL_FORMAT_SWIZZLE_1
= 5,
113 UTIL_FORMAT_SWIZZLE_NONE
= 6,
114 UTIL_FORMAT_SWIZZLE_MAX
= 7 /**< Number of enums counter (must be last) */
118 enum util_format_colorspace
{
119 UTIL_FORMAT_COLORSPACE_RGB
= 0,
120 UTIL_FORMAT_COLORSPACE_SRGB
= 1,
121 UTIL_FORMAT_COLORSPACE_YUV
= 2,
122 UTIL_FORMAT_COLORSPACE_ZS
= 3
126 struct util_format_channel_description
128 unsigned type
:5; /**< UTIL_FORMAT_TYPE_x */
129 unsigned normalized
:1;
130 unsigned pure_integer
:1;
131 unsigned size
:9; /**< bits per channel */
135 struct util_format_description
137 enum pipe_format format
;
142 * Short name, striped of the prefix, lower case.
144 const char *short_name
;
147 * Pixel block dimensions.
149 struct util_format_block block
;
151 enum util_format_layout layout
;
154 * The number of channels.
156 unsigned nr_channels
:3;
159 * Whether all channels have the same number of (whole) bytes.
164 * Whether the pixel format can be described as a bitfield structure.
167 * - pixel depth must be 8, 16, or 32 bits;
168 * - all channels must be unsigned, signed, or void
170 unsigned is_bitmask
:1;
173 * Whether channels have mixed types (ignoring UTIL_FORMAT_TYPE_VOID).
178 * Input channel description.
180 * Only valid for UTIL_FORMAT_LAYOUT_PLAIN formats.
182 struct util_format_channel_description channel
[4];
185 * Output channel swizzle.
187 * The order is either:
191 * depending on the colorspace.
193 unsigned char swizzle
[4];
196 * Colorspace transformation.
198 enum util_format_colorspace colorspace
;
201 * Unpack pixel blocks to R8G8B8A8_UNORM.
202 * Note: strides are in bytes.
204 * Only defined for non-depth-stencil formats.
207 (*unpack_rgba_8unorm
)(uint8_t *dst
, unsigned dst_stride
,
208 const uint8_t *src
, unsigned src_stride
,
209 unsigned width
, unsigned height
);
212 * Pack pixel blocks from R8G8B8A8_UNORM.
213 * Note: strides are in bytes.
215 * Only defined for non-depth-stencil formats.
218 (*pack_rgba_8unorm
)(uint8_t *dst
, unsigned dst_stride
,
219 const uint8_t *src
, unsigned src_stride
,
220 unsigned width
, unsigned height
);
223 * Fetch a single pixel (i, j) from a block.
225 * XXX: Only defined for a very few select formats.
228 (*fetch_rgba_8unorm
)(uint8_t *dst
,
230 unsigned i
, unsigned j
);
233 * Unpack pixel blocks to R32G32B32A32_FLOAT.
234 * Note: strides are in bytes.
236 * Only defined for non-depth-stencil formats.
239 (*unpack_rgba_float
)(float *dst
, unsigned dst_stride
,
240 const uint8_t *src
, unsigned src_stride
,
241 unsigned width
, unsigned height
);
244 * Pack pixel blocks from R32G32B32A32_FLOAT.
245 * Note: strides are in bytes.
247 * Only defined for non-depth-stencil formats.
250 (*pack_rgba_float
)(uint8_t *dst
, unsigned dst_stride
,
251 const float *src
, unsigned src_stride
,
252 unsigned width
, unsigned height
);
255 * Fetch a single pixel (i, j) from a block.
257 * Only defined for non-depth-stencil and non-integer formats.
260 (*fetch_rgba_float
)(float *dst
,
262 unsigned i
, unsigned j
);
265 * Unpack pixels to Z32_UNORM.
266 * Note: strides are in bytes.
268 * Only defined for depth formats.
271 (*unpack_z_32unorm
)(uint32_t *dst
, unsigned dst_stride
,
272 const uint8_t *src
, unsigned src_stride
,
273 unsigned width
, unsigned height
);
276 * Pack pixels from Z32_FLOAT.
277 * Note: strides are in bytes.
279 * Only defined for depth formats.
282 (*pack_z_32unorm
)(uint8_t *dst
, unsigned dst_stride
,
283 const uint32_t *src
, unsigned src_stride
,
284 unsigned width
, unsigned height
);
287 * Unpack pixels to Z32_FLOAT.
288 * Note: strides are in bytes.
290 * Only defined for depth formats.
293 (*unpack_z_float
)(float *dst
, unsigned dst_stride
,
294 const uint8_t *src
, unsigned src_stride
,
295 unsigned width
, unsigned height
);
298 * Pack pixels from Z32_FLOAT.
299 * Note: strides are in bytes.
301 * Only defined for depth formats.
304 (*pack_z_float
)(uint8_t *dst
, unsigned dst_stride
,
305 const float *src
, unsigned src_stride
,
306 unsigned width
, unsigned height
);
309 * Unpack pixels to S8_UINT.
310 * Note: strides are in bytes.
312 * Only defined for stencil formats.
315 (*unpack_s_8uint
)(uint8_t *dst
, unsigned dst_stride
,
316 const uint8_t *src
, unsigned src_stride
,
317 unsigned width
, unsigned height
);
320 * Pack pixels from S8_UINT.
321 * Note: strides are in bytes.
323 * Only defined for stencil formats.
326 (*pack_s_8uint
)(uint8_t *dst
, unsigned dst_stride
,
327 const uint8_t *src
, unsigned src_stride
,
328 unsigned width
, unsigned height
);
331 * Unpack pixel blocks to R32G32B32A32_UINT.
332 * Note: strides are in bytes.
334 * Only defined for INT formats.
337 (*unpack_rgba_uint
)(unsigned *dst
, unsigned dst_stride
,
338 const uint8_t *src
, unsigned src_stride
,
339 unsigned width
, unsigned height
);
342 (*pack_rgba_uint
)(uint8_t *dst
, unsigned dst_stride
,
343 const unsigned *src
, unsigned src_stride
,
344 unsigned width
, unsigned height
);
347 * Unpack pixel blocks to R32G32B32A32_SINT.
348 * Note: strides are in bytes.
350 * Only defined for INT formats.
353 (*unpack_rgba_sint
)(signed *dst
, unsigned dst_stride
,
354 const uint8_t *src
, unsigned src_stride
,
355 unsigned width
, unsigned height
);
358 (*pack_rgba_sint
)(uint8_t *dst
, unsigned dst_stride
,
359 const int *src
, unsigned src_stride
,
360 unsigned width
, unsigned height
);
363 * Fetch a single pixel (i, j) from a block.
365 * Only defined for unsigned (pure) integer formats.
368 (*fetch_rgba_uint
)(uint32_t *dst
,
370 unsigned i
, unsigned j
);
373 * Fetch a single pixel (i, j) from a block.
375 * Only defined for signed (pure) integer formats.
378 (*fetch_rgba_sint
)(int32_t *dst
,
380 unsigned i
, unsigned j
);
384 extern const struct util_format_description
385 util_format_description_table
[];
388 const struct util_format_description
*
389 util_format_description(enum pipe_format format
);
393 * Format query functions.
396 static INLINE
const char *
397 util_format_name(enum pipe_format format
)
399 const struct util_format_description
*desc
= util_format_description(format
);
403 return "PIPE_FORMAT_???";
409 static INLINE
const char *
410 util_format_short_name(enum pipe_format format
)
412 const struct util_format_description
*desc
= util_format_description(format
);
419 return desc
->short_name
;
423 * Whether this format is plain, see UTIL_FORMAT_LAYOUT_PLAIN for more info.
425 static INLINE boolean
426 util_format_is_plain(enum pipe_format format
)
428 const struct util_format_description
*desc
= util_format_description(format
);
434 return desc
->layout
== UTIL_FORMAT_LAYOUT_PLAIN
? TRUE
: FALSE
;
437 static INLINE boolean
438 util_format_is_compressed(enum pipe_format format
)
440 const struct util_format_description
*desc
= util_format_description(format
);
447 switch (desc
->layout
) {
448 case UTIL_FORMAT_LAYOUT_S3TC
:
449 case UTIL_FORMAT_LAYOUT_RGTC
:
450 /* XXX add other formats in the future */
457 static INLINE boolean
458 util_format_is_s3tc(enum pipe_format format
)
460 const struct util_format_description
*desc
= util_format_description(format
);
467 return desc
->layout
== UTIL_FORMAT_LAYOUT_S3TC
? TRUE
: FALSE
;
470 static INLINE boolean
471 util_format_is_srgb(enum pipe_format format
)
473 const struct util_format_description
*desc
= util_format_description(format
);
474 return desc
->colorspace
== UTIL_FORMAT_COLORSPACE_SRGB
;
477 static INLINE boolean
478 util_format_has_depth(const struct util_format_description
*desc
)
480 return desc
->colorspace
== UTIL_FORMAT_COLORSPACE_ZS
&&
481 desc
->swizzle
[0] != UTIL_FORMAT_SWIZZLE_NONE
;
484 static INLINE boolean
485 util_format_has_stencil(const struct util_format_description
*desc
)
487 return desc
->colorspace
== UTIL_FORMAT_COLORSPACE_ZS
&&
488 desc
->swizzle
[1] != UTIL_FORMAT_SWIZZLE_NONE
;
491 static INLINE boolean
492 util_format_is_depth_or_stencil(enum pipe_format format
)
494 const struct util_format_description
*desc
= util_format_description(format
);
501 return util_format_has_depth(desc
) ||
502 util_format_has_stencil(desc
);
505 static INLINE boolean
506 util_format_is_depth_and_stencil(enum pipe_format format
)
508 const struct util_format_description
*desc
= util_format_description(format
);
515 return util_format_has_depth(desc
) &&
516 util_format_has_stencil(desc
);
521 * Give the RGBA colormask of the channels that can be represented in this
524 * That is, the channels whose values are preserved.
526 static INLINE
unsigned
527 util_format_colormask(const struct util_format_description
*desc
)
532 switch (desc
->colorspace
) {
533 case UTIL_FORMAT_COLORSPACE_RGB
:
534 case UTIL_FORMAT_COLORSPACE_SRGB
:
535 case UTIL_FORMAT_COLORSPACE_YUV
:
537 for (chan
= 0; chan
< 4; ++chan
) {
538 if (desc
->swizzle
[chan
] < 4) {
539 colormask
|= (1 << chan
);
543 case UTIL_FORMAT_COLORSPACE_ZS
:
553 * Checks if color mask covers every channel for the specified format
555 * @param desc a format description to check colormask with
556 * @param colormask a bit mask for channels, matches format of PIPE_MASK_RGBA
558 static INLINE boolean
559 util_format_colormask_full(const struct util_format_description
*desc
, unsigned colormask
)
561 return (~colormask
& util_format_colormask(desc
)) == 0;
566 util_format_is_float(enum pipe_format format
);
570 util_format_is_rgb_no_alpha(enum pipe_format format
);
574 util_format_is_luminance(enum pipe_format format
);
578 util_format_is_luminance_alpha(enum pipe_format format
);
582 util_format_is_intensity(enum pipe_format format
);
585 util_format_is_pure_integer(enum pipe_format format
);
588 util_format_is_pure_sint(enum pipe_format format
);
591 util_format_is_pure_uint(enum pipe_format format
);
594 * Whether the format is a simple array format where all channels
595 * are of the same type and can be loaded from memory as a vector.
597 * If format is 4 channel it can be swizzled (eg BGRA) as long
598 * as the alpha is the 3rd channel.
601 util_format_is_array(const struct util_format_description
*desc
);
604 * Check if the src format can be blitted to the destination format with
605 * a simple memcpy. For example, blitting from RGBA to RGBx is OK, but not
609 util_is_format_compatible(const struct util_format_description
*src_desc
,
610 const struct util_format_description
*dst_desc
);
613 * Whether the format is supported by Gallium for the given bindings.
614 * This covers S3TC textures and floating-point render targets.
617 util_format_is_supported(enum pipe_format format
, unsigned bind
);
620 * Whether this format is a rgab8 variant.
622 * That is, any format that matches the
624 * PIPE_FORMAT_?8?8?8?8_UNORM
626 static INLINE boolean
627 util_format_is_rgba8_variant(const struct util_format_description
*desc
)
631 if(desc
->block
.width
!= 1 ||
632 desc
->block
.height
!= 1 ||
633 desc
->block
.bits
!= 32)
636 for(chan
= 0; chan
< 4; ++chan
) {
637 if(desc
->channel
[chan
].type
!= UTIL_FORMAT_TYPE_UNSIGNED
&&
638 desc
->channel
[chan
].type
!= UTIL_FORMAT_TYPE_VOID
)
640 if(desc
->channel
[chan
].size
!= 8)
649 * Return total bits needed for the pixel format per block.
652 util_format_get_blocksizebits(enum pipe_format format
)
654 const struct util_format_description
*desc
= util_format_description(format
);
661 return desc
->block
.bits
;
665 * Return bytes per block (not pixel) for the given format.
668 util_format_get_blocksize(enum pipe_format format
)
670 uint bits
= util_format_get_blocksizebits(format
);
672 assert(bits
% 8 == 0);
678 util_format_get_blockwidth(enum pipe_format format
)
680 const struct util_format_description
*desc
= util_format_description(format
);
687 return desc
->block
.width
;
691 util_format_get_blockheight(enum pipe_format format
)
693 const struct util_format_description
*desc
= util_format_description(format
);
700 return desc
->block
.height
;
703 static INLINE
unsigned
704 util_format_get_nblocksx(enum pipe_format format
,
707 unsigned blockwidth
= util_format_get_blockwidth(format
);
708 return (x
+ blockwidth
- 1) / blockwidth
;
711 static INLINE
unsigned
712 util_format_get_nblocksy(enum pipe_format format
,
715 unsigned blockheight
= util_format_get_blockheight(format
);
716 return (y
+ blockheight
- 1) / blockheight
;
719 static INLINE
unsigned
720 util_format_get_nblocks(enum pipe_format format
,
724 return util_format_get_nblocksx(format
, width
) * util_format_get_nblocksy(format
, height
);
728 util_format_get_stride(enum pipe_format format
,
731 return util_format_get_nblocksx(format
, width
) * util_format_get_blocksize(format
);
735 util_format_get_2d_size(enum pipe_format format
,
739 return util_format_get_nblocksy(format
, height
) * stride
;
743 util_format_get_component_bits(enum pipe_format format
,
744 enum util_format_colorspace colorspace
,
747 const struct util_format_description
*desc
= util_format_description(format
);
748 enum util_format_colorspace desc_colorspace
;
755 assert(component
< 4);
757 /* Treat RGB and SRGB as equivalent. */
758 if (colorspace
== UTIL_FORMAT_COLORSPACE_SRGB
) {
759 colorspace
= UTIL_FORMAT_COLORSPACE_RGB
;
761 if (desc
->colorspace
== UTIL_FORMAT_COLORSPACE_SRGB
) {
762 desc_colorspace
= UTIL_FORMAT_COLORSPACE_RGB
;
764 desc_colorspace
= desc
->colorspace
;
767 if (desc_colorspace
!= colorspace
) {
771 switch (desc
->swizzle
[component
]) {
772 case UTIL_FORMAT_SWIZZLE_X
:
773 return desc
->channel
[0].size
;
774 case UTIL_FORMAT_SWIZZLE_Y
:
775 return desc
->channel
[1].size
;
776 case UTIL_FORMAT_SWIZZLE_Z
:
777 return desc
->channel
[2].size
;
778 case UTIL_FORMAT_SWIZZLE_W
:
779 return desc
->channel
[3].size
;
785 static INLINE boolean
786 util_format_has_alpha(enum pipe_format format
)
788 const struct util_format_description
*desc
= util_format_description(format
);
795 switch (desc
->colorspace
) {
796 case UTIL_FORMAT_COLORSPACE_RGB
:
797 case UTIL_FORMAT_COLORSPACE_SRGB
:
798 return desc
->swizzle
[3] != UTIL_FORMAT_SWIZZLE_1
;
799 case UTIL_FORMAT_COLORSPACE_YUV
:
801 case UTIL_FORMAT_COLORSPACE_ZS
:
810 * Given a linear RGB colorspace format, return the corresponding SRGB
811 * format, or PIPE_FORMAT_NONE if none.
813 static INLINE
enum pipe_format
814 util_format_srgb(enum pipe_format format
)
817 case PIPE_FORMAT_L8_UNORM
:
818 return PIPE_FORMAT_L8_SRGB
;
819 case PIPE_FORMAT_L8A8_UNORM
:
820 return PIPE_FORMAT_L8A8_SRGB
;
821 case PIPE_FORMAT_R8G8B8_UNORM
:
822 return PIPE_FORMAT_R8G8B8_SRGB
;
823 case PIPE_FORMAT_A8B8G8R8_UNORM
:
824 return PIPE_FORMAT_A8B8G8R8_SRGB
;
825 case PIPE_FORMAT_X8B8G8R8_UNORM
:
826 return PIPE_FORMAT_X8B8G8R8_SRGB
;
827 case PIPE_FORMAT_B8G8R8A8_UNORM
:
828 return PIPE_FORMAT_B8G8R8A8_SRGB
;
829 case PIPE_FORMAT_B8G8R8X8_UNORM
:
830 return PIPE_FORMAT_B8G8R8X8_SRGB
;
831 case PIPE_FORMAT_A8R8G8B8_UNORM
:
832 return PIPE_FORMAT_A8R8G8B8_SRGB
;
833 case PIPE_FORMAT_X8R8G8B8_UNORM
:
834 return PIPE_FORMAT_X8R8G8B8_SRGB
;
835 case PIPE_FORMAT_DXT1_RGB
:
836 return PIPE_FORMAT_DXT1_SRGB
;
837 case PIPE_FORMAT_DXT1_RGBA
:
838 return PIPE_FORMAT_DXT1_SRGBA
;
839 case PIPE_FORMAT_DXT3_RGBA
:
840 return PIPE_FORMAT_DXT3_SRGBA
;
841 case PIPE_FORMAT_DXT5_RGBA
:
842 return PIPE_FORMAT_DXT5_SRGBA
;
844 return PIPE_FORMAT_NONE
;
849 * Given an sRGB format, return the corresponding linear colorspace format.
850 * For non sRGB formats, return the format unchanged.
852 static INLINE
enum pipe_format
853 util_format_linear(enum pipe_format format
)
856 case PIPE_FORMAT_L8_SRGB
:
857 return PIPE_FORMAT_L8_UNORM
;
858 case PIPE_FORMAT_L8A8_SRGB
:
859 return PIPE_FORMAT_L8A8_UNORM
;
860 case PIPE_FORMAT_R8G8B8_SRGB
:
861 return PIPE_FORMAT_R8G8B8_UNORM
;
862 case PIPE_FORMAT_A8B8G8R8_SRGB
:
863 return PIPE_FORMAT_A8B8G8R8_UNORM
;
864 case PIPE_FORMAT_X8B8G8R8_SRGB
:
865 return PIPE_FORMAT_X8B8G8R8_UNORM
;
866 case PIPE_FORMAT_B8G8R8A8_SRGB
:
867 return PIPE_FORMAT_B8G8R8A8_UNORM
;
868 case PIPE_FORMAT_B8G8R8X8_SRGB
:
869 return PIPE_FORMAT_B8G8R8X8_UNORM
;
870 case PIPE_FORMAT_A8R8G8B8_SRGB
:
871 return PIPE_FORMAT_A8R8G8B8_UNORM
;
872 case PIPE_FORMAT_X8R8G8B8_SRGB
:
873 return PIPE_FORMAT_X8R8G8B8_UNORM
;
874 case PIPE_FORMAT_DXT1_SRGB
:
875 return PIPE_FORMAT_DXT1_RGB
;
876 case PIPE_FORMAT_DXT1_SRGBA
:
877 return PIPE_FORMAT_DXT1_RGBA
;
878 case PIPE_FORMAT_DXT3_SRGBA
:
879 return PIPE_FORMAT_DXT3_RGBA
;
880 case PIPE_FORMAT_DXT5_SRGBA
:
881 return PIPE_FORMAT_DXT5_RGBA
;
888 * Given a depth-stencil format, return the corresponding stencil-only format.
889 * For stencil-only formats, return the format unchanged.
891 static INLINE
enum pipe_format
892 util_format_stencil_only(enum pipe_format format
)
895 /* mask out the depth component */
896 case PIPE_FORMAT_Z24_UNORM_S8_UINT
:
897 return PIPE_FORMAT_X24S8_UINT
;
898 case PIPE_FORMAT_S8_UINT_Z24_UNORM
:
899 return PIPE_FORMAT_S8X24_UINT
;
900 case PIPE_FORMAT_Z32_FLOAT_S8X24_UINT
:
901 return PIPE_FORMAT_X32_S8X24_UINT
;
903 /* stencil only formats */
904 case PIPE_FORMAT_X24S8_UINT
:
905 case PIPE_FORMAT_S8X24_UINT
:
906 case PIPE_FORMAT_X32_S8X24_UINT
:
907 case PIPE_FORMAT_S8_UINT
:
912 return PIPE_FORMAT_NONE
;
917 * Return the number of components stored.
918 * Formats with block size != 1x1 will always have 1 component (the block).
920 static INLINE
unsigned
921 util_format_get_nr_components(enum pipe_format format
)
923 const struct util_format_description
*desc
= util_format_description(format
);
924 return desc
->nr_channels
;
928 * Return the index of the first non-void channel
929 * -1 if no non-void channels
932 util_format_get_first_non_void_channel(enum pipe_format format
)
934 const struct util_format_description
*desc
= util_format_description(format
);
937 for (i
= 0; i
< 4; i
++)
938 if (desc
->channel
[i
].type
!= UTIL_FORMAT_TYPE_VOID
)
948 * Format access functions.
952 util_format_read_4f(enum pipe_format format
,
953 float *dst
, unsigned dst_stride
,
954 const void *src
, unsigned src_stride
,
955 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
958 util_format_write_4f(enum pipe_format format
,
959 const float *src
, unsigned src_stride
,
960 void *dst
, unsigned dst_stride
,
961 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
964 util_format_read_4ub(enum pipe_format format
,
965 uint8_t *dst
, unsigned dst_stride
,
966 const void *src
, unsigned src_stride
,
967 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
970 util_format_write_4ub(enum pipe_format format
,
971 const uint8_t *src
, unsigned src_stride
,
972 void *dst
, unsigned dst_stride
,
973 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
976 util_format_read_4ui(enum pipe_format format
,
977 unsigned *dst
, unsigned dst_stride
,
978 const void *src
, unsigned src_stride
,
979 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
982 util_format_write_4ui(enum pipe_format format
,
983 const unsigned int *src
, unsigned src_stride
,
984 void *dst
, unsigned dst_stride
,
985 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
988 util_format_read_4i(enum pipe_format format
,
989 int *dst
, unsigned dst_stride
,
990 const void *src
, unsigned src_stride
,
991 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
994 util_format_write_4i(enum pipe_format format
,
995 const int *src
, unsigned src_stride
,
996 void *dst
, unsigned dst_stride
,
997 unsigned x
, unsigned y
, unsigned w
, unsigned h
);
1000 * Generic format conversion;
1004 util_format_fits_8unorm(const struct util_format_description
*format_desc
);
1007 util_format_translate(enum pipe_format dst_format
,
1008 void *dst
, unsigned dst_stride
,
1009 unsigned dst_x
, unsigned dst_y
,
1010 enum pipe_format src_format
,
1011 const void *src
, unsigned src_stride
,
1012 unsigned src_x
, unsigned src_y
,
1013 unsigned width
, unsigned height
);
1016 * Swizzle operations.
1019 /* Compose two sets of swizzles.
1020 * If V is a 4D vector and the function parameters represent functions that
1021 * swizzle vector components, this holds:
1022 * swz2(swz1(V)) = dst(V)
1024 void util_format_compose_swizzles(const unsigned char swz1
[4],
1025 const unsigned char swz2
[4],
1026 unsigned char dst
[4]);
1028 void util_format_swizzle_4f(float *dst
, const float *src
,
1029 const unsigned char swz
[4]);
1031 void util_format_unswizzle_4f(float *dst
, const float *src
,
1032 const unsigned char swz
[4]);
1038 #endif /* ! U_FORMAT_H */