adaptors/public-api/adaptor-framework/pixmap-image.h

   1 #ifndef __DALI_PIXMAP_IMAGE_H__
   2 #define __DALI_PIXMAP_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 // EXTERNAL INCLUDES
  22 #include <string>
  23
  24 #include <dali/public-api/common/vector-wrapper.h>
  25 #include <dali/public-api/images/native-image-interface.h>
  26 #include <dali/public-api/images/pixel.h>
  27 #include <dali/public-api/object/any.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 PixmapImage;
  41 }
  42 }
  43
  44 class PixmapImage;
  45 /**
  46  * @brief Pointer to Dali::PixmapImage.
  47  */
  48 typedef IntrusivePtr<PixmapImage> PixmapImagePtr;
  49
  50 /**
  51  * @brief Used for displaying native Pixmap images.
  52  *
  53  * The native pixmap can be created internally or
  54  * externally by X11 or ECORE-X11.
  55  *
  56  * @since DALi 1.1.4
  57  */
  58 class DALI_IMPORT_API PixmapImage : public NativeImageInterface
  59 {
  60 public:
  61
  62    /**
  63     * @brief When creating a pixmap the color depth has to be specified.
  64     */
  65    enum ColorDepth
  66    {
  67      COLOR_DEPTH_DEFAULT,     ///< Uses the current X screen default depth (recommended)
  68      COLOR_DEPTH_8,           ///< 8 bits per pixel
  69      COLOR_DEPTH_16,          ///< 16 bits per pixel
  70      COLOR_DEPTH_24,          ///< 24 bits per pixel
  71      COLOR_DEPTH_32           ///< 32 bits per pixel
  72    };
  73
  74   /**
  75    * @brief Create a new PixmapImage.
  76    *
  77    * Depending on hardware the width and height may have to be a power of two.
  78    * @param[in] width The width of the image.
  79    * @param[in] height The height of the image.
  80    * @param[in] depth color depth of the pixmap
  81    * @return A smart-pointer to a newly allocated image.
  82    */
  83   static PixmapImagePtr New( unsigned int width, unsigned int height, ColorDepth depth );
  84
  85   /**
  86    * @brief Create a new PixmapImage from an existing pixmap.
  87    *
  88    * @param[in] pixmap must be a X11 pixmap or a Ecore_X_Pixmap
  89    * @return A smart-pointer to a newly allocated image.
  90    */
  91   static PixmapImagePtr New( Any pixmap );
  92
  93   /**
  94    * @brief Retrieve the internal pixmap
  95    *
  96    * @return pixmap any object containing the internal pixmap
  97    */
  98   Any GetPixmap();
  99
 100   /**
 101    * @brief Get a copy of the pixels used by PixmapImage.
 102    *
 103    * This is only supported for 24 bit RGB and 32 bit RGBA internal formats
 104    * (COLOR_DEPTH_24 and COLOR_DEPTH_32).
 105    * @param[out] pixbuf a vector to store the pixels in
 106    * @param[out] width  width of image
 107    * @param[out] height height of image
 108    * @param[out] pixelFormat pixel format used by image
 109    * @return     True if the pixels were gotten, and false otherwise.
 110    */
 111   bool GetPixels( std::vector<unsigned char>& pixbuf, unsigned int& width, unsigned int& height, Pixel::Format& pixelFormat ) const;
 112
 113   /**
 114    * @brief Convert the current pixel contents to either a JPEG or PNG format
 115    * and write that to the filesytem.
 116    *
 117    * @param[in] filename Identify the filesytem location at which to write the
 118    *                     encoded image. The extension determines the encoding used.
 119    *                     The two valid encoding are (".jpeg"|".jpg") and ".png".
 120    * @return    True if the pixels were written, and false otherwise.
 121    */
 122   bool EncodeToFile(const std::string& filename) const;
 123
 124 private:   // native image
 125
 126   /**
 127    * @copydoc Dali::NativeImageInterface::GlExtensionCreate()
 128    */
 129   virtual bool GlExtensionCreate();
 130
 131   /**
 132    * @copydoc Dali::NativeImageInterface::GlExtensionDestroy()
 133    */
 134   virtual void GlExtensionDestroy();
 135
 136   /**
 137    * @copydoc Dali::NativeImageInterface::TargetTexture()
 138    */
 139   virtual unsigned int TargetTexture();
 140
 141   /**
 142    * @copydoc Dali::NativeImageInterface::PrepareTexture()
 143    */
 144   virtual void PrepareTexture();
 145
 146   /**
 147    * @copydoc Dali::NativeImageInterface::GetWidth()
 148    */
 149   virtual unsigned int GetWidth() const;
 150
 151   /**
 152    * @copydoc Dali::NativeImageInterface::GetHeight()
 153    */
 154   virtual unsigned int GetHeight() const;
 155
 156   /**
 157    * @copydoc Dali::NativeImageInterface::RequiresBlending()
 158    */
 159   virtual bool RequiresBlending() const;
 160
 161 private:
 162
 163   /**
 164    * @brief Private constructor
 165    * @param[in] width The width of the image.
 166    * @param[in] height The height of the image.
 167    * @param[in] depth color depth of the pixmap
 168    * @param[in] pixmap contains either: pixmap of type X11 Pixmap , a Ecore_X_Pixmap or is empty
 169    */
 170   DALI_INTERNAL PixmapImage( unsigned int width, unsigned int height, ColorDepth depth, Any pixmap );
 171
 172   /**
 173    * @brief A reference counted object may only be deleted by calling Unreference().
 174    *
 175    * The implementation should destroy the NativeImage resources.
 176    */
 177   DALI_INTERNAL virtual ~PixmapImage();
 178
 179   /**
 180    * @brief Undefined copy constructor
 181    *
 182    * This avoids accidental calls to a default copy constructor.
 183    * @param[in] pixmapImage A reference to the object to copy.
 184    */
 185   DALI_INTERNAL PixmapImage( const PixmapImage& pixmapImage );
 186
 187   /**
 188    * @brief Undefined assignment operator.
 189    *
 190    * This avoids accidental calls to a default assignment operator.
 191    * @param[in] rhs A reference to the object to copy.
 192    */
 193   DALI_INTERNAL PixmapImage& operator=(const PixmapImage& rhs);
 194
 195 private:
 196
 197   Internal::Adaptor::PixmapImage* mImpl; ///< Implementation pointer
 198 };
 199
 200 /**
 201  * @}
 202  */
 203 } // namespace Dali
 204
 205 #endif // __DALI_PIXMAP_IMAGE_H__