namespace Dali
{
/**
- * @addtogroup dali-core-images
+ * @addtogroup dali_core_images
* @{
*/
* Reload only takes effect if the ResourceImage has already finished loading
*
* Signals
- * | %Signal Name | Method |
- * |------------------------|------------------------------|
- * | image-loading-finished | @ref LoadingFinishedSignal() |
+ * | %Signal Name | Method |
+ * |----------------------|------------------------------|
+ * | imageLoadingFinished | @ref LoadingFinishedSignal() |
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API ResourceImage : public Image
{
public:
/**
+ * @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.
- * @deprecated DALi 1.1.3 Image loading starts immediately in the frame when then ResourceImage object is created
+ * @SINCE_1_0.0
*/
enum LoadPolicy
{
- IMMEDIATE, ///< load image once it is created (default)
- ON_DEMAND ///< delay loading until the image is being used (a related actor is added to Stage)
+ 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
*/
typedef Signal< void (ResourceImage) > ResourceImageSignal;
* 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.
*/
* @brief Constructor which creates an empty ResourceImage object.
*
* Use ResourceImage::New(...) to create an initialised object.
+ * @SINCE_1_0.0
*/
ResourceImage();
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~ResourceImage();
/**
* @brief This copy constructor is required for (smart) pointer semantics.
*
+ * @SINCE_1_0.0
* @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
* @return A reference to this
*/
* 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.
* @return A handle to a newly allocated object
static ResourceImage New( const std::string& url, bool orientationCorrection = true );
/**
- * @brief Create an initialised ResourceImage object.
+ * @DEPRECATED_1_1.3. Use New( const std::string& url ) instead.
*
- * @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.
/**
* @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.
bool orientationCorrection = true );
/**
- * @brief Create an initialised ResourceImage object.
+ * @DEPRECATED_1_1.3. Use New( const std::string& url, ImageDimensions size ) instead.
*
- * @deprecated DALi 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.
*
* 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
*/
static ResourceImage DownCast( BaseHandle handle );
/**
+ * @DEPRECATED_1_1.3
+ *
* @brief Return load policy.
- * @deprecated DALi 1.1.3
*
+ * @SINCE_1_0.0
* @return resource load policy
*/
LoadPolicy GetLoadPolicy() const;
*
* 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.
*/
LoadingState GetLoadingState() const;
/**
* @brief Returns the URL of the image.
*
+ * @SINCE_1_0.0
* @return The URL of the image file.
*/
std::string GetUrl() const;
*
* 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.
*/
/**
* @brief Emitted when the image data loads successfully, or when the loading fails.
*
+ * @SINCE_1_0.0
* @return A signal object to Connect() with.
*/
ResourceImageSignal& LoadingFinishedSignal();