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 added to ImageActors.
  42  *
  43  * Image objects can be shared between ImageActors. This is practical if you have a visual element on screen
  44  * which is repeatedly used. An example would be a button background image.
  45  * The image resource is discarded when all ImageActors using the Image object are discarded or in case they
  46  * were created with ReleasePolicy::Unused, taken off stage.
  47  * Note: if a resource was shared between Image objects it exists until its last reference is gone.
  48  *
  49  * Image objects are responsible for the underlying resource's lifetime.
  50  *
  51  * <i>ReleasePolicies</i>
  52  * - Unused: release resource once ImageActor using it is taken off stage.
  53  * - Never: keep resource alive until Image object is thrown away.
  54  *
  55  * <i>Resolution of conflicting policies</i>
  56  * If the same image is created more than once with conflicting policies, ReleasePolicy "Never" overrides "Unused".
  57  *
  58  * Signals
  59  * | %Signal Name           | Method                       |
  60  * |------------------------|------------------------------|
  61  * | uploaded               | @ref UploadedSignal()        |
  62  */
  63 class DALI_IMPORT_API Image : public BaseHandle
  64 {
  65 public:
  66   /**
  67    * @brief Resource management options.
  68    */
  69
  70   /**
  71    * @brief ReleasePolicy controls the way images are deleted from memory.
  72    */
  73   enum ReleasePolicy
  74   {
  75     UNUSED, ///< release resource once image is not in use anymore (eg. all actors using it become offstage). Reload when resource is required again.
  76     NEVER   ///< keep image data for the lifetime of the object. (default)
  77   };
  78
  79   /**
  80    * @brief Type of signal for Image Uploaded.
  81    */
  82   typedef Signal< void (Image) > ImageSignalType;
  83
  84 public:
  85
  86   /**
  87    * @brief Constructor which creates an empty Image handle.
  88    *
  89    * Use Image::New(...) to create an initialised handle.
  90    */
  91   Image();
  92
  93   /**
  94    * @brief Destructor
  95    *
  96    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  97    */
  98   ~Image();
  99
 100   /**
 101    * @brief This copy constructor is required for (smart) pointer semantics.
 102    *
 103    * @param [in] handle A reference to the copied handle
 104    */
 105   Image(const Image& handle);
 106
 107   /**
 108    * @brief This assignment operator is required for (smart) pointer semantics.
 109    *
 110    * @param [in] rhs  A reference to the copied handle
 111    * @return A reference to this
 112    */
 113   Image& operator=(const Image& rhs);
 114
 115   /**
 116    * @brief Downcast an Object handle to Image handle.
 117    *
 118    * If handle points to a Image object the
 119    * downcast produces valid handle. If not the returned handle is left uninitialized.
 120    * @param[in] handle to An object
 121    * @return handle to a Image object or an uninitialized handle
 122    */
 123   static Image DownCast( BaseHandle handle );
 124
 125   /**
 126    * @brief Return resource release policy.
 127    *
 128    * @return resource release policy
 129    */
 130   ReleasePolicy GetReleasePolicy() const;
 131
 132   /**
 133    * @brief Returns the width of the image.
 134    *
 135    * Returns either the requested width or the actual loaded width if no specific size was requested.
 136    *
 137    * @return width of the image in pixels.
 138    */
 139   unsigned int GetWidth() const;
 140
 141   /**
 142    * @brief Returns the height of the image.
 143    *
 144    * Returns either the requested height or the actual loaded height if no specific size was requested.
 145    *
 146    * @return height of the image in pixels.
 147    */
 148   unsigned int GetHeight() const;
 149
 150 public: // Signals
 151
 152   /**
 153    * @brief This signal is emitted when the image data gets uploaded to GL.
 154    *
 155    * It Will be sent after an actor using the image is added to
 156    * the stage, when such a staged image is reloaded, or when a staged
 157    * BufferImage calls Update().
 158    * @return A signal object to Connect() with.
 159    */
 160   ImageSignalType& UploadedSignal();
 161
 162 public: // Not intended for application developers
 163
 164   explicit DALI_INTERNAL Image(Internal::Image*);
 165 };
 166
 167 /**
 168  * @}
 169  */
 170 } // namespace Dali
 171
 172 #endif // __DALI_IMAGE_H__