mirror of
https://github.com/thorvg/thorvg.git
synced 2025-06-08 13:43:43 +00:00
241 lines
18 KiB
HTML
241 lines
18 KiB
HTML
<!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: ThorVG_CAPI</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.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">ThorVG
|
|
 <span id="projectnumber">v0.9</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&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&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="#groups">Modules</a> |
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ThorVG_CAPI</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>ThorVG C language binding APIs.
|
|
<a href="#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ThorVG_CAPI:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="group__ThorVG__CAPI.png" border="0" usemap="#agroup____ThorVG____CAPI" alt=""/></div>
|
|
<map name="agroup____ThorVG____CAPI" id="agroup____ThorVG____CAPI">
|
|
<area shape="rect" title="ThorVG C language binding APIs." alt="" coords="5,179,112,204"/>
|
|
<area shape="rect" href="group__ThorVGCapi__Paint.html" title="A module for managing graphical elements. It enables duplication, transformation and composition." alt="" coords="174,5,229,31"/>
|
|
<area shape="rect" href="group__ThorVGCapi__Saver.html" title="A module for exporting a paint object into a specified file." alt="" coords="172,55,231,80"/>
|
|
<area shape="rect" href="group__ThorVGCapi__Shape.html" title="A module for managing two-dimensional figures and their properties." alt="" coords="170,104,233,129"/>
|
|
<area shape="rect" href="group__ThorVGCapi__Scene.html" title="A module managing the multiple paints as one group paint." alt="" coords="171,153,232,179"/>
|
|
<area shape="rect" href="group__ThorVGCapi__Initializer.html" title="A module enabling initialization and termination of the TVG engines." alt="" coords="160,203,243,228"/>
|
|
<area shape="rect" href="group__ThorVGCapi__Canvas.html" title="A module for managing and drawing graphical elements." alt="" coords="166,252,237,277"/>
|
|
<area shape="rect" href="group__ThorVGCapi__Picture.html" title="A module enabling to create and to load an image in one of the supported formats: svg,..." alt="" coords="168,301,235,327"/>
|
|
<area shape="rect" href="group__ThorVGCapi__Gradient.html" title="A module managing the gradient fill of objects." alt="" coords="162,351,241,376"/>
|
|
</map>
|
|
</div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
|
|
Modules</h2></td></tr>
|
|
<tr class="memitem:group__ThorVGCapi__Initializer"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Initializer.html">Initializer</a></td></tr>
|
|
<tr class="memdesc:group__ThorVGCapi__Initializer"><td class="mdescLeft"> </td><td class="mdescRight">A module enabling initialization and termination of the TVG engines. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:group__ThorVGCapi__Canvas"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Canvas.html">Canvas</a></td></tr>
|
|
<tr class="memdesc:group__ThorVGCapi__Canvas"><td class="mdescLeft"> </td><td class="mdescRight">A module for managing and drawing graphical elements. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:group__ThorVGCapi__Paint"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Paint.html">Paint</a></td></tr>
|
|
<tr class="memdesc:group__ThorVGCapi__Paint"><td class="mdescLeft"> </td><td class="mdescRight">A module for managing graphical elements. It enables duplication, transformation and composition. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:group__ThorVGCapi__Shape"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Shape.html">Shape</a></td></tr>
|
|
<tr class="memdesc:group__ThorVGCapi__Shape"><td class="mdescLeft"> </td><td class="mdescRight">A module for managing two-dimensional figures and their properties. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:group__ThorVGCapi__Gradient"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html">Gradient</a></td></tr>
|
|
<tr class="memdesc:group__ThorVGCapi__Gradient"><td class="mdescLeft"> </td><td class="mdescRight">A module managing the gradient fill of objects. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:group__ThorVGCapi__Picture"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Picture.html">Picture</a></td></tr>
|
|
<tr class="memdesc:group__ThorVGCapi__Picture"><td class="mdescLeft"> </td><td class="mdescRight">A module enabling to create and to load an image in one of the supported formats: svg, png, jpg and raw. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:group__ThorVGCapi__Scene"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Scene.html">Scene</a></td></tr>
|
|
<tr class="memdesc:group__ThorVGCapi__Scene"><td class="mdescLeft"> </td><td class="mdescRight">A module managing the multiple paints as one group paint. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:group__ThorVGCapi__Saver"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Saver.html">Saver</a></td></tr>
|
|
<tr class="memdesc:group__ThorVGCapi__Saver"><td class="mdescLeft"> </td><td class="mdescRight">A module for exporting a paint object into a specified file. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structTvg__Point.html">Tvg_Point</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A data structure representing a point in two-dimensional space. <a href="structTvg__Point.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A data structure representing a three-dimensional matrix. <a href="structTvg__Matrix.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ga5f10c1f3dabdc9287166611c7fe5fd8a"><td class="memItemLeft" align="right" valign="top">typedef struct _Tvg_Canvas </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a></td></tr>
|
|
<tr class="memdesc:ga5f10c1f3dabdc9287166611c7fe5fd8a"><td class="mdescLeft"> </td><td class="mdescRight">A structure responsible for managing and drawing graphical elements. <a href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">More...</a><br /></td></tr>
|
|
<tr class="separator:ga5f10c1f3dabdc9287166611c7fe5fd8a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga98af7c3fe18afa8ad65ea6a6e097a292"><td class="memItemLeft" align="right" valign="top">typedef struct _Tvg_Paint </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a></td></tr>
|
|
<tr class="memdesc:ga98af7c3fe18afa8ad65ea6a6e097a292"><td class="mdescLeft"> </td><td class="mdescRight">A structure representing a graphical element. <a href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">More...</a><br /></td></tr>
|
|
<tr class="separator:ga98af7c3fe18afa8ad65ea6a6e097a292"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafc8e0d01812127260d0753eceb056181"><td class="memItemLeft" align="right" valign="top"><a id="gafc8e0d01812127260d0753eceb056181"></a>
|
|
typedef struct _Tvg_Gradient </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a></td></tr>
|
|
<tr class="memdesc:gafc8e0d01812127260d0753eceb056181"><td class="mdescLeft"> </td><td class="mdescRight">A structure representing a gradient fill of a Tvg_Paint object. <br /></td></tr>
|
|
<tr class="separator:gafc8e0d01812127260d0753eceb056181"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac16750954e423565f6d143a66aa03b31"><td class="memItemLeft" align="right" valign="top"><a id="gac16750954e423565f6d143a66aa03b31"></a>
|
|
typedef struct _Tvg_Saver </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVG__CAPI.html#gac16750954e423565f6d143a66aa03b31">Tvg_Saver</a></td></tr>
|
|
<tr class="memdesc:gac16750954e423565f6d143a66aa03b31"><td class="mdescLeft"> </td><td class="mdescRight">A structure representing an object that enables to save a Tvg_Paint object into a file. <br /></td></tr>
|
|
<tr class="separator:gac16750954e423565f6d143a66aa03b31"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:gad980f552658dcbbe42a0168f35c27781"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> { <br />
|
|
  <a class="el" href="group__ThorVG__CAPI.html#ggad980f552658dcbbe42a0168f35c27781ab3840b5bbade03c076caa5a32fe5ee47">TVG_RESULT_SUCCESS</a> = 0
|
|
, <a class="el" href="group__ThorVG__CAPI.html#ggad980f552658dcbbe42a0168f35c27781a1cf3b50869745c98ef4f59079aed3a6e">TVG_RESULT_INVALID_ARGUMENT</a>
|
|
, <a class="el" href="group__ThorVG__CAPI.html#ggad980f552658dcbbe42a0168f35c27781a6ac2425d9e8afeff9d6d847cb6fc44b3">TVG_RESULT_INSUFFICIENT_CONDITION</a>
|
|
, <a class="el" href="group__ThorVG__CAPI.html#ggad980f552658dcbbe42a0168f35c27781a30ea1fee167bdc1fc70005fb6d2d1b59">TVG_RESULT_FAILED_ALLOCATION</a>
|
|
, <br />
|
|
  <a class="el" href="group__ThorVG__CAPI.html#ggad980f552658dcbbe42a0168f35c27781a7e0e245d6bf67c84e0b74838e765d98b">TVG_RESULT_MEMORY_CORRUPTION</a>
|
|
, <a class="el" href="group__ThorVG__CAPI.html#ggad980f552658dcbbe42a0168f35c27781a24cd3c83f47655b8987281f4cbc1dd24">TVG_RESULT_NOT_SUPPORTED</a>
|
|
, <a class="el" href="group__ThorVG__CAPI.html#ggad980f552658dcbbe42a0168f35c27781a1820972547d1ef01782d7e8f60266109">TVG_RESULT_UNKNOWN</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:gad980f552658dcbbe42a0168f35c27781"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration specifying the result from the APIs. <a href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">More...</a><br /></td></tr>
|
|
<tr class="separator:gad980f552658dcbbe42a0168f35c27781"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>ThorVG C language binding APIs. </p>
|
|
<h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="ga5f10c1f3dabdc9287166611c7fe5fd8a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5f10c1f3dabdc9287166611c7fe5fd8a">◆ </a></span>Tvg_Canvas</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct _Tvg_Canvas <a class="el" href="group__ThorVG__CAPI.html#ga5f10c1f3dabdc9287166611c7fe5fd8a">Tvg_Canvas</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A structure responsible for managing and drawing graphical elements. </p>
|
|
<p>It sets up the target buffer, which can be drawn on the screen. It stores the Tvg_Paint objects (Shape, Scene, Picture). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga98af7c3fe18afa8ad65ea6a6e097a292"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga98af7c3fe18afa8ad65ea6a6e097a292">◆ </a></span>Tvg_Paint</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef struct _Tvg_Paint <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A structure representing a graphical element. </p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>The TvgPaint objects can not be shared between Canvases. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="gad980f552658dcbbe42a0168f35c27781"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gad980f552658dcbbe42a0168f35c27781">◆ </a></span>Tvg_Result</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration specifying the result from the APIs. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggad980f552658dcbbe42a0168f35c27781ab3840b5bbade03c076caa5a32fe5ee47"></a>TVG_RESULT_SUCCESS </td><td class="fielddoc"><p>The value returned in case of a correct request execution. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggad980f552658dcbbe42a0168f35c27781a1cf3b50869745c98ef4f59079aed3a6e"></a>TVG_RESULT_INVALID_ARGUMENT </td><td class="fielddoc"><p>The value returned in the event of a problem with the arguments given to the API - e.g. empty paths or null pointers. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggad980f552658dcbbe42a0168f35c27781a6ac2425d9e8afeff9d6d847cb6fc44b3"></a>TVG_RESULT_INSUFFICIENT_CONDITION </td><td class="fielddoc"><p>The value returned in case the request cannot be processed - e.g. asking for properties of an object, which does not exist. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggad980f552658dcbbe42a0168f35c27781a30ea1fee167bdc1fc70005fb6d2d1b59"></a>TVG_RESULT_FAILED_ALLOCATION </td><td class="fielddoc"><p>The value returned in case of unsuccessful memory allocation. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggad980f552658dcbbe42a0168f35c27781a7e0e245d6bf67c84e0b74838e765d98b"></a>TVG_RESULT_MEMORY_CORRUPTION </td><td class="fielddoc"><p>The value returned in the event of bad memory handling - e.g. failing in pointer releasing or casting. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggad980f552658dcbbe42a0168f35c27781a24cd3c83f47655b8987281f4cbc1dd24"></a>TVG_RESULT_NOT_SUPPORTED </td><td class="fielddoc"><p>The value returned in case of choosing unsupported options. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggad980f552658dcbbe42a0168f35c27781a1820972547d1ef01782d7e8f60266109"></a>TVG_RESULT_UNKNOWN </td><td class="fielddoc"><p>The value returned in all other cases. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
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
|
|
</small></address>
|
|
</body>
|
|
</html>
|