dali/public-api/images/image.h

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