1 #ifndef DALI_TOOLKIT_SYNC_IMAGE_LOADER_H
2 #define DALI_TOOLKIT_SYNC_IMAGE_LOADER_H
5 * Copyright (c) 2018 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/public-api/images/image-operations.h>
23 #include <dali/public-api/images/pixel-data.h>
26 #include <dali-toolkit/public-api/dali-toolkit-common.h>
35 * @addtogroup dali_toolkit_image_loader
39 namespace SyncImageLoader
43 * @brief The methods in the SyncImageLoader namespace are used to load pixel data from a URL synchronously.
48 * PixelData pixelData = Toolkit::SyncImageLoader::Load( "image_url.jpg" );
50 * // Check the image was loaded without error.
60 * @brief Loads an image synchronously.
61 * Note: When using this method, the following defaults will be used:
62 * fittingMode = FittingMode::DEFAULT
63 * samplingMode = SamplingMode::BOX_THEN_LINEAR
64 * orientationCorrection = true
69 * @param[in] url The URL of the image file to load
70 * @return A PixelData object containing the image, or an invalid object on failure
72 DALI_TOOLKIT_API PixelData Load( const std::string& url );
75 * @brief Loads an image synchronously by specifying the target dimensions.
76 * Note: When using this method, the following defaults will be used:
77 * fittingMode = FittingMode::DEFAULT
78 * samplingMode = SamplingMode::BOX_THEN_LINEAR
79 * orientationCorrection = true
84 * @param[in] url The URL of the image file to load
85 * @param[in] dimensions The width and height to fit the loaded image to
86 * @return A PixelData object containing the image, or an invalid object on failure
88 DALI_TOOLKIT_API PixelData Load( const std::string& url, ImageDimensions dimensions );
91 * @brief Loads an image synchronously by specifying the target dimensions and options.
95 * @param[in] url The URL of the image file to load
96 * @param[in] dimensions The width and height to fit the loaded image to
97 * @param[in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter
98 * @param[in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size
99 * @param[in] orientationCorrection Reorient the image to respect any orientation metadata in its header
100 * @return A PixelData object containing the image, or an invalid object on failure
102 DALI_TOOLKIT_API PixelData Load( const std::string& url,
103 ImageDimensions dimensions,
104 FittingMode::Type fittingMode,
105 SamplingMode::Type samplingMode,
106 bool orientationCorrection );
108 } // namespace SyncImageLoader
113 } // namespace Toolkit
117 #endif // DALI_TOOLKIT_SYNC_IMAGE_LOADER_H