dali/devel-api/adaptor-framework/native-image-source-queue.h

   1 #ifndef DALI_NATIVE_IMAGE_SOURCE_QUEUE_H
   2 #define DALI_NATIVE_IMAGE_SOURCE_QUEUE_H
   3
   4 /*
   5  * Copyright (c) 2018 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 <dali/public-api/images/native-image-interface.h>
  23 #include <dali/public-api/object/any.h>
  24 #include <memory>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali/public-api/dali-adaptor-common.h>
  28
  29 namespace Dali
  30 {
  31 /**
  32  * @addtogroup dali_adaptor_framework
  33  * @{
  34  */
  35
  36 namespace Internal DALI_INTERNAL
  37 {
  38 namespace Adaptor
  39 {
  40 class NativeImageSourceQueue;
  41 }
  42 }
  43
  44 class NativeImageSourceQueue;
  45
  46 /**
  47  * @brief Pointer to Dali::NativeImageSourceQueue.
  48  */
  49 typedef Dali::IntrusivePtr< Dali::NativeImageSourceQueue > NativeImageSourceQueuePtr;
  50
  51 /**
  52  * @brief Used for displaying native images.
  53  *
  54  * NativeImage is a platform specific way of providing pixel data to the GPU for rendering,for example via an EGL image.
  55  * NativeImageSourceQueue can be created internally or externally by native image source.
  56  * It has a queue which handles some image buffers.
  57  * Someone should fill the buffers and enqueue them, then DALi will show them.
  58  */
  59 class DALI_ADAPTOR_API NativeImageSourceQueue : public NativeImageInterface
  60 {
  61 public:
  62
  63    /**
  64     * @brief Enumeration for the instance when creating a native image, the color depth has to be specified.
  65     */
  66    enum ColorDepth
  67    {
  68      COLOR_DEPTH_DEFAULT,     ///< Uses the current screen default depth (recommended)
  69      COLOR_DEPTH_24,          ///< 24 bits per pixel
  70      COLOR_DEPTH_32           ///< 32 bits per pixel
  71    };
  72
  73   /**
  74    * @brief Creates a new NativeImageSourceQueue.
  75    *        Depending on hardware, the width and height may have to be a power of two.
  76    * @param[in] width The width of the image
  77    * @param[in] height The height of the image
  78    * @param[in] depth color depth of the image
  79    * @return A smart-pointer to a newly allocated image
  80    */
  81   static NativeImageSourceQueuePtr New( uint32_t width, uint32_t height, ColorDepth depth );
  82
  83   /**
  84    * @brief Creates a new NativeImageSourceQueue from an existing native image source.
  85    *
  86    * @param[in] nativeImageSourceQueue NativeImageSourceQueue must be a any handle with native image source
  87    * @return A smart-pointer to a newly allocated image
  88    * @see NativeImageInterface
  89    */
  90   static NativeImageSourceQueuePtr New( Any nativeImageSourceQueue );
  91
  92   /**
  93    * @brief Retrieves the internal native image.
  94    *
  95    * @return Any object containing the internal native image source queue
  96    */
  97   Any GetNativeImageSourceQueue();
  98
  99   /**
 100    * @brief Sets the size of the image.
 101    *
 102    * @param[in] width The width of the image
 103    * @param[in] height The height of the image
 104    */
 105   void SetSize( uint32_t width, uint32_t height );
 106
 107   /**
 108    * @brief Ignores a source image which is inserted to the queue.
 109    *
 110    * @note This can be called from worker threads.
 111    */
 112   void IgnoreSourceImage();
 113
 114 private:   // native image
 115
 116   /**
 117    * @copydoc Dali::NativeImageInterface::GlExtensionCreate()
 118    */
 119   virtual bool GlExtensionCreate();
 120
 121   /**
 122    * @copydoc Dali::NativeImageInterface::GlExtensionDestroy()
 123    */
 124   virtual void GlExtensionDestroy();
 125
 126   /**
 127    * @copydoc Dali::NativeImageInterface::TargetTexture()
 128    */
 129   virtual uint32_t TargetTexture();
 130
 131   /**
 132    * @copydoc Dali::NativeImageInterface::PrepareTexture()
 133    */
 134   virtual void PrepareTexture();
 135
 136   /**
 137    * @copydoc Dali::NativeImageInterface::GetWidth()
 138    */
 139   virtual uint32_t GetWidth() const;
 140
 141   /**
 142    * @copydoc Dali::NativeImageInterface::GetHeight()
 143    */
 144   virtual uint32_t GetHeight() const;
 145
 146   /**
 147    * @copydoc Dali::NativeImageInterface::RequiresBlending()
 148    */
 149   virtual bool RequiresBlending() const;
 150
 151   /**
 152    * @copydoc Dali::NativeImageInterface::GetExtension()
 153    */
 154   NativeImageInterface::Extension* GetExtension();
 155
 156 private:
 157
 158   /// @cond internal
 159   /**
 160    * @brief Private constructor.
 161    * @param[in] width The width of the image
 162    * @param[in] height The height of the image
 163    * @param[in] depth color depth of the image
 164    * @param[in] nativeImageSourceQueue contains either: native image source or is empty
 165    */
 166   DALI_INTERNAL NativeImageSourceQueue( uint32_t width, uint32_t height, ColorDepth depth, Any nativeImageSourceQueue );
 167
 168   /**
 169    * @brief A reference counted object may only be deleted by calling Unreference().
 170    *
 171    * The implementation should destroy the NativeImage resources.
 172    */
 173   DALI_INTERNAL virtual ~NativeImageSourceQueue();
 174
 175   /**
 176    * @brief Undefined copy constructor.
 177    *
 178    * This avoids accidental calls to a default copy constructor.
 179    * @param[in] nativeImageSourceQueue A reference to the object to copy
 180    */
 181   DALI_INTERNAL NativeImageSourceQueue( const NativeImageSourceQueue& nativeImageSourceQueue );
 182
 183   /**
 184    * @brief Undefined assignment operator.
 185    *
 186    * This avoids accidental calls to a default assignment operator.
 187    * @param[in] rhs A reference to the object to copy
 188    */
 189   DALI_INTERNAL NativeImageSourceQueue& operator=(const NativeImageSourceQueue& rhs);
 190   /// @endcond
 191
 192 private:
 193
 194   /// @cond internal
 195   std::unique_ptr< Internal::Adaptor::NativeImageSourceQueue > mImpl; ///< Implementation pointer
 196   /// @endcond
 197 };
 198
 199 /**
 200  * @}
 201  */
 202 } // namespace Dali
 203
 204 #endif // DALI_NATIVE_IMAGE_SOURCE_QUEUE_H