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
thorvg/docs/html/group__ThorVGCapi__SwCanvas.html
Hermet Park d522e37565 release: update the docs
2023-07-29 14:24:37 +09:00

368 lines
26 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ThorVG: SwCanvas</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.10</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__ThorVGCapi__SwCanvas.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">SwCanvas<div class="ingroups"><a class="el" href="group__ThorVG__CAPI.html">ThorVG_CAPI</a> &raquo; <a class="el" href="group__ThorVGCapi__Canvas.html">Canvas</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A module for rendering the graphical elements using the software engine.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for SwCanvas:</div>
<div class="dyncontent">
<div class="center"><img src="group__ThorVGCapi__SwCanvas.png" border="0" usemap="#agroup____ThorVGCapi____SwCanvas" alt=""/></div>
<map name="agroup____ThorVGCapi____SwCanvas" id="agroup____ThorVGCapi____SwCanvas">
<area shape="rect" href="group__ThorVGCapi__Canvas.html" title="A module for managing and drawing graphical elements." alt="" coords="5,5,76,31"/>
<area shape="rect" title="A module for rendering the graphical elements using the software engine." alt="" coords="124,5,213,31"/>
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gae63c2c2eee33be6410d3c8a013067b47"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__SwCanvas.html#gae63c2c2eee33be6410d3c8a013067b47">Tvg_Mempool_Policy</a> { <a class="el" href="group__ThorVGCapi__SwCanvas.html#ggae63c2c2eee33be6410d3c8a013067b47aa37438e515a19c5770e52b7346c8d8c5">TVG_MEMPOOL_POLICY_DEFAULT</a> = 0
, <a class="el" href="group__ThorVGCapi__SwCanvas.html#ggae63c2c2eee33be6410d3c8a013067b47aec88b2753a257cdc5be880c7d4bfeef9">TVG_MEMPOOL_POLICY_SHAREABLE</a>
, <a class="el" href="group__ThorVGCapi__SwCanvas.html#ggae63c2c2eee33be6410d3c8a013067b47a17b8765ba731e3c626d04ce31487c859">TVG_MEMPOOL_POLICY_INDIVIDUAL</a>
}</td></tr>
<tr class="memdesc:gae63c2c2eee33be6410d3c8a013067b47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration specifying the methods of Memory Pool behavior policy. <a href="group__ThorVGCapi__SwCanvas.html#gae63c2c2eee33be6410d3c8a013067b47">More...</a><br /></td></tr>
<tr class="separator:gae63c2c2eee33be6410d3c8a013067b47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae038f89e569d85c0896711a0a31b4a78"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__SwCanvas.html#gae038f89e569d85c0896711a0a31b4a78">Tvg_Colorspace</a> { <a class="el" href="group__ThorVGCapi__SwCanvas.html#ggae038f89e569d85c0896711a0a31b4a78a3e19cdea8a31c91c381385ba87626ae4">TVG_COLORSPACE_ABGR8888</a> = 0
, <a class="el" href="group__ThorVGCapi__SwCanvas.html#ggae038f89e569d85c0896711a0a31b4a78a362994879a2332b343d408dd3a397d97">TVG_COLORSPACE_ARGB8888</a>
}</td></tr>
<tr class="memdesc:gae038f89e569d85c0896711a0a31b4a78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration specifying the methods of combining the 8-bit color channels into 32-bit color. <a href="group__ThorVGCapi__SwCanvas.html#gae038f89e569d85c0896711a0a31b4a78">More...</a><br /></td></tr>
<tr class="separator:gae038f89e569d85c0896711a0a31b4a78"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga1929b0e99eff5584ed03c36cdfa81065"><td class="memItemLeft" align="right" valign="top">TVG_API <a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__SwCanvas.html#ga1929b0e99eff5584ed03c36cdfa81065">tvg_swcanvas_create</a> ()</td></tr>
<tr class="memdesc:ga1929b0e99eff5584ed03c36cdfa81065"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a Canvas object. <a href="group__ThorVGCapi__SwCanvas.html#ga1929b0e99eff5584ed03c36cdfa81065">More...</a><br /></td></tr>
<tr class="separator:ga1929b0e99eff5584ed03c36cdfa81065"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7bd619a80e4a2ba4bc012734387a2010"><td class="memItemLeft" align="right" valign="top">TVG_API <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__SwCanvas.html#ga7bd619a80e4a2ba4bc012734387a2010">tvg_swcanvas_set_target</a> (<a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *canvas, uint32_t *buffer, uint32_t stride, uint32_t w, uint32_t h, <a class="el" href="group__ThorVGCapi__SwCanvas.html#gae038f89e569d85c0896711a0a31b4a78">Tvg_Colorspace</a> cs)</td></tr>
<tr class="memdesc:ga7bd619a80e4a2ba4bc012734387a2010"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the buffer used in the rasterization process and defines the used colorspace. <a href="group__ThorVGCapi__SwCanvas.html#ga7bd619a80e4a2ba4bc012734387a2010">More...</a><br /></td></tr>
<tr class="separator:ga7bd619a80e4a2ba4bc012734387a2010"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabba194e9e4290909eea1e65af6eb9764"><td class="memItemLeft" align="right" valign="top">TVG_API <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__SwCanvas.html#gabba194e9e4290909eea1e65af6eb9764">tvg_swcanvas_set_mempool</a> (<a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *canvas, <a class="el" href="group__ThorVGCapi__SwCanvas.html#gae63c2c2eee33be6410d3c8a013067b47">Tvg_Mempool_Policy</a> policy)</td></tr>
<tr class="memdesc:gabba194e9e4290909eea1e65af6eb9764"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the software engine memory pool behavior policy. <a href="group__ThorVGCapi__SwCanvas.html#gabba194e9e4290909eea1e65af6eb9764">More...</a><br /></td></tr>
<tr class="separator:gabba194e9e4290909eea1e65af6eb9764"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>A module for rendering the graphical elements using the software engine. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gae038f89e569d85c0896711a0a31b4a78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae038f89e569d85c0896711a0a31b4a78">&#9670;&nbsp;</a></span>Tvg_Colorspace</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__ThorVGCapi__SwCanvas.html#gae038f89e569d85c0896711a0a31b4a78">Tvg_Colorspace</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration specifying the methods of combining the 8-bit color channels into 32-bit color. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggae038f89e569d85c0896711a0a31b4a78a3e19cdea8a31c91c381385ba87626ae4"></a>TVG_COLORSPACE_ABGR8888&#160;</td><td class="fielddoc"><p>The 8-bit color channels are combined into 32-bit color in the order: alpha, blue, green, red. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae038f89e569d85c0896711a0a31b4a78a362994879a2332b343d408dd3a397d97"></a>TVG_COLORSPACE_ARGB8888&#160;</td><td class="fielddoc"><p>The 8-bit color channels are combined into 32-bit color in the order: alpha, red, green, blue. </p>
</td></tr>
</table>
</div>
</div>
<a id="gae63c2c2eee33be6410d3c8a013067b47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae63c2c2eee33be6410d3c8a013067b47">&#9670;&nbsp;</a></span>Tvg_Mempool_Policy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__ThorVGCapi__SwCanvas.html#gae63c2c2eee33be6410d3c8a013067b47">Tvg_Mempool_Policy</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration specifying the methods of Memory Pool behavior policy. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggae63c2c2eee33be6410d3c8a013067b47aa37438e515a19c5770e52b7346c8d8c5"></a>TVG_MEMPOOL_POLICY_DEFAULT&#160;</td><td class="fielddoc"><p>Default behavior that ThorVG is designed to. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae63c2c2eee33be6410d3c8a013067b47aec88b2753a257cdc5be880c7d4bfeef9"></a>TVG_MEMPOOL_POLICY_SHAREABLE&#160;</td><td class="fielddoc"><p>Memory Pool is shared among canvases. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae63c2c2eee33be6410d3c8a013067b47a17b8765ba731e3c626d04ce31487c859"></a>TVG_MEMPOOL_POLICY_INDIVIDUAL&#160;</td><td class="fielddoc"><p>Allocate designated memory pool that is used only by the current canvas instance. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga1929b0e99eff5584ed03c36cdfa81065"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1929b0e99eff5584ed03c36cdfa81065">&#9670;&nbsp;</a></span>tvg_swcanvas_create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_API <a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a>* tvg_swcanvas_create </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a Canvas object. </p>
<div class="fragment"><div class="line"><a class="code" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *canvas = NULL;</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__ThorVGCapi__Initializer.html#ga437d5601fe8dc17eb4788b7694000452">tvg_engine_init</a>(<a class="code" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a>, 4);</div>
<div class="line">canvas = <a class="code" href="group__ThorVGCapi__SwCanvas.html#ga1929b0e99eff5584ed03c36cdfa81065">tvg_swcanvas_create</a>();</div>
<div class="line"> </div>
<div class="line"><span class="comment">//set up the canvas buffer</span></div>
<div class="line">uint32_t *buffer = NULL;</div>
<div class="line">buffer = (uint32_t*) malloc(<span class="keyword">sizeof</span>(uint32_t) * 100 * 100);</div>
<div class="line"><span class="keywordflow">if</span> (!buffer) <span class="keywordflow">return</span>;</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__ThorVGCapi__SwCanvas.html#ga7bd619a80e4a2ba4bc012734387a2010">tvg_swcanvas_set_target</a>(canvas, buffer, 100, 100, 100, <a class="code" href="group__ThorVGCapi__SwCanvas.html#ggae038f89e569d85c0896711a0a31b4a78a362994879a2332b343d408dd3a397d97">TVG_COLORSPACE_ARGB8888</a>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">//set up paints and add them into the canvas before drawing it</span></div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__ThorVGCapi__Canvas.html#ga15208125646162cd19a928708a335295">tvg_canvas_destroy</a>(canvas);</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Initializer.html#gaaee6b1a83765cfecd47d8f979a9a3211">tvg_engine_term</a>(<a class="code" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a>);</div>
<div class="ttc" id="agroup__ThorVGCapi__Canvas_html_ga15208125646162cd19a928708a335295"><div class="ttname"><a href="group__ThorVGCapi__Canvas.html#ga15208125646162cd19a928708a335295">tvg_canvas_destroy</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_canvas_destroy(Tvg_Canvas *canvas)</div><div class="ttdoc">Clears the canvas internal data, releases all paints stored by the canvas and destroys the canvas obj...</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Initializer_html_ga437d5601fe8dc17eb4788b7694000452"><div class="ttname"><a href="group__ThorVGCapi__Initializer.html#ga437d5601fe8dc17eb4788b7694000452">tvg_engine_init</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_engine_init(Tvg_Engine engine_method, unsigned threads)</div><div class="ttdoc">Initializes TVG engines.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Initializer_html_gaaee6b1a83765cfecd47d8f979a9a3211"><div class="ttname"><a href="group__ThorVGCapi__Initializer.html#gaaee6b1a83765cfecd47d8f979a9a3211">tvg_engine_term</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_engine_term(Tvg_Engine engine_method)</div><div class="ttdoc">Terminates TVG engines.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Initializer_html_ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96"><div class="ttname"><a href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a></div><div class="ttdeci">@ TVG_ENGINE_SW</div><div class="ttdoc">CPU rasterizer.</div><div class="ttdef"><b>Definition:</b> thorvg_capi.h:106</div></div>
<div class="ttc" id="agroup__ThorVGCapi__SwCanvas_html_ga1929b0e99eff5584ed03c36cdfa81065"><div class="ttname"><a href="group__ThorVGCapi__SwCanvas.html#ga1929b0e99eff5584ed03c36cdfa81065">tvg_swcanvas_create</a></div><div class="ttdeci">TVG_API Tvg_Canvas * tvg_swcanvas_create()</div><div class="ttdoc">Creates a Canvas object.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__SwCanvas_html_ga7bd619a80e4a2ba4bc012734387a2010"><div class="ttname"><a href="group__ThorVGCapi__SwCanvas.html#ga7bd619a80e4a2ba4bc012734387a2010">tvg_swcanvas_set_target</a></div><div class="ttdeci">TVG_API Tvg_Result tvg_swcanvas_set_target(Tvg_Canvas *canvas, uint32_t *buffer, uint32_t stride, uint32_t w, uint32_t h, Tvg_Colorspace cs)</div><div class="ttdoc">Sets the buffer used in the rasterization process and defines the used colorspace.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__SwCanvas_html_ggae038f89e569d85c0896711a0a31b4a78a362994879a2332b343d408dd3a397d97"><div class="ttname"><a href="group__ThorVGCapi__SwCanvas.html#ggae038f89e569d85c0896711a0a31b4a78a362994879a2332b343d408dd3a397d97">TVG_COLORSPACE_ARGB8888</a></div><div class="ttdeci">@ TVG_COLORSPACE_ARGB8888</div><div class="ttdoc">The 8-bit color channels are combined into 32-bit color in the order: alpha, red, green,...</div><div class="ttdef"><b>Definition:</b> thorvg_capi.h:372</div></div>
<div class="ttc" id="agroup__ThorVG__CAPI_html_ga5f10c1f3dabdc9287166611c7fe5fd8a"><div class="ttname"><a href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a></div><div class="ttdeci">struct _Tvg_Canvas Tvg_Canvas</div><div class="ttdoc">A structure responsible for managing and drawing graphical elements.</div><div class="ttdef"><b>Definition:</b> thorvg_capi.h:77</div></div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>A new Tvg_Canvas object. </dd></dl>
</div>
</div>
<a id="gabba194e9e4290909eea1e65af6eb9764"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabba194e9e4290909eea1e65af6eb9764">&#9670;&nbsp;</a></span>tvg_swcanvas_set_mempool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_API <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> tvg_swcanvas_set_mempool </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *&#160;</td>
<td class="paramname"><em>canvas</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__ThorVGCapi__SwCanvas.html#gae63c2c2eee33be6410d3c8a013067b47">Tvg_Mempool_Policy</a>&#160;</td>
<td class="paramname"><em>policy</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the software engine memory pool behavior policy. </p>
<p>ThorVG draws a lot of shapes, it allocates/deallocates a few chunk of memory while processing rendering. It internally uses one shared memory pool which can be reused among the canvases in order to avoid memory overhead.</p>
<p>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.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">canvas</td><td>The Tvg_Canvas object of which the Memory Pool behavior is to be specified. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">policy</td><td>The method specifying the Memory Pool behavior. The default value is <code>TVG_MEMPOOL_POLICY_DEFAULT</code>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Tvg_Result enumeration. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">TVG_RESULT_SUCCESS</td><td>Succeed. </td></tr>
<tr><td class="paramname">TVG_RESULT_INVALID_ARGUMENTS</td><td>An invalid canvas pointer passed. </td></tr>
<tr><td class="paramname">TVG_RESULT_INSUFFICIENT_CONDITION</td><td>The canvas contains some paints already. </td></tr>
<tr><td class="paramname">TVG_RESULT_NOT_SUPPORTED</td><td>The software engine is not supported.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>When <code>policy</code> is set as <code>TVG_MEMPOOL_POLICY_INDIVIDUAL</code>, 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.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>It's not allowed after pushing any paints. </dd></dl>
</div>
</div>
<a id="ga7bd619a80e4a2ba4bc012734387a2010"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7bd619a80e4a2ba4bc012734387a2010">&#9670;&nbsp;</a></span>tvg_swcanvas_set_target()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_API <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> tvg_swcanvas_set_target </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a> *&#160;</td>
<td class="paramname"><em>canvas</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>stride</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>h</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__ThorVGCapi__SwCanvas.html#gae038f89e569d85c0896711a0a31b4a78">Tvg_Colorspace</a>&#160;</td>
<td class="paramname"><em>cs</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the buffer used in the rasterization process and defines the used colorspace. </p>
<p>For optimisation reasons TVG does not allocate memory for the output buffer on its own. The buffer of a desirable size should be allocated and owned by the caller.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">canvas</td><td>The Tvg_Canvas object managing the <code>buffer</code>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>A pointer to the allocated memory block of the size <code>stride</code> x <code>h</code>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">stride</td><td>The stride of the raster image - in most cases same value as <code>w</code>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">w</td><td>The width of the raster image. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>The height of the raster image. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>The colorspace value defining the way the 32-bits colors should be read/written.<ul>
<li>TVG_COLORSPACE_ABGR8888</li>
<li>TVG_COLORSPACE_ARGB8888</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Tvg_Result enumeration. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">TVG_RESULT_SUCCESS</td><td>Succeed. </td></tr>
<tr><td class="paramname">TVG_RESULT_MEMORY_CORRUPTION</td><td>Casting in the internal function implementation failed. </td></tr>
<tr><td class="paramname">TVG_RESULT_INVALID_ARGUMENTS</td><td>An invalid canvas or buffer pointer passed or one of the <code>stride</code>, <code>w</code> or <code>h</code> being zero. </td></tr>
<tr><td class="paramname">TVG_RESULT_NOT_SUPPORTED</td><td>The software engine is not supported.</td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>Do not access <code>buffer</code> during <a class="el" href="group__ThorVGCapi__Canvas.html#gafb0f659e1dd0fd71287c3c7ccedca1d2" title="Requests the canvas to draw the Tvg_Paint objects.">tvg_canvas_draw()</a> - <a class="el" href="group__ThorVGCapi__Canvas.html#gad0b79fd5411b47faf7b185c2e01034ce" title="Guarantees that the drawing process is finished.">tvg_canvas_sync()</a>. It should not be accessed while TVG is writing on it.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__SwCanvas.html#gae038f89e569d85c0896711a0a31b4a78" title="Enumeration specifying the methods of combining the 8-bit color channels into 32-bit color.">Tvg_Colorspace</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink