dali/devel-api/adaptor-framework/vector-image-renderer.h

   1 #ifndef DALI_VECTOR_IMAGE_RENDERER_H
   2 #define DALI_VECTOR_IMAGE_RENDERER_H
   3
   4 /*
   5  * Copyright (c) 2020 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/object/base-handle.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/dali-adaptor-common.h>
  26 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
  27
  28 namespace Dali
  29 {
  30 /**
  31  * @addtogroup dali_adaptor_framework
  32  * @{
  33  */
  34
  35 namespace Internal DALI_INTERNAL
  36 {
  37 namespace Adaptor
  38 {
  39 class VectorImageRenderer;
  40 }
  41 }
  42
  43 /**
  44  * @brief Used for rendering a vector image file (SVG)
  45  */
  46 class DALI_ADAPTOR_API VectorImageRenderer : public BaseHandle
  47 {
  48 public:
  49
  50   /**
  51    * @brief Creates an initialized handle to a new VectorImageRenderer.
  52    *
  53    * @return A handle to a newly allocated VectorImageRenderer
  54    */
  55   static VectorImageRenderer New();
  56
  57   /**
  58    * @brief Creates an empty handle.
  59    * Use VectorImageRenderer::New() to create an initialized object.
  60    */
  61   VectorImageRenderer();
  62
  63   /**
  64    * @brief Destructor.
  65    */
  66   ~VectorImageRenderer();
  67
  68   /**
  69    * @brief This copy constructor is required for (smart) pointer semantics.
  70    *
  71    * @param[in] handle A reference to the copied handle
  72    */
  73   VectorImageRenderer( const VectorImageRenderer& handle ) = default;
  74
  75   /**
  76    * @brief This assignment operator is required for (smart) pointer semantics.
  77    *
  78    * @param[in] rhs A reference to the copied handle
  79    * @return A reference to this
  80    */
  81   VectorImageRenderer& operator=( const VectorImageRenderer& rhs ) = default;
  82
  83   /**
  84    * @brief Load vector image data directly.
  85    *
  86    * @param[in] data SVG image data to load.
  87    * @param[in] dpi The DPI of the screen.
  88    * @return True if the load success, false otherwise.
  89    */
  90   bool Load(const Vector<uint8_t>& data, float dpi);
  91
  92   /**
  93    * @brief Rasterizes the content to the target buffer synchronously.
  94    *
  95    * @param[in] buffer The target buffer
  96    * @param[in] scale The target image scale factor
  97    * @return True if the rendering succeeds, false otherwise.
  98    */
  99   bool Rasterize(Dali::Devel::PixelBuffer& buffer, float scale);
 100
 101   /**
 102    * @brief Gets the default size of the file.
 103    *
 104    * @param[out] width The default width of the file
 105    * @param[out] height The default height of the file
 106    */
 107   void GetDefaultSize(uint32_t& width, uint32_t& height) const;
 108
 109 public: // Not intended for application developers
 110
 111   /// @cond internal
 112   /**
 113    * @brief The constructor.
 114    * @note  Not intended for application developers.
 115    *
 116    * @param[in] pointer A pointer to a newly allocated VectorImageRenderer
 117    */
 118   explicit DALI_INTERNAL VectorImageRenderer( Internal::Adaptor::VectorImageRenderer* internal );
 119   /// @endcond
 120
 121 };
 122
 123 /**
 124  * @}
 125  */
 126 } // namespace Dali
 127
 128 #endif // DALI_VECTOR_IMAGE_RENDERER_H