X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fvisuals%2Fgradient-visual-properties.h;h=8bf083ca8ef778d861142a6fced5271c48ed00ef;hb=117abe1d637258abf7f02807047cd3cef5de2bbf;hp=6933015b0f358347800944c411e13ad0f1f08c1c;hpb=a6e53c231632bf7da20cbd2633a4cf40f648045c;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/visuals/gradient-visual-properties.h b/dali-toolkit/public-api/visuals/gradient-visual-properties.h index 6933015..8bf083c 100644 --- a/dali-toolkit/public-api/visuals/gradient-visual-properties.h +++ b/dali-toolkit/public-api/visuals/gradient-visual-properties.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_GRADIENT_VISUAL_PROPERTIES_H /* - * Copyright (c) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2020 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. @@ -23,16 +23,29 @@ namespace Dali { - namespace Toolkit { +/** + * @addtogroup dali_toolkit_visuals + * @{ + */ +/** + * @brief GradientVisual is to render a smooth transition of colors to the control's quad. + * @SINCE_1_1.45 + */ namespace GradientVisual { - +/** + * @brief GradientVisual Property. + * @SINCE_1_1.45 + */ namespace Property { - +/** + * @brief Enumeration for the instance of properties belonging to the GradientVisual. + * @SINCE_1_1.45 + */ enum { /** @@ -104,41 +117,57 @@ enum } // namespace Property +/** + * @brief The type of coordinate system for certain attributes of the points in a gradient. + * + * This applies to the: + * - Start (x1, y1) and End (x2 and y2) points of a line if using a linear gradient. + * - Center point (cx, cy) and radius (r) of a circle if using a radial gradient. + * @SINCE_1_1.45 + */ namespace Units { - /** * @brief The type of coordinate system for certain attributes of the points in a gradient. * * This applies to the: * - Start (x1, y1) and End (x2 and y2) points of a line if using a linear gradient. * - Center point (cx, cy) and radius (r) of a circle if using a radial gradient. + * @SINCE_1_1.45 */ enum Type { OBJECT_BOUNDING_BOX, ///< Uses the normals for the start, end & center points, i.e. top-left is (-0.5, -0.5) and bottom-right is (0.5, 0.5). @SINCE_1_1.45 - USER_SPACE ///< Uses the user coordinates for the start, end & center points, i.e. in a 200 by 200 control, top-left is (0, 0) and bottom-right is (200, 200). @SINCE_1_1.45 + USER_SPACE ///< Uses the user coordinates for the start, end & center points, i.e. in a 200 by 200 control, top-left is (0, 0) and bottom-right is (200, 200). @SINCE_1_1.45 }; } // namespace Units +/** + * @brief Policies that define what happens if the gradient starts or ends inside the bounds of the target rectangle. + * @SINCE_1_1.45 + */ namespace SpreadMethod { - /** * @brief Policies that define what happens if the gradient starts or ends inside the bounds of the target rectangle. + * @SINCE_1_1.45 */ enum Type { - PAD, ///< Uses the terminal colors of the gradient to fill the remainder of the quad. @SINCE_1_1.45 + PAD, ///< Uses the terminal colors of the gradient to fill the remainder of the quad. @SINCE_1_1.45 REFLECT, ///< Reflect the gradient pattern start-to-end, end-to-start, start-to-end etc. until the quad is filled. @SINCE_1_1.45 - REPEAT ///< Repeat the gradient pattern start-to-end, start-to-end, start-to-end etc. until the quad is filled. @SINCE_1_1.45 + REPEAT ///< Repeat the gradient pattern start-to-end, start-to-end, start-to-end etc. until the quad is filled. @SINCE_1_1.45 }; } // namespace SpreadMethod } // namespace GradientVisual +/** + * @} + */ + } // namespace Toolkit } // namespace Dali