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

   1 #ifndef DALI_VECTOR_ANIMATION_RENDERER_PLUGIN_H
   2 #define DALI_VECTOR_ANIMATION_RENDERER_PLUGIN_H
   3
   4 /*
   5  * Copyright (c) 2018 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/rendering/renderer.h>
  23 #include <string>
  24
  25 namespace Dali
  26 {
  27
  28 /**
  29  * VectorAnimationRendererPlugin is an abstract interface, used by dali-adaptor to render a vector animation.
  30  * A concrete implementation must be created for each platform and provided as a dynamic library which
  31  * will be loaded at run time by the adaptor.
  32  */
  33 class VectorAnimationRendererPlugin
  34 {
  35 public:
  36
  37   /**
  38    * @brief Constructor
  39    */
  40   VectorAnimationRendererPlugin() {}
  41
  42   /**
  43    * @brief Destructor
  44    */
  45   virtual ~VectorAnimationRendererPlugin() {}
  46
  47   /**
  48    * @brief Creates a renderer to render an vector animation file.
  49    *
  50    * @param[in] url The url of an animation file
  51    * @param[in] renderer The renderer used to render the image
  52    * @param[in] width The target image width
  53    * @param[in] height The target image height
  54    * @return True if the renderer is successfully created, false otherwise
  55    */
  56   virtual bool CreateRenderer( const std::string& url, Renderer renderer, uint32_t width, uint32_t height ) = 0;
  57
  58   /**
  59    * @brief Sets the target image size.
  60    *
  61    * @param[in] width The target image width
  62    * @param[in] height The target image height
  63    */
  64   virtual void SetSize( uint32_t width, uint32_t height ) = 0;
  65
  66   /**
  67    * @brief Starts the rendering.
  68    *
  69    * @return True if the renderer is successfully started, false otherwise
  70    */
  71   virtual bool StartRender() = 0;
  72
  73   /**
  74    * @brief Stops the rendering.
  75    */
  76   virtual void StopRender() = 0;
  77
  78   /**
  79    * @brief Renders the content to the target buffer synchronously.
  80    *
  81    * @param[in] frameNumber The frame number to be rendered
  82    */
  83   virtual void Render( uint32_t frameNumber ) = 0;
  84
  85   /**
  86    * @brief Gets the total number of frames of the file
  87    *
  88    * @return The total number of frames
  89    */
  90   virtual uint32_t GetTotalFrameNumber() = 0;
  91
  92   /**
  93    * @brief Function pointer called in adaptor to create a plugin instance.
  94    */
  95   using CreateVectorAnimationRendererFunction = VectorAnimationRendererPlugin* (*)();
  96 };
  97
  98 } // namespace Dali
  99
 100 #endif // DALI_VECTOR_ANIMATION_RENDERER_PLUGIN_H