git_clone/thorvg
1
0
Fork 0
mirror of https://github.com/thorvg/thorvg.git synced 2025-06-08 13:43:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

doc: adds the api version history

Browse source
This commit is contained in:
Hermet Park 2024-04-30 11:48:51 +09:00 • committed by Mira Grudzinska
parent 6211db93bc
commit 7a9ba52d0c
2 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
inc/thorvg.h
View file

@ -1786,6 +1786,7 @@ public:
* *
* This class supports the display and control of animation frames. * This class supports the display and control of animation frames.
* *
* @since 0.13
*/ */
class TVG_API Animation class TVG_API Animation

16
src/bindings/capi/thorvg_capi.h
View file

@ -2234,6 +2234,8 @@ TVG_API Tvg_Result tvg_saver_del(Tvg_Saver* saver);
* \brief Creates a new Animation object. * \brief Creates a new Animation object.
* *
* \return Tvg_Animation A new Tvg_Animation object. * \return Tvg_Animation A new Tvg_Animation object.
*
* \since 0.13
*/ */
TVG_API Tvg_Animation* tvg_animation_new(); TVG_API Tvg_Animation* tvg_animation_new();
@ -2253,6 +2255,8 @@ TVG_API Tvg_Animation* tvg_animation_new();
* \note For efficiency, ThorVG ignores updates to the new frame value if the difference from the current frame value * \note For efficiency, ThorVG ignores updates to the new frame value if the difference from the current frame value
* is less than 0.001. In such cases, it returns @c Result::InsufficientCondition. * is less than 0.001. In such cases, it returns @c Result::InsufficientCondition.
* \see tvg_animation_get_total_frame() * \see tvg_animation_get_total_frame()
*
* \since 0.13
*/ */
TVG_API Tvg_Result tvg_animation_set_frame(Tvg_Animation* animation, float no); TVG_API Tvg_Result tvg_animation_set_frame(Tvg_Animation* animation, float no);
@ -2269,6 +2273,8 @@ TVG_API Tvg_Result tvg_animation_set_frame(Tvg_Animation* animation, float no);
* \return A picture instance that is tied to this animation. * \return A picture instance that is tied to this animation.
* *
* \warning The picture instance is owned by Animation. It should not be deleted manually. * \warning The picture instance is owned by Animation. It should not be deleted manually.
*
* \since 0.13
*/ */
TVG_API Tvg_Paint* tvg_animation_get_picture(Tvg_Animation* animation); TVG_API Tvg_Paint* tvg_animation_get_picture(Tvg_Animation* animation);
@ -2285,6 +2291,8 @@ TVG_API Tvg_Paint* tvg_animation_get_picture(Tvg_Animation* animation);
* *
* \see tvg_animation_get_total_frame() * \see tvg_animation_get_total_frame()
* \see tvg_animation_set_frame() * \see tvg_animation_set_frame()
*
* \since 0.13
*/ */
TVG_API Tvg_Result tvg_animation_get_frame(Tvg_Animation* animation, float* no); TVG_API Tvg_Result tvg_animation_get_frame(Tvg_Animation* animation, float* no);
@ -2301,6 +2309,8 @@ TVG_API Tvg_Result tvg_animation_get_frame(Tvg_Animation* animation, float* no);
* *
* \note Frame numbering starts from 0. * \note Frame numbering starts from 0.
* \note If the Picture is not properly configured, this function will return 0. * \note If the Picture is not properly configured, this function will return 0.
*
* \since 0.13
*/ */
TVG_API Tvg_Result tvg_animation_get_total_frame(Tvg_Animation* animation, float* cnt); TVG_API Tvg_Result tvg_animation_get_total_frame(Tvg_Animation* animation, float* cnt);
@ -2316,6 +2326,8 @@ TVG_API Tvg_Result tvg_animation_get_total_frame(Tvg_Animation* animation, float
* \retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Animation pointer or @p duration. * \retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Animation pointer or @p duration.
* *
* \note If the Picture is not properly configured, this function will return 0. * \note If the Picture is not properly configured, this function will return 0.
*
* \since 0.13
*/ */
TVG_API Tvg_Result tvg_animation_get_duration(Tvg_Animation* animation, float* duration); TVG_API Tvg_Result tvg_animation_get_duration(Tvg_Animation* animation, float* duration);
@ -2331,6 +2343,8 @@ TVG_API Tvg_Result tvg_animation_get_duration(Tvg_Animation* animation, float* d
* \retval TVG_RESULT_SUCCESS Succeed. * \retval TVG_RESULT_SUCCESS Succeed.
* \retval TVG_RESULT_INSUFFICIENT_CONDITION In case the animation is not loaded. * \retval TVG_RESULT_INSUFFICIENT_CONDITION In case the animation is not loaded.
* \retval TVG_RESULT_INVALID_ARGUMENT When the given parameters are out of range. * \retval TVG_RESULT_INVALID_ARGUMENT When the given parameters are out of range.
*
* \since 0.13
*/ */
TVG_API Tvg_Result tvg_animation_set_segment(Tvg_Animation* animation, float begin, float end); TVG_API Tvg_Result tvg_animation_set_segment(Tvg_Animation* animation, float begin, float end);
@ -2358,6 +2372,8 @@ TVG_API Tvg_Result tvg_animation_get_segment(Tvg_Animation* animation, float* be
* \return Tvg_Result enumeration. * \return Tvg_Result enumeration.
* \retval TVG_RESULT_SUCCESS Succeed. * \retval TVG_RESULT_SUCCESS Succeed.
* \retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Animation pointer. * \retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Animation pointer.
*
* \since 0.13
*/ */
TVG_API Tvg_Result tvg_animation_del(Tvg_Animation* animation); TVG_API Tvg_Result tvg_animation_del(Tvg_Animation* animation);