From: Heeyong Song <heeyong.song@samsung.com>
Date: Mon, 5 Jan 2015 06:03:14 +0000 (+0900)
Subject: Jira TSAM-30 issue (Tizen 3.0 Release). Add comments of Pixel::GetAlphaOffsetAndMask()
X-Git-Tag: dali_1.0.24~8
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=e43796c0a53ca45f8aead9e9cb14ec68b753aff5;p=platform%2Fcore%2Fuifw%2Fdali-core.git

Jira TSAM-30 issue (Tizen 3.0 Release). Add comments of Pixel::GetAlphaOffsetAndMask()

Change-Id: I2f3b20b60fbe3cda56b1fb85bc5828e8f553c24c
---

diff --git a/dali/public-api/images/pixel.h b/dali/public-api/images/pixel.h
index 907c3cc..a84eb3c 100644
--- a/dali/public-api/images/pixel.h
+++ b/dali/public-api/images/pixel.h
@@ -99,13 +99,15 @@ DALI_IMPORT_API bool HasAlpha(Format pixelformat);
 DALI_IMPORT_API unsigned int GetBytesPerPixel(Format pixelFormat);
 
 /**
- * @brief Returns the offset of the byte containing the alpha mask from the start of the pixel data
+ * @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.
+ * 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
- * @param[in]  pixelFormat
- * @param[out] byteOffset the byte offset
- * @param[out] bitMask the bitmask
+ * @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);