Add comment for gradient visual 72/293172/1
authorseungho baek <sbsh.baek@samsung.com>
Mon, 22 May 2023 05:17:51 +0000 (14:17 +0900)
committerseungho baek <sbsh.baek@samsung.com>
Mon, 22 May 2023 05:17:51 +0000 (14:17 +0900)
Change-Id: I41b226479eaef61cff387c81d4532664ec961bce
Signed-off-by: seungho baek <sbsh.baek@samsung.com>
dali-toolkit/public-api/visuals/gradient-visual-properties.h

index 8bf083c..5e2c6bf 100644 (file)
@@ -51,6 +51,10 @@ enum
   /**
    * @brief The start position of a linear gradient.
    * @details Name "startPosition", type Property::VECTOR2.
+   * Gradient is drawn in a rectangular area, TopLeft is (-0.5, -0.5) and BottomRight is (0.5, 0.5).
+   * The outside of the entered Start Position and End Position is extended to the value of the border.
+   * Even if the range between Start Position and End Position is greater than (-0.5, -0.5) to (0.5, 0.5),
+   * only the corresponding area is drawn.
    * @SINCE_1_1.45
    * @note Mandatory for Linear.
    */
@@ -59,6 +63,10 @@ enum
   /**
    * @brief The end position of a linear gradient.
    * @details Name "endPosition", type Property::VECTOR2.
+   * Gradient is drawn in a rectangular area, TopLeft is (-0.5, -0.5) and BottomRight is (0.5, 0.5).
+   * The outside of the entered Start Position and End Position is extended to the value of the border.
+   * Even if the range between Start Position and End Position is greater than (-0.5, -0.5) to (0.5, 0.5),
+   * only the corresponding area is drawn.
    * @SINCE_1_1.45
    * @note Mandatory for Linear.
    */