mirror of
https://github.com/thorvg/thorvg.git
synced 2025-06-07 21:23:32 +00:00
659 lines
54 KiB
HTML
659 lines
54 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</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
|
|
 <span id="projectnumber">v0.14</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 -->
|
|
<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&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('group__ThorVG.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="#nested-classes">Classes</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ThorVG</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>ThorVG classes and enumerations providing C++ APIs.
|
|
<a href="#details">More...</a></p>
|
|
<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_1_1Point.html">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_1_1Point.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_1_1Matrix.html">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_1_1Matrix.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_1_1Vertex.html">Vertex</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A data structure representing a texture mesh vertex. <a href="structtvg_1_1Vertex.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_1_1Polygon.html">Polygon</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A data structure representing a triangle in a texture mesh. <a href="structtvg_1_1Polygon.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Paint.html">Paint</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An abstract class for managing graphical elements. <a href="classtvg_1_1Paint.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Fill.html">Fill</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An abstract class representing the gradient fill of the <a class="el" href="classtvg_1_1Shape.html" title="A class representing two-dimensional figures and their properties.">Shape</a> object. <a href="classtvg_1_1Fill.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html">Canvas</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An abstract class for drawing graphical elements. <a href="classtvg_1_1Canvas.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1LinearGradient.html">LinearGradient</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A class representing the linear gradient fill of the <a class="el" href="classtvg_1_1Shape.html" title="A class representing two-dimensional figures and their properties.">Shape</a> object. <a href="classtvg_1_1LinearGradient.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1RadialGradient.html">RadialGradient</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A class representing the radial gradient fill of the <a class="el" href="classtvg_1_1Shape.html" title="A class representing two-dimensional figures and their properties.">Shape</a> object. <a href="classtvg_1_1RadialGradient.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Shape.html">Shape</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A class representing two-dimensional figures and their properties. <a href="classtvg_1_1Shape.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Picture.html">Picture</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A class representing an image read in one of the supported formats: raw, svg, png, jpg, lottie(json) and etc. Besides the methods inherited from the <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a>, it provides methods to load & draw images on the canvas. <a href="classtvg_1_1Picture.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Scene.html">Scene</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A class to composite children paints. <a href="classtvg_1_1Scene.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Text.html">Text</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A class to represent text objects in a graphical context, allowing for rendering and manipulation of unicode text. <a href="classtvg_1_1Text.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1SwCanvas.html">SwCanvas</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A class for the rendering graphical elements with a software raster engine. <a href="classtvg_1_1SwCanvas.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1GlCanvas.html">GlCanvas</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A class for the rendering graphic elements with a GL raster engine. <a href="classtvg_1_1GlCanvas.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1WgCanvas.html">WgCanvas</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A class for the rendering graphic elements with a WebGPU raster engine. <a href="classtvg_1_1WgCanvas.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Initializer.html">Initializer</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A class that enables initialization and termination of the TVG engines. <a href="classtvg_1_1Initializer.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Animation.html">Animation</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classtvg_1_1Animation.html" title="The Animation class enables manipulation of animatable images.">Animation</a> class enables manipulation of animatable images. <a href="classtvg_1_1Animation.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Saver.html">Saver</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A class for exporting a paint object into a specified file, from which to recover the paint data later. <a href="classtvg_1_1Saver.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Accessor.html">Accessor</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classtvg_1_1Accessor.html" title="The Accessor is a utility class to debug the Scene structure by traversing the scene-tree.">Accessor</a> is a utility class to debug the <a class="el" href="classtvg_1_1Scene.html" title="A class to composite children paints.">Scene</a> structure by traversing the scene-tree. <a href="classtvg_1_1Accessor.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="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ga28287671eaf7406afd604bd055ba4066"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> { <br />
|
|
  <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38">Success</a> = 0
|
|
, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066ae73a2e92f1c87086c838b442552a4775">InvalidArguments</a>
|
|
, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a119732ff568bf103d744e930ae2404f1">InsufficientCondition</a>
|
|
, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066abc2b4181e818f2e9b52b2bc54dd55907">FailedAllocation</a>
|
|
, <br />
|
|
  <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066ae8c0c653fcac575c31470f0f800991c6">MemoryCorruption</a>
|
|
, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066aa0cfd518e4385f31d38720579321ed29">NonSupport</a>
|
|
, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a88183b946cc5f0e8c96b2e66e1c74a7e">Unknown</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:ga28287671eaf7406afd604bd055ba4066"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration specifying the result from the APIs. <a href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">More...</a><br /></td></tr>
|
|
<tr class="separator:ga28287671eaf7406afd604bd055ba4066"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6876ed676934f4dbcc19b1b53c153cc1"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVG.html#ga6876ed676934f4dbcc19b1b53c153cc1">PathCommand</a> { <a class="el" href="group__ThorVG.html#gga6876ed676934f4dbcc19b1b53c153cc1ad3d2e617335f08df83599665eef8a418">Close</a> = 0
|
|
, <a class="el" href="group__ThorVG.html#gga6876ed676934f4dbcc19b1b53c153cc1ad9046d3b1ebf3889943b3be3ca477613">MoveTo</a>
|
|
, <a class="el" href="group__ThorVG.html#gga6876ed676934f4dbcc19b1b53c153cc1a5dc59cf06f56c730c0a4bfe69c9bf689">LineTo</a>
|
|
, <a class="el" href="group__ThorVG.html#gga6876ed676934f4dbcc19b1b53c153cc1ac8cd9cd16086764627079ed21bfc4e29">CubicTo</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga6876ed676934f4dbcc19b1b53c153cc1"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration specifying the values of the path commands accepted by TVG. <a href="group__ThorVG.html#ga6876ed676934f4dbcc19b1b53c153cc1">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6876ed676934f4dbcc19b1b53c153cc1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6239974a858100e129f1e0b8ffac4f96"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVG.html#ga6239974a858100e129f1e0b8ffac4f96">StrokeCap</a> { <a class="el" href="group__ThorVG.html#gga6239974a858100e129f1e0b8ffac4f96aceb46ca115d05c51aa5a16a8867c3304">Square</a> = 0
|
|
, <a class="el" href="group__ThorVG.html#gga6239974a858100e129f1e0b8ffac4f96ab7f41fc1412ad2ee75e9b2635d3b9d5c">Round</a>
|
|
, <a class="el" href="group__ThorVG.html#gga6239974a858100e129f1e0b8ffac4f96ab2635ed1075287dea1eb1598a90df1fe">Butt</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga6239974a858100e129f1e0b8ffac4f96"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration determining the ending type of a stroke in the open sub-paths. <a href="group__ThorVG.html#ga6239974a858100e129f1e0b8ffac4f96">More...</a><br /></td></tr>
|
|
<tr class="separator:ga6239974a858100e129f1e0b8ffac4f96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaba8b7236c41a171289aef2f3c71eef51"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVG.html#gaba8b7236c41a171289aef2f3c71eef51">StrokeJoin</a> { <a class="el" href="group__ThorVG.html#ggaba8b7236c41a171289aef2f3c71eef51a1b9ae4ca6d43fc984af318046e1e7bb5">Bevel</a> = 0
|
|
, <a class="el" href="group__ThorVG.html#ggaba8b7236c41a171289aef2f3c71eef51ab7f41fc1412ad2ee75e9b2635d3b9d5c">Round</a>
|
|
, <a class="el" href="group__ThorVG.html#ggaba8b7236c41a171289aef2f3c71eef51ae4396f81cd926bb129ccf3c147c64514">Miter</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:gaba8b7236c41a171289aef2f3c71eef51"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration determining the style used at the corners of joined stroked path segments. <a href="group__ThorVG.html#gaba8b7236c41a171289aef2f3c71eef51">More...</a><br /></td></tr>
|
|
<tr class="separator:gaba8b7236c41a171289aef2f3c71eef51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga0cfa2c92260cca776292cc9e8964f2da"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVG.html#ga0cfa2c92260cca776292cc9e8964f2da">FillSpread</a> { <a class="el" href="group__ThorVG.html#gga0cfa2c92260cca776292cc9e8964f2daade43468adaf6acb2c38ebc0c1176f82f">Pad</a> = 0
|
|
, <a class="el" href="group__ThorVG.html#gga0cfa2c92260cca776292cc9e8964f2daa74de3e45e4491e956e8dc18d841d9b00">Reflect</a>
|
|
, <a class="el" href="group__ThorVG.html#gga0cfa2c92260cca776292cc9e8964f2daa7020426cfb0a204051be4b3053d2acc8">Repeat</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga0cfa2c92260cca776292cc9e8964f2da"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration specifying how to fill the area outside the gradient bounds. <a href="group__ThorVG.html#ga0cfa2c92260cca776292cc9e8964f2da">More...</a><br /></td></tr>
|
|
<tr class="separator:ga0cfa2c92260cca776292cc9e8964f2da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9a534b0377c9ca41983d53b0dae0d5a4"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVG.html#ga9a534b0377c9ca41983d53b0dae0d5a4">FillRule</a> { <a class="el" href="group__ThorVG.html#gga9a534b0377c9ca41983d53b0dae0d5a4a268b61c62382fc1f9ca5cf52a4fece32">Winding</a> = 0
|
|
, <a class="el" href="group__ThorVG.html#gga9a534b0377c9ca41983d53b0dae0d5a4a8e586e4bd2c45e86222301f2e6e0e390">EvenOdd</a>
|
|
}</td></tr>
|
|
<tr class="memdesc:ga9a534b0377c9ca41983d53b0dae0d5a4"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration specifying the algorithm used to establish which parts of the shape are treated as the inside of the shape. <a href="group__ThorVG.html#ga9a534b0377c9ca41983d53b0dae0d5a4">More...</a><br /></td></tr>
|
|
<tr class="separator:ga9a534b0377c9ca41983d53b0dae0d5a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaabdf94ada64e69d06deabc5aa6576f87"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVG.html#gaabdf94ada64e69d06deabc5aa6576f87">CompositeMethod</a> { <br />
|
|
  <a class="el" href="group__ThorVG.html#ggaabdf94ada64e69d06deabc5aa6576f87a6adf97f83acf6453d4a6a4b1070f3754">None</a> = 0
|
|
, <a class="el" href="group__ThorVG.html#ggaabdf94ada64e69d06deabc5aa6576f87a60575a18ece363c72551a982450efd52">ClipPath</a>
|
|
, <a class="el" href="group__ThorVG.html#ggaabdf94ada64e69d06deabc5aa6576f87abd68e2bb79d1a5e65ad8f0d202d14cbc">AlphaMask</a>
|
|
, <a class="el" href="group__ThorVG.html#ggaabdf94ada64e69d06deabc5aa6576f87a59cc48dcf714e3a3c2492f4dce1fe134">InvAlphaMask</a>
|
|
, <br />
|
|
  <a class="el" href="group__ThorVG.html#ggaabdf94ada64e69d06deabc5aa6576f87a4dae6fdfeb902e322a7bc9122c4e4cb4">LumaMask</a>
|
|
, <a class="el" href="group__ThorVG.html#ggaabdf94ada64e69d06deabc5aa6576f87a28f3dcc7d8cad65deff7d3a83031ef5a">InvLumaMask</a>
|
|
, <a class="el" href="group__ThorVG.html#ggaabdf94ada64e69d06deabc5aa6576f87a8e1e296c3f01c21b1a3db79f0ce4fe9a">AddMask</a>
|
|
, <a class="el" href="group__ThorVG.html#ggaabdf94ada64e69d06deabc5aa6576f87a9d512562eaac237c0cb5119d202decb1">SubtractMask</a>
|
|
, <br />
|
|
  <a class="el" href="group__ThorVG.html#ggaabdf94ada64e69d06deabc5aa6576f87ac41b6c9f18e9ee080e9f74bceff36a47">IntersectMask</a>
|
|
, <a class="el" href="group__ThorVG.html#ggaabdf94ada64e69d06deabc5aa6576f87a8c6c379355c2381e10645dbd19f29884">DifferenceMask</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:gaabdf94ada64e69d06deabc5aa6576f87"><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__ThorVG.html#gaabdf94ada64e69d06deabc5aa6576f87">More...</a><br /></td></tr>
|
|
<tr class="separator:gaabdf94ada64e69d06deabc5aa6576f87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4dd2f3776540c10b565e0446aa8e9e02"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVG.html#ga4dd2f3776540c10b565e0446aa8e9e02">BlendMethod</a> : uint8_t { <br />
|
|
  <a class="el" href="group__ThorVG.html#gga4dd2f3776540c10b565e0446aa8e9e02a960b44c579bc2f6818d2daaf9e4c16f0">Normal</a> = 0
|
|
, <a class="el" href="group__ThorVG.html#gga4dd2f3776540c10b565e0446aa8e9e02aec211f7c20af43e742bf2570c3cb84f9">Add</a>
|
|
, <a class="el" href="group__ThorVG.html#gga4dd2f3776540c10b565e0446aa8e9e02a2fc3359e12b2a9104121dcf04246f6a0">Screen</a>
|
|
, <a class="el" href="group__ThorVG.html#gga4dd2f3776540c10b565e0446aa8e9e02ae257376d913f3b53cbb4a9b19d770648">Multiply</a>
|
|
, <br />
|
|
  <a class="el" href="group__ThorVG.html#gga4dd2f3776540c10b565e0446aa8e9e02a6b551379c3c0b59326abdaf3b4395bd3">Overlay</a>
|
|
, <a class="el" href="group__ThorVG.html#gga4dd2f3776540c10b565e0446aa8e9e02a28ed2ac6c29f64a3692c956004b8ff7a">Difference</a>
|
|
, <a class="el" href="group__ThorVG.html#gga4dd2f3776540c10b565e0446aa8e9e02a25218e43e67f1b1c1c833bc48c7ca7bb">Exclusion</a>
|
|
, <a class="el" href="group__ThorVG.html#gga4dd2f3776540c10b565e0446aa8e9e02a9d8c3c91bdcdae522fb3e0cf921ee4ef">SrcOver</a>
|
|
, <br />
|
|
  <a class="el" href="group__ThorVG.html#gga4dd2f3776540c10b565e0446aa8e9e02af367cda25ead743bb0d2ab9c217e0b99">Darken</a>
|
|
, <a class="el" href="group__ThorVG.html#gga4dd2f3776540c10b565e0446aa8e9e02a1371ecd5df513d77a001392435cf4d12">Lighten</a>
|
|
, <a class="el" href="group__ThorVG.html#gga4dd2f3776540c10b565e0446aa8e9e02aee9ea3fbc70cb0f07c7ec4c48712d900">ColorDodge</a>
|
|
, <a class="el" href="group__ThorVG.html#gga4dd2f3776540c10b565e0446aa8e9e02aa061fdf49738be2999f722b45661e825">ColorBurn</a>
|
|
, <br />
|
|
  <a class="el" href="group__ThorVG.html#gga4dd2f3776540c10b565e0446aa8e9e02ad509708d332760c4dac5299aee3aa518">HardLight</a>
|
|
, <a class="el" href="group__ThorVG.html#gga4dd2f3776540c10b565e0446aa8e9e02a0110233d77ea3a1b09b5a5a5e3e48ec3">SoftLight</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:ga4dd2f3776540c10b565e0446aa8e9e02"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration indicates the method used for blending paint. Please refer to the respective formulas for each method. <a href="group__ThorVG.html#ga4dd2f3776540c10b565e0446aa8e9e02">More...</a><br /></td></tr>
|
|
<tr class="separator:ga4dd2f3776540c10b565e0446aa8e9e02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3dfc0651e85484b1011772dd9f8300df"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVG.html#ga3dfc0651e85484b1011772dd9f8300df">CanvasEngine</a> { <a class="el" href="group__ThorVG.html#gga3dfc0651e85484b1011772dd9f8300dfa1f030517f6d25e8607a2a9a7f6227ebc">Sw</a> = (1 << 1)
|
|
, <a class="el" href="group__ThorVG.html#gga3dfc0651e85484b1011772dd9f8300dfa0f16de4274952a7184e059c5f2d048d6">Gl</a> = (1 << 2)
|
|
, <a class="el" href="group__ThorVG.html#gga3dfc0651e85484b1011772dd9f8300dfaaa30321309dc6c2ee993415b375db259">Wg</a> = (1 << 3)
|
|
}</td></tr>
|
|
<tr class="memdesc:ga3dfc0651e85484b1011772dd9f8300df"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration specifying the engine type used for the graphics backend. For multiple backends bitwise operation is allowed. <a href="group__ThorVG.html#ga3dfc0651e85484b1011772dd9f8300df">More...</a><br /></td></tr>
|
|
<tr class="separator:ga3dfc0651e85484b1011772dd9f8300df"><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:ga18826bfb9bff2e77bdafce9a510be57f"><td class="memTemplParams" colspan="2">template<typename T = tvg::Paint> </td></tr>
|
|
<tr class="memitem:ga18826bfb9bff2e77bdafce9a510be57f"><td class="memTemplItemLeft" align="right" valign="top">std::unique_ptr< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__ThorVG.html#ga18826bfb9bff2e77bdafce9a510be57f">cast</a> (<a class="el" href="classtvg_1_1Paint.html">Paint</a> *paint)</td></tr>
|
|
<tr class="memdesc:ga18826bfb9bff2e77bdafce9a510be57f"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="group__ThorVG.html#ga151ac90e5e41b7dcbea2265cfd6a54ca" title="The cast() function is a utility function used to cast a 'Fill' to type 'T'.">cast()</a> function is a utility function used to cast a '<a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a>' to type 'T'. <a href="group__ThorVG.html#ga18826bfb9bff2e77bdafce9a510be57f">More...</a><br /></td></tr>
|
|
<tr class="separator:ga18826bfb9bff2e77bdafce9a510be57f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga151ac90e5e41b7dcbea2265cfd6a54ca"><td class="memTemplParams" colspan="2">template<typename T = tvg::Fill> </td></tr>
|
|
<tr class="memitem:ga151ac90e5e41b7dcbea2265cfd6a54ca"><td class="memTemplItemLeft" align="right" valign="top">std::unique_ptr< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__ThorVG.html#ga151ac90e5e41b7dcbea2265cfd6a54ca">cast</a> (<a class="el" href="classtvg_1_1Fill.html">Fill</a> *fill)</td></tr>
|
|
<tr class="memdesc:ga151ac90e5e41b7dcbea2265cfd6a54ca"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="group__ThorVG.html#ga151ac90e5e41b7dcbea2265cfd6a54ca" title="The cast() function is a utility function used to cast a 'Fill' to type 'T'.">cast()</a> function is a utility function used to cast a '<a class="el" href="classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object.">Fill</a>' to type 'T'. <a href="group__ThorVG.html#ga151ac90e5e41b7dcbea2265cfd6a54ca">More...</a><br /></td></tr>
|
|
<tr class="separator:ga151ac90e5e41b7dcbea2265cfd6a54ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>ThorVG classes and enumerations providing C++ APIs. </p>
|
|
<h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="ga4dd2f3776540c10b565e0446aa8e9e02"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga4dd2f3776540c10b565e0446aa8e9e02">◆ </a></span>BlendMethod</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__ThorVG.html#ga4dd2f3776540c10b565e0446aa8e9e02">BlendMethod</a> : uint8_t</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration indicates the method used for blending paint. Please refer to the respective formulas for each method. </p>
|
|
<p>Notation: S(source paint as the top layer), D(destination as the bottom layer), Sa(source paint alpha), Da(destination alpha)</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classtvg_1_1Paint.html#a7e1214a5dc2f3c19ddeedc5371c4e488" title="Sets the blending method for the paint object.">Paint::blend()</a></dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Experimental API </dd></dl>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga4dd2f3776540c10b565e0446aa8e9e02a960b44c579bc2f6818d2daaf9e4c16f0"></a>Normal </td><td class="fielddoc"><p>Perform the alpha blending(default). S if (Sa == 255), otherwise (Sa * S) + (255 - Sa) * D. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga4dd2f3776540c10b565e0446aa8e9e02aec211f7c20af43e742bf2570c3cb84f9"></a>Add </td><td class="fielddoc"><p>Simply adds pixel values of one layer with the other. (S + D) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga4dd2f3776540c10b565e0446aa8e9e02a2fc3359e12b2a9104121dcf04246f6a0"></a>Screen </td><td class="fielddoc"><p>The values of the pixels in the two layers are inverted, multiplied, and then inverted again. (S + D) - (S * D) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga4dd2f3776540c10b565e0446aa8e9e02ae257376d913f3b53cbb4a9b19d770648"></a>Multiply </td><td class="fielddoc"><p>Takes the RGB channel values from 0 to 255 of each pixel in the top layer and multiples them with the values for the corresponding pixel from the bottom layer. (S * D) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga4dd2f3776540c10b565e0446aa8e9e02a6b551379c3c0b59326abdaf3b4395bd3"></a>Overlay </td><td class="fielddoc"><p>Combines Multiply and Screen blend modes. (2 * S * D) if (2 * D < Da), otherwise (Sa * Da) - 2 * (Da - S) * (Sa - D) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga4dd2f3776540c10b565e0446aa8e9e02a28ed2ac6c29f64a3692c956004b8ff7a"></a>Difference </td><td class="fielddoc"><p>Subtracts the bottom layer from the top layer or the other way around, to always get a non-negative value. (S - D) if (S > D), otherwise (D - S) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga4dd2f3776540c10b565e0446aa8e9e02a25218e43e67f1b1c1c833bc48c7ca7bb"></a>Exclusion </td><td class="fielddoc"><p>The result is twice the product of the top and bottom layers, subtracted from their sum. s + d - (2 * s * d) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga4dd2f3776540c10b565e0446aa8e9e02a9d8c3c91bdcdae522fb3e0cf921ee4ef"></a>SrcOver </td><td class="fielddoc"><p>Replace the bottom layer with the top layer. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga4dd2f3776540c10b565e0446aa8e9e02af367cda25ead743bb0d2ab9c217e0b99"></a>Darken </td><td class="fielddoc"><p>Creates a pixel that retains the smallest components of the top and bottom layer pixels. min(S, D) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga4dd2f3776540c10b565e0446aa8e9e02a1371ecd5df513d77a001392435cf4d12"></a>Lighten </td><td class="fielddoc"><p>Only has the opposite action of Darken Only. max(S, D) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga4dd2f3776540c10b565e0446aa8e9e02aee9ea3fbc70cb0f07c7ec4c48712d900"></a>ColorDodge </td><td class="fielddoc"><p>Divides the bottom layer by the inverted top layer. D / (255 - S) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga4dd2f3776540c10b565e0446aa8e9e02aa061fdf49738be2999f722b45661e825"></a>ColorBurn </td><td class="fielddoc"><p>Divides the inverted bottom layer by the top layer, and then inverts the result. 255 - (255 - D) / S. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga4dd2f3776540c10b565e0446aa8e9e02ad509708d332760c4dac5299aee3aa518"></a>HardLight </td><td class="fielddoc"><p>The same as Overlay but with the color roles reversed. (2 * S * D) if (S < Sa), otherwise (Sa * Da) - 2 * (Da - S) * (Sa - D) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga4dd2f3776540c10b565e0446aa8e9e02a0110233d77ea3a1b09b5a5a5e3e48ec3"></a>SoftLight </td><td class="fielddoc"><p>The same as Overlay but with applying pure black or white does not result in pure black or white. (1 - 2 * S) * (D ^ 2) + (2 * S * D) </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga3dfc0651e85484b1011772dd9f8300df"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga3dfc0651e85484b1011772dd9f8300df">◆ </a></span>CanvasEngine</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__ThorVG.html#ga3dfc0651e85484b1011772dd9f8300df">CanvasEngine</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </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="gga3dfc0651e85484b1011772dd9f8300dfa1f030517f6d25e8607a2a9a7f6227ebc"></a>Sw </td><td class="fielddoc"><p>CPU rasterizer. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga3dfc0651e85484b1011772dd9f8300dfa0f16de4274952a7184e059c5f2d048d6"></a>Gl </td><td class="fielddoc"><p>OpenGL rasterizer. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga3dfc0651e85484b1011772dd9f8300dfaaa30321309dc6c2ee993415b375db259"></a>Wg </td><td class="fielddoc"><p>WebGPU rasterizer. (Experimental API) </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaabdf94ada64e69d06deabc5aa6576f87"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaabdf94ada64e69d06deabc5aa6576f87">◆ </a></span>CompositeMethod</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__ThorVG.html#gaabdf94ada64e69d06deabc5aa6576f87">CompositeMethod</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </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>
|
|
<p>Notation: S(Source), T(Target), SA(Source Alpha), TA(Target Alpha)</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classtvg_1_1Paint.html#a2e2d077b820d1cfd6502a86e0221638b" title="Sets the composition target object and the composition method.">Paint::composite()</a> </dd></dl>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaabdf94ada64e69d06deabc5aa6576f87a6adf97f83acf6453d4a6a4b1070f3754"></a>None </td><td class="fielddoc"><p>No composition is applied. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaabdf94ada64e69d06deabc5aa6576f87a60575a18ece363c72551a982450efd52"></a>ClipPath </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="ggaabdf94ada64e69d06deabc5aa6576f87abd68e2bb79d1a5e65ad8f0d202d14cbc"></a>AlphaMask </td><td class="fielddoc"><p>Alpha Masking using the compositing target's pixels as an alpha value. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaabdf94ada64e69d06deabc5aa6576f87a59cc48dcf714e3a3c2492f4dce1fe134"></a>InvAlphaMask </td><td class="fielddoc"><p>Alpha Masking using the complement to the compositing target's pixels as an alpha value. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaabdf94ada64e69d06deabc5aa6576f87a4dae6fdfeb902e322a7bc9122c4e4cb4"></a>LumaMask </td><td class="fielddoc"><p>Alpha Masking using the grayscale (0.2125R + 0.7154G + 0.0721*B) of the compositing target's pixels. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.9 </dd></dl>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaabdf94ada64e69d06deabc5aa6576f87a28f3dcc7d8cad65deff7d3a83031ef5a"></a>InvLumaMask </td><td class="fielddoc"><p>Alpha Masking using the grayscale (0.2125R + 0.7154G + 0.0721*B) of the complement to the compositing target's pixels. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.11 </dd></dl>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaabdf94ada64e69d06deabc5aa6576f87a8e1e296c3f01c21b1a3db79f0ce4fe9a"></a>AddMask </td><td class="fielddoc"><p>Combines the target and source objects pixels using target alpha. (T * TA) + (S * (255 - TA)) (Experimental API) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaabdf94ada64e69d06deabc5aa6576f87a9d512562eaac237c0cb5119d202decb1"></a>SubtractMask </td><td class="fielddoc"><p>Subtracts the source color from the target color while considering their respective target alpha. (T * TA) - (S * (255 - TA)) (Experimental API) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaabdf94ada64e69d06deabc5aa6576f87ac41b6c9f18e9ee080e9f74bceff36a47"></a>IntersectMask </td><td class="fielddoc"><p>Computes the result by taking the minimum value between the target alpha and the source alpha and multiplies it with the target color. (T * min(TA, SA)) (Experimental API) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaabdf94ada64e69d06deabc5aa6576f87a8c6c379355c2381e10645dbd19f29884"></a>DifferenceMask </td><td class="fielddoc"><p>Calculates the absolute difference between the target color and the source color multiplied by the complement of the target alpha. abs(T - S * (255 - TA)) (Experimental API) </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9a534b0377c9ca41983d53b0dae0d5a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9a534b0377c9ca41983d53b0dae0d5a4">◆ </a></span>FillRule</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__ThorVG.html#ga9a534b0377c9ca41983d53b0dae0d5a4">FillRule</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration specifying the algorithm used to establish which parts of the shape are treated as the inside of the shape. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga9a534b0377c9ca41983d53b0dae0d5a4a268b61c62382fc1f9ca5cf52a4fece32"></a>Winding </td><td class="fielddoc"><p>A line from the point to a location outside the shape is drawn. The intersections of the line with the path segment of the shape are counted. Starting from zero, if the path segment of the shape crosses the line clockwise, one is added, otherwise one is subtracted. If the resulting sum is non zero, the point is inside the shape. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga9a534b0377c9ca41983d53b0dae0d5a4a8e586e4bd2c45e86222301f2e6e0e390"></a>EvenOdd </td><td class="fielddoc"><p>A line from the point to a location outside the shape is drawn and its intersections with the path segments of the shape are counted. If the number of intersections is an odd number, the point is inside the shape. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga0cfa2c92260cca776292cc9e8964f2da"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga0cfa2c92260cca776292cc9e8964f2da">◆ </a></span>FillSpread</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__ThorVG.html#ga0cfa2c92260cca776292cc9e8964f2da">FillSpread</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration specifying how to fill the area outside the gradient bounds. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga0cfa2c92260cca776292cc9e8964f2daade43468adaf6acb2c38ebc0c1176f82f"></a>Pad </td><td class="fielddoc"><p>The remaining area is filled with the closest stop color. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga0cfa2c92260cca776292cc9e8964f2daa74de3e45e4491e956e8dc18d841d9b00"></a>Reflect </td><td class="fielddoc"><p>The gradient pattern is reflected outside the gradient area until the expected region is filled. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga0cfa2c92260cca776292cc9e8964f2daa7020426cfb0a204051be4b3053d2acc8"></a>Repeat </td><td class="fielddoc"><p>The gradient pattern is repeated continuously beyond the gradient area until the expected region is filled. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6876ed676934f4dbcc19b1b53c153cc1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6876ed676934f4dbcc19b1b53c153cc1">◆ </a></span>PathCommand</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__ThorVG.html#ga6876ed676934f4dbcc19b1b53c153cc1">PathCommand</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration specifying the values of the path commands accepted by TVG. </p>
|
|
<p>Not to be confused with the path commands from the svg path element (like M, L, Q, H and many others). TVG interprets all of them and translates to the ones from the PathCommand values. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga6876ed676934f4dbcc19b1b53c153cc1ad3d2e617335f08df83599665eef8a418"></a>Close </td><td class="fielddoc"><p>Ends the current sub-path and connects it with its initial point. This command doesn't expect any points. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga6876ed676934f4dbcc19b1b53c153cc1ad9046d3b1ebf3889943b3be3ca477613"></a>MoveTo </td><td class="fielddoc"><p>Sets a new initial point of the sub-path and a new current point. This command expects 1 point: the starting position. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga6876ed676934f4dbcc19b1b53c153cc1a5dc59cf06f56c730c0a4bfe69c9bf689"></a>LineTo </td><td class="fielddoc"><p>Draws a line from the current point to the given point and sets a new value of the current point. This command expects 1 point: the end-position of the line. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga6876ed676934f4dbcc19b1b53c153cc1ac8cd9cd16086764627079ed21bfc4e29"></a>CubicTo </td><td class="fielddoc"><p>Draws a cubic Bezier curve from the current point to the given point using two given control points and sets a new value of the current point. This command expects 3 points: the 1st control-point, the 2nd control-point, the end-point of the curve. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga28287671eaf7406afd604bd055ba4066"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga28287671eaf7406afd604bd055ba4066">◆ </a></span>Result</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration specifying the result from the APIs. </p>
|
|
<p>All ThorVG APIs could potentially return one of the values in the list. Please note that some APIs may additionally specify the reasons that trigger their return values. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38"></a>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="gga28287671eaf7406afd604bd055ba4066ae73a2e92f1c87086c838b442552a4775"></a>InvalidArguments </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="gga28287671eaf7406afd604bd055ba4066a119732ff568bf103d744e930ae2404f1"></a>InsufficientCondition </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="gga28287671eaf7406afd604bd055ba4066abc2b4181e818f2e9b52b2bc54dd55907"></a>FailedAllocation </td><td class="fielddoc"><p>The value returned in case of unsuccessful memory allocation. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga28287671eaf7406afd604bd055ba4066ae8c0c653fcac575c31470f0f800991c6"></a>MemoryCorruption </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="gga28287671eaf7406afd604bd055ba4066aa0cfd518e4385f31d38720579321ed29"></a>NonSupport </td><td class="fielddoc"><p>The value returned in case of choosing unsupported engine features(options). </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga28287671eaf7406afd604bd055ba4066a88183b946cc5f0e8c96b2e66e1c74a7e"></a>Unknown </td><td class="fielddoc"><p>The value returned in all other cases. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6239974a858100e129f1e0b8ffac4f96"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6239974a858100e129f1e0b8ffac4f96">◆ </a></span>StrokeCap</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__ThorVG.html#ga6239974a858100e129f1e0b8ffac4f96">StrokeCap</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration determining the ending type of a stroke in the open sub-paths. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga6239974a858100e129f1e0b8ffac4f96aceb46ca115d05c51aa5a16a8867c3304"></a>Square </td><td class="fielddoc"><p>The stroke is extended in both end-points of a sub-path by a rectangle, with the width equal to the stroke width and the length equal to the half of the stroke width. For zero length sub-paths the square is rendered with the size of the stroke width. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga6239974a858100e129f1e0b8ffac4f96ab7f41fc1412ad2ee75e9b2635d3b9d5c"></a>Round </td><td class="fielddoc"><p>The stroke is extended in both end-points of a sub-path by a half circle, with a radius equal to the half of a stroke width. For zero length sub-paths a full circle is rendered. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="gga6239974a858100e129f1e0b8ffac4f96ab2635ed1075287dea1eb1598a90df1fe"></a>Butt </td><td class="fielddoc"><p>The stroke ends exactly at each of the two end-points of a sub-path. For zero length sub-paths no stroke is rendered. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaba8b7236c41a171289aef2f3c71eef51"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaba8b7236c41a171289aef2f3c71eef51">◆ </a></span>StrokeJoin</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="group__ThorVG.html#gaba8b7236c41a171289aef2f3c71eef51">StrokeJoin</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration determining the style used at the corners of joined stroked path segments. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaba8b7236c41a171289aef2f3c71eef51a1b9ae4ca6d43fc984af318046e1e7bb5"></a>Bevel </td><td class="fielddoc"><p>The outer corner of the joined path segments is bevelled at the join point. The triangular region of the corner is enclosed by a straight line between the outer corners of each stroke. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaba8b7236c41a171289aef2f3c71eef51ab7f41fc1412ad2ee75e9b2635d3b9d5c"></a>Round </td><td class="fielddoc"><p>The outer corner of the joined path segments is rounded. The circular region is centered at the join point. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ggaba8b7236c41a171289aef2f3c71eef51ae4396f81cd926bb129ccf3c147c64514"></a>Miter </td><td class="fielddoc"><p>The outer corner of the joined path segments is spiked. The spike is created by extension beyond the join point of the outer edges of the stroke until they intersect. In case the extension goes beyond the limit, the join style is converted to the Bevel style. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ga151ac90e5e41b7dcbea2265cfd6a54ca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga151ac90e5e41b7dcbea2265cfd6a54ca">◆ </a></span>cast() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::unique_ptr<T> tvg::cast </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classtvg_1_1Fill.html">Fill</a> * </td>
|
|
<td class="paramname"><em>fill</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The <a class="el" href="group__ThorVG.html#ga151ac90e5e41b7dcbea2265cfd6a54ca" title="The cast() function is a utility function used to cast a 'Fill' to type 'T'.">cast()</a> function is a utility function used to cast a '<a class="el" href="classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object.">Fill</a>' to type 'T'. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.11 </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga18826bfb9bff2e77bdafce9a510be57f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga18826bfb9bff2e77bdafce9a510be57f">◆ </a></span>cast() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::unique_ptr<T> tvg::cast </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classtvg_1_1Paint.html">Paint</a> * </td>
|
|
<td class="paramname"><em>paint</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The <a class="el" href="group__ThorVG.html#ga151ac90e5e41b7dcbea2265cfd6a54ca" title="The cast() function is a utility function used to cast a 'Fill' to type 'T'.">cast()</a> function is a utility function used to cast a '<a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements.">Paint</a>' to type 'T'. </p>
|
|
<dl class="section since"><dt>Since</dt><dd>0.11 </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>
|