git_clone/thorvg
1
0
Fork 0
mirror of https://github.com/thorvg/thorvg.git synced 2025-07-23 14:48:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

lottie: updated lottie apis doc

Browse source 
- removed useless return value info.
- removed all beta api tags.
This commit is contained in:
Hermet Park 2025-01-16 00:15:59 +09:00
parent 4aba0caaad
commit 2d32c2a45c
2 changed files with 8 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -2481,7 +2481,7 @@ TVG_API Tvg_Animation* tvg_lottie_animation_new(void);
* @retval TVG_RESULT_INVALID_ARGUMENT When the given @p slot is invalid * @retval TVG_RESULT_INVALID_ARGUMENT When the given @p slot is invalid
* @retval TVG_RESULT_NOT_SUPPORTED The Lottie Animation is not supported. * @retval TVG_RESULT_NOT_SUPPORTED The Lottie Animation is not supported.
* *
* @note Experimental API * @since 1.0
*/ */
TVG_API Tvg_Result tvg_lottie_animation_override(Tvg_Animation* animation, const char* slot); TVG_API Tvg_Result tvg_lottie_animation_override(Tvg_Animation* animation, const char* slot);
@ -2497,7 +2497,7 @@ TVG_API Tvg_Result tvg_lottie_animation_override(Tvg_Animation* animation, const
* @retval TVG_RESULT_INVALID_ARGUMENT When the given @p marker is invalid. * @retval TVG_RESULT_INVALID_ARGUMENT When the given @p marker is invalid.
* @retval TVG_RESULT_NOT_SUPPORTED The Lottie Animation is not supported. * @retval TVG_RESULT_NOT_SUPPORTED The Lottie Animation is not supported.
* *
* @note Experimental API * @since 1.0
*/ */
TVG_API Tvg_Result tvg_lottie_animation_set_marker(Tvg_Animation* animation, const char* marker); TVG_API Tvg_Result tvg_lottie_animation_set_marker(Tvg_Animation* animation, const char* marker);
@ -2511,7 +2511,7 @@ TVG_API Tvg_Result tvg_lottie_animation_set_marker(Tvg_Animation* animation, con
* @return Tvg_Result enumeration. * @return Tvg_Result enumeration.
* @retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument. * @retval TVG_RESULT_INVALID_ARGUMENT In case a @c nullptr is passed as the argument.
* *
* @note Experimental API * @since 1.0
*/ */
TVG_API Tvg_Result tvg_lottie_animation_get_markers_cnt(Tvg_Animation* animation, uint32_t* cnt); TVG_API Tvg_Result tvg_lottie_animation_get_markers_cnt(Tvg_Animation* animation, uint32_t* cnt);
@ -2526,7 +2526,7 @@ TVG_API Tvg_Result tvg_lottie_animation_get_markers_cnt(Tvg_Animation* animation
* @return Tvg_Result enumeration. * @return Tvg_Result enumeration.
* @retval TVG_RESULT_INVALID_ARGUMENT In case @c nullptr is passed as the argument or @c idx is out of range. * @retval TVG_RESULT_INVALID_ARGUMENT In case @c nullptr is passed as the argument or @c idx is out of range.
* *
* @note Experimental API * @since 1.0
*/ */
TVG_API Tvg_Result tvg_lottie_animation_get_marker(Tvg_Animation* animation, uint32_t idx, const char** name); TVG_API Tvg_Result tvg_lottie_animation_get_marker(Tvg_Animation* animation, uint32_t idx, const char** name);

12
src/loaders/lottie/thorvg_lottie.h
View file

@ -25,11 +25,9 @@ public:
* *
* @param[in] slot The Lottie slot data in JSON format to override, or @c nullptr to reset. * @param[in] slot The Lottie slot data in JSON format to override, or @c nullptr to reset.
* *
* @retval Result::Success When succeed.
* @retval Result::InsufficientCondition In case the animation is not loaded. * @retval Result::InsufficientCondition In case the animation is not loaded.
* @retval Result::InvalidArguments When the given parameter is invalid.
* *
* @note Experimental API * @since 1.0
*/ */
Result override(const char* slot) noexcept; Result override(const char* slot) noexcept;
@ -43,15 +41,13 @@ public:
* *
* @param[in] marker The name of the segment marker. * @param[in] marker The name of the segment marker.
* *
* @retval Result::Success When successful.
* @retval Result::InsufficientCondition If the animation is not loaded. * @retval Result::InsufficientCondition If the animation is not loaded.
* @retval Result::InvalidArguments When the given parameter is invalid.
* @retval Result::NonSupport When it's not animatable. * @retval Result::NonSupport When it's not animatable.
* *
* @note If a @c marker is specified, the previously set segment will be disregarded. * @note If a @c marker is specified, the previously set segment will be disregarded.
* @note Set @c nullptr to reset the specified segment. * @note Set @c nullptr to reset the specified segment.
* @see Animation::segment(float begin, float end) * @see Animation::segment(float begin, float end)
* @note Experimental API * @since 1.0
*/ */
Result segment(const char* marker) noexcept; Result segment(const char* marker) noexcept;
@ -61,7 +57,7 @@ public:
* @retval The count of the markers, zero if there is no marker. * @retval The count of the markers, zero if there is no marker.
* *
* @see LottieAnimation::marker() * @see LottieAnimation::marker()
* @note Experimental API * @since 1.0
*/ */
uint32_t markersCnt() noexcept; uint32_t markersCnt() noexcept;
@ -73,7 +69,7 @@ public:
* @retval The name of marker when succeed, @c nullptr otherwise. * @retval The name of marker when succeed, @c nullptr otherwise.
* *
* @see LottieAnimation::markersCnt() * @see LottieAnimation::markersCnt()
* @note Experimental API * @since 1.0
*/ */
const char* marker(uint32_t idx) noexcept; const char* marker(uint32_t idx) noexcept;