Making DALi public API typesafe using guaranteed types; uint8_t, uint32_t

[platform/core/uifw/dali-core.git] / dali / public-api / images / image.h

diff --git a/dali/public-api/images/image.h b/dali/public-api/images/image.h
index 70d18e7..7c649a2 100644 (file)
--- a/dali/public-api/images/image.h
+++ b/dali/public-api/images/image.h
@@ -2,7 +2,7 @@
 #define __DALI_IMAGE_H__
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2018 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,6 +20,7 @@
 
 // EXTERNAL INCLUDES
 #include <string>
+#include <cstdint> // uint32_t
 
 // INTERNAL INCLUDES
 #include <dali/public-api/object/base-handle.h>
@@ -38,6 +39,8 @@ class Image;
 }
 
 /**
+ * @DEPRECATED_1_2.41
+ *
  * @brief An Image object represents an image resource that can be used for rendering.
  *
  * Image objects can be shared between Actors. This is practical if you have a visual element on screen
@@ -55,24 +58,13 @@ class Image;
  * | uploaded               | @ref UploadedSignal()        |
  * @SINCE_1_0.0
  */
-class DALI_IMPORT_API Image : public BaseHandle
+class DALI_CORE_API Image : public BaseHandle
 {
 public:
 
   /**
-   * @DEPRECATED_1_1.3. Image resource is released as soon as last handle is released.
-   * @brief ReleasePolicy controls the way images are deleted from 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 ReleasePolicy
-  {
-    UNUSED, ///< release resource once image is not in use anymore (eg. all actors using it become offstage). Reload when resource is required again. @SINCE_1_0.0
-    NEVER   ///< keep image data for the lifetime of the object. (default) @SINCE_1_0.0
-  };
-
-  /**
+   * @DEPRECATED_1_2.41
+   *
    * @brief Type of signal for Image Uploaded.
    * @SINCE_1_0.0
    */
@@ -81,93 +73,100 @@ public:
 public:
 
   /**
+   * @DEPRECATED_1_2.41
+   *
    * @brief Constructor which creates an empty Image handle.
    *
-   * Use the appropriate New method to create an initialized handle.
+   * This class has no New method.
+   * Use the appropriate New method of its subclasses to create an initialized handle.
+   * (Dali::BufferImage::New(), Dali::EncodedBufferImage::New(), Dali::FrameBufferImage::New(),
+   * Dali::NativeImage::New(), Dali::ResourceImage::New()).
    * @SINCE_1_0.0
    */
-  Image();
+  Image() DALI_DEPRECATED_API;
 
   /**
-   * @brief Destructor
+   * @DEPRECATED_1_2.41
+   *
+   * @brief Destructor.
    *
    * This is non-virtual since derived Handle types must not contain data or virtual methods.
    * @SINCE_1_0.0
    */
-  ~Image();
+  ~Image() DALI_DEPRECATED_API;
 
   /**
+   * @DEPRECATED_1_2.41
+   *
    * @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
    */
-  Image(const Image& handle);
+  Image(const Image& handle) DALI_DEPRECATED_API;
 
   /**
+   * @DEPRECATED_1_2.41
+   *
    * @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
    */
-  Image& operator=(const Image& rhs);
+  Image& operator=(const Image& rhs) DALI_DEPRECATED_API;
 
   /**
-   * @brief Downcast a handle to Image handle.
+   * @DEPRECATED_1_2.41
+   *
+   * @brief Downcasts a handle to Image handle.
    *
-   * If handle points to a Image object the
-   * downcast produces valid handle. If not the returned handle is left uninitialized.
+   * If handle points to a Image 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 Image DownCast( BaseHandle handle );
+  static Image DownCast( BaseHandle handle ) DALI_DEPRECATED_API;
 
   /**
-   * @DEPRECATED_1_1.3
-   *
-   * @brief Return resource release policy.
+   * @DEPRECATED_1_2.41
    *
-   * @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 release policy
-   */
-  ReleasePolicy GetReleasePolicy() const;
-
-  /**
    * @brief Returns the width of the image.
    *
    * Returns either the requested width or the actual loaded width if no specific size was requested.
    *
    * @SINCE_1_0.0
-   * @return Width of the image in pixels.
+   * @return Width of the image in pixels
    */
-  unsigned int GetWidth() const;
+  uint32_t GetWidth() const DALI_DEPRECATED_API;
 
   /**
+   * @DEPRECATED_1_2.41
+   *
    * @brief Returns the height of the image.
    *
    * Returns either the requested height or the actual loaded height if no specific size was requested.
    *
    * @SINCE_1_0.0
-   * @return Height of the image in pixels.
+   * @return Height of the image in pixels
    */
-  unsigned int GetHeight() const;
+  uint32_t GetHeight() const DALI_DEPRECATED_API;
 
 public: // Signals
 
   /**
+   * @DEPRECATED_1_2.41
+   *
    * @brief This signal is emitted when the image data gets uploaded to GL.
    *
    * It Will be sent after an actor using the image is added to
    * the stage, when such a staged image is reloaded, or when a staged
    * BufferImage calls Update().
    * @SINCE_1_0.0
-   * @return A signal object to Connect() with.
+   * @return A signal object to Connect() with
    */
-  ImageSignalType& UploadedSignal();
+  ImageSignalType& UploadedSignal() DALI_DEPRECATED_API;
 
 public: // Not intended for application developers