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

   1 #ifndef DALI_VECTOR_IMAGE_RENDERER_PLUGIN_H
   2 #define DALI_VECTOR_IMAGE_RENDERER_PLUGIN_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 // INTERNAL INCLUDES
  22 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
  23
  24 namespace Dali
  25 {
  26
  27 /**
  28  * VectorImageRendererPlugin is an abstract interface, used by dali-adaptor to render a vector image(SVG).
  29  * A concrete implementation must be created for each platform and provided as a dynamic library which
  30  * will be loaded at run time by the adaptor.
  31  */
  32 class VectorImageRendererPlugin
  33 {
  34 public:
  35   /**
  36    * @brief Constructor
  37    */
  38   VectorImageRendererPlugin() {}
  39
  40   /**
  41    * @brief Destructor
  42    */
  43   virtual ~VectorImageRendererPlugin() {}
  44
  45   /**
  46    * @brief Load vector image data directly.
  47    *
  48    * @param[in] data The memory data of vector image
  49    * @return True if the load success, false otherwise.
  50    */
  51   virtual bool Load(const Vector<uint8_t>& data) = 0;
  52
  53   /**
  54    * @brief Rasterizes the content to the target buffer synchronously.
  55    *
  56    * @param[in] buffer The target buffer
  57    * @return True if the rendering succeeds, false otherwise.
  58    */
  59   virtual bool Rasterize(Dali::Devel::PixelBuffer &buffer) = 0;
  60
  61   /**
  62    * @brief Gets the default size of the file.
  63    *
  64    * @param[out] width The default width of the file
  65    * @param[out] height The default height of the file
  66    */
  67   virtual void GetDefaultSize( uint32_t& width, uint32_t& height ) const = 0;
  68
  69   /**
  70    * @brief Function pointer called in adaptor to create a plugin instance.
  71    */
  72   using CreateVectorImageRendererFunction = VectorImageRendererPlugin* (*)();
  73 };
  74
  75 } // namespace Dali
  76
  77 #endif // DALI_VECTOR_IMAGE_RENDERER_PLUGIN_H