git_clone/thorvg
1
0
Fork 0
mirror of https://github.com/thorvg/thorvg.git synced 2025-06-08 05:33:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
thorvg/docs/html/classtvg_1_1Fill.html
Hermet Park e4ae146716 updated doc
2021-09-24 12:50:07 +09:00

302 lines
18 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: Fill</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.5</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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>tvg</b></li><li class="navelem"><a class="el" href="classtvg_1_1Fill.html">Fill</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classtvg_1_1Fill-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Fill<div class="ingroups"><a class="el" href="group__ThorVG.html">ThorVG</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>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></p>
<div class="dynheader">
Inheritance diagram for Fill:</div>
<div class="dyncontent">
<div class="center"><img src="classtvg_1_1Fill__inherit__graph.png" border="0" usemap="#Fill_inherit__map" alt="Inheritance graph"/></div>
<map name="Fill_inherit__map" id="Fill_inherit__map">
<area shape="rect" title="An abstract class representing the gradient fill of the Shape object." alt="" coords="115,5,156,32"/>
<area shape="rect" href="classtvg_1_1LinearGradient.html" title="A class representing the linear gradient fill of the Shape object." alt="" coords="5,80,124,107"/>
<area shape="rect" href="classtvg_1_1RadialGradient.html" title="A class representing the radial gradient fill of the Shape object." alt="" coords="148,80,267,107"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></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_1_1Fill_1_1ColorStop.html">ColorStop</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_1_1Fill_1_1ColorStop.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="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a92717fc84a7d5df56e42e3bc863fce1a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</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"><td class="mdescLeft">&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed49d00ca09e69fdf97aaae235f8e950"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</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"><td class="mdescLeft">&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addbc9de36b4427639f3cc1dceeccb734"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</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"><td class="mdescLeft">&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55f6de063e5ac8023243c9cef5cb9a12"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga0cfa2c92260cca776292cc9e8964f2da">FillSpread</a>&#160;</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"><td class="mdescLeft">&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a48e358abab4478ff7f84dfb85608eaf3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtvg_1_1Fill.html">Fill</a> *&#160;</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"><td class="mdescLeft">&#160;</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"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>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. </p>
<p>It contains the information about the gradient colors and their arrangement inside the gradient bounds. The gradients bounds are defined in the <a class="el" href="classtvg_1_1LinearGradient.html" title="A class representing the linear gradient fill of the Shape object.">LinearGradient</a> or <a class="el" href="classtvg_1_1RadialGradient.html" title="A class representing the radial gradient fill of the Shape object.">RadialGradient</a> class, depending on the type of the gradient to be used. It specifies the gradient behavior in case the area defined by the gradient bounds is smaller than the area to be filled. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="addbc9de36b4427639f3cc1dceeccb734"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addbc9de36b4427639f3cc1dceeccb734">&#9670;&nbsp;</a></span>colorStops() <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">uint32_t colorStops </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html">ColorStop</a> **&#160;</td>
<td class="paramname"><em>colorStops</em></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 parameters of the colors of the gradient, their position and number. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">colorStops</td><td>A pointer to the memory location, where the array of the gradient's <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html" title="A data structure storing the information about the color and its relative position inside the gradien...">ColorStop</a> is stored.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of colors used in the gradient. This value corresponds to the length of the <code>colorStops</code> array. </dd></dl>
</div>
</div>
<a id="a92717fc84a7d5df56e42e3bc863fce1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92717fc84a7d5df56e42e3bc863fce1a">&#9670;&nbsp;</a></span>colorStops() <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> colorStops </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html">ColorStop</a> *&#160;</td>
<td class="paramname"><em>colorStops</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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </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">colorStops</td><td>An array of <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html" title="A data structure storing the information about the color and its relative position inside the gradien...">ColorStop</a> data structure. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cnt</td><td>The count of the <code>colorStops</code> array equal to the colors number used in the gradient.</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>
<a id="a48e358abab4478ff7f84dfb85608eaf3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a48e358abab4478ff7f84dfb85608eaf3">&#9670;&nbsp;</a></span>duplicate()</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="classtvg_1_1Fill.html">Fill</a>* duplicate </td>
<td>(</td>
<td class="paramname"></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>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. </p>
<p>Return a newly created <a class="el" href="classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object.">Fill</a> object with the properties copied from the original.</p>
<dl class="section return"><dt>Returns</dt><dd>A copied <a class="el" href="classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object.">Fill</a> object when succeed, <code>nullptr</code> otherwise. </dd></dl>
</div>
</div>
<a id="a55f6de063e5ac8023243c9cef5cb9a12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55f6de063e5ac8023243c9cef5cb9a12">&#9670;&nbsp;</a></span>spread() <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#ga0cfa2c92260cca776292cc9e8964f2da">FillSpread</a> spread </td>
<td>(</td>
<td class="paramname"></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 FillSpread value of the fill. </p>
<dl class="section return"><dt>Returns</dt><dd>The FillSpread value of this <a class="el" href="classtvg_1_1Fill.html" title="An abstract class representing the gradient fill of the Shape object.">Fill</a>. </dd></dl>
</div>
</div>
<a id="aed49d00ca09e69fdf97aaae235f8e950"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed49d00ca09e69fdf97aaae235f8e950">&#9670;&nbsp;</a></span>spread() <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> spread </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ThorVG.html#ga0cfa2c92260cca776292cc9e8964f2da">FillSpread</a>&#160;</td>
<td class="paramname"><em>s</em></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 FillSpread 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">s</td><td>The FillSpread value.</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 -->
<!-- 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