git_clone/thorvg
1
0
Fork 0
mirror of https://github.com/thorvg/thorvg.git synced 2025-06-07 21:23:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
thorvg/docs/html/group__ThorVGCapi__Initializer.html
Hermet Park 9f914d596e doc: added capi documentation.
2021-11-02 21:10:46 +09:00

247 lines
16 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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ThorVG: Initializer</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="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" />
<link href="doxygen-awesome.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.svg"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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');
/* @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 -->
<!-- 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">Initializer<div class="ingroups"><a class="el" href="group__ThorVG__CAPI.html">ThorVG_CAPI</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A module enabling initialization and termination of the TVG engines.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Initializer:</div>
<div class="dyncontent">
<div class="center"><img src="group__ThorVGCapi__Initializer.png" border="0" usemap="#group____ThorVGCapi____Initializer" alt=""/></div>
<map name="group____ThorVGCapi____Initializer" id="group____ThorVGCapi____Initializer">
<area shape="rect" href="group__ThorVG__CAPI.html" title="ThorVG C language binding APIs." alt="" coords="5,5,112,31"/>
<area shape="rect" title="A module enabling initialization and termination of the TVG engines." alt="" coords="160,5,243,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:gaa61c2088915fc211ac91ffafaf45f695"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695">Tvg_Engine</a> { <a class="el" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a> = (1 &lt;&lt; 1),
<a class="el" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a512e634431a51f22e388d7b87828cac1">TVG_ENGINE_GL</a> = (1 &lt;&lt; 2)
}</td></tr>
<tr class="memdesc:gaa61c2088915fc211ac91ffafaf45f695"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration specifying the engine type used for the graphics backend. For multiple backends bitwise operation is allowed. <a href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695">More...</a><br /></td></tr>
<tr class="separator:gaa61c2088915fc211ac91ffafaf45f695"><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:ga315ed4054d2547029c3d67414d0f227e"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <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__Initializer.html#ga315ed4054d2547029c3d67414d0f227e">tvg_engine_init</a> (<a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695">Tvg_Engine</a> engine_method, unsigned threads)</td></tr>
<tr class="memdesc:ga315ed4054d2547029c3d67414d0f227e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes TVG engines. <a href="group__ThorVGCapi__Initializer.html#ga315ed4054d2547029c3d67414d0f227e">More...</a><br /></td></tr>
<tr class="separator:ga315ed4054d2547029c3d67414d0f227e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga96d2cc74ed36a277467aba48093e7862"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <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__Initializer.html#ga96d2cc74ed36a277467aba48093e7862">tvg_engine_term</a> (<a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695">Tvg_Engine</a> engine_method)</td></tr>
<tr class="memdesc:ga96d2cc74ed36a277467aba48093e7862"><td class="mdescLeft">&#160;</td><td class="mdescRight">Terminates TVG engines. <a href="group__ThorVGCapi__Initializer.html#ga96d2cc74ed36a277467aba48093e7862">More...</a><br /></td></tr>
<tr class="separator:ga96d2cc74ed36a277467aba48093e7862"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>A module enabling initialization and termination of the TVG engines. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gaa61c2088915fc211ac91ffafaf45f695"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa61c2088915fc211ac91ffafaf45f695">&#9670;&nbsp;</a></span>Tvg_Engine</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695">Tvg_Engine</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration specifying the engine type used for the graphics backend. For multiple backends bitwise operation is allowed. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96"></a>TVG_ENGINE_SW&#160;</td><td class="fielddoc"><p>CPU rasterizer. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaa61c2088915fc211ac91ffafaf45f695a512e634431a51f22e388d7b87828cac1"></a>TVG_ENGINE_GL&#160;</td><td class="fielddoc"><p>OpenGL rasterizer. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga315ed4054d2547029c3d67414d0f227e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga315ed4054d2547029c3d67414d0f227e">&#9670;&nbsp;</a></span>tvg_engine_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> tvg_engine_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695">Tvg_Engine</a>&#160;</td>
<td class="paramname"><em>engine_method</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned&#160;</td>
<td class="paramname"><em>threads</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes TVG engines. </p>
<p>TVG requires the running-engine environment. TVG runs its own task-scheduler for parallelizing rendering tasks efficiently. You can indicate the number of threads, the count of which is designated <code>threads</code>. In the initialization step, TVG will generate/spawn the threads as set by <code>threads</code> count.</p>
<div class="fragment"><div class="line"><a class="code" href="group__ThorVGCapi__Initializer.html#ga315ed4054d2547029c3d67414d0f227e">tvg_engine_init</a>(<a class="code" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a>, 0); <span class="comment">//Initialize software renderer and use the main thread only</span></div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">engine_method</td><td>The engine types to initialize. This is relative to the Canvas types, in which it will be used. For multiple backends bitwise operation is allowed.<ul>
<li>TVG_ENGINE_SW: CPU rasterizer</li>
<li>TVG_ENGINE_GL: OpenGL rasterizer (not supported yet) </li>
</ul>
</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">threads</td><td>The number of additional threads used to perform rendering. Zero indicates only the main thread is to be used.</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_FAILED_ALLOCATION</td><td>An internal error possibly with memory allocation. </td></tr>
<tr><td class="paramname">TVG_RESULT_INVALID_ARGUMENT</td><td>Unknown engine type. </td></tr>
<tr><td class="paramname">TVG_RESULT_NOT_SUPPORTED</td><td>Unsupported engine type. </td></tr>
<tr><td class="paramname">TVG_RESULT_UNKNOWN</td><td>Other error.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The Initializer keeps track of the number of times it was called. Threads count is fixed at the first init() call. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Initializer.html#ga96d2cc74ed36a277467aba48093e7862" title="Terminates TVG engines.">tvg_engine_term()</a> </dd>
<dd>
<a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695" title="Enumeration specifying the engine type used for the graphics backend. For multiple backends bitwise o...">Tvg_Engine</a> </dd></dl>
</div>
</div>
<a id="ga96d2cc74ed36a277467aba48093e7862"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga96d2cc74ed36a277467aba48093e7862">&#9670;&nbsp;</a></span>tvg_engine_term()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> tvg_engine_term </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695">Tvg_Engine</a>&#160;</td>
<td class="paramname"><em>engine_method</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Terminates TVG engines. </p>
<p>It should be called in case of termination of the TVG client with the same engine types as were passed when <a class="el" href="group__ThorVGCapi__Initializer.html#ga315ed4054d2547029c3d67414d0f227e" title="Initializes TVG engines.">tvg_engine_init()</a> was called.</p>
<div class="fragment"><div class="line"><a class="code" href="group__ThorVGCapi__Initializer.html#ga315ed4054d2547029c3d67414d0f227e">tvg_engine_init</a>(<a class="code" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a>, 0);</div>
<div class="line"><span class="comment">//define canvas and shapes, update shapes, general rendering calls</span></div>
<div class="line"><a class="code" href="group__ThorVGCapi__Initializer.html#ga96d2cc74ed36a277467aba48093e7862">tvg_engine_term</a>(<a class="code" href="group__ThorVGCapi__Initializer.html#ggaa61c2088915fc211ac91ffafaf45f695a87a18b02d5fc2509c1c4372e46183c96">TVG_ENGINE_SW</a>);</div>
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">engine_method</td><td>The engine types to terminate. This is relative to the Canvas types, in which it will be used. For multiple backends bitwise operation is allowed<ul>
<li>TVG_ENGINE_SW: CPU rasterizer</li>
<li>TVG_ENGINE_GL: OpenGL rasterizer (not supported yet)</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_INSUFFICIENT_CONDITION</td><td>Nothing to be terminated. </td></tr>
<tr><td class="paramname">TVG_RESULT_INVALID_ARGUMENT</td><td>Unknown engine type. </td></tr>
<tr><td class="paramname">TVG_RESULT_NOT_SUPPORTED</td><td>Unsupported engine type. </td></tr>
<tr><td class="paramname">TVG_RESULT_UNKNOWN</td><td>An internal error.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Initializer.html#ga315ed4054d2547029c3d67414d0f227e" title="Initializes TVG engines.">tvg_engine_init()</a> </dd>
<dd>
<a class="el" href="group__ThorVGCapi__Initializer.html#gaa61c2088915fc211ac91ffafaf45f695" title="Enumeration specifying the engine type used for the graphics backend. For multiple backends bitwise o...">Tvg_Engine</a> </dd></dl>
</div>
</div>
</div><!-- contents -->
<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:84</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Initializer_html_ga315ed4054d2547029c3d67414d0f227e"><div class="ttname"><a href="group__ThorVGCapi__Initializer.html#ga315ed4054d2547029c3d67414d0f227e">tvg_engine_init</a></div><div class="ttdeci">TVG_EXPORT 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_ga96d2cc74ed36a277467aba48093e7862"><div class="ttname"><a href="group__ThorVGCapi__Initializer.html#ga96d2cc74ed36a277467aba48093e7862">tvg_engine_term</a></div><div class="ttdeci">TVG_EXPORT Tvg_Result tvg_engine_term(Tvg_Engine engine_method)</div><div class="ttdoc">Terminates TVG engines.</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink