git_clone/thorvg
1
0
Fork 0
mirror of https://github.com/thorvg/thorvg.git synced 2025-06-07 21:23:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
thorvg/docs/html/group__ThorVGCapi__Gradient.html
Hermet Park 686e47d2cd doc: up to date v0.7
2021-12-22 19:11:22 +09:00

828 lines
53 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ThorVG: Gradient</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="small_logo.svg"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ThorVG
&#160;<span id="projectnumber">v0.7</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Gradient<div class="ingroups"><a class="el" href="group__ThorVG__CAPI.html">ThorVG_CAPI</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A module managing the gradient fill of objects.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Gradient:</div>
<div class="dyncontent">
<div class="center"><img src="group__ThorVGCapi__Gradient.png" border="0" usemap="#group____ThorVGCapi____Gradient" alt=""/></div>
<map name="group____ThorVGCapi____Gradient" id="group____ThorVGCapi____Gradient">
<area shape="rect" href="group__ThorVG__CAPI.html" title="ThorVG C language binding APIs." alt="" coords="5,5,112,31"/>
<area shape="rect" title="A module managing the gradient fill of objects." alt="" coords="160,5,239,31"/>
</map>
</div>
<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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structTvg__Color__Stop.html">Tvg_Color_Stop</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A data structure storing the information about the color and its relative position inside the gradient bounds. <a href="structTvg__Color__Stop.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gab77d80df3c269fa531e7b81c8e8410d2"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#gab77d80df3c269fa531e7b81c8e8410d2">tvg_linear_gradient_new</a> ()</td></tr>
<tr class="memdesc:gab77d80df3c269fa531e7b81c8e8410d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new linear gradient object. <a href="group__ThorVGCapi__Gradient.html#gab77d80df3c269fa531e7b81c8e8410d2">More...</a><br /></td></tr>
<tr class="separator:gab77d80df3c269fa531e7b81c8e8410d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7dc487e5d1557961cd2cc31a42daeb28"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#ga7dc487e5d1557961cd2cc31a42daeb28">tvg_radial_gradient_new</a> ()</td></tr>
<tr class="memdesc:ga7dc487e5d1557961cd2cc31a42daeb28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new radial gradient object. <a href="group__ThorVGCapi__Gradient.html#ga7dc487e5d1557961cd2cc31a42daeb28">More...</a><br /></td></tr>
<tr class="separator:ga7dc487e5d1557961cd2cc31a42daeb28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga00590e1313394b75b8619ff27ddd233b"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#ga00590e1313394b75b8619ff27ddd233b">tvg_linear_gradient_set</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, float x1, float y1, float x2, float y2)</td></tr>
<tr class="memdesc:ga00590e1313394b75b8619ff27ddd233b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the linear gradient bounds. <a href="group__ThorVGCapi__Gradient.html#ga00590e1313394b75b8619ff27ddd233b">More...</a><br /></td></tr>
<tr class="separator:ga00590e1313394b75b8619ff27ddd233b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa503fc8455eb63acda4b3ff0737f4d4e"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#gaa503fc8455eb63acda4b3ff0737f4d4e">tvg_linear_gradient_get</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, float *x1, float *y1, float *x2, float *y2)</td></tr>
<tr class="memdesc:gaa503fc8455eb63acda4b3ff0737f4d4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the linear gradient bounds. <a href="group__ThorVGCapi__Gradient.html#gaa503fc8455eb63acda4b3ff0737f4d4e">More...</a><br /></td></tr>
<tr class="separator:gaa503fc8455eb63acda4b3ff0737f4d4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga321045b5fda8e8e002c4837bd03ccdac"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#ga321045b5fda8e8e002c4837bd03ccdac">tvg_radial_gradient_set</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, float cx, float cy, float radius)</td></tr>
<tr class="memdesc:ga321045b5fda8e8e002c4837bd03ccdac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the radial gradient bounds. <a href="group__ThorVGCapi__Gradient.html#ga321045b5fda8e8e002c4837bd03ccdac">More...</a><br /></td></tr>
<tr class="separator:ga321045b5fda8e8e002c4837bd03ccdac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaabab5eabf6d11b95b96e9c543a341199"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#gaabab5eabf6d11b95b96e9c543a341199">tvg_radial_gradient_get</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, float *cx, float *cy, float *radius)</td></tr>
<tr class="memdesc:gaabab5eabf6d11b95b96e9c543a341199"><td class="mdescLeft">&#160;</td><td class="mdescRight">The function gets radial gradient center point ant radius. <a href="group__ThorVGCapi__Gradient.html#gaabab5eabf6d11b95b96e9c543a341199">More...</a><br /></td></tr>
<tr class="separator:gaabab5eabf6d11b95b96e9c543a341199"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8d5755566bb7281984a44c9c687f2b48"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#ga8d5755566bb7281984a44c9c687f2b48">tvg_gradient_set_color_stops</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, const <a class="el" href="structTvg__Color__Stop.html">Tvg_Color_Stop</a> *color_stop, uint32_t cnt)</td></tr>
<tr class="memdesc:ga8d5755566bb7281984a44c9c687f2b48"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the parameters of the colors of the gradient and their position. <a href="group__ThorVGCapi__Gradient.html#ga8d5755566bb7281984a44c9c687f2b48">More...</a><br /></td></tr>
<tr class="separator:ga8d5755566bb7281984a44c9c687f2b48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac52a300f42295ac9f4c4ab1d41f68d28"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#gac52a300f42295ac9f4c4ab1d41f68d28">tvg_gradient_get_color_stops</a> (const <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, const <a class="el" href="structTvg__Color__Stop.html">Tvg_Color_Stop</a> **color_stop, uint32_t *cnt)</td></tr>
<tr class="memdesc:gac52a300f42295ac9f4c4ab1d41f68d28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the parameters of the colors of the gradient, their position and number. <a href="group__ThorVGCapi__Gradient.html#gac52a300f42295ac9f4c4ab1d41f68d28">More...</a><br /></td></tr>
<tr class="separator:gac52a300f42295ac9f4c4ab1d41f68d28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad800cb39d78429089adba8f0952ba433"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#gad800cb39d78429089adba8f0952ba433">tvg_gradient_set_spread</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, const <a class="el" href="group__ThorVGCapi__Shape.html#ga9ac44e712782a9b2a5a36a49b2ae52c7">Tvg_Stroke_Fill</a> spread)</td></tr>
<tr class="memdesc:gad800cb39d78429089adba8f0952ba433"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the Tvg_Stroke_Fill value, which specifies how to fill the area outside the gradient bounds. <a href="group__ThorVGCapi__Gradient.html#gad800cb39d78429089adba8f0952ba433">More...</a><br /></td></tr>
<tr class="separator:gad800cb39d78429089adba8f0952ba433"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa40a5554a7abd6b19c07c2335ab7f539"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#gaa40a5554a7abd6b19c07c2335ab7f539">tvg_gradient_get_spread</a> (const <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, <a class="el" href="group__ThorVGCapi__Shape.html#ga9ac44e712782a9b2a5a36a49b2ae52c7">Tvg_Stroke_Fill</a> *spread)</td></tr>
<tr class="memdesc:gaa40a5554a7abd6b19c07c2335ab7f539"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the FillSpread value of the gradient object. <a href="group__ThorVGCapi__Gradient.html#gaa40a5554a7abd6b19c07c2335ab7f539">More...</a><br /></td></tr>
<tr class="separator:gaa40a5554a7abd6b19c07c2335ab7f539"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga64c5d823f8a3f1791e215da25e290905"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#ga64c5d823f8a3f1791e215da25e290905">tvg_gradient_set_transform</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, const <a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a> *m)</td></tr>
<tr class="memdesc:ga64c5d823f8a3f1791e215da25e290905"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the matrix of the affine transformation for the gradient object. <a href="group__ThorVGCapi__Gradient.html#ga64c5d823f8a3f1791e215da25e290905">More...</a><br /></td></tr>
<tr class="separator:ga64c5d823f8a3f1791e215da25e290905"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga07743c5cb03f2a484558b7728aefba2c"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#ga07743c5cb03f2a484558b7728aefba2c">tvg_gradient_get_transform</a> (const <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad, <a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a> *m)</td></tr>
<tr class="memdesc:ga07743c5cb03f2a484558b7728aefba2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the matrix of the affine transformation of the gradient object. <a href="group__ThorVGCapi__Gradient.html#ga07743c5cb03f2a484558b7728aefba2c">More...</a><br /></td></tr>
<tr class="separator:ga07743c5cb03f2a484558b7728aefba2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6eba942f41e445f09011647fea1b1ae1"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#ga6eba942f41e445f09011647fea1b1ae1">tvg_gradient_duplicate</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad)</td></tr>
<tr class="memdesc:ga6eba942f41e445f09011647fea1b1ae1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Duplicates the given Tvg_Gradient object. <a href="group__ThorVGCapi__Gradient.html#ga6eba942f41e445f09011647fea1b1ae1">More...</a><br /></td></tr>
<tr class="separator:ga6eba942f41e445f09011647fea1b1ae1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad267b161f306064cc3c0082ec7906a95"><td class="memItemLeft" align="right" valign="top">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gad980f552658dcbbe42a0168f35c27781">Tvg_Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ThorVGCapi__Gradient.html#gad267b161f306064cc3c0082ec7906a95">tvg_gradient_del</a> (<a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *grad)</td></tr>
<tr class="memdesc:gad267b161f306064cc3c0082ec7906a95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deletes the given gradient object. <a href="group__ThorVGCapi__Gradient.html#gad267b161f306064cc3c0082ec7906a95">More...</a><br /></td></tr>
<tr class="separator:gad267b161f306064cc3c0082ec7906a95"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>A module managing the gradient fill of objects. </p>
<p>The module enables to set and to get the gradient colors and their arrangement inside the gradient bounds, to specify the gradient bounds and the gradient behavior in case the area defined by the gradient bounds is smaller than the area to be filled. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad267b161f306064cc3c0082ec7906a95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad267b161f306064cc3c0082ec7906a95">&#9670;&nbsp;</a></span>tvg_gradient_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_gradient_del </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deletes the given gradient object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The gradient object to be deleted.</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_Gradient pointer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga6eba942f41e445f09011647fea1b1ae1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6eba942f41e445f09011647fea1b1ae1">&#9670;&nbsp;</a></span>tvg_gradient_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#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a>* tvg_gradient_duplicate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Duplicates the given Tvg_Gradient 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">grad</td><td>The Tvg_Gradient object to be copied.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A copied Tvg_Gradient object if succeed, <code>nullptr</code> otherwise. </dd></dl>
</div>
</div>
<a id="gac52a300f42295ac9f4c4ab1d41f68d28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac52a300f42295ac9f4c4ab1d41f68d28">&#9670;&nbsp;</a></span>tvg_gradient_get_color_stops()</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_gradient_get_color_stops </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structTvg__Color__Stop.html">Tvg_Color_Stop</a> **&#160;</td>
<td class="paramname"><em>color_stop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>cnt</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the parameters of the colors of the gradient, their position and number. </p>
<p>The function does not allocate any memory.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object of which to get the color information. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">color_stop</td><td>An array of <a class="el" href="structTvg__Color__Stop.html" title="A data structure storing the information about the color and its relative position inside the gradien...">Tvg_Color_Stop</a> data structure. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">cnt</td><td>The size of the <code>color_stop</code> array equal to the colors number used in the gradient.</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>A <code>nullptr</code> passed as the argument. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaa40a5554a7abd6b19c07c2335ab7f539"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa40a5554a7abd6b19c07c2335ab7f539">&#9670;&nbsp;</a></span>tvg_gradient_get_spread()</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_gradient_get_spread </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__ThorVGCapi__Shape.html#ga9ac44e712782a9b2a5a36a49b2ae52c7">Tvg_Stroke_Fill</a> *&#160;</td>
<td class="paramname"><em>spread</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the FillSpread value of the gradient object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">spread</td><td>The FillSpread value.</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>A <code>nullptr</code> passed as the argument. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga07743c5cb03f2a484558b7728aefba2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga07743c5cb03f2a484558b7728aefba2c">&#9670;&nbsp;</a></span>tvg_gradient_get_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_gradient_get_transform </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a> *&#160;</td>
<td class="paramname"><em>m</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the matrix of the affine transformation of the gradient object. </p>
<p>In case no transformation was applied, the identity matrix is set.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object of which to get the transformation matrix. </td></tr>
<tr><td class="paramdir">[out]</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>A <code>nullptr</code> is passed as the argument. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga8d5755566bb7281984a44c9c687f2b48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8d5755566bb7281984a44c9c687f2b48">&#9670;&nbsp;</a></span>tvg_gradient_set_color_stops()</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_gradient_set_color_stops </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structTvg__Color__Stop.html">Tvg_Color_Stop</a> *&#160;</td>
<td class="paramname"><em>color_stop</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>cnt</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the parameters of the colors of the gradient and their position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object of which the color information is to be set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">color_stop</td><td>An array of <a class="el" href="structTvg__Color__Stop.html" title="A data structure storing the information about the color and its relative position inside the gradien...">Tvg_Color_Stop</a> data structure. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cnt</td><td>The size of the <code>color_stop</code> array equal to the colors number used in the gradient.</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_Gradient pointer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gad800cb39d78429089adba8f0952ba433"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad800cb39d78429089adba8f0952ba433">&#9670;&nbsp;</a></span>tvg_gradient_set_spread()</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_gradient_set_spread </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__ThorVGCapi__Shape.html#ga9ac44e712782a9b2a5a36a49b2ae52c7">Tvg_Stroke_Fill</a>&#160;</td>
<td class="paramname"><em>spread</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the Tvg_Stroke_Fill value, which specifies how to fill the area outside the gradient bounds. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">spread</td><td>The FillSpread value.</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_Gradient pointer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga64c5d823f8a3f1791e215da25e290905"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga64c5d823f8a3f1791e215da25e290905">&#9670;&nbsp;</a></span>tvg_gradient_set_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_gradient_set_transform </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structTvg__Matrix.html">Tvg_Matrix</a> *&#160;</td>
<td class="paramname"><em>m</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the matrix of the affine transformation for the gradient object. </p>
<p>The augmented matrix of the transformation is expected to be given.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient 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>A <code>nullptr</code> is passed as the argument. </td></tr>
<tr><td class="paramname">TVG_RESULT_FAILED_ALLOCATION</td><td>An internal error with a memory allocation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaa503fc8455eb63acda4b3ff0737f4d4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa503fc8455eb63acda4b3ff0737f4d4e">&#9670;&nbsp;</a></span>tvg_linear_gradient_get()</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_linear_gradient_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>x1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>y1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>x2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>y2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the linear gradient bounds. </p>
<p>The bounds of the linear gradient are defined as a surface constrained by two parallel lines crossing the given points (<code>x1</code>, <code>y1</code>) and (<code>x2</code>, <code>y2</code>), respectively. Both lines are perpendicular to the line linking (<code>x1</code>, <code>y1</code>) and (<code>x2</code>, <code>y2</code>).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object of which to get the bounds. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">x1</td><td>The horizontal coordinate of the first point used to determine the gradient bounds. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">y1</td><td>The vertical coordinate of the first point used to determine the gradient bounds. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">x2</td><td>The horizontal coordinate of the second point used to determine the gradient bounds. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">y2</td><td>The vertical coordinate of the second point used to determine the gradient bounds.</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_Gradient pointer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gab77d80df3c269fa531e7b81c8e8410d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab77d80df3c269fa531e7b81c8e8410d2">&#9670;&nbsp;</a></span>tvg_linear_gradient_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a>* tvg_linear_gradient_new </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new linear gradient object. </p>
<div class="fragment"><div class="line"><a class="code" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a>* shape = <a class="code" href="group__ThorVGCapi__Shape.html#ga9c0423ae5b7747a9b6b086a93504bd8d">tvg_shape_new</a>();</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Shape.html#gac1af7237c282fc0269e65a3ba6609291">tvg_shape_append_rect</a>(shape, 700, 700, 100, 100, 20, 20);</div>
<div class="line"><a class="code" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a>* grad = <a class="code" href="group__ThorVGCapi__Gradient.html#gab77d80df3c269fa531e7b81c8e8410d2">tvg_linear_gradient_new</a>();</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Gradient.html#ga00590e1313394b75b8619ff27ddd233b">tvg_linear_gradient_set</a>(grad, 700, 700, 800, 800);</div>
<div class="line"><a class="code" href="structTvg__Color__Stop.html">Tvg_Color_Stop</a> color_stops[2] =</div>
<div class="line">{</div>
<div class="line"> {0.0, 0, 0, 0, 255},</div>
<div class="line"> {1.0, 0, 255, 0, 255},</div>
<div class="line">};</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Gradient.html#ga8d5755566bb7281984a44c9c687f2b48">tvg_gradient_set_color_stops</a>(grad, color_stops, 2);</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Shape.html#ga02aa5aa9a017270ce0375b1b9db75d57">tvg_shape_set_linear_gradient</a>(shape, grad);</div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>A new linear gradient object. </dd></dl>
</div>
</div>
<a id="ga00590e1313394b75b8619ff27ddd233b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga00590e1313394b75b8619ff27ddd233b">&#9670;&nbsp;</a></span>tvg_linear_gradient_set()</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_linear_gradient_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>x1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>y1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>x2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>y2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the linear gradient bounds. </p>
<p>The bounds of the linear gradient are defined as a surface constrained by two parallel lines crossing the given points (<code>x1</code>, <code>y1</code>) and (<code>x2</code>, <code>y2</code>), respectively. Both lines are perpendicular to the line linking (<code>x1</code>, <code>y1</code>) and (<code>x2</code>, <code>y2</code>).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object of which bounds are to be set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">x1</td><td>The horizontal coordinate of the first point used to determine the gradient bounds. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">y1</td><td>The vertical coordinate of the first point used to determine the gradient bounds. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">x2</td><td>The horizontal coordinate of the second point used to determine the gradient bounds. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">y2</td><td>The vertical coordinate of the second point used to determine the gradient bounds.</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_Gradient pointer.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>In case the first and the second points are equal, an object filled with such a gradient fill is not rendered. </dd></dl>
</div>
</div>
<a id="gaabab5eabf6d11b95b96e9c543a341199"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaabab5eabf6d11b95b96e9c543a341199">&#9670;&nbsp;</a></span>tvg_radial_gradient_get()</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_radial_gradient_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>cx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>cy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float *&#160;</td>
<td class="paramname"><em>radius</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The function gets radial gradient center point ant radius. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object of which bounds are to be set. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">cx</td><td>The horizontal coordinate of the center of the bounding circle. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">cy</td><td>The vertical coordinate of the center of the bounding circle. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">radius</td><td>The radius of the bounding circle.</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_Gradient pointer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga7dc487e5d1557961cd2cc31a42daeb28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7dc487e5d1557961cd2cc31a42daeb28">&#9670;&nbsp;</a></span>tvg_radial_gradient_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TVG_EXPORT <a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a>* tvg_radial_gradient_new </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new radial gradient object. </p>
<div class="fragment"><div class="line"><a class="code" href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a>* shape = <a class="code" href="group__ThorVGCapi__Shape.html#ga9c0423ae5b7747a9b6b086a93504bd8d">tvg_shape_new</a>();</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Shape.html#gac1af7237c282fc0269e65a3ba6609291">tvg_shape_append_rect</a>(shape, 700, 700, 100, 100, 20, 20);</div>
<div class="line"><a class="code" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a>* grad = <a class="code" href="group__ThorVGCapi__Gradient.html#ga7dc487e5d1557961cd2cc31a42daeb28">tvg_radial_gradient_new</a>();</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Gradient.html#ga321045b5fda8e8e002c4837bd03ccdac">tvg_radial_gradient_set</a>(grad, 550, 550, 50);</div>
<div class="line"><a class="code" href="structTvg__Color__Stop.html">Tvg_Color_Stop</a> color_stops[2] =</div>
<div class="line">{</div>
<div class="line"> {0.0, 0, 0, 0, 255},</div>
<div class="line"> {1.0, 0, 255, 0, 255},</div>
<div class="line">};</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Gradient.html#ga8d5755566bb7281984a44c9c687f2b48">tvg_gradient_set_color_stops</a>(grad, color_stops, 2);</div>
<div class="line"><a class="code" href="group__ThorVGCapi__Shape.html#gabd7b9020f1058aa9e9fae9b683265ef8">tvg_shape_set_radial_gradient</a>(shape, grad);</div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>A new radial gradient object. </dd></dl>
</div>
</div>
<a id="ga321045b5fda8e8e002c4837bd03ccdac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga321045b5fda8e8e002c4837bd03ccdac">&#9670;&nbsp;</a></span>tvg_radial_gradient_set()</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_radial_gradient_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a> *&#160;</td>
<td class="paramname"><em>grad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>cx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>cy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>radius</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the radial gradient bounds. </p>
<p>The radial gradient bounds are defined as a circle centered in a given point (<code>cx</code>, <code>cy</code>) of a given radius.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">grad</td><td>The Tvg_Gradient object of which bounds are to be set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cx</td><td>The horizontal coordinate of the center of the bounding circle. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cy</td><td>The vertical coordinate of the center of the bounding circle. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">radius</td><td>The radius of the bounding circle.</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_Gradient pointer or the <code>radius</code> value less than zero. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<div class="ttc" id="agroup__ThorVGCapi__Gradient_html_ga8d5755566bb7281984a44c9c687f2b48"><div class="ttname"><a href="group__ThorVGCapi__Gradient.html#ga8d5755566bb7281984a44c9c687f2b48">tvg_gradient_set_color_stops</a></div><div class="ttdeci">TVG_EXPORT Tvg_Result tvg_gradient_set_color_stops(Tvg_Gradient *grad, const Tvg_Color_Stop *color_stop, uint32_t cnt)</div><div class="ttdoc">Sets the parameters of the colors of the gradient and their position.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Shape_html_gac1af7237c282fc0269e65a3ba6609291"><div class="ttname"><a href="group__ThorVGCapi__Shape.html#gac1af7237c282fc0269e65a3ba6609291">tvg_shape_append_rect</a></div><div class="ttdeci">TVG_EXPORT Tvg_Result tvg_shape_append_rect(Tvg_Paint *paint, float x, float y, float w, float h, float rx, float ry)</div><div class="ttdoc">Appends a rectangle to the path.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Gradient_html_ga7dc487e5d1557961cd2cc31a42daeb28"><div class="ttname"><a href="group__ThorVGCapi__Gradient.html#ga7dc487e5d1557961cd2cc31a42daeb28">tvg_radial_gradient_new</a></div><div class="ttdeci">TVG_EXPORT Tvg_Gradient * tvg_radial_gradient_new()</div><div class="ttdoc">Creates a new radial gradient object.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Shape_html_ga9c0423ae5b7747a9b6b086a93504bd8d"><div class="ttname"><a href="group__ThorVGCapi__Shape.html#ga9c0423ae5b7747a9b6b086a93504bd8d">tvg_shape_new</a></div><div class="ttdeci">TVG_EXPORT Tvg_Paint * tvg_shape_new()</div><div class="ttdoc">Creates a new shape object.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Shape_html_ga02aa5aa9a017270ce0375b1b9db75d57"><div class="ttname"><a href="group__ThorVGCapi__Shape.html#ga02aa5aa9a017270ce0375b1b9db75d57">tvg_shape_set_linear_gradient</a></div><div class="ttdeci">TVG_EXPORT Tvg_Result tvg_shape_set_linear_gradient(Tvg_Paint *paint, Tvg_Gradient *grad)</div><div class="ttdoc">Sets the linear gradient fill for all of the figures from the path.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Gradient_html_ga321045b5fda8e8e002c4837bd03ccdac"><div class="ttname"><a href="group__ThorVGCapi__Gradient.html#ga321045b5fda8e8e002c4837bd03ccdac">tvg_radial_gradient_set</a></div><div class="ttdeci">TVG_EXPORT Tvg_Result tvg_radial_gradient_set(Tvg_Gradient *grad, float cx, float cy, float radius)</div><div class="ttdoc">Sets the radial gradient bounds.</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Gradient_html_ga00590e1313394b75b8619ff27ddd233b"><div class="ttname"><a href="group__ThorVGCapi__Gradient.html#ga00590e1313394b75b8619ff27ddd233b">tvg_linear_gradient_set</a></div><div class="ttdeci">TVG_EXPORT Tvg_Result tvg_linear_gradient_set(Tvg_Gradient *grad, float x1, float y1, float x2, float y2)</div><div class="ttdoc">Sets the linear gradient bounds.</div></div>
<div class="ttc" id="agroup__ThorVG__CAPI_html_gafc8e0d01812127260d0753eceb056181"><div class="ttname"><a href="group__ThorVG__CAPI.html#gafc8e0d01812127260d0753eceb056181">Tvg_Gradient</a></div><div class="ttdeci">struct _Tvg_Gradient Tvg_Gradient</div><div class="ttdoc">A structure representing a gradient fill of a Tvg_Paint object.</div><div class="ttdef"><b>Definition:</b> thorvg_capi.h:69</div></div>
<div class="ttc" id="agroup__ThorVG__CAPI_html_ga98af7c3fe18afa8ad65ea6a6e097a292"><div class="ttname"><a href="group__ThorVG__CAPI.html#ga98af7c3fe18afa8ad65ea6a6e097a292">Tvg_Paint</a></div><div class="ttdeci">struct _Tvg_Paint Tvg_Paint</div><div class="ttdoc">A structure representing a graphical element.</div><div class="ttdef"><b>Definition:</b> thorvg_capi.h:63</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Gradient_html_gab77d80df3c269fa531e7b81c8e8410d2"><div class="ttname"><a href="group__ThorVGCapi__Gradient.html#gab77d80df3c269fa531e7b81c8e8410d2">tvg_linear_gradient_new</a></div><div class="ttdeci">TVG_EXPORT Tvg_Gradient * tvg_linear_gradient_new()</div><div class="ttdoc">Creates a new linear gradient object.</div></div>
<div class="ttc" id="astructTvg__Color__Stop_html"><div class="ttname"><a href="structTvg__Color__Stop.html">Tvg_Color_Stop</a></div><div class="ttdoc">A data structure storing the information about the color and its relative position inside the gradien...</div><div class="ttdef"><b>Definition:</b> thorvg_capi.h:184</div></div>
<div class="ttc" id="agroup__ThorVGCapi__Shape_html_gabd7b9020f1058aa9e9fae9b683265ef8"><div class="ttname"><a href="group__ThorVGCapi__Shape.html#gabd7b9020f1058aa9e9fae9b683265ef8">tvg_shape_set_radial_gradient</a></div><div class="ttdeci">TVG_EXPORT Tvg_Result tvg_shape_set_radial_gradient(Tvg_Paint *paint, Tvg_Gradient *grad)</div><div class="ttdoc">Sets the radial gradient fill for all of the figures from the path.</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink