api: ++description

issue: https://github.com/thorvg/thorvg/issues/2494
This commit is contained in:
Hermet Park 2024-07-01 11:24:56 +09:00
parent 3d3c76083f
commit 7b79f37dd2
3 changed files with 4 additions and 1 deletions

View file

@ -631,6 +631,8 @@ public:
* The Canvas rendering can be performed asynchronously. To make sure that rendering is finished, * The Canvas rendering can be performed asynchronously. To make sure that rendering is finished,
* the sync() must be called after the draw() regardless of threading. * the sync() must be called after the draw() regardless of threading.
* *
* @retval Result::InsufficientCondition: The canvas is either already in sync condition or in a damaged condition (a draw is required before syncing).
*
* @see Canvas::draw() * @see Canvas::draw()
*/ */
virtual Result sync() noexcept; virtual Result sync() noexcept;

View file

@ -719,6 +719,7 @@ TVG_API Tvg_Result tvg_canvas_draw(Tvg_Canvas* canvas);
* *
* \return Tvg_Result enumeration. * \return Tvg_Result enumeration.
* \retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Canvas pointer. * \retval TVG_RESULT_INVALID_ARGUMENT An invalid Tvg_Canvas pointer.
* \retval TVG_RESULT_INSUFFICIENT_CONDITION @p canvas is either already in sync condition or in a damaged condition (a draw is required before syncing).
* *
* \see tvg_canvas_draw() * \see tvg_canvas_draw()
*/ */

View file

@ -129,7 +129,7 @@ struct Canvas::Impl
return Result::Success; return Result::Success;
} }
return Result::InsufficientCondition; return Result::Unknown;
} }
Result viewport(int32_t x, int32_t y, int32_t w, int32_t h) Result viewport(int32_t x, int32_t y, int32_t w, int32_t h)