(Partial update) Fix surface damage area
[platform/core/uifw/dali-adaptor.git] / dali / devel-api / adaptor-framework / vector-animation-renderer-plugin.h
index 6fa992d..d262cfc 100644 (file)
@@ -57,6 +57,11 @@ public:
   virtual bool Initialize( const std::string& url ) = 0;
 
   /**
+   * @brief Finalizes the renderer. It will be called in the main thread.
+   */
+  virtual void Finalize() = 0;
+
+  /**
    * @brief Sets the renderer used to display the result image.
    *
    * @param[in] renderer The renderer used to display the result image
@@ -94,13 +99,41 @@ public:
   virtual float GetFrameRate() const = 0;
 
   /**
-   * @brief Gets the default size of the file,.
+   * @brief Gets the default size of the file.
    *
-   * @return The default size of the file
+   * @param[out] width The default width of the file
+   * @param[out] height The default height of the file
    */
   virtual void GetDefaultSize( uint32_t& width, uint32_t& height ) const = 0;
 
   /**
+   * @brief Gets the layer information of all the child layers.
+   *
+   * @param[out] map The layer information
+   */
+  virtual void GetLayerInfo( Property::Map& map ) const = 0;
+
+  /**
+   * @brief Gets the start frame and the end frame number of the composition marker.
+   *
+   * @param[in] marker The composition marker of the file
+   * @param[out] startFrame The start frame number of the specified marker
+   * @param[out] endFrame The end frame number of the specified marker
+   * @return True if the marker is found in the file, false otherwise.
+   *
+   * @note https://helpx.adobe.com/after-effects/using/layer-markers-composition-markers.html
+   * Markers exported from AfterEffect are used to describe a segment of an animation {comment/tag , startFrame, endFrame}
+   * Marker can be use to devide a resource in to separate animations by tagging the segment with comment string,
+   * start frame and duration of that segment.
+   */
+  virtual bool GetMarkerInfo( const std::string& marker, uint32_t& startFrame, uint32_t& endFrame ) const = 0;
+
+  /**
+   * @brief Ignores a rendered frame which is not shown yet.
+   */
+  virtual void IgnoreRenderedFrame() = 0;
+
+  /**
    * @brief Connect to this signal to be notified when the texture upload is completed.
    *
    * @return The signal to connect to.