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 a platform specific image resource.
  39  *
  40  * Its data is provided by native resources, such as shared bitmap memory or pixmap.
  41  * @SINCE_1_0.0
  42  */
  43 class DALI_IMPORT_API  NativeImage : public Image
  44 {
  45 public:
  46
  47   /**
  48    * @brief Constructor with creates an uninitialized NativeImage object.
  49    *
  50    * Use NativeImage::New(...) to create an initialised object.
  51    * @SINCE_1_0.0
  52    */
  53   NativeImage();
  54
  55   /**
  56    * @brief Destructor.
  57    *
  58    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  59    * @SINCE_1_0.0
  60    */
  61    ~NativeImage();
  62
  63    /**
  64     * @brief This copy constructor is required for (smart) pointer semantics.
  65     *
  66     * @SINCE_1_0.0
  67     * @param[in] handle A reference to the copied handle
  68     */
  69    NativeImage( const NativeImage& handle );
  70
  71   /**
  72    * @brief This assignment operator is required for (smart) pointer semantics.
  73    *
  74    * @SINCE_1_0.0
  75    * @param[in] rhs A reference to the copied handle
  76    * @return A reference to this
  77    */
  78   NativeImage& operator=( const NativeImage& rhs );
  79
  80   /**
  81    * @brief Triggers asynchronous creation of backing GL texture immediately.
  82    *
  83    * The normal policy is for a GL texture to created lazily when needed.
  84    * This function forces the allocation of a texture to happen at the earliest
  85    * opportunity.
  86    *
  87    * @SINCE_1_0.0
  88    * @note If the application loses its GL context, native images may lose their
  89    * GL textures. This function can be called again after context regain to force
  90    * the creation of the GL texture if still needed.
  91    */
  92   void CreateGlTexture();
  93
  94   /**
  95    * @brief Creates a new NativeImage, which used native resources.
  96    *
  97    * The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE
  98    * @SINCE_1_0.0
  99    * @param[in] nativeImageInterface An reference to the object of the interface implementation
 100    * @return A handle to a newly allocated object
 101    */
 102   static NativeImage New( NativeImageInterface& nativeImageInterface );
 103
 104   /**
 105    * @brief Downcasts a handle to NativeImage handle.
 106    *
 107    * If handle points to a NativeImage object, the downcast produces valid handle.
 108    * If not, the returned handle is left uninitialized.
 109    * @SINCE_1_0.0
 110    * @param[in] handle Handle to an object
 111    * @return handle to a NativeImage or an uninitialized handle
 112    */
 113   static NativeImage DownCast( BaseHandle handle );
 114
 115   /**
 116    * @brief Gets custom fragment prefix for rendering a native image.
 117    *
 118    * @return String for custom fragment prefix
 119    */
 120   const char* GetCustomFragmentPreFix();
 121
 122   /**
 123    * @brief Gets custom sampler type name for rendering a native image.
 124    *
 125    * @return String for custom sampler type name
 126    */
 127   const char* GetCustomSamplerTypename();
 128
 129 public: // Not intended for application developers
 130
 131   explicit DALI_INTERNAL NativeImage( Internal::NativeImage* );
 132
 133 };
 134
 135 /**
 136  * @}
 137  */
 138 } // namespace Dali
 139
 140 #endif // __DALI_NATIVE_IMAGE_H__