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

   1 #ifndef __DALI_NATIVE_IMAGE_H__
   2 #define __DALI_NATIVE_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 // INTERNAL INCLUDES
  22 #include <dali/public-api/images/image.h>
  23 #include <dali/public-api/images/native-image-interface.h>
  24
  25 namespace Dali
  26 {
  27 /**
  28  * @addtogroup dali-core-images
  29  * @{
  30  */
  31
  32 namespace Internal DALI_INTERNAL
  33 {
  34 class NativeImage;
  35 }
  36
  37 /**
  38  * @brief NativeImage represents an image resource that can be added to ImageActors.
  39  * Its data is provided by native resources, such as shared bitmap memory or pixmap from X11 or ECORE-X11, etc.
  40  */
  41 class DALI_IMPORT_API  NativeImage : public Image
  42 {
  43 public:
  44
  45   /**
  46    * @brief Constructor with creates an uninitialized NativeImage object.
  47    *
  48    * Use NativeImage::New(...) to create an initialised object.
  49    */
  50   NativeImage();
  51
  52   /**
  53    * @brief Destructor.
  54    *
  55    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  56    */
  57    ~NativeImage();
  58
  59    /**
  60     * @brief This copy constructor is required for (smart) pointer semantics.
  61     *
  62     * @param [in] handle A reference to the copied handle
  63     */
  64    NativeImage( const NativeImage& handle );
  65
  66   /**
  67    * @brief This assignment operator is required for (smart) pointer semantics.
  68    *
  69    * @param[in] rhs A reference to the copied handle.
  70    * @return A reference to this.
  71    */
  72   NativeImage& operator=( const NativeImage& rhs );
  73
  74   /**
  75    * @brief Trigger asynchronous creation of backing GL texture immediately.
  76    *
  77    * The normal policy is for a GL texture to created lazily when needed.
  78    * This function forces the allocation of a texture to happen at the earliest
  79    * opportunity.
  80    *
  81    * @note If the application loses its GL context, native images may lose their
  82    * GL textures. This function can be called again after context regain to force
  83    * the creation of the GL texture if still needed.
  84    */
  85   void CreateGlTexture();
  86
  87   /**
  88    * @brief Create a new NativeImage, which used native resources.
  89    *
  90    * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE
  91    * @param [in] nativeImageInterface An reference to the object of the interface implementation.
  92    * @return A handle to a newly allocated object.
  93    */
  94   static NativeImage New( NativeImageInterface& nativeImageInterface );
  95
  96   /**
  97    * @brief Downcast an Object handle to NativeImage handle.
  98    *
  99    * If handle points to a NativeImage object, the downcast produces valid handle.
 100    * If not, the returned handle is left unintialized.
 101    * @param[in] handle Handle to an object.
 102    * @return handle to a NativeImage or an uninitialized handle.
 103    */
 104   static NativeImage DownCast( BaseHandle handle );
 105
 106 public: // Not intended for application developers
 107
 108   explicit DALI_INTERNAL NativeImage( Internal::NativeImage* );
 109
 110 };
 111
 112 /**
 113  * @}
 114  */
 115 } // namespace Dali
 116
 117 #endif // __DALI_NATIVE_IMAGE_H__