/**
* @brief ResourceImage is an image loaded using a URL
*
- * <h3>ResourceImage Loading</h3>
+ * <i>Customizing load requests</i>
*
- * When the ResourceImage is created, resource loading will be attempted unless a compatible resource is found in cache.
- * Scaling of images to a desired smaller size can be requested by providing desired dimensions,
- * scaling mode and filter mode to to ResourceImage::New().
- *
- * <i>Custom load requests</i>
* Size, scaling mode, filter mode, and orientation compensation can be set when requesting an image.
*
- * <i>Compatible resources</i>
- *
- * Before loading a new ResourceImage the internal image resource cache is checked by DALi.
- * If there is an image already loaded in memory and is deemed "compatible" with the requested image,
- * that resource is reused.
- * This happens for example if a loaded image exists with the same URL, scaling and filtering modes,
- * and the difference between both of the dimensions is less than a few pixels.
- *
* <i>Reloading images</i>
*
* The same request used on creating the ResourceImage is re-issued when reloading images.
* If the file changed since the last load operation, this might result in a different resource.
- * Reload only takes effect if the ResourceImage has already finished loading
+ * Reload only takes effect if the ResourceImage has already finished loading.
*
* Signals
* | %Signal Name | Method |
public:
/**
- * @deprecated DALi 1.1.3 Image loading starts immediately in the frame when then ResourceImage object is created
- *
- * @brief LoadPolicy controls the way images are loaded into memory.
- * @SINCE_1_0.0
- */
- enum LoadPolicy
- {
- IMMEDIATE, ///< load image once it is created (default) @SINCE_1_0.0
- ON_DEMAND ///< delay loading until the image is being used (a related actor is added to Stage) @SINCE_1_0.0
- };
-
- /**
* @brief Type of signal for LoadingFinished and Uploaded.
* @SINCE_1_0.0
*/
*
* @sa Dali::FittingMode::Type Dali::SamplingMode::Type
* @SINCE_1_0.0
+ * @REMARK_INTERNET
* @param [in] url The URL of the image file to use.
* @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
* @return A handle to a newly allocated object
static ResourceImage New( const std::string& url, bool orientationCorrection = true );
/**
- * @deprecated DALi 1.1.3 use New( const std::string& url ) instead.
- *
- * @brief Create an initialised ResourceImage object.
- *
- * @SINCE_1_0.0
- * @param [in] url The URL of the image file to use.
- * @param [in] loadPol The LoadPolicy to apply when loading the image resource.
- * @param [in] releasePol The ReleasePolicy to apply to Image.
- * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
- * @return A handle to a newly allocated object
- */
- static ResourceImage New( const std::string& url, LoadPolicy loadPol, ReleasePolicy releasePol, bool orientationCorrection = true );
-
- /**
- * @brief Create an initialised ResourceImage object.
- *
- * @SINCE_1_0.0
- * @param [in] url The URL of the image file to use.
- * @param [in] size The width and height to fit the loaded image to.
- * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
- * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
- * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
- * @return A handle to a newly allocated object
- */
- static ResourceImage New( const std::string& url,
- ImageDimensions size,
- FittingMode::Type fittingMode = FittingMode::DEFAULT,
- SamplingMode::Type samplingMode = SamplingMode::DEFAULT,
- bool orientationCorrection = true );
-
- /**
- * @deprecated DALi 1.1.3 use New( const std::string& url, ImageDimensions size ) instead.
- *
* @brief Create an initialised ResourceImage object.
*
* @SINCE_1_0.0
+ * @REMARK_INTERNET
* @param [in] url The URL of the image file to use.
- * @param [in] loadPol The LoadPolicy to apply when loading the image resource.
- * @param [in] releasePol The ReleasePolicy to apply to Image.
* @param [in] size The width and height to fit the loaded image to.
* @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
* @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
* @return A handle to a newly allocated object
*/
static ResourceImage New( const std::string& url,
- LoadPolicy loadPol,
- ReleasePolicy releasePol,
ImageDimensions size,
FittingMode::Type fittingMode = FittingMode::DEFAULT,
SamplingMode::Type samplingMode = SamplingMode::DEFAULT,
///@}
/**
- * @brief Downcast an Object handle to ResourceImage handle.
+ * @brief Downcast a handle to ResourceImage handle.
*
* If handle points to a ResourceImage object the
* downcast produces valid handle. If not the returned handle is left uninitialized.
* @SINCE_1_0.0
- * @param[in] handle to An object
- * @return handle to a Image object or an uninitialized handle
+ * @param[in] handle Handle to an object
+ * @return Handle to a Image object or an uninitialized handle
*/
static ResourceImage DownCast( BaseHandle handle );
/**
- * @deprecated DALi 1.1.3
- *
- * @brief Return load policy.
- *
- * @SINCE_1_0.0
- * @return resource load policy
- */
- LoadPolicy GetLoadPolicy() const;
-
- /**
* @brief Query whether the image data has loaded.
*
* The asynchronous loading begins when the Image object is created.
projects / platform / core / uifw / dali-core.git / blobdiff