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

docs: ++

Browse source
This commit is contained in:
Mira Grudzinska 2021-10-12 14:00:05 +02:00 • committed by Mira Grudzinska
parent 6a63a5feac
commit 39af185de8
2 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
inc/thorvg.h
View file

@ -1258,7 +1258,7 @@ public:
* @param[in] policy The method specifying the Memory Pool behavior. The default value is @c MempoolPolicy::Default. * @param[in] policy The method specifying the Memory Pool behavior. The default value is @c MempoolPolicy::Default.
* *
* @retval Result::Success When succeed. * @retval Result::Success When succeed.
* @retval Result::InsufficientCondition If the canvas has no paints. * @retval Result::InsufficientCondition If the canvas contains some paints already.
* @retval Result::NonSupport In case the software engine is not supported. * @retval Result::NonSupport In case the software engine is not supported.
* *
* @note When @c policy is set as @c MempoolPolicy::Individual, the current instance of canvas uses its own individual * @note When @c policy is set as @c MempoolPolicy::Individual, the current instance of canvas uses its own individual

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

@ -372,7 +372,7 @@ TVG_EXPORT Tvg_Canvas* tvg_swcanvas_create();
* \return Tvg_Result enumeration. * \return Tvg_Result enumeration.
* \retval TVG_RESULT_SUCCESS Succeed. * \retval TVG_RESULT_SUCCESS Succeed.
* \retval TVG_RESULT_MEMORY_CORRUPTION Casting in the internal function implementation failed. * \retval TVG_RESULT_MEMORY_CORRUPTION Casting in the internal function implementation failed.
* \retval TVG_RESULT_INVALID_ARGUMENTS An invalid buffer pointer passed or one of the @p stride, @p w or @p h being zero. * \retval TVG_RESULT_INVALID_ARGUMENTS An invalid canvas or buffer pointer passed or one of the @p stride, @p w or @p h being zero.
* \retval TVG_RESULT_NOT_SUPPORTED The software engine is not supported. * \retval TVG_RESULT_NOT_SUPPORTED The software engine is not supported.
* *
* \warning Do not access @p buffer during tvg_canvas_draw() - tvg_canvas_sync(). It should not be accessed while TVG is writing on it. * \warning Do not access @p buffer during tvg_canvas_draw() - tvg_canvas_sync(). It should not be accessed while TVG is writing on it.