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

docs: descriptions++

Browse source
This commit is contained in:
Mira Grudzinska 2024-06-20 13:53:46 +02:00 • committed by Hermet Park
parent 53de5f2ff7
commit e8b5062657
2 changed files with 4 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
inc/thorvg.h
View file

@ -586,10 +586,10 @@ public:
* @brief Clear the internal canvas resources that used for the drawing.
*
* This API sets the total number of paints pushed into the canvas to zero.
* Depending on the value of the @p free argument, the paints are either freed or retained.
* So if you need to update paint properties while maintaining the existing scene structure, you can set @p free = false.
* Depending on the value of the @p paints argument, the paints are either freed or retained.
* So if you need to update paint properties while maintaining the existing scene structure, you can set @p paints = false.
*
* @param[in] paints If @c true, The memory occupied by paints is deallocated; otherwise, the paints will be retained on the canvas.
* @param[in] paints If @c true, the memory occupied by paints is deallocated; otherwise, the paints will be retained on the canvas.
* @param[in] buffer If @c true, the canvas target buffer is cleared with a zero value.
*
* @retval Result::Success when succeed, Result::InsufficientCondition otherwise.

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

@ -565,7 +565,6 @@ TVG_API Tvg_Result tvg_canvas_destroy(Tvg_Canvas* canvas);
*
* Only the paints pushed into the canvas will be drawing targets.
* They are retained by the canvas until you call tvg_canvas_clear().
* If you know the number of the pushed objects in advance, please call tvg_canvas_reserve().
*
* \return Tvg_Result return values:
* \retval TVG_RESULT_SUCCESS Succeed.
@ -613,7 +612,7 @@ TVG_DEPRECATED TVG_API Tvg_Result tvg_canvas_reserve(Tvg_Canvas* canvas, uint32_
/*!
* \brief Sets the total number of the paints pushed into the canvas to be zero.
* Tvg_Paint objects stored in the canvas are released if @p free is set to @c true, otherwise the memory is not deallocated and
* Tvg_Paint objects stored in the canvas are released if @p paints is set to @c true, otherwise the memory is not deallocated and
* all paints should be released manually in order to avoid memory leaks.
*
* \param[in] canvas The Tvg_Canvas object to be cleared.