1 #ifndef DALI_IMAGE_LOADING_H
2 #define DALI_IMAGE_LOADING_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/devel-api/adaptor-framework/pixel-buffer.h>
26 #include <dali/public-api/dali-adaptor-common.h>
33 * @brief Load an image synchronously from local file.
35 * @note This method is thread safe, i.e. can be called from any thread.
37 * @param [in] url The URL of the image file to load.
38 * @param [in] size The width and height to fit the loaded image to, 0.0 means whole image
39 * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
40 * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
41 * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
42 * @return handle to the loaded PixelBuffer object or an empty handle in case loading failed.
44 DALI_ADAPTOR_API Devel::PixelBuffer LoadImageFromFile(
45 const std::string& url,
46 ImageDimensions size = ImageDimensions( 0, 0 ),
47 FittingMode::Type fittingMode = FittingMode::DEFAULT,
48 SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR,
49 bool orientationCorrection = true );
52 * @brief Determine the size of an image that LoadImageFromFile will provide when
53 * given the same image loading parameters.
55 * This is a synchronous request.
56 * This function is used to determine the size of an image before it has loaded.
57 * @param[in] filename name of the image.
58 * @param[in] size The requested size for the image.
59 * @param[in] fittingMode The method to use to map the source image to the desired
61 * @param[in] samplingMode The image filter to use if the image needs to be
62 * downsampled to the requested size.
63 * @param[in] orientationCorrection Whether to use image metadata to rotate or
64 * flip the image, e.g., from portrait to landscape.
65 * @return dimensions that image will have if it is loaded with given parameters.
67 DALI_ADAPTOR_API ImageDimensions GetClosestImageSize(
68 const std::string& filename,
69 ImageDimensions size = ImageDimensions(0, 0),
70 FittingMode::Type fittingMode = FittingMode::DEFAULT,
71 SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR ,
72 bool orientationCorrection = true );
75 * @brief Get the size of an original image
76 * @param[in] filename name of the image.
78 * @return dimensions to original image
80 DALI_ADAPTOR_API ImageDimensions GetOriginalImageSize(
81 const std::string& filename);
84 * @brief Load an image synchronously from a remote resource.
86 * @param [in] url The URL of the image file to load.
87 * @param [in] size The width and height to fit the loaded image to, 0.0 means whole image
88 * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
89 * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
90 * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
92 * @return handle to the loaded PixelBuffer object or an empty handle in case downloading or decoding failed.
94 DALI_ADAPTOR_API Devel::PixelBuffer DownloadImageSynchronously(
95 const std::string& url,
96 ImageDimensions size = ImageDimensions( 0, 0 ),
97 FittingMode::Type fittingMode = FittingMode::DEFAULT,
98 SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR,
99 bool orientationCorrection = true );
102 * @brief get the maximum texture size.
104 * @return The maximum texture size
106 DALI_ADAPTOR_API unsigned int GetMaxTextureSize();
110 #endif // DALI_IMAGE_LOADING_H