mirror of
https://github.com/thorvg/thorvg.git
synced 2025-06-13 19:44:28 +00:00
8eb3517da8
This is a documentation page based on doxygen. CSS: https://jothepro.github.io/doxygen-awesome-css/
288 lines
19 KiB
HTML
288 lines
19 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>ThorVG: RadialGradient</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="docs_logo.svg"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">ThorVG
|
|
 <span id="projectnumber">v0.1</span>
|
|
</div>
|
|
<div id="projectbrief">ThorVG is a platform-independent portable library for drawing vector-based scene and animation. It's an open-source software that is freely used by a variety of software platforms and applications. ThorVG provides neat and easy APIs, its library has no dependencies and keeps cheap and super compact size. It serves as the vector graphics engine for Tizen OS that powers many products.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('classtvg_1_1RadialGradient.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="classtvg_1_1RadialGradient-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">RadialGradient<span class="mlabels"><span class="mlabel">final</span></span><div class="ingroups"><a class="el" href="group__ThorVG.html">ThorVG</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>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></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for RadialGradient:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classtvg_1_1RadialGradient__inherit__graph.png" border="0" usemap="#RadialGradient_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="RadialGradient_inherit__map" id="RadialGradient_inherit__map">
|
|
<area shape="rect" id="node2" href="classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object. " alt="" coords="40,5,79,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a3688387d86ebd5003ee98d90f24a6030"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1RadialGradient.html#a3688387d86ebd5003ee98d90f24a6030">radial</a> (float cx, float cy, float radius) noexcept</td></tr>
|
|
<tr class="memdesc:a3688387d86ebd5003ee98d90f24a6030"><td class="mdescLeft"> </td><td class="mdescRight">Sets the radial gradient bounds. <a href="#a3688387d86ebd5003ee98d90f24a6030">More...</a><br /></td></tr>
|
|
<tr class="separator:a3688387d86ebd5003ee98d90f24a6030"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a706e9ec51bf12483b1d59f99c6fe045e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1RadialGradient.html#a706e9ec51bf12483b1d59f99c6fe045e">radial</a> (float *cx, float *cy, float *radius) const noexcept</td></tr>
|
|
<tr class="memdesc:a706e9ec51bf12483b1d59f99c6fe045e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the radial gradient bounds. <a href="#a706e9ec51bf12483b1d59f99c6fe045e">More...</a><br /></td></tr>
|
|
<tr class="separator:a706e9ec51bf12483b1d59f99c6fe045e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classtvg_1_1Fill"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classtvg_1_1Fill')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classtvg_1_1Fill.html">Fill</a></td></tr>
|
|
<tr class="memitem:a92717fc84a7d5df56e42e3bc863fce1a inherit pub_methods_classtvg_1_1Fill"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Fill.html#a92717fc84a7d5df56e42e3bc863fce1a">colorStops</a> (const <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html">ColorStop</a> *colorStops, uint32_t cnt) noexcept</td></tr>
|
|
<tr class="memdesc:a92717fc84a7d5df56e42e3bc863fce1a inherit pub_methods_classtvg_1_1Fill"><td class="mdescLeft"> </td><td class="mdescRight">Sets the parameters of the colors of the gradient and their position. <a href="classtvg_1_1Fill.html#a92717fc84a7d5df56e42e3bc863fce1a">More...</a><br /></td></tr>
|
|
<tr class="separator:a92717fc84a7d5df56e42e3bc863fce1a inherit pub_methods_classtvg_1_1Fill"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed49d00ca09e69fdf97aaae235f8e950 inherit pub_methods_classtvg_1_1Fill"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Fill.html#aed49d00ca09e69fdf97aaae235f8e950">spread</a> (<a class="el" href="group__ThorVG.html#ga0cfa2c92260cca776292cc9e8964f2da">FillSpread</a> s) noexcept</td></tr>
|
|
<tr class="memdesc:aed49d00ca09e69fdf97aaae235f8e950 inherit pub_methods_classtvg_1_1Fill"><td class="mdescLeft"> </td><td class="mdescRight">Sets the FillSpread value, which specifies how to fill the area outside the gradient bounds. <a href="classtvg_1_1Fill.html#aed49d00ca09e69fdf97aaae235f8e950">More...</a><br /></td></tr>
|
|
<tr class="separator:aed49d00ca09e69fdf97aaae235f8e950 inherit pub_methods_classtvg_1_1Fill"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:addbc9de36b4427639f3cc1dceeccb734 inherit pub_methods_classtvg_1_1Fill"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Fill.html#addbc9de36b4427639f3cc1dceeccb734">colorStops</a> (const <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html">ColorStop</a> **colorStops) const noexcept</td></tr>
|
|
<tr class="memdesc:addbc9de36b4427639f3cc1dceeccb734 inherit pub_methods_classtvg_1_1Fill"><td class="mdescLeft"> </td><td class="mdescRight">Gets the parameters of the colors of the gradient, their position and number. <a href="classtvg_1_1Fill.html#addbc9de36b4427639f3cc1dceeccb734">More...</a><br /></td></tr>
|
|
<tr class="separator:addbc9de36b4427639f3cc1dceeccb734 inherit pub_methods_classtvg_1_1Fill"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55f6de063e5ac8023243c9cef5cb9a12 inherit pub_methods_classtvg_1_1Fill"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga0cfa2c92260cca776292cc9e8964f2da">FillSpread</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Fill.html#a55f6de063e5ac8023243c9cef5cb9a12">spread</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a55f6de063e5ac8023243c9cef5cb9a12 inherit pub_methods_classtvg_1_1Fill"><td class="mdescLeft"> </td><td class="mdescRight">Gets the FillSpread value of the fill. <a href="classtvg_1_1Fill.html#a55f6de063e5ac8023243c9cef5cb9a12">More...</a><br /></td></tr>
|
|
<tr class="separator:a55f6de063e5ac8023243c9cef5cb9a12 inherit pub_methods_classtvg_1_1Fill"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48e358abab4478ff7f84dfb85608eaf3 inherit pub_methods_classtvg_1_1Fill"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtvg_1_1Fill.html">Fill</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Fill.html#a48e358abab4478ff7f84dfb85608eaf3">duplicate</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a48e358abab4478ff7f84dfb85608eaf3 inherit pub_methods_classtvg_1_1Fill"><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of the <a class="el" href="classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object. ">Fill</a> object. <a href="classtvg_1_1Fill.html#a48e358abab4478ff7f84dfb85608eaf3">More...</a><br /></td></tr>
|
|
<tr class="separator:a48e358abab4478ff7f84dfb85608eaf3 inherit pub_methods_classtvg_1_1Fill"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aba51891c8702157ba088bf7e2f1425eb"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr< <a class="el" href="classtvg_1_1RadialGradient.html">RadialGradient</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1RadialGradient.html#aba51891c8702157ba088bf7e2f1425eb">gen</a> () noexcept</td></tr>
|
|
<tr class="memdesc:aba51891c8702157ba088bf7e2f1425eb"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classtvg_1_1RadialGradient.html" title="A class representing the radial gradient fill of the Shape object. ">RadialGradient</a> object. <a href="#aba51891c8702157ba088bf7e2f1425eb">More...</a><br /></td></tr>
|
|
<tr class="separator:aba51891c8702157ba088bf7e2f1425eb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>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. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aba51891c8702157ba088bf7e2f1425eb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aba51891c8702157ba088bf7e2f1425eb">◆ </a></span>gen()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::unique_ptr<<a class="el" href="classtvg_1_1RadialGradient.html">RadialGradient</a>> gen </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a new <a class="el" href="classtvg_1_1RadialGradient.html" title="A class representing the radial gradient fill of the Shape object. ">RadialGradient</a> object. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="classtvg_1_1RadialGradient.html" title="A class representing the radial gradient fill of the Shape object. ">RadialGradient</a> object. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3688387d86ebd5003ee98d90f24a6030"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3688387d86ebd5003ee98d90f24a6030">◆ </a></span>radial() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> radial </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>cx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>cy</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>radius</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </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">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><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution. ">Result::Success</a> when succeed, <a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066ae73a2e92f1c87086c838b442552a4775" title="The value returned in the event of a problem with the arguments given to the API - e...">Result::InvalidArguments</a> otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a706e9ec51bf12483b1d59f99c6fe045e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a706e9ec51bf12483b1d59f99c6fe045e">◆ </a></span>radial() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> radial </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>cx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>cy</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float * </td>
|
|
<td class="paramname"><em>radius</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets 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">[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><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution. ">Result::Success</a> when succeed. </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="navelem"><b>tvg</b></li><li class="navelem"><a class="el" href="classtvg_1_1RadialGradient.html">RadialGradient</a></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|