dali/public-api/images/native-image-interface.h

   1 #ifndef DALI_INTEGRATION_NATIVE_IMAGE_INTERFACE_H
   2 #define DALI_INTEGRATION_NATIVE_IMAGE_INTERFACE_H
   3
   4 /*
   5  * Copyright (c) 2019 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 <cstddef>
  23 #include <cstdint> // uint32_t
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/object/ref-object.h>
  27
  28 namespace Dali
  29 {
  30 /**
  31  * @addtogroup dali_core_images
  32  * @{
  33  */
  34
  35 /**
  36  * @brief Abstract interface to provide platform-specific support for handling image data.
  37  *
  38  * For example, an implementation could use EGL extensions, etc.
  39  * @SINCE_1_0.0
  40  */
  41 class NativeImageInterface : public Dali::RefObject
  42 {
  43 public:
  44
  45   class Extension; ///< Forward declare future extension interface
  46
  47   /**
  48    * @brief Creates the GL resource for the NativeImage.
  49    *
  50    * e.g. For the EglImageKHR extension, this corresponds to calling eglCreateImageKHR().
  51    * @SINCE_1_0.0
  52    * @return false If the initialization fails
  53    * @pre There is a GL context for the current thread.
  54    */
  55   virtual bool GlExtensionCreate() = 0;
  56
  57   /**
  58    * @brief Destroys the GL resource for the NativeImage.
  59    *
  60    * e.g. For the EglImageKHR extension, this corresponds to calling eglDestroyImageKHR().
  61    * @SINCE_1_0.0
  62    * @pre There is a GL context for the current thread.
  63    */
  64   virtual void GlExtensionDestroy() = 0;
  65
  66   /**
  67    * @brief Uses the NativeImage as a texture for rendering.
  68    *
  69    * @SINCE_1_0.0
  70    * @return A GL error code
  71    * @pre There is a GL context for the current thread.
  72    */
  73   virtual uint32_t TargetTexture() = 0;
  74
  75   /**
  76    * @brief Called internally for each Bind call for this texture to allow implementation specific operations.
  77    *
  78    * The correct texture sampler has already been bound before the function gets called.
  79    * @SINCE_1_0.0
  80    * @pre glAbstraction is being used by context in current thread
  81    */
  82   virtual void PrepareTexture() = 0;
  83
  84   /**
  85    * @brief Returns the width of the NativeImage.
  86    *
  87    * @SINCE_1_0.0
  88    * @return Width
  89    */
  90   virtual uint32_t GetWidth() const = 0;
  91
  92   /**
  93    * @brief Returns the height of the NativeImage.
  94    *
  95    * @SINCE_1_0.0
  96    * @return Height
  97    */
  98   virtual uint32_t GetHeight() const = 0;
  99
 100  /**
 101   * @brief Queries whether blending is required.
 102   * @SINCE_1_0.0
 103   * @return True if blending is required
 104   */
 105   virtual bool RequiresBlending() const = 0;
 106
 107   /**
 108    * @brief Retrieves the extension for the interface.
 109    *
 110    * @SINCE_1_0.0
 111    * @return The extension if available, NULL otherwise
 112    */
 113   virtual Extension* GetExtension()
 114   {
 115     return NULL;
 116   }
 117
 118 protected:
 119
 120   /**
 121    * @brief A reference counted object may only be deleted by calling Unreference().
 122    *
 123    * The implementation should destroy the NativeImage resources.
 124    * @SINCE_1_0.0
 125    */
 126   virtual ~NativeImageInterface()
 127   {
 128   }
 129
 130 };
 131
 132 /**
 133  * @brief Pointer to Dali::NativeImageInterface.
 134  * @SINCE_1_0.0
 135  */
 136 typedef Dali::IntrusivePtr<NativeImageInterface>  NativeImageInterfacePtr;
 137
 138 /**
 139  * @}
 140  */
 141 } // namespace Dali
 142
 143 #endif // DALI_INTEGRATION_NATIVE_IMAGE_INTERFACE_H