mirror of
https://github.com/thorvg/thorvg.git
synced 2025-06-08 13:43:43 +00:00
8eb3517da8
This is a documentation page based on doxygen. CSS: https://jothepro.github.io/doxygen-awesome-css/
655 lines
38 KiB
HTML
655 lines
38 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>ThorVG: Paint</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>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</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="docs_logo.svg"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">ThorVG
|
|
 <span id="projectnumber">v0.1</span>
|
|
</div>
|
|
<div id="projectbrief">ThorVG is a platform-independent portable library for drawing vector-based scene and animation. It's an open-source software that is freely used by a variety of software platforms and applications. ThorVG provides neat and easy APIs, its library has no dependencies and keeps cheap and super compact size. It serves as the vector graphics engine for Tizen OS that powers many products.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</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">
|
|
$(document).ready(function(){initNavTree('group__ThorVGCapi__Paint.html','');});
|
|
</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> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Paint<div class="ingroups"><a class="el" href="group__ThorVG__CAPI.html">ThorVG_CAPI (BETA version)</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A module for managing graphical elements. It enables duplication, transformation and composition.
|
|
<a href="#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for Paint:</div>
|
|
<div class="dyncontent">
|
|
<center><table><tr><td><img src="group__ThorVGCapi__Paint.png" border="0" alt="" usemap="#group____ThorVGCapi____Paint"/>
|
|
<map name="group____ThorVGCapi____Paint" id="group____ThorVGCapi____Paint">
|
|
<area shape="rect" id="node1" href="group__ThorVG__CAPI.html" title="ThorVG C language binding APIs. " alt="" coords="5,5,204,32"/>
|
|
</map>
|
|
</td></tr></table></center>
|
|
</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:ga1ec9193ca6959f9d91a80cc61cd0df3a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Paint.html#ga1ec9193ca6959f9d91a80cc61cd0df3a">Tvg_Composite_Method</a> { <a class="el" href="group__ThorVGCapi__Paint.html#gga1ec9193ca6959f9d91a80cc61cd0df3aa9122090fc6c074e22fa0964effa1b375">TVG_COMPOSITE_METHOD_NONE</a> = 0,
|
|
<a class="el" href="group__ThorVGCapi__Paint.html#gga1ec9193ca6959f9d91a80cc61cd0df3aa517f996a4e50e88727607b959ce52852">TVG_COMPOSITE_METHOD_CLIP_PATH</a>,
|
|
<a class="el" href="group__ThorVGCapi__Paint.html#gga1ec9193ca6959f9d91a80cc61cd0df3aae536c237d654d73f306f2d346fc3c86a">TVG_COMPOSITE_METHOD_ALPHA_MASK</a>,
|
|
<a class="el" href="group__ThorVGCapi__Paint.html#gga1ec9193ca6959f9d91a80cc61cd0df3aaf5b9626da41b4a50070f97139062c759">TVG_COMPOSITE_METHOD_INVERSE_ALPHA_MASK</a>
|
|
}<tr class="memdesc:ga1ec9193ca6959f9d91a80cc61cd0df3a"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration indicating the method used in the composition of two objects - the target and the source. <a href="group__ThorVGCapi__Paint.html#ga1ec9193ca6959f9d91a80cc61cd0df3a">More...</a><br /></td></tr>
|
|
</td></tr>
|
|
<tr class="separator:ga1ec9193ca6959f9d91a80cc61cd0df3a"><td class="memSeparator" colspan="2"> </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:ga707bc7b4cf99ab40063b7eeef89ca170"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Paint.html#ga707bc7b4cf99ab40063b7eeef89ca170">tvg_paint_del</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint)</td></tr>
|
|
<tr class="memdesc:ga707bc7b4cf99ab40063b7eeef89ca170"><td class="mdescLeft"> </td><td class="mdescRight">Releases the given Tvg_Paint object. <a href="#ga707bc7b4cf99ab40063b7eeef89ca170">More...</a><br /></td></tr>
|
|
<tr class="separator:ga707bc7b4cf99ab40063b7eeef89ca170"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad91401c9574f634f0f744d8e5903203b"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Paint.html#gad91401c9574f634f0f744d8e5903203b">tvg_paint_scale</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, float factor)</td></tr>
|
|
<tr class="memdesc:gad91401c9574f634f0f744d8e5903203b"><td class="mdescLeft"> </td><td class="mdescRight">Scales the given Tvg_Paint object by the given factor. <a href="#gad91401c9574f634f0f744d8e5903203b">More...</a><br /></td></tr>
|
|
<tr class="separator:gad91401c9574f634f0f744d8e5903203b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga60ab7fce408fc3065d77895855fcf532"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Paint.html#ga60ab7fce408fc3065d77895855fcf532">tvg_paint_rotate</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, float degree)</td></tr>
|
|
<tr class="memdesc:ga60ab7fce408fc3065d77895855fcf532"><td class="mdescLeft"> </td><td class="mdescRight">Rotates the given Tvg_Paint by the given angle. <a href="#ga60ab7fce408fc3065d77895855fcf532">More...</a><br /></td></tr>
|
|
<tr class="separator:ga60ab7fce408fc3065d77895855fcf532"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf7c5c66bd41da9262996ee9a9def42ff"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Paint.html#gaf7c5c66bd41da9262996ee9a9def42ff">tvg_paint_translate</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, float x, float y)</td></tr>
|
|
<tr class="memdesc:gaf7c5c66bd41da9262996ee9a9def42ff"><td class="mdescLeft"> </td><td class="mdescRight">Moves the given Tvg_Paint in a two-dimensional space. <a href="#gaf7c5c66bd41da9262996ee9a9def42ff">More...</a><br /></td></tr>
|
|
<tr class="separator:gaf7c5c66bd41da9262996ee9a9def42ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga20305aeb11a622e2651ac514296ef008"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Paint.html#ga20305aeb11a622e2651ac514296ef008">tvg_paint_transform</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, const <a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a> *m)</td></tr>
|
|
<tr class="memdesc:ga20305aeb11a622e2651ac514296ef008"><td class="mdescLeft"> </td><td class="mdescRight">Transforms the given Tvg_Paint using the augmented transformation matrix. <a href="#ga20305aeb11a622e2651ac514296ef008">More...</a><br /></td></tr>
|
|
<tr class="separator:ga20305aeb11a622e2651ac514296ef008"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9b621889be1a6aac905a6564d71a800f"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Paint.html#ga9b621889be1a6aac905a6564d71a800f">tvg_paint_set_opacity</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, uint8_t opacity)</td></tr>
|
|
<tr class="memdesc:ga9b621889be1a6aac905a6564d71a800f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the opacity of the given Tvg_Paint. <a href="#ga9b621889be1a6aac905a6564d71a800f">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9b621889be1a6aac905a6564d71a800f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga17ee85c79749f4ee89766e3ad9a5a975"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Paint.html#ga17ee85c79749f4ee89766e3ad9a5a975">tvg_paint_get_opacity</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, uint8_t *opacity)</td></tr>
|
|
<tr class="memdesc:ga17ee85c79749f4ee89766e3ad9a5a975"><td class="mdescLeft"> </td><td class="mdescRight">Gets the opacity of the given Tvg_Paint. <a href="#ga17ee85c79749f4ee89766e3ad9a5a975">More...</a><br /></td></tr>
|
|
<tr class="separator:ga17ee85c79749f4ee89766e3ad9a5a975"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae7852760d3f05e2d7ce0c899535d223b"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Paint.html#gae7852760d3f05e2d7ce0c899535d223b">tvg_paint_duplicate</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint)</td></tr>
|
|
<tr class="memdesc:gae7852760d3f05e2d7ce0c899535d223b"><td class="mdescLeft"> </td><td class="mdescRight">Duplicates the given Tvg_Paint object. <a href="#gae7852760d3f05e2d7ce0c899535d223b">More...</a><br /></td></tr>
|
|
<tr class="separator:gae7852760d3f05e2d7ce0c899535d223b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaae4eee0f8e66407fc933f1552f913d6b"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Paint.html#gaae4eee0f8e66407fc933f1552f913d6b">tvg_paint_get_bounds</a> (const <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, float *x, float *y, float *w, float *h)</td></tr>
|
|
<tr class="memdesc:gaae4eee0f8e66407fc933f1552f913d6b"><td class="mdescLeft"> </td><td class="mdescRight">Gets the bounding box of the Tvg_Paint object before any transformation. <a href="#gaae4eee0f8e66407fc933f1552f913d6b">More...</a><br /></td></tr>
|
|
<tr class="separator:gaae4eee0f8e66407fc933f1552f913d6b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5af1043991b0de19c888855feeab2e5d"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Paint.html#ga5af1043991b0de19c888855feeab2e5d">tvg_paint_set_composite_method</a> (<a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *paint, <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *target, <a class="el" href="group__ThorVGCapi__Paint.html#ga1ec9193ca6959f9d91a80cc61cd0df3a">Tvg_Composite_Method</a> method)</td></tr>
|
|
<tr class="memdesc:ga5af1043991b0de19c888855feeab2e5d"><td class="mdescLeft"> </td><td class="mdescRight">Sets the composition target object and the composition method. <a href="#ga5af1043991b0de19c888855feeab2e5d">More...</a><br /></td></tr>
|
|
<tr class="separator:ga5af1043991b0de19c888855feeab2e5d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>A module for managing graphical elements. It enables duplication, transformation and composition. </p>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="ga1ec9193ca6959f9d91a80cc61cd0df3a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga1ec9193ca6959f9d91a80cc61cd0df3a">◆ </a></span>Tvg_Composite_Method</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__ThorVGCapi__Paint.html#ga1ec9193ca6959f9d91a80cc61cd0df3a">Tvg_Composite_Method</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration indicating the method used in the composition of two objects - the target and the source. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga1ec9193ca6959f9d91a80cc61cd0df3aa9122090fc6c074e22fa0964effa1b375"></a>TVG_COMPOSITE_METHOD_NONE </td><td class="fielddoc"><p>No composition is applied. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga1ec9193ca6959f9d91a80cc61cd0df3aa517f996a4e50e88727607b959ce52852"></a>TVG_COMPOSITE_METHOD_CLIP_PATH </td><td class="fielddoc"><p>The intersection of the source and the target is determined and only the resulting pixels from the source are rendered. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga1ec9193ca6959f9d91a80cc61cd0df3aae536c237d654d73f306f2d346fc3c86a"></a>TVG_COMPOSITE_METHOD_ALPHA_MASK </td><td class="fielddoc"><p>The pixels of the source and the target are alpha blended. As a result, only the part of the source, which intersects with the target is visible. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga1ec9193ca6959f9d91a80cc61cd0df3aaf5b9626da41b4a50070f97139062c759"></a>TVG_COMPOSITE_METHOD_INVERSE_ALPHA_MASK </td><td class="fielddoc"><p>The pixels of the source and the complement to the target's pixels are alpha blended. As a result, only the part of the source which is not covered by the target is visible. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga707bc7b4cf99ab40063b7eeef89ca170"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga707bc7b4cf99ab40063b7eeef89ca170">◆ </a></span>tvg_paint_del()</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_paint_del </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td>
|
|
<td class="paramname"><em>paint</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Releases the given Tvg_Paint object. </p>
|
|
<div class="fragment"><div class="line"><span class="comment">//example of cleanup function</span></div><div class="line"><a class="code" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> *rect = NULL; <span class="comment">//rectangle shape added in other function</span></div><div class="line"></div><div class="line"><span class="comment">//rectangle delete API</span></div><div class="line"><span class="keywordtype">int</span> rectangle_delete(<span class="keywordtype">void</span>) {</div><div class="line"> <span class="keywordflow">if</span> (rect) <a class="code" href="group__ThorVGCapi__Paint.html#ga707bc7b4cf99ab40063b7eeef89ca170">tvg_paint_del</a>(rect);</div><div class="line"> rect = NULL;</div><div class="line">}</div><div class="line"></div><div class="line"><span class="keywordtype">int</span> cleanup(<span class="keywordtype">void</span>) {</div><div class="line"> <a class="code" href="group__ThorVGCapi__Canvas.html#ga052c131ed5a2a3a053dcb321542c2c80">tvg_canvas_clear</a>(canvas, <span class="keyword">false</span>);</div><div class="line"> <a class="code" href="group__ThorVGCapi__Canvas.html#ga0a3af123f8054dc6c182c70dc4907813">tvg_canvas_destroy</a>(canvas);</div><div class="line"> canvas = NULL;</div><div class="line">}</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object to be released.</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_ARGUMENT</td><td>An invalid Tvg_Paint pointer.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section warning"><dt>Warning</dt><dd>If this function is used, <a class="el" href="group__ThorVGCapi__Canvas.html#ga052c131ed5a2a3a053dcb321542c2c80" title="Clears a Tvg_Canvas objects from pushed paints. ">tvg_canvas_clear()</a> with the <code>free</code> argument value set to <code>false</code> should be used in order to avoid unexpected behaviours.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ThorVGCapi__Canvas.html#ga052c131ed5a2a3a053dcb321542c2c80" title="Clears a Tvg_Canvas objects from pushed paints. ">tvg_canvas_clear()</a>, <a class="el" href="group__ThorVGCapi__Canvas.html#ga0a3af123f8054dc6c182c70dc4907813" title="Clears the canvas internal data, releases all paints stored by the canvas and destroys the canvas obj...">tvg_canvas_destroy()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gae7852760d3f05e2d7ce0c899535d223b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gae7852760d3f05e2d7ce0c899535d223b">◆ </a></span>tvg_paint_duplicate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a>* tvg_paint_duplicate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td>
|
|
<td class="paramname"><em>paint</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Duplicates the given Tvg_Paint object. </p>
|
|
<p>Creates a new object and sets its all properties as in the original object.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object to be copied.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A copied Tvg_Paint object if succeed, <code>nullptr</code> otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaae4eee0f8e66407fc933f1552f913d6b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaae4eee0f8e66407fc933f1552f913d6b">◆ </a></span>tvg_paint_get_bounds()</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_paint_get_bounds </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td>
|
|
<td class="paramname"><em>paint</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>w</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>h</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the bounding box of the Tvg_Paint object before any transformation. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object of which to get the bounds. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">x</td><td>The x coordinate of the upper left corner of the object. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">y</td><td>The y coordinate of the upper left corner of the object. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">w</td><td>The width of the object. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">h</td><td>The height of the object.</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_ARGUMENT</td><td>An invalid Tvg_Paint pointer. </td></tr>
|
|
<tr><td class="paramname">TVG_RESULT_INSUFFICIENT_CONDITION</td><td>Other errors. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga17ee85c79749f4ee89766e3ad9a5a975"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga17ee85c79749f4ee89766e3ad9a5a975">◆ </a></span>tvg_paint_get_opacity()</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_paint_get_opacity </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td>
|
|
<td class="paramname"><em>paint</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>opacity</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the opacity of the given Tvg_Paint. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object of which to get the opacity value. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">opacity</td><td>The opacity value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque.</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_ARGUMENT</td><td>In case a <code>nullptr</code> is passed as the argument. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga60ab7fce408fc3065d77895855fcf532"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga60ab7fce408fc3065d77895855fcf532">◆ </a></span>tvg_paint_rotate()</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_paint_rotate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td>
|
|
<td class="paramname"><em>paint</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>degree</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Rotates the given Tvg_Paint by the given angle. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object to be rotated. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">degree</td><td>The value of the rotation angle in degrees.</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_ARGUMENT</td><td>An invalid Tvg_Paint pointer. </td></tr>
|
|
<tr><td class="paramname">TVG_RESULT_FAILED_ALLOCATION</td><td>An internal error with memory allocation. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gad91401c9574f634f0f744d8e5903203b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gad91401c9574f634f0f744d8e5903203b">◆ </a></span>tvg_paint_scale()</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_paint_scale </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td>
|
|
<td class="paramname"><em>paint</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>factor</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Scales the given Tvg_Paint object by the given factor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object to be scaled. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">factor</td><td>The value of the scaling factor. The default value is 1.</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_ARGUMENT</td><td>An invalid Tvg_Paint pointer. </td></tr>
|
|
<tr><td class="paramname">TVG_RESULT_FAILED_ALLOCATION</td><td>An internal error with memory allocation. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5af1043991b0de19c888855feeab2e5d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5af1043991b0de19c888855feeab2e5d">◆ </a></span>tvg_paint_set_composite_method()</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_paint_set_composite_method </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td>
|
|
<td class="paramname"><em>paint</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td>
|
|
<td class="paramname"><em>target</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__ThorVGCapi__Paint.html#ga1ec9193ca6959f9d91a80cc61cd0df3a">Tvg_Composite_Method</a> </td>
|
|
<td class="paramname"><em>method</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the composition target object and the composition method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The source object of the composition. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">target</td><td>The target object of the composition. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">method</td><td>The method used to composite the source object with the target.</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_ARGUMENT</td><td>An invalid <code>paint</code> or <code>target</code> object or the <code>method</code> equal to TVG_COMPOSITE_METHOD_NONE. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9b621889be1a6aac905a6564d71a800f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9b621889be1a6aac905a6564d71a800f">◆ </a></span>tvg_paint_set_opacity()</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_paint_set_opacity </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td>
|
|
<td class="paramname"><em>paint</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>opacity</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the opacity of the given Tvg_Paint. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object of which the opacity value is to be set. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">opacity</td><td>The opacity value in the range [0 ~ 255], where 0 is completely transparent and 255 is opaque.</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_ARGUMENT</td><td>An invalid Tvg_Paint pointer.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Setting the opacity with this API may require multiple renderings using a composition. It is recommended to avoid changing the opacity if possible. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga20305aeb11a622e2651ac514296ef008"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga20305aeb11a622e2651ac514296ef008">◆ </a></span>tvg_paint_transform()</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_paint_transform </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td>
|
|
<td class="paramname"><em>paint</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a> * </td>
|
|
<td class="paramname"><em>m</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Transforms the given Tvg_Paint using the augmented transformation matrix. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object to be transformed. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">m</td><td>The 3x3 augmented matrix.</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_ARGUMENT</td><td>An invalid Tvg_Paint pointer. </td></tr>
|
|
<tr><td class="paramname">TVG_RESULT_FAILED_ALLOCATION</td><td>An internal error with memory allocation. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaf7c5c66bd41da9262996ee9a9def42ff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf7c5c66bd41da9262996ee9a9def42ff">◆ </a></span>tvg_paint_translate()</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_paint_translate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a> * </td>
|
|
<td class="paramname"><em>paint</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Moves the given Tvg_Paint in a two-dimensional space. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">paint</td><td>The Tvg_Paint object to be shifted. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>The value of the horizontal shift. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>The value of the vertical shift.</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_ARGUMENT</td><td>An invalid Tvg_Paint pointer. </td></tr>
|
|
<tr><td class="paramname">TVG_RESULT_FAILED_ALLOCATION</td><td>An internal error with memory allocation. </td></tr>
|
|
</table>
|
|
</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="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|