1 #ifndef DALI_TOOLKIT_VISUAL_PROPERTIES_H
2 #define DALI_TOOLKIT_VISUAL_PROPERTIES_H
5 * Copyright (c) 2017 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali-toolkit/public-api/toolkit-property-index-ranges.h>
31 * @addtogroup dali_toolkit_visuals
36 * @brief All the visual types
43 * @brief All the visual types.
48 BORDER, ///< Renders a solid color as an internal border to the control's quad. @SINCE_1_1.45
49 COLOR, ///< Renders a solid color to the control's quad. @SINCE_1_1.45
50 GRADIENT, ///< Renders a smooth transition of colors to the control's quad. @SINCE_1_1.45
51 IMAGE, ///< Renders an image into the control's quad. @SINCE_1_1.45
52 MESH, ///< Renders a mesh using an "obj" file, optionally with textures provided by an "mtl" file. @SINCE_1_1.45
53 PRIMITIVE, ///< Renders a simple 3D shape, such as a cube or sphere. @SINCE_1_1.45
54 WIREFRAME ///< Renders a simple wire-frame outlining a quad. @SINCE_1_2_2
58 * @brief Visual Property
65 * @brief Visual Property
71 * @brief The index for the visual type.
72 * @details Name "visualType", type [Type](@ref Dali::Toolkit::Visual::Type) (Property::INTEGER) or Property::STRING.
77 TYPE = VISUAL_PROPERTY_BASE_START_INDEX,
80 * @brief The shader to use in the visual.
81 * @details Name "shader", type Property::Map.
84 * @note Will override the existing shaders.
85 * @see Shader::Property
90 } // namespace Property
93 * @brief Shader for Visuals
100 * @brief Shader Property
107 * @brief The type of Shader
113 * @brief The vertex shader.
114 * @details Name "vertexShader", type Property::STRING or Property::ARRAY of Property::STRING.
115 * A Property::ARRAY of Property::STRING values can be used to split the shader string over multiple lines.
118 * @note If not supplied, the visual's already set vertex shader is used.
123 * @brief The fragment shader.
124 * @details Name "fragmentShader", type Property::STRING or Property::ARRAY of Property::STRING.
125 * A Property::ARRAY of Property::STRING values can be used to split the shader string over multiple lines.
128 * @note If not supplied, the visual's already set fragment shader is used.
133 * @brief How to subdivide the grid along the X-Axis.
134 * @details Name "subdivideGridX", type Property::INTEGER.
137 * @note If not supplied, the default is 1.
138 * @note Value should be greater than or equal to 1.
143 * @brief How to subdivide the grid along the Y-Axis.
144 * @details Name "subdivideGridY", type Property::INTEGER.
147 * @note If not supplied, the default is 1.
148 * @note Value should be greater than or equal to 1.
153 * @brief Hints for rendering.
154 * @details Name "hints", type Dali::Shader::Hint (Property::INTEGER), Property::STRING or Property::ARRAY of Property::STRING.
157 * @note If not supplied, the default is Dali::Shader::Hint::NONE.
162 } // namespace Property
164 } // namespace Shader
166 } // namespace Visual
172 } // namespace Toolkit
176 #endif // DALI_TOOLKIT_VISUAL_PROPERTIES_H