1 #ifndef __DALI_RESOURCE_IMAGE_H__
2 #define __DALI_RESOURCE_IMAGE_H__
5 * Copyright (c) 2015 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.
25 #include <dali/public-api/common/loading-state.h>
26 #include <dali/public-api/images/image.h>
27 #include <dali/public-api/signals/dali-signal.h>
28 #include <dali/public-api/images/image-operations.h>
33 * @addtogroup dali-core-images
37 namespace Internal DALI_INTERNAL
43 * @brief ResourceImage is an image loaded using a URL
45 * <h3>ResourceImage Loading</h3>
47 * When the ResourceImage is created, resource loading will be attempted unless a compatible resource is found in cache.
48 * Scaling of images to a desired smaller size can be requested by providing desired dimensions,
49 * scaling mode and filter mode to to ResourceImage::New().
51 * <i>Custom load requests</i>
52 * Size, scaling mode, filter mode, and orientation compensation can be set when requesting an image.
54 * <i>Compatible resources</i>
56 * Before loading a new ResourceImage the internal image resource cache is checked by DALi.
57 * If there is an image already loaded in memory and is deemed "compatible" with the requested image,
58 * that resource is reused.
59 * This happens for example if a loaded image exists with the same URL, scaling and filtering modes,
60 * and the difference between both of the dimensions is less than a few pixels.
62 * <i>Reloading images</i>
64 * The same request used on creating the ResourceImage is re-issued when reloading images.
65 * If the file changed since the last load operation, this might result in a different resource.
66 * Reload only takes effect if the ResourceImage has already finished loading
69 * | %Signal Name | Method |
70 * |------------------------|------------------------------|
71 * | image-loading-finished | @ref LoadingFinishedSignal() |
73 class DALI_IMPORT_API ResourceImage : public Image
78 * @brief LoadPolicy controls the way images are loaded into memory.
79 * @deprecated DALi 1.1.3 Image loading starts immediately in the frame when then ResourceImage object is created
83 IMMEDIATE, ///< load image once it is created (default)
84 ON_DEMAND ///< delay loading until the image is being used (a related actor is added to Stage)
88 * @brief Type of signal for LoadingFinished and Uploaded.
90 typedef Signal< void (ResourceImage) > ResourceImageSignal;
95 * @brief Get the size of an image from disk.
97 * This function will read the header info from file on disk and is
98 * synchronous, so it should not be used repeatedly or in tight
101 * @param [in] url The URL of the image file.
102 * @return The width and height in pixels of the image.
104 static ImageDimensions GetImageSize( const std::string& url );
107 * @brief Constructor which creates an empty ResourceImage object.
109 * Use ResourceImage::New(...) to create an initialised object.
116 * This is non-virtual since derived Handle types must not contain data or virtual methods.
121 * @brief This copy constructor is required for (smart) pointer semantics.
123 * @param [in] handle A reference to the copied handle
125 ResourceImage( const ResourceImage& handle );
128 * @brief This assignment operator is required for (smart) pointer semantics.
130 * @param [in] rhs A reference to the copied handle
131 * @return A reference to this
133 ResourceImage& operator=( const ResourceImage& rhs );
136 * @name ResourceImageFactoryFunctions
137 * Create ResourceImage object instances using these functions.
142 * @brief Create an initialised ResourceImage object.
144 * Uses defaults for all options.
146 * @sa Dali::FittingMode::Type Dali::SamplingMode::Type
147 * @param [in] url The URL of the image file to use.
148 * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
149 * @return A handle to a newly allocated object
151 static ResourceImage New( const std::string& url, bool orientationCorrection = true );
154 * @brief Create an initialised ResourceImage object.
156 * @deprecated DALi 1.1.3 use New( const std::string& url ) instead.
158 * @param [in] url The URL of the image file to use.
159 * @param [in] loadPol The LoadPolicy to apply when loading the image resource.
160 * @param [in] releasePol The ReleasePolicy to apply to Image.
161 * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
162 * @return A handle to a newly allocated object
164 static ResourceImage New( const std::string& url, LoadPolicy loadPol, ReleasePolicy releasePol, bool orientationCorrection = true );
167 * @brief Create an initialised ResourceImage object.
169 * @param [in] url The URL of the image file to use.
170 * @param [in] size The width and height to fit the loaded image to.
171 * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
172 * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
173 * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
174 * @return A handle to a newly allocated object
176 static ResourceImage New( const std::string& url,
177 ImageDimensions size,
178 FittingMode::Type fittingMode = FittingMode::DEFAULT,
179 SamplingMode::Type samplingMode = SamplingMode::DEFAULT,
180 bool orientationCorrection = true );
183 * @brief Create an initialised ResourceImage object.
185 * @deprecated DALi 1.1.3 use New( const std::string& url, ImageDimensions size ) instead.
187 * @param [in] url The URL of the image file to use.
188 * @param [in] loadPol The LoadPolicy to apply when loading the image resource.
189 * @param [in] releasePol The ReleasePolicy to apply to Image.
190 * @param [in] size The width and height to fit the loaded image to.
191 * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
192 * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
193 * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
194 * @return A handle to a newly allocated object
196 static ResourceImage New( const std::string& url,
198 ReleasePolicy releasePol,
199 ImageDimensions size,
200 FittingMode::Type fittingMode = FittingMode::DEFAULT,
201 SamplingMode::Type samplingMode = SamplingMode::DEFAULT,
202 bool orientationCorrection = true );
207 * @brief Downcast an Object handle to ResourceImage handle.
209 * If handle points to a ResourceImage object the
210 * downcast produces valid handle. If not the returned handle is left uninitialized.
211 * @param[in] handle to An object
212 * @return handle to a Image object or an uninitialized handle
214 static ResourceImage DownCast( BaseHandle handle );
217 * @brief Return load policy.
218 * @deprecated DALi 1.1.3
220 * @return resource load policy
222 LoadPolicy GetLoadPolicy() const;
225 * @brief Query whether the image data has loaded.
227 * The asynchronous loading begins when the Image object is created.
228 * After the Image object is discarded, the image data will be released from memory.
229 * @return The loading state, either Loading, Success or Failed.
231 LoadingState GetLoadingState() const;
234 * @brief Returns the URL of the image.
236 * @return The URL of the image file.
238 std::string GetUrl() const;
241 * @brief Reload image from filesystem.
243 * The original set of image loading attributes (requested dimensions, scaling
244 * mode and filter mode) are used when requesting the image again.
245 * @note If image is offstage and OnDemand policy is set, the reload request is
253 * @brief Emitted when the image data loads successfully, or when the loading fails.
255 * @return A signal object to Connect() with.
257 ResourceImageSignal& LoadingFinishedSignal();
259 public: // Not intended for application developers
261 explicit DALI_INTERNAL ResourceImage( Internal::ResourceImage* );
269 #endif // __DALI_RESOURCE_IMAGE_H__