namespace Pixel
{
/**
- * @brief Pixel formats
+ * @brief Enumeration for Pixel formats.
*
- * @note: BufferImage::Update might not work with BGR/BGRA formats!
+ * Pixel format, default color depth is RGBA 32 bit with alpha.
+ * @SINCE_1_0.0
+ * @note BufferImage::Update might not work with BGR/BGRA formats!
*/
-enum Format ///< pixel format, default color depth is RGBA 32 bit with alpha @SINCE_1_0.0
+enum Format
{
INVALID = 0, ///< Used to represent an unsupported format. @SINCE_1_1.17
* @brief Whether specified pixel format contains an alpha value.
*
* @SINCE_1_0.0
- * @param [in] pixelformat pixel format
- * @return true if format has alpha, false otherwise
+ * @param[in] pixelformat Pixel format
+ * @return @c true if format has alpha, @c false otherwise
*/
DALI_IMPORT_API bool HasAlpha(Format pixelformat);
* @brief Returns The number of bytes per pixel for the specified pixel format.
*
* @SINCE_1_0.0
- * @param [in] pixelFormat The pixel format
+ * @param[in] pixelFormat The pixel format
* @return The number of bytes per pixel
*/
DALI_IMPORT_API unsigned int GetBytesPerPixel(Format pixelFormat);
/**
* @brief Returns the offset of the byte containing the alpha value from the start of the pixel data
* and the bitmask of that byte to get the alpha value.
- * For example, in case of RGBA4444, byteOffset value is 1 and bitMask value is 0x0f.
+ *
+ * For example, in case of Pixel::RGBA4444, byteOffset value is 1 and bitMask value is 0x0f.
* It means the second byte contains the alpha value and the last 4 bits of the byte is the alpha value.
*
- * Bitmask is zero if the pixelFormat does not support alpha
+ * Bitmask is zero if the pixelFormat does not support alpha.
* @SINCE_1_0.0
- * @param[in] pixelFormat the pixel format
- * @param[out] byteOffset the byte offset of the byte containing the alpha value
- * @param[out] bitMask the bitmask of the byte to get the alpha value
+ * @param[in] pixelFormat The pixel format
+ * @param[out] byteOffset The byte offset of the byte containing the alpha value
+ * @param[out] bitMask The bitmask of the byte to get the alpha value
+ *
*/
DALI_IMPORT_API void GetAlphaOffsetAndMask(Format pixelFormat, int& byteOffset, int& bitMask);