1 #ifndef DALI_TOOLKIT_IMAGE_VISUAL_PROPERTIES_H
2 #define DALI_TOOLKIT_IMAGE_VISUAL_PROPERTIES_H
5 * Copyright (c) 2016 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
44 * @brief The URL of the image.
45 * @details Name "url", type Property::STRING.
49 URL = VISUAL_PROPERTY_START_INDEX,
52 * @brief Fitting options, used when resizing images to fit desired dimensions.
53 * @details Name "fittingMode", type Dali::FittingMode (Property::INTEGER) or Property::STRING.
55 * @note Optional. If not supplied, default is FittingMode::SHRINK_TO_FIT.
56 * @note For Normal Quad images only.
57 * @see Dali::FittingMode
62 * @brief Filtering options, used when resizing images to sample original pixels.
63 * @details Name "samplingMode", type Dali::SamplingMode (Property::INTEGER) or Property::STRING.
65 * @note Optional. If not supplied, default is SamplingMode::BOX.
66 * @note For Normal Quad images only.
67 * @see Dali::SamplingMode
72 * @brief The desired image width.
73 * @details Name "desiredWidth", type Property::INTEGER.
75 * @note Optional. If not specified, the actual image width is used.
76 * @note For Normal Quad images only.
81 * @brief The desired image height.
82 * @details Name "desiredHeight", type Property::INTEGER.
84 * @note Optional. If not specified, the actual image height is used.
85 * @note For Normal Quad images only.
90 * @brief Whether to load the image synchronously.
91 * @details Name "synchronousLoading", type Property::BOOLEAN.
93 * @note Optional. If not specified, the default is false, i.e. the image is loaded asynchronously.
94 * @note For Normal Quad images only.
99 * @brief If true, only draws the borders.
100 * @details Name "borderOnly", type Property::BOOLEAN.
102 * @note Optional. If not specified, the default is false.
103 * @note For N-Patch images only.
108 * @brief This enables Image visuals to automatically be converted to Batch-Image visuals.
109 * @details Name "batchingEnabled", type Property::BOOLEAN.
111 * @note Optional. If not specified, the default is false.
112 * @note For Image visuals only. Not to be used with NPatch or SVG images.
117 * @brief The image area to be displayed.
118 * @details Name "pixelArea", type Property::VECTOR4.
119 * It is a rectangular area.
120 * The first two elements indicate the top-left position of the area, and the last two elements are the area width and height respectively.
122 * @note Optional. If not specified, the default value is [0.0, 0.0, 1.0, 1.0], i.e. the entire area of the image.
123 * @note For Normal Quad images only.
128 * @brief The wrap mode for u coordinate.
129 * @details Name "wrapModeU", type Dali::WrapMode::Type (Property::INTEGER) or Property::STRING
130 * It decides how the texture should be sampled when the u coordinate exceeds the range of 0.0 to 1.0.
132 * @note Optional. If not specified, the default is CLAMP.
133 * @note For Normal QUAD image only.
138 * @brief The wrap mode for v coordinate.
139 * @details Name "wrapModeV", type Dali::WrapMode::Type (Property::INTEGER) or Property::STRING
140 * it decides how the texture should be sampled when the v coordinate exceeds the range of 0.0 to 1.0.
142 * @note Optional. If not specified, the default is CLAMP.
143 * @note For Normal QUAD image only.
148 } // namespace Property
150 } // namespace ImageVisual
156 } // namespace Toolkit
160 #endif // DALI_TOOLKIT_IMAGE_VISUAL_PROPERTIES_H