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