}
/**
- * @brief ResourceImage is an image loaded using a URL
+ * @brief ResourceImage is an image loaded using a URL.
*
- * <h3>ResourceImage Loading</h3>
- *
- * When the ResourceImage is created, resource loading will be attempted unless
- * the ResourceImage is created with ResourceImage::IMMEDIATE loading policy or a compatible resource is found in cache.
- * In case of loading images ResourceImage::ON_DEMAND, resource loading will only be attempted if the associated Dali::Toolkit::ImageView
- * is put on Stage.
- * 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>
+ * <i>Customizing 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 both of these conditions apply:
- * - The ResourceImage has already finished loading
- * - The ResourceImage is either on Stage or using ResourceImage::IMMEDIATE load policy
+ * Reload only takes effect if the ResourceImage has already finished loading.
*
* Signals
* | %Signal Name | Method |
class DALI_IMPORT_API ResourceImage : public Image
{
public:
- /**
- * @brief Resource management options.
- */
-
- /**
- * @DEPRECATED_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
- * @remarks This is an experimental feature and might not be supported in the next release.
- * We do recommend not to use it.
- */
- 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.
public:
/**
- * @brief Get the size of an image from disk.
+ * @brief Gets the size of an image from disk.
*
* This function will read the header info from file on disk and is
* synchronous, so it should not be used repeatedly or in tight
* loops.
*
* @SINCE_1_0.0
- * @param [in] url The URL of the image file.
- * @return The width and height in pixels of the image.
+ * @REMARK_STORAGE
+ * @param[in] url The URL of the image file
+ * @return The width and height in pixels of the image
*/
static ImageDimensions GetImageSize( const std::string& url );
ResourceImage();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
ResourceImage( const ResourceImage& handle );
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
ResourceImage& operator=( const ResourceImage& rhs );
/**
* @name ResourceImageFactoryFunctions
- * Create ResourceImage object instances using these functions.
+ * Creates ResourceImage object instances using these functions.
*/
///@{
/**
- * @brief Create an initialised ResourceImage object.
+ * @brief Creates an initialized ResourceImage object.
*
* Uses defaults for all options.
*
* @sa Dali::FittingMode::Type Dali::SamplingMode::Type
* @SINCE_1_0.0
- * @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.
+ * @REMARK_INTERNET
+ * @REMARK_STORAGE
+ * @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_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.
+ * @brief Creates an initialized 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.
+ * @REMARK_INTERNET
+ * @REMARK_STORAGE
+ * @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,
SamplingMode::Type samplingMode = SamplingMode::DEFAULT,
bool orientationCorrection = true );
- /**
- * @DEPRECATED_1_1.3. Use New( const std::string& url, ImageDimensions size ) 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] 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,
- LoadPolicy loadPol,
- ReleasePolicy releasePol,
- ImageDimensions size,
- FittingMode::Type fittingMode = FittingMode::DEFAULT,
- SamplingMode::Type samplingMode = SamplingMode::DEFAULT,
- bool orientationCorrection = true );
-
///@}
/**
- * @brief Downcast a handle to ResourceImage handle.
+ * @brief Downcasts 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.
+ * 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 Handle to an object
* @return Handle to a Image object or an uninitialized handle
static ResourceImage DownCast( BaseHandle handle );
/**
- * @DEPRECATED_1_1.3
- *
- * @brief Return load policy.
- *
- * @SINCE_1_0.0
- * @remarks This is an experimental feature and might not be supported in the next release.
- * We do recommend not to use it.
- * @return Resource load policy
- */
- LoadPolicy GetLoadPolicy() const;
-
- /**
- * @brief Query whether the image data has loaded.
+ * @brief Queries whether the image data has loaded.
*
* The asynchronous loading begins when the Image object is created.
* After the Image object is discarded, the image data will be released from memory.
* @SINCE_1_0.0
- * @return The loading state, either Loading, Success or Failed.
+ * @return The loading state, either Loading, Success or Failed
*/
LoadingState GetLoadingState() const;
* @brief Returns the URL of the image.
*
* @SINCE_1_0.0
- * @return The URL of the image file.
+ * @return The URL of the image file
*/
std::string GetUrl() const;
/**
- * @brief Reload image from filesystem.
+ * @brief Reloads image from filesystem.
*
* The original set of image loading attributes (requested dimensions, scaling
* mode and filter mode) are used when requesting the image again.
* @SINCE_1_0.0
- * @note If image is offstage and OnDemand policy is set, the reload request is
- * ignored.
+ * @note If image is offstage and OnDemand policy is set, the reload request is ignored.
*/
void Reload();
* @brief Emitted when the image data loads successfully, or when the loading fails.
*
* @SINCE_1_0.0
- * @return A signal object to Connect() with.
+ * @return A signal object to Connect() with
*/
ResourceImageSignal& LoadingFinishedSignal();