1 #ifndef __DALI_PIXEL_H__
2 #define __DALI_PIXEL_H__
5 * Copyright (c) 2016 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/common/dali-common.h>
27 * @addtogroup dali_core_images
32 * @brief Pixel format types and their properties.
38 * @brief Enumeration for Pixel formats.
40 * Pixel format, default color depth is RGBA 32 bit with alpha.
42 * @note BufferImage::Update might not work with BGR/BGRA formats!
46 INVALID = 0, ///< Used to represent an unsupported format. @SINCE_1_1.17
48 // Start at > 0 to distinguish null data:
49 A8 = 1, ///< color depth 8-bit, alpha @SINCE_1_0.0
50 L8, ///< color depth 8-bit, luminance @SINCE_1_0.0
51 LA88, ///< color depth 16-bit, luminance with 8 bit alpha @SINCE_1_0.0
52 RGB565, ///< color depth 16 bit, 5-6-5 @SINCE_1_0.0
53 BGR565, ///< color depth 16 bit, 5-6-5 @SINCE_1_0.0
54 RGBA4444, ///< color depth 16 bit with alpha, 4-4-4-4 @SINCE_1_0.0
55 BGRA4444, ///< color depth 16 bit with alpha, 4-4-4-4 @SINCE_1_0.0
56 RGBA5551, ///< color depth 16 bit with alpha, 5-5-5-1 @SINCE_1_0.0
57 BGRA5551, ///< color depth 16 bit with alpha, 5-5-5-1 @SINCE_1_0.0
58 RGB888, ///< color depth 24 bit, 8-8-8 @SINCE_1_0.0
59 RGB8888, ///< color depth 32 bit, alpha is reserved but not used, 8-8-8-8# @SINCE_1_0.0
60 BGR8888, ///< color depth 32 bit, alpha is reserved but not used, 8-8-8-8# @SINCE_1_0.0
61 RGBA8888, ///< color depth 32 bit with alpha, 8-8-8-8 @SINCE_1_0.0
62 BGRA8888, ///< color depth 32 bit with alpha, 8-8-8-8 @SINCE_1_0.0
64 // GLES 3 Standard compressed formats:
65 COMPRESSED_R11_EAC, ///< ETC2 / EAC single-channel, unsigned @SINCE_1_0.0
66 COMPRESSED_SIGNED_R11_EAC, ///< ETC2 / EAC single-channel, signed @SINCE_1_0.0
67 COMPRESSED_RG11_EAC, ///< ETC2 / EAC dual-channel, unsigned @SINCE_1_0.0
68 COMPRESSED_SIGNED_RG11_EAC, ///< ETC2 / EAC dual-channel, signed @SINCE_1_0.0
69 COMPRESSED_RGB8_ETC2, ///< ETC2 / EAC RGB @SINCE_1_0.0
70 COMPRESSED_SRGB8_ETC2, ///< ETC2 / EAC RGB using sRGB colourspace. @SINCE_1_0.0
71 COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2, ///< ETC2 / EAC RGB with single bit per pixel alpha mask. @SINCE_1_0.0
72 COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2,///< ETC2 / EAC RGB using sRGB colourspace, with single bit per pixel alpha mask. @SINCE_1_0.0
73 COMPRESSED_RGBA8_ETC2_EAC, ///< ETC2 / EAC RGB plus separate alpha channel. @SINCE_1_0.0
74 COMPRESSED_SRGB8_ALPHA8_ETC2_EAC, ///< ETC2 / EAC RGB using sRGB colourspace, plus separate alpha channel. @SINCE_1_0.0
76 // GLES 2 extension compressed formats:
77 COMPRESSED_RGB8_ETC1, ///< ETC1 RGB as defined by GLES 2 extension OES_compressed_ETC1_RGB8_texture: http://www.khronos.org/registry/gles/extensions/OES/OES_compressed_ETC1_RGB8_texture.txt @SINCE_1_0.0
78 COMPRESSED_RGB_PVRTC_4BPPV1, ///< PowerVR 4bpp RGB format (v1) as defined by extension IMG_texture_compression_pvrtc: http://www.khronos.org/registry/gles/extensions/IMG/IMG_texture_compression_pvrtc.txt @SINCE_1_0.0
80 // GLES 3.1 compressed formats:
81 COMPRESSED_RGBA_ASTC_4x4_KHR, ///< ASTC Linear color space with a 4x4 block-size. @SINCE_1_1.17
82 COMPRESSED_RGBA_ASTC_5x4_KHR, ///< ASTC Linear color space with a 5x4 block-size. @SINCE_1_1.17
83 COMPRESSED_RGBA_ASTC_5x5_KHR, ///< ASTC Linear color space with a 5x5 block-size. @SINCE_1_1.17
84 COMPRESSED_RGBA_ASTC_6x5_KHR, ///< ASTC Linear color space with a 6x5 block-size. @SINCE_1_1.17
85 COMPRESSED_RGBA_ASTC_6x6_KHR, ///< ASTC Linear color space with a 6x6 block-size. @SINCE_1_1.17
86 COMPRESSED_RGBA_ASTC_8x5_KHR, ///< ASTC Linear color space with a 8x5 block-size. @SINCE_1_1.17
87 COMPRESSED_RGBA_ASTC_8x6_KHR, ///< ASTC Linear color space with a 8x6 block-size. @SINCE_1_1.17
88 COMPRESSED_RGBA_ASTC_8x8_KHR, ///< ASTC Linear color space with a 8x8 block-size. @SINCE_1_1.17
89 COMPRESSED_RGBA_ASTC_10x5_KHR, ///< ASTC Linear color space with a 10x5 block-size. @SINCE_1_1.17
90 COMPRESSED_RGBA_ASTC_10x6_KHR, ///< ASTC Linear color space with a 10x6 block-size. @SINCE_1_1.17
91 COMPRESSED_RGBA_ASTC_10x8_KHR, ///< ASTC Linear color space with a 10x8 block-size. @SINCE_1_1.17
92 COMPRESSED_RGBA_ASTC_10x10_KHR, ///< ASTC Linear color space with a 10x10 block-size. @SINCE_1_1.17
93 COMPRESSED_RGBA_ASTC_12x10_KHR, ///< ASTC Linear color space with a 12x10 block-size. @SINCE_1_1.17
94 COMPRESSED_RGBA_ASTC_12x12_KHR, ///< ASTC Linear color space with a 12x12 block-size. @SINCE_1_1.17
95 COMPRESSED_SRGB8_ALPHA8_ASTC_4x4_KHR, ///< ASTC Non-linear (gamma-corrected) color space with a 4x4 block-size. @SINCE_1_1.17
96 COMPRESSED_SRGB8_ALPHA8_ASTC_5x4_KHR, ///< ASTC Non-linear (gamma-corrected) color space with a 5x4 block-size. @SINCE_1_1.17
97 COMPRESSED_SRGB8_ALPHA8_ASTC_5x5_KHR, ///< ASTC Non-linear (gamma-corrected) color space with a 5x5 block-size. @SINCE_1_1.17
98 COMPRESSED_SRGB8_ALPHA8_ASTC_6x5_KHR, ///< ASTC Non-linear (gamma-corrected) color space with a 6x5 block-size. @SINCE_1_1.17
99 COMPRESSED_SRGB8_ALPHA8_ASTC_6x6_KHR, ///< ASTC Non-linear (gamma-corrected) color space with a 6x6 block-size. @SINCE_1_1.17
100 COMPRESSED_SRGB8_ALPHA8_ASTC_8x5_KHR, ///< ASTC Non-linear (gamma-corrected) color space with a 8x5 block-size. @SINCE_1_1.17
101 COMPRESSED_SRGB8_ALPHA8_ASTC_8x6_KHR, ///< ASTC Non-linear (gamma-corrected) color space with a 8x6 block-size. @SINCE_1_1.17
102 COMPRESSED_SRGB8_ALPHA8_ASTC_8x8_KHR, ///< ASTC Non-linear (gamma-corrected) color space with a 8x8 block-size. @SINCE_1_1.17
103 COMPRESSED_SRGB8_ALPHA8_ASTC_10x5_KHR, ///< ASTC Non-linear (gamma-corrected) color space with a 10x5 block-size. @SINCE_1_1.17
104 COMPRESSED_SRGB8_ALPHA8_ASTC_10x6_KHR, ///< ASTC Non-linear (gamma-corrected) color space with a 10x6 block-size. @SINCE_1_1.17
105 COMPRESSED_SRGB8_ALPHA8_ASTC_10x8_KHR, ///< ASTC Non-linear (gamma-corrected) color space with a 10x8 block-size. @SINCE_1_1.17
106 COMPRESSED_SRGB8_ALPHA8_ASTC_10x10_KHR, ///< ASTC Non-linear (gamma-corrected) color space with a 10x10 block-size. @SINCE_1_1.17
107 COMPRESSED_SRGB8_ALPHA8_ASTC_12x10_KHR, ///< ASTC Non-linear (gamma-corrected) color space with a 12x10 block-size. @SINCE_1_1.17
108 COMPRESSED_SRGB8_ALPHA8_ASTC_12x12_KHR, ///< ASTC Non-linear (gamma-corrected) color space with a 12x12 block-size. @SINCE_1_1.17
110 ///! Update LAST_VALID_PIXEL_FORMAT below if you add an enum value here.
114 * @brief For asserting that a variable has a valid pixel format.
116 * Sync it to the first value above.
118 const Format FIRST_VALID_PIXEL_FORMAT = A8;
121 * @brief For asserting that a variable has a valid pixel format.
123 * Sync it to the last value above.
125 const Format LAST_VALID_PIXEL_FORMAT = COMPRESSED_SRGB8_ALPHA8_ASTC_12x12_KHR;
128 * @brief Whether specified pixel format contains an alpha value.
131 * @param[in] pixelformat Pixel format
132 * @return @c true if format has alpha, @c false otherwise
134 DALI_IMPORT_API bool HasAlpha(Format pixelformat);
137 * @brief Returns The number of bytes per pixel for the specified pixel format.
140 * @param[in] pixelFormat The pixel format
141 * @return The number of bytes per pixel
143 DALI_IMPORT_API unsigned int GetBytesPerPixel(Format pixelFormat);
146 * @brief Returns the offset of the byte containing the alpha value from the start of the pixel data
147 * and the bitmask of that byte to get the alpha value.
149 * For example, in case of Pixel::RGBA4444, byteOffset value is 1 and bitMask value is 0x0f.
150 * It means the second byte contains the alpha value and the last 4 bits of the byte is the alpha value.
152 * Bitmask is zero if the pixelFormat does not support alpha.
154 * @param[in] pixelFormat The pixel format
155 * @param[out] byteOffset The byte offset of the byte containing the alpha value
156 * @param[out] bitMask The bitmask of the byte to get the alpha value
159 DALI_IMPORT_API void GetAlphaOffsetAndMask(Format pixelFormat, int& byteOffset, int& bitMask);
168 #endif // __DALI_PIXEL_H__