X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fvisuals%2Fvisual-properties.h;h=be3aeadb4177a7f3d3cf77f2aad555dd44fa258c;hb=52f63e08e4386ce4f33bf03a34e6f039364a4064;hp=5617198ef14fa481eda8860d088c880e891092c3;hpb=410125f32fcd135226a2a0a668b2855ea9e17a69;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/public-api/visuals/visual-properties.h b/dali-toolkit/public-api/visuals/visual-properties.h index 5617198..be3aead 100644 --- a/dali-toolkit/public-api/visuals/visual-properties.h +++ b/dali-toolkit/public-api/visuals/visual-properties.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_VISUAL_PROPERTIES_H /* - * Copyright (c) 2017 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,57 +23,53 @@ namespace Dali { - namespace Toolkit { - /** * @addtogroup dali_toolkit_visuals * @{ */ /** - * @brief All the visual types + * @brief All the visual types. * @SINCE_1_1.45 */ namespace Visual { - /** * @brief All the visual types. * @SINCE_1_1.45 */ enum Type { - BORDER, ///< Renders a solid color as an internal border to the control's quad. @SINCE_1_1.45 - COLOR, ///< Renders a solid color to the control's quad. @SINCE_1_1.45 - GRADIENT, ///< Renders a smooth transition of colors to the control's quad. @SINCE_1_1.45 - IMAGE, ///< Renders an image into the control's quad. @SINCE_1_1.45 - MESH, ///< Renders a mesh using an "obj" file, optionally with textures provided by an "mtl" file. @SINCE_1_1.45 - PRIMITIVE, ///< Renders a simple 3D shape, such as a cube or sphere. @SINCE_1_1.45 - WIREFRAME, ///< Renders a simple wire-frame outlining a quad. @SINCE_1_2_2 - TEXT, ///< Renders text @SINCE_1_2.60 - N_PATCH, ///< Renders an n-patch image. @SINCE_1_2.60 - SVG, ///< Renders an SVG image. @SINCE_1_2.60 - ANIMATED_IMAGE, ///< Renders a animated image. @SINCE_1_2.60 + BORDER, ///< Renders a solid color as an internal border to the control's quad. @SINCE_1_1.45 + COLOR, ///< Renders a solid color to the control's quad. @SINCE_1_1.45 + GRADIENT, ///< Renders a smooth transition of colors to the control's quad. @SINCE_1_1.45 + IMAGE, ///< Renders an image into the control's quad. @SINCE_1_1.45 + MESH, ///< Renders a mesh using an "obj" file, optionally with textures provided by an "mtl" file. @SINCE_1_1.45 + PRIMITIVE, ///< Renders a simple 3D shape, such as a cube or sphere. @SINCE_1_1.45 + WIREFRAME, ///< Renders a simple wire-frame outlining a quad. @SINCE_1_2_2 + TEXT, ///< Renders text @SINCE_1_2.60 + N_PATCH, ///< Renders an n-patch image. @SINCE_1_2.60 + SVG, ///< Renders an SVG image. @SINCE_1_2.60 + ANIMATED_IMAGE, ///< Renders a animated image. @SINCE_1_2.60 }; /** - * @brief Visual Property + * @brief Visual Property. * @SINCE_1_1.45 */ namespace Property { - /** - * @brief Visual Property + * @brief Enumeration for the instance of properties belonging to the Visual Property. * @SINCE_1_1.45 */ enum { /** * @brief The index for the visual type. - * @details Name "visualType", type [Type](@ref Dali::Toolkit::Visual::Type) (Property::INTEGER) or Property::STRING. + * @details Name "visualType", type [Type](Dali::Toolkit::Visual::Type) (Property::INTEGER) or Property::STRING. * @SINCE_1_1.45 * @note Mandatory. * @see Type @@ -95,7 +91,7 @@ enum * @details Name "transform", type Property::MAP. * @SINCE_1_2.60 * @note Optional. - * @see DevelVisual::Transform::Property + * @see Toolkit::Visual::Transform::Property */ TRANSFORM, @@ -128,28 +124,40 @@ enum } // namespace Property +/** + * @brief Visual Transform for the offset or size. + * @SINCE_1_2.60 + */ namespace Transform { - /** * @brief Policies used by the transform for the offset or size. * @SINCE_1_2.60 - * */ namespace Policy { - +/** + * @brief Enumeration for the type of Transform Policy. + * @SINCE_1_2.60 + */ enum Type { - RELATIVE = 0, ///< Relative to the control (percentage [0.0f to 1.0f] of the control). - ABSOLUTE = 1 ///< Absolute value in world units. + RELATIVE = 0, ///< Relative to the control (percentage [0.0f to 1.0f] of the control). @SINCE_1_2.60 + ABSOLUTE = 1 ///< Absolute value in world units. @SINCE_1_2.60 }; } // namespace Policy +/** + * @brief Visual Transform Property. + * @SINCE_1_2.60 + */ namespace Property { - +/** + * @brief Enumeration for the type of Transform Property. + * @SINCE_1_2.60 + */ enum Type { /** @@ -196,8 +204,8 @@ enum Type * control.SetProperty( ..., // Some visual based property * Property::Map().Add( ... ) // Properties to set up visual * .Add( Visual::Property::TRANSFORM, - * Property::Array().Add( DevelVisual::Transform::Property::OFFSET_POLICY, Vector2( Policy::ABSOLUTE, Policy::RELATIVE ) ) ) - * .Add( DevelVisual::Transform::Property::OFFSET, Vector2( 10, 1.0f ) ) ); + * Property::Array().Add( Toolkit::Visual::Transform::Property::OFFSET_POLICY, Vector2( Policy::ABSOLUTE, Policy::RELATIVE ) ) ) + * .Add( Toolkit::Visual::Transform::Property::OFFSET, Vector2( 10, 1.0f ) ) ); * @endcode * * JSON: @@ -237,21 +245,19 @@ enum Type } // namespace Transform /** - * @brief Shader for Visuals + * @brief Shader for Visuals. * @SINCE_1_1.45 */ namespace Shader { - /** - * @brief Shader Property + * @brief Shader Property. * @SINCE_1_1.45 */ namespace Property { - /** - * @brief The type of Shader + * @brief The type of Shader. * @SINCE_1_1.45 */ enum @@ -310,6 +316,17 @@ enum } // namespace Shader +/** + * @brief Status of resource which is used for visual. + * @SINCE_1_3_5 + */ +enum class ResourceStatus +{ + PREPARING, /// Resource is prepared. @SINCE_1_3_5 + READY, /// Resource is ready. @SINCE_1_3_5 + FAILED /// Resource is fail to load @SINCE_1_3_5 +}; + } // namespace Visual /**