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) 2019 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 // INTERNAL INCLUDES
  26 #include <dali/devel-api/adaptor-framework/vector-animation-renderer.h>
  27
  28 namespace Dali
  29 {
  30
  31 /**
  32  * VectorAnimationRendererPlugin is an abstract interface, used by dali-adaptor to render a vector animation.
  33  * A concrete implementation must be created for each platform and provided as a dynamic library which
  34  * will be loaded at run time by the adaptor.
  35  */
  36 class VectorAnimationRendererPlugin
  37 {
  38 public:
  39
  40   using UploadCompletedSignalType = Dali::VectorAnimationRenderer::UploadCompletedSignalType;
  41
  42   /**
  43    * @brief Constructor
  44    */
  45   VectorAnimationRendererPlugin() {}
  46
  47   /**
  48    * @brief Destructor
  49    */
  50   virtual ~VectorAnimationRendererPlugin() {}
  51
  52   /**
  53    * @brief Second-phase constructor.
  54    *
  55    * @param[in] url The url of the animation file
  56    */
  57   virtual bool Initialize( const std::string& url ) = 0;
  58
  59   /**
  60    * @brief Sets the renderer used to display the result image.
  61    *
  62    * @param[in] renderer The renderer used to display the result image
  63    */
  64   virtual void SetRenderer( Renderer renderer ) = 0;
  65
  66   /**
  67    * @brief Sets the target image size.
  68    *
  69    * @param[in] width The target image width
  70    * @param[in] height The target image height
  71    */
  72   virtual void SetSize( uint32_t width, uint32_t height ) = 0;
  73
  74   /**
  75    * @brief Renders the content to the target buffer synchronously.
  76    *
  77    * @param[in] frameNumber The frame number to be rendered
  78    * @return True if the rendering success, false otherwise.
  79    */
  80   virtual bool Render( uint32_t frameNumber ) = 0;
  81
  82   /**
  83    * @brief Gets the total number of frames of the file.
  84    *
  85    * @return The total number of frames
  86    */
  87   virtual uint32_t GetTotalFrameNumber() const = 0;
  88
  89   /**
  90    * @brief Gets the frame rate of the file.
  91    *
  92    * @return The frame rate of the file
  93    */
  94   virtual float GetFrameRate() const = 0;
  95
  96   /**
  97    * @brief Gets the default size of the file.
  98    *
  99    * @param[out] width The default width of the file
 100    * @param[out] height The default height of the file
 101    */
 102   virtual void GetDefaultSize( uint32_t& width, uint32_t& height ) const = 0;
 103
 104   /**
 105    * @brief Gets the layer information of all the child layers.
 106    *
 107    * @param[out] map The layer information
 108    */
 109   virtual void GetLayerInfo( Property::Map& map ) const = 0;
 110
 111   /**
 112    * @brief Connect to this signal to be notified when the texture upload is completed.
 113    *
 114    * @return The signal to connect to.
 115    */
 116   virtual UploadCompletedSignalType& UploadCompletedSignal() = 0;
 117
 118   /**
 119    * @brief Function pointer called in adaptor to create a plugin instance.
 120    */
 121   using CreateVectorAnimationRendererFunction = VectorAnimationRendererPlugin* (*)();
 122 };
 123
 124 } // namespace Dali
 125
 126 #endif // DALI_VECTOR_ANIMATION_RENDERER_PLUGIN_H