1 #ifndef DALI_VECTOR_ANIMATION_RENDERER_PLUGIN_H
2 #define DALI_VECTOR_ANIMATION_RENDERER_PLUGIN_H
5 * Copyright (c) 2018 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/rendering/renderer.h>
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.
33 class VectorAnimationRendererPlugin
40 VectorAnimationRendererPlugin() {}
45 virtual ~VectorAnimationRendererPlugin() {}
48 * @brief Sets the url of the animation file.
50 * @param[in] url The url of the animation file
52 virtual void SetUrl( const std::string& url ) = 0;
55 * @brief Sets the renderer used to display the result image.
57 * @param[in] renderer The renderer used to display the result image
59 virtual void SetRenderer( Renderer renderer ) = 0;
62 * @brief Sets the target image size.
64 * @param[in] width The target image width
65 * @param[in] height The target image height
67 virtual void SetSize( uint32_t width, uint32_t height ) = 0;
70 * @brief Starts the rendering.
72 * @return True if the renderer is successfully started, false otherwise
74 virtual bool StartRender() = 0;
77 * @brief Stops the rendering.
79 virtual void StopRender() = 0;
82 * @brief Renders the content to the target buffer synchronously.
84 * @param[in] frameNumber The frame number to be rendered
86 virtual void Render( uint32_t frameNumber ) = 0;
89 * @brief Gets the total number of frames of the file
91 * @return The total number of frames
93 virtual uint32_t GetTotalFrameNumber() = 0;
96 * @brief Function pointer called in adaptor to create a plugin instance.
98 using CreateVectorAnimationRendererFunction = VectorAnimationRendererPlugin* (*)();
103 #endif // DALI_VECTOR_ANIMATION_RENDERER_PLUGIN_H