1 #ifndef DALI_TOOLKIT_SYNC_IMAGE_LOADER_H
2 #define DALI_TOOLKIT_SYNC_IMAGE_LOADER_H
5 * Copyright (c) 2020 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.
21 #include <dali/public-api/images/image-operations.h>
22 #include <dali/public-api/images/pixel-data.h>
26 #include <dali-toolkit/public-api/dali-toolkit-common.h>
33 * @addtogroup dali_toolkit_image_loader
37 namespace SyncImageLoader
40 * @brief The methods in the SyncImageLoader namespace are used to load pixel data from a URL synchronously.
45 * PixelData pixelData = Toolkit::SyncImageLoader::Load( "image_url.jpg" );
47 * // Check the image was loaded without error.
57 * @brief Loads an image synchronously.
58 * Note: When using this method, the following defaults will be used:
59 * fittingMode = FittingMode::DEFAULT
60 * samplingMode = SamplingMode::BOX_THEN_LINEAR
61 * orientationCorrection = true
66 * @param[in] url The URL of the image file to load
67 * @return A PixelData object containing the image, or an invalid object on failure
69 DALI_TOOLKIT_API PixelData Load(const std::string& url);
72 * @brief Loads an image synchronously by specifying the target dimensions.
73 * Note: When using this method, the following defaults will be used:
74 * fittingMode = FittingMode::DEFAULT
75 * samplingMode = SamplingMode::BOX_THEN_LINEAR
76 * orientationCorrection = true
81 * @param[in] url The URL of the image file to load
82 * @param[in] dimensions The width and height to fit the loaded image to
83 * @return A PixelData object containing the image, or an invalid object on failure
85 DALI_TOOLKIT_API PixelData Load(const std::string& url, ImageDimensions dimensions);
88 * @brief Loads an image synchronously by specifying the target dimensions and options.
92 * @param[in] url The URL of the image file to load
93 * @param[in] dimensions The width and height to fit the loaded image to
94 * @param[in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter
95 * @param[in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size
96 * @param[in] orientationCorrection Reorient the image to respect any orientation metadata in its header
97 * @return A PixelData object containing the image, or an invalid object on failure
99 DALI_TOOLKIT_API PixelData Load(const std::string& url,
100 ImageDimensions dimensions,
101 FittingMode::Type fittingMode,
102 SamplingMode::Type samplingMode,
103 bool orientationCorrection);
105 } // namespace SyncImageLoader
110 } // namespace Toolkit
114 #endif // DALI_TOOLKIT_SYNC_IMAGE_LOADER_H