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  * NativeImageSource can be created internally or externally by native image source.
  55  * NativeImage is a platform specific way of providing pixel data to the GPU for rendering,for example via an EGL image.
  56  */
  57 class DALI_ADAPTOR_API NativeImageSourceQueue : public NativeImageInterface
  58 {
  59 public:
  60
  61    /**
  62     * @brief Enumeration for the instance when creating a native image, the color depth has to be specified.
  63     */
  64    enum ColorDepth
  65    {
  66      COLOR_DEPTH_DEFAULT,     ///< Uses the current screen default depth (recommended)
  67      COLOR_DEPTH_24,          ///< 24 bits per pixel
  68      COLOR_DEPTH_32           ///< 32 bits per pixel
  69    };
  70
  71   /**
  72    * @brief Creates a new NativeImageSourceQueue.
  73    *        Depending on hardware, the width and height may have to be a power of two.
  74    * @param[in] width The width of the image
  75    * @param[in] height The height of the image
  76    * @param[in] depth color depth of the image
  77    * @return A smart-pointer to a newly allocated image
  78    */
  79   static NativeImageSourceQueuePtr New( unsigned int width, unsigned int height, ColorDepth depth );
  80
  81   /**
  82    * @brief Creates a new NativeImageSourceQueue from an existing native image source.
  83    *
  84    * @param[in] nativeImageSourceQueue NativeImageSourceQueue must be a any handle with native image source
  85    * @return A smart-pointer to a newly allocated image
  86    * @see NativeImageInterface
  87    */
  88   static NativeImageSourceQueuePtr New( Any nativeImageSourceQueue );
  89
  90   /**
  91    * @brief Retrieves the internal native image.
  92    *
  93    * @return Any object containing the internal native image source queue
  94    */
  95   Any GetNativeImageSourceQueue();
  96
  97   /**
  98    * @brief Sets an existing source.
  99    *
 100    * @param[in] source Any handle with the source
 101    */
 102   void SetSource( Any source );
 103
 104 private:   // native image
 105
 106   /**
 107    * @copydoc Dali::NativeImageInterface::GlExtensionCreate()
 108    */
 109   virtual bool GlExtensionCreate();
 110
 111   /**
 112    * @copydoc Dali::NativeImageInterface::GlExtensionDestroy()
 113    */
 114   virtual void GlExtensionDestroy();
 115
 116   /**
 117    * @copydoc Dali::NativeImageInterface::TargetTexture()
 118    */
 119   virtual unsigned int TargetTexture();
 120
 121   /**
 122    * @copydoc Dali::NativeImageInterface::PrepareTexture()
 123    */
 124   virtual void PrepareTexture();
 125
 126   /**
 127    * @copydoc Dali::NativeImageInterface::GetWidth()
 128    */
 129   virtual unsigned int GetWidth() const;
 130
 131   /**
 132    * @copydoc Dali::NativeImageInterface::GetHeight()
 133    */
 134   virtual unsigned int GetHeight() const;
 135
 136   /**
 137    * @copydoc Dali::NativeImageInterface::RequiresBlending()
 138    */
 139   virtual bool RequiresBlending() const;
 140
 141   /**
 142    * @copydoc Dali::NativeImageInterface::GetExtension()
 143    */
 144   NativeImageInterface::Extension* GetExtension();
 145
 146 private:
 147
 148   /// @cond internal
 149   /**
 150    * @brief Private constructor.
 151    * @param[in] width The width of the image
 152    * @param[in] height The height of the image
 153    * @param[in] depth color depth of the image
 154    * @param[in] nativeImageSourceQueue contains either: native image source or is empty
 155    */
 156   DALI_INTERNAL NativeImageSourceQueue( unsigned int width, unsigned int height, ColorDepth depth, Any nativeImageSourceQueue );
 157
 158   /**
 159    * @brief A reference counted object may only be deleted by calling Unreference().
 160    *
 161    * The implementation should destroy the NativeImage resources.
 162    */
 163   DALI_INTERNAL virtual ~NativeImageSourceQueue();
 164
 165   /**
 166    * @brief Undefined copy constructor.
 167    *
 168    * This avoids accidental calls to a default copy constructor.
 169    * @param[in] nativeImageSourceQueue A reference to the object to copy
 170    */
 171   DALI_INTERNAL NativeImageSourceQueue( const NativeImageSourceQueue& nativeImageSourceQueue );
 172
 173   /**
 174    * @brief Undefined assignment operator.
 175    *
 176    * This avoids accidental calls to a default assignment operator.
 177    * @param[in] rhs A reference to the object to copy
 178    */
 179   DALI_INTERNAL NativeImageSourceQueue& operator=(const NativeImageSourceQueue& rhs);
 180   /// @endcond
 181
 182 private:
 183
 184   /// @cond internal
 185   std::unique_ptr< Internal::Adaptor::NativeImageSourceQueue > mImpl; ///< Implementation pointer
 186   /// @endcond
 187 };
 188
 189 /**
 190  * @}
 191  */
 192 } // namespace Dali
 193
 194 #endif // DALI_NATIVE_IMAGE_SOURCE_QUEUE_H