1 #ifndef DALI_TOOLKIT_IMAGE_VISUAL_PROPERTIES_H
2 #define DALI_TOOLKIT_IMAGE_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 ImageVisual is to render an image into the control's quad.
43 * @brief ImageVisual Property
50 * @brief ImageVisual Property
56 * @brief The URL of the image.
57 * @details Name "url", type Property::STRING or Property::ARRAY of Property::STRING
58 * @note The array form is used for generating animated image visuals.
59 * @note The number of threads used for local and remote image loading can be controlled by the
60 * environment variables DALI_TEXTURE_LOCAL_THREADS and DALI_TEXTURE_REMOTE_THREADS respectively.
61 * The default values are 4 threads for local image loading and 8 threads for remote image loading.
65 URL = VISUAL_PROPERTY_START_INDEX,
68 * @brief Fitting options, used when resizing images to fit desired dimensions.
69 * @details Name "fittingMode", type Dali::FittingMode (Property::INTEGER) or Property::STRING.
71 * @note Optional. If not supplied, default is FittingMode::SHRINK_TO_FIT.
72 * @note For Normal Quad images only.
73 * @see Dali::FittingMode
78 * @brief Filtering options, used when resizing images to sample original pixels.
79 * @details Name "samplingMode", type Dali::SamplingMode (Property::INTEGER) or Property::STRING.
81 * @note Optional. If not supplied, default is SamplingMode::BOX.
82 * @note For Normal Quad images only.
83 * @see Dali::SamplingMode
88 * @brief The desired image width.
89 * @details Name "desiredWidth", type Property::INTEGER.
91 * @note Optional. If not specified, the actual image width is used.
92 * @note For Normal Quad images only.
97 * @brief The desired image height.
98 * @details Name "desiredHeight", type Property::INTEGER.
100 * @note Optional. If not specified, the actual image height is used.
101 * @note For Normal Quad images only.
106 * @brief Whether to load the image synchronously.
107 * @details Name "synchronousLoading", type Property::BOOLEAN.
109 * @note Optional. If not specified, the default is false, i.e. the image is loaded asynchronously.
110 * @note For Normal Quad images only.
115 * @brief If true, only draws the borders.
116 * @details Name "borderOnly", type Property::BOOLEAN.
118 * @note Optional. If not specified, the default is false.
119 * @note For N-Patch images only.
124 * @brief The image area to be displayed.
125 * @details Name "pixelArea", type Property::VECTOR4.
126 * It is a rectangular area.
127 * The first two elements indicate the top-left position of the area, and the last two elements are the area width and height respectively.
129 * @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.
130 * @note For Normal Quad images only.
135 * @brief The wrap mode for u coordinate.
136 * @details Name "wrapModeU", type Dali::WrapMode::Type (Property::INTEGER) or Property::STRING
137 * It decides how the texture should be sampled when the u coordinate exceeds the range of 0.0 to 1.0.
139 * @note Optional. If not specified, the default is CLAMP.
140 * @note For Normal QUAD image only.
145 * @brief The wrap mode for v coordinate.
146 * @details Name "wrapModeV", type Dali::WrapMode::Type (Property::INTEGER) or Property::STRING
147 * it decides how the texture should be sampled when the v coordinate exceeds the range of 0.0 to 1.0.
149 * @note Optional. If not specified, the default is CLAMP.
150 * @note For Normal QUAD image only.
155 } // namespace Property
157 } // namespace ImageVisual
163 } // namespace Toolkit
167 #endif // DALI_TOOLKIT_IMAGE_VISUAL_PROPERTIES_H