Tizen 2.4.0 rev3 SDK Public Release

[framework/graphics/dali.git] / dali / public-api / images / encoded-buffer-image.h

diff --git a/dali/public-api/images/encoded-buffer-image.h b/dali/public-api/images/encoded-buffer-image.h
index 85354cd..1a060ec 100644 (file)
--- a/dali/public-api/images/encoded-buffer-image.h
+++ b/dali/public-api/images/encoded-buffer-image.h
@@ -38,7 +38,7 @@ namespace Internal DALI_INTERNAL
 class EncodedBufferImage;
 }
 
-typedef Uint16Pair ImageDimensions;
+typedef Uint16Pair ImageDimensions; ///< Image dimension type @since_tizen 2.4
 
 
 /**
@@ -60,9 +60,6 @@ typedef Uint16Pair ImageDimensions;
  *
  * <h3> Signals </h3>
  *
- * Image::LoadingFinishedSignal is emitted when the decoding of the
- * image data is completed, either successfully or not.
- *
  * Image::UploadedSignal is emitted when the decoded image data gets
  * uploaded to the OpenGL ES implementation.
  * @since_tizen 2.4
@@ -73,7 +70,7 @@ public:
   /**
    * @brief Constructor which creates an uninitialized EncodedBufferImage object.
    *
-   * Use Image::New(...) to create an initialised object.
+   * Use @ref Image::New to create an initialised object.
    * @since_tizen 2.4
    */
   EncodedBufferImage();
@@ -81,10 +78,10 @@ public:
   /**
    * @brief Create an initialised image object from an encoded image buffer in memory.
    *
-   * The image will be created eagerly using LoadPolicy::Immediate.
-   * The function is non-blocking and returns immediately while the image
-   * decoding happens on a background thread.
    * @since_tizen 2.4
+   * @remarks Image::ReleasePolicy is an experimental feature and might not be supported in the next release.
+   * We do recommend not to use this method.
+   * Please refer the remarks of ReleasePolicy for more information.
    * @param [in] encodedImage The encoded bytes of an image, in a supported
    * image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised
    * exactly as it would be as a file in the filesystem.
@@ -95,7 +92,7 @@ public:
    * @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] releasePol The ReleasePolicy to apply to Image. If the Unused
+   * @param [in] releasePol The releasePolicy to apply to Image. If the Image::UNUSED.
    * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
    * policy is set, a reload will not be possible, so the Image should never be
    * used once all actors using it have gone off-stage.
@@ -106,9 +103,6 @@ public:
   /**
    * @brief Create an initialised image object from an encoded image buffer in memory.
    *
-   * The image will be created eagerly using LoadPolicy::Immediate.
-   * The function is non-blocking and returns immediately while the image
-   * decoding happens on a background thread.
    * @since_tizen 2.4
    * @param [in] encodedImage The encoded bytes of an image, in a supported
    * image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised
@@ -122,13 +116,13 @@ public:
   static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount );
 
   /**
-   * @brief Downcast an Object handle to EncodedBufferImage.
+   * @brief Downcast a handle to EncodedBufferImage handle.
    *
    * If handle points to a EncodedBufferImage the
    * downcast produces valid handle. If not the returned handle is left uninitialized.
    * @since_tizen 2.4
-   * @param[in] handle to An object
-   * @return handle to a EncodedBufferImage or an uninitialized handle
+   * @param[in] handle Handle to an object
+   * @return Handle to a EncodedBufferImage or an uninitialized handle
    */
   static EncodedBufferImage DownCast( BaseHandle handle );