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

lottie/api: specify clear result for override API

Browse source 
In case the given JSON is invalid, it's more closed to `Result::InvalidArguments`.
This commit is contained in:
Jinny You 2024-03-06 16:58:03 +09:00 • committed by Hermet Park
parent cc2fa23359
commit 449cee7cf0
3 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -2359,7 +2359,8 @@ TVG_API Tvg_Animation* tvg_lottie_animation_new();
* *
* \return Tvg_Animation A new Tvg_LottieAnimation object. * \return Tvg_Animation A new Tvg_LottieAnimation object.
* \retval TVG_RESULT_SUCCESS Succeed. * \retval TVG_RESULT_SUCCESS Succeed.
* \retval TVG_RESULT_INSUFFICIENT_CONDITION When the given @p slot is invalid * \retval TVG_RESULT_INSUFFICIENT_CONDITION In case the animation is not loaded.
* \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.
*/ */
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);

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

@ -28,7 +28,8 @@ public:
* @param[in] slot The Lottie slot data in JSON format. * @param[in] slot The Lottie slot data in JSON format.
* *
* @retval Result::Success When succeed. * @retval Result::Success When succeed.
* @retval Result::InsufficientCondition When the given parameter is invalid. * @retval Result::InsufficientCondition In case the animation is not loaded.
* @retval Result::InvalidArguments When the given parameter is invalid.
* *
* @note Experimental API * @note Experimental API
*/ */

2
src/loaders/lottie/tvgLottieAnimation.cpp
View file

@ -46,7 +46,7 @@ Result LottieAnimation::override(const char* slot) noexcept
return Result::Success; return Result::Success;
} }
return Result::InsufficientCondition; return Result::InvalidArguments;
} }