dali/public-api/images/image.h

   1 #ifndef __DALI_IMAGE_H__
   2 #define __DALI_IMAGE_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <string>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/object/base-handle.h>
  26 #include <dali/public-api/signals/dali-signal.h>
  27
  28 namespace Dali
  29 {
  30 /**
  31  * @addtogroup dali_core_images
  32  * @{
  33  */
  34
  35 namespace Internal DALI_INTERNAL
  36 {
  37 class Image;
  38 }
  39
  40 /**
  41  * @brief An Image object represents an image resource that can be used for rendering
  42  *
  43  * Image objects can be shared between Actors. This is practical if you have a visual element on screen
  44  * which is repeatedly used.
  45  *
  46  * Image objects are responsible for the underlying resource's lifetime.
  47  * Note: if a resource was shared between Image objects it exists until its last reference is gone.
  48  *
  49  * Signals
  50  * | %Signal Name           | Method                       |
  51  * |------------------------|------------------------------|
  52  * | uploaded               | @ref UploadedSignal()        |
  53  */
  54 class DALI_IMPORT_API Image : public BaseHandle
  55 {
  56 public:
  57
  58   /**
  59    * @brief ReleasePolicy controls the way images are deleted from memory.
  60    * @deprecated DALi 1.1.3 Image resource is relased as soon as last handle is released
  61    */
  62   enum ReleasePolicy
  63   {
  64     UNUSED, ///< release resource once image is not in use anymore (eg. all actors using it become offstage). Reload when resource is required again.
  65     NEVER   ///< keep image data for the lifetime of the object. (default)
  66   };
  67
  68   /**
  69    * @brief Type of signal for Image Uploaded.
  70    */
  71   typedef Signal< void (Image) > ImageSignalType;
  72
  73 public:
  74
  75   /**
  76    * @brief Constructor which creates an empty Image handle.
  77    *
  78    * Use Image::New(...) to create an initialised handle.
  79    */
  80   Image();
  81
  82   /**
  83    * @brief Destructor
  84    *
  85    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  86    */
  87   ~Image();
  88
  89   /**
  90    * @brief This copy constructor is required for (smart) pointer semantics.
  91    *
  92    * @param [in] handle A reference to the copied handle
  93    */
  94   Image(const Image& handle);
  95
  96   /**
  97    * @brief This assignment operator is required for (smart) pointer semantics.
  98    *
  99    * @param [in] rhs  A reference to the copied handle
 100    * @return A reference to this
 101    */
 102   Image& operator=(const Image& rhs);
 103
 104   /**
 105    * @brief Downcast an Object handle to Image handle.
 106    *
 107    * If handle points to a Image object the
 108    * downcast produces valid handle. If not the returned handle is left uninitialized.
 109    * @param[in] handle to An object
 110    * @return handle to a Image object or an uninitialized handle
 111    */
 112   static Image DownCast( BaseHandle handle );
 113
 114   /**
 115    * @brief Return resource release policy.
 116    * @deprecated DALi 1.1.3
 117    *
 118    * @return resource release policy
 119    */
 120   ReleasePolicy GetReleasePolicy() const;
 121
 122   /**
 123    * @brief Returns the width of the image.
 124    *
 125    * Returns either the requested width or the actual loaded width if no specific size was requested.
 126    *
 127    * @return width of the image in pixels.
 128    */
 129   unsigned int GetWidth() const;
 130
 131   /**
 132    * @brief Returns the height of the image.
 133    *
 134    * Returns either the requested height or the actual loaded height if no specific size was requested.
 135    *
 136    * @return height of the image in pixels.
 137    */
 138   unsigned int GetHeight() const;
 139
 140 public: // Signals
 141
 142   /**
 143    * @brief This signal is emitted when the image data gets uploaded to GL.
 144    *
 145    * It Will be sent after an actor using the image is added to
 146    * the stage, when such a staged image is reloaded, or when a staged
 147    * BufferImage calls Update().
 148    * @return A signal object to Connect() with.
 149    */
 150   ImageSignalType& UploadedSignal();
 151
 152 public: // Not intended for application developers
 153
 154   explicit DALI_INTERNAL Image(Internal::Image*);
 155 };
 156
 157 /**
 158  * @}
 159  */
 160 } // namespace Dali
 161
 162 #endif // __DALI_IMAGE_H__