Fix comments about CornerRadiusPolicy and BorderlineColor

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / visuals / visual-properties-devel.h

diff --git a/dali-toolkit/devel-api/visuals/visual-properties-devel.h b/dali-toolkit/devel-api/visuals/visual-properties-devel.h
index 99e3837..0042451 100644 (file)
--- a/dali-toolkit/devel-api/visuals/visual-properties-devel.h
+++ b/dali-toolkit/devel-api/visuals/visual-properties-devel.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_DEVEL_API_VISUALS_VISUAL_PROPERTIES_DEVEL_H
 
 /*
- * Copyright (c) 2020 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -64,7 +64,7 @@ enum Type
   OPACITY             = Dali::Toolkit::Visual::Property::OPACITY,
 
   /**
-   * @brief The fitting mode of the visual
+   * @brief The fitting mode of the visual.
    * @details Name "fittingMode", type FittingMode (Property::INTEGER) or Property::STRING.
    * @see DevelVisual::FittingMode
    * @note The default is defined by the type of visual (if it's suitable to be stretched or not).
@@ -72,20 +72,53 @@ enum Type
   VISUAL_FITTING_MODE = OPACITY + 1,
 
   /**
-   * @brief The radius for the rounded corners of the visual
-   * @details Name "cornerRadius", type Property::FLOAT.
-   * @note Optional.
+   * @brief The radius for the rounded corners of the visual.
+   * @details Name "cornerRadius", type Property::FLOAT or Prooperty::VECTOR4, animatable
+   * @note By default, it is Vector::ZERO.
+   * @note Only Property::Vector4 can be animated.
+   * @note Each radius will clamp internally to the half of smaller of the visual width and visual height.
+   * @note Their may exist some alias when you use it as ClippingMode::CLIP_CHILDREN.
+   * @note Radius value are used in clockwise order from top-left-corner to bottom-left-corner.
+   *       When radius is Vector4(x, y, z, w)
+   *       x    y
+   *        +--+
+   *        |  |
+   *        +--+
+   *       w    z
    */
   CORNER_RADIUS = OPACITY + 2,
 
   /**
-   * @brief Whether the corner radius value is relative (percentage [0.0f to 1.0f] of the visual size) or absolute (in world units).
+   * @brief Whether the corner radius value is relative (percentage [0.0f to 0.5f] of the visual size) or absolute (in world units).
    * @details Name "cornerRadiusPolicy", type Property::INTEGER.
    * @see Policy::Type
    * @note By default, it is ABSOLUTE to the visual's size.
    *       If it it RELATIVE, the corner radius value is relative to the smaller of the visual width and visual height.
    */
   CORNER_RADIUS_POLICY = OPACITY + 3,
+
+  /**
+   * @brief The width for the borderline of the visual.
+   * @details Name "borderlineWidth", type Property::FLOAT, animatable
+   * @note Optional. Default value is 0.0f.
+   */
+  BORDERLINE_WIDTH = OPACITY + 4,
+
+  /**
+   * @brief The color for the borderline of the visual.
+   * @details Name "borderlineColor", type Property::VECTOR4, animatable
+   * @note Default value is Color::BLACK.
+   * @note This color is affected by opacity.
+   */
+  BORDERLINE_COLOR = OPACITY + 5,
+
+  /**
+   * @brief The offset from the visual borderline (recommend [-1.0f to 1.0f]).
+   * @details Name "borderlineOffset", type Property::FLOAT, animatable
+   * @note Default value is 0.0f.
+   * @note This value will clamp internally to [-1.0f to 1.0f].
+   */
+  BORDERLINE_OFFSET = OPACITY + 6,
 };
 
 } // namespace Property