X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fvisuals%2Fvisual-properties.h;h=ee24889e48766ad0ec77ac28e8d417b4667143b9;hp=c64a73c0ab139301a4a6cb894ba081fb7212c632;hb=cb30ef68af0383b073ba2d425d3d95c1e916cbb4;hpb=f05c437df1fc28be1354e47af9dbf336828956f1 diff --git a/dali-toolkit/public-api/visuals/visual-properties.h b/dali-toolkit/public-api/visuals/visual-properties.h index c64a73c..ee24889 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) 2016 Samsung Electronics Co., Ltd. + * Copyright (c) 2017 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. @@ -27,6 +27,15 @@ namespace Dali namespace Toolkit { +/** + * @addtogroup dali_toolkit_visuals + * @{ + */ + +/** + * @brief All the visual types + * @SINCE_1_1.45 + */ namespace Visual { @@ -42,13 +51,20 @@ enum Type 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.11 + WIREFRAME ///< Renders a simple wire-frame outlining a quad. @SINCE_1_2_2 }; +/** + * @brief Visual Property + * @SINCE_1_1.45 + */ namespace Property { +/** + * @brief Visual Property + * @SINCE_1_1.45 + */ enum { /** @@ -68,22 +84,35 @@ enum * @note Will override the existing shaders. * @see Shader::Property */ - SHADER, + SHADER }; } // namespace Property +/** + * @brief Shader for Visuals + * @SINCE_1_1.45 + */ namespace Shader { +/** + * @brief Shader Property + * @SINCE_1_1.45 + */ namespace Property { +/** + * @brief The type of Shader + * @SINCE_1_1.45 + */ enum { /** * @brief The vertex shader. - * @details Name "vertexShader", type Property::STRING. + * @details Name "vertexShader", type Property::STRING or Property::ARRAY of Property::STRING. + * A Property::ARRAY of Property::STRING values can be used to split the shader string over multiple lines. * @SINCE_1_1.45 * @note Optional * @note If not supplied, the visual's already set vertex shader is used. @@ -92,7 +121,8 @@ enum /** * @brief The fragment shader. - * @details Name "fragmentShader", type Property::STRING. + * @details Name "fragmentShader", type Property::STRING or Property::ARRAY of Property::STRING. + * A Property::ARRAY of Property::STRING values can be used to split the shader string over multiple lines. * @SINCE_1_1.45 * @note Optional * @note If not supplied, the visual's already set fragment shader is used. @@ -135,6 +165,10 @@ enum } // namespace Visual +/** + * @} + */ + } // namespace Toolkit } // namespace Dali