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

doc: ++ MemPool docs

Browse source
This commit is contained in:
Mira Grudzinska 2021-07-23 12:33:00 +02:00 • committed by Hermet Park
parent 330e258495
commit 82c7a96628
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
inc/thorvg.h
View file

@ -1221,17 +1221,17 @@ public:
* while processing rendering. It internally uses one shared memory pool
* which can be reused among the canvases in order to avoid memory overhead.
*
* Thus ThorVG suggests memory pool policy to satisfy user demands,
* Thus ThorVG suggests using a memory pool policy to satisfy user demands,
* if it needs to guarantee the thread-safety of the internal data access.
*
* @param[in] policy Use the shared cache memory. The default value is @c true
* @param[in] policy The method specifying the Memory Pool behavior. The default value is @c MempoolPolicy::Default.
*
* @retval Result::Success When succeed.
* @retval Result::InsufficientCondition If the canvas has any paints.
* @retval Result::InsufficientCondition If the canvas has no paints.
* @retval Result::NonSupport In case the software engine is not supported.
*
* @note When @c policy is set as @c MempoolPolicy::Individual, current instance of canvas uses its own individual
* memory data that is not shared with others. This is necessary when the canvas is accessed on a worker-thread.
* @note When @c policy is set as @c MempoolPolicy::Individual, the current instance of canvas uses its own individual
* memory data, which is not shared with others. This is necessary when the canvas is accessed on a worker-thread.
*
* @warning It's not allowed after pushing any paints.
*