docs/html/classtvg_1_1Fill.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.13"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>ThorVG: Fill</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="resize.js"></script>
  14 <script type="text/javascript" src="navtreedata.js"></script>
  15 <script type="text/javascript" src="navtree.js"></script>
  16 <script type="text/javascript">
  17   $(document).ready(initResizable);
  18 </script>
  19 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="search/searchdata.js"></script>
  21 <script type="text/javascript" src="search/search.js"></script>
  22 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  23 <link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
  24 </head>
  25 <body>
  26 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  27 <div id="titlearea">
  28 <table cellspacing="0" cellpadding="0">
  29  <tbody>
  30  <tr style="height: 56px;">
  31   <td id="projectlogo"><img alt="Logo" src="docs_logo.svg"/></td>
  32   <td id="projectalign" style="padding-left: 0.5em;">
  33    <div id="projectname">ThorVG
  34    &#160;<span id="projectnumber">v0.1</span>
  35    </div>
  36    <div id="projectbrief">ThorVG is a platform-independent portable library for drawing vector-based scene and animation. It&#39;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>
  37   </td>
  38  </tr>
  39  </tbody>
  40 </table>
  41 </div>
  42 <!-- end header part -->
  43 <!-- Generated by Doxygen 1.8.13 -->
  44 <script type="text/javascript">
  45 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  46 </script>
  47 <script type="text/javascript" src="menudata.js"></script>
  48 <script type="text/javascript" src="menu.js"></script>
  49 <script type="text/javascript">
  50 $(function() {
  51   initMenu('',true,false,'search.php','Search');
  52   $(document).ready(function() { init_search(); });
  53 });
  54 </script>
  55 <div id="main-nav"></div>
  56 </div><!-- top -->
  57 <div id="side-nav" class="ui-resizable side-nav-resizable">
  58   <div id="nav-tree">
  59     <div id="nav-tree-contents">
  60       <div id="nav-sync" class="sync"></div>
  61     </div>
  62   </div>
  63   <div id="splitbar" style="-moz-user-select:none;"
  64        class="ui-resizable-handle">
  65   </div>
  66 </div>
  67 <script type="text/javascript">
  68 $(document).ready(function(){initNavTree('classtvg_1_1Fill.html','');});
  69 </script>
  70 <div id="doc-content">
  71 <!-- window showing the filter options -->
  72 <div id="MSearchSelectWindow"
  73      onmouseover="return searchBox.OnSearchSelectShow()"
  74      onmouseout="return searchBox.OnSearchSelectHide()"
  75      onkeydown="return searchBox.OnSearchSelectKey(event)">
  76 </div>
  77
  78 <!-- iframe showing the search results (closed by default) -->
  79 <div id="MSearchResultsWindow">
  80 <iframe src="javascript:void(0)" frameborder="0"
  81         name="MSearchResults" id="MSearchResults">
  82 </iframe>
  83 </div>
  84
  85 <div class="header">
  86   <div class="summary">
  87 <a href="#nested-classes">Classes</a> &#124;
  88 <a href="#pub-methods">Public Member Functions</a> &#124;
  89 <a href="classtvg_1_1Fill-members.html">List of all members</a>  </div>
  90   <div class="headertitle">
  91 <div class="title">Fill<div class="ingroups"><a class="el" href="group__ThorVG.html">ThorVG</a></div></div>  </div>
  92 </div><!--header-->
  93 <div class="contents">
  94
  95 <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.
  96  <a href="classtvg_1_1Fill.html#details">More...</a></p>
  97 <div class="dynheader">
  98 Inheritance diagram for Fill:</div>
  99 <div class="dyncontent">
 100 <div class="center"><img src="classtvg_1_1Fill__inherit__graph.png" border="0" usemap="#Fill_inherit__map" alt="Inheritance graph"/></div>
 101 <map name="Fill_inherit__map" id="Fill_inherit__map">
 102 <area shape="rect" id="node2" href="classtvg_1_1LinearGradient.html" title="A class representing the linear gradient fill of the Shape object. " alt="" coords="5,80,112,107"/>
 103 <area shape="rect" id="node3" href="classtvg_1_1RadialGradient.html" title="A class representing the radial gradient fill of the Shape object. " alt="" coords="137,80,245,107"/>
 104 </map>
 105 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
 106 <table class="memberdecls">
 107 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
 108 Classes</h2></td></tr>
 109 <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>
 110 <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>
 111 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 112 </table><table class="memberdecls">
 113 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 114 Public Member Functions</h2></td></tr>
 115 <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>
 116 <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="#a92717fc84a7d5df56e42e3bc863fce1a">More...</a><br /></td></tr>
 117 <tr class="separator:a92717fc84a7d5df56e42e3bc863fce1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 118 <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>
 119 <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="#aed49d00ca09e69fdf97aaae235f8e950">More...</a><br /></td></tr>
 120 <tr class="separator:aed49d00ca09e69fdf97aaae235f8e950"><td class="memSeparator" colspan="2">&#160;</td></tr>
 121 <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>
 122 <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="#addbc9de36b4427639f3cc1dceeccb734">More...</a><br /></td></tr>
 123 <tr class="separator:addbc9de36b4427639f3cc1dceeccb734"><td class="memSeparator" colspan="2">&#160;</td></tr>
 124 <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>
 125 <tr class="memdesc:a55f6de063e5ac8023243c9cef5cb9a12"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the FillSpread value of the fill.  <a href="#a55f6de063e5ac8023243c9cef5cb9a12">More...</a><br /></td></tr>
 126 <tr class="separator:a55f6de063e5ac8023243c9cef5cb9a12"><td class="memSeparator" colspan="2">&#160;</td></tr>
 127 <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>
 128 <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="#a48e358abab4478ff7f84dfb85608eaf3">More...</a><br /></td></tr>
 129 <tr class="separator:a48e358abab4478ff7f84dfb85608eaf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 130 </table>
 131 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 132 <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>
 133 <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>
 134 </div><h2 class="groupheader">Member Function Documentation</h2>
 135 <a id="a92717fc84a7d5df56e42e3bc863fce1a"></a>
 136 <h2 class="memtitle"><span class="permalink"><a href="#a92717fc84a7d5df56e42e3bc863fce1a">&#9670;&nbsp;</a></span>colorStops() <span class="overload">[1/2]</span></h2>
 137
 138 <div class="memitem">
 139 <div class="memproto">
 140 <table class="mlabels">
 141   <tr>
 142   <td class="mlabels-left">
 143       <table class="memname">
 144         <tr>
 145           <td class="memname"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> colorStops </td>
 146           <td>(</td>
 147           <td class="paramtype">const <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html">ColorStop</a> *&#160;</td>
 148           <td class="paramname"><em>colorStops</em>, </td>
 149         </tr>
 150         <tr>
 151           <td class="paramkey"></td>
 152           <td></td>
 153           <td class="paramtype">uint32_t&#160;</td>
 154           <td class="paramname"><em>cnt</em>&#160;</td>
 155         </tr>
 156         <tr>
 157           <td></td>
 158           <td>)</td>
 159           <td></td><td></td>
 160         </tr>
 161       </table>
 162   </td>
 163   <td class="mlabels-right">
 164 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
 165   </tr>
 166 </table>
 167 </div><div class="memdoc">
 168
 169 <p>Sets the parameters of the colors of the gradient and their position. </p>
 170 <dl class="params"><dt>Parameters</dt><dd>
 171   <table class="params">
 172     <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>
 173     <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>
 174   </table>
 175   </dd>
 176 </dl>
 177 <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>
 178
 179 </div>
 180 </div>
 181 <a id="addbc9de36b4427639f3cc1dceeccb734"></a>
 182 <h2 class="memtitle"><span class="permalink"><a href="#addbc9de36b4427639f3cc1dceeccb734">&#9670;&nbsp;</a></span>colorStops() <span class="overload">[2/2]</span></h2>
 183
 184 <div class="memitem">
 185 <div class="memproto">
 186 <table class="mlabels">
 187   <tr>
 188   <td class="mlabels-left">
 189       <table class="memname">
 190         <tr>
 191           <td class="memname">uint32_t colorStops </td>
 192           <td>(</td>
 193           <td class="paramtype">const <a class="el" href="structtvg_1_1Fill_1_1ColorStop.html">ColorStop</a> **&#160;</td>
 194           <td class="paramname"><em>colorStops</em></td><td>)</td>
 195           <td> const</td>
 196         </tr>
 197       </table>
 198   </td>
 199   <td class="mlabels-right">
 200 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
 201   </tr>
 202 </table>
 203 </div><div class="memdoc">
 204
 205 <p>Gets the parameters of the colors of the gradient, their position and number. </p>
 206 <dl class="params"><dt>Parameters</dt><dd>
 207   <table class="params">
 208     <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>
 209   </table>
 210   </dd>
 211 </dl>
 212 <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>
 213
 214 </div>
 215 </div>
 216 <a id="a48e358abab4478ff7f84dfb85608eaf3"></a>
 217 <h2 class="memtitle"><span class="permalink"><a href="#a48e358abab4478ff7f84dfb85608eaf3">&#9670;&nbsp;</a></span>duplicate()</h2>
 218
 219 <div class="memitem">
 220 <div class="memproto">
 221 <table class="mlabels">
 222   <tr>
 223   <td class="mlabels-left">
 224       <table class="memname">
 225         <tr>
 226           <td class="memname"><a class="el" href="classtvg_1_1Fill.html">Fill</a>* duplicate </td>
 227           <td>(</td>
 228           <td class="paramname"></td><td>)</td>
 229           <td> const</td>
 230         </tr>
 231       </table>
 232   </td>
 233   <td class="mlabels-right">
 234 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
 235   </tr>
 236 </table>
 237 </div><div class="memdoc">
 238
 239 <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>
 240 <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>
 241 <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>
 242
 243 </div>
 244 </div>
 245 <a id="aed49d00ca09e69fdf97aaae235f8e950"></a>
 246 <h2 class="memtitle"><span class="permalink"><a href="#aed49d00ca09e69fdf97aaae235f8e950">&#9670;&nbsp;</a></span>spread() <span class="overload">[1/2]</span></h2>
 247
 248 <div class="memitem">
 249 <div class="memproto">
 250 <table class="mlabels">
 251   <tr>
 252   <td class="mlabels-left">
 253       <table class="memname">
 254         <tr>
 255           <td class="memname"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> spread </td>
 256           <td>(</td>
 257           <td class="paramtype"><a class="el" href="group__ThorVG.html#ga0cfa2c92260cca776292cc9e8964f2da">FillSpread</a>&#160;</td>
 258           <td class="paramname"><em>s</em></td><td>)</td>
 259           <td></td>
 260         </tr>
 261       </table>
 262   </td>
 263   <td class="mlabels-right">
 264 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
 265   </tr>
 266 </table>
 267 </div><div class="memdoc">
 268
 269 <p>Sets the FillSpread value, which specifies how to fill the area outside the gradient bounds. </p>
 270 <dl class="params"><dt>Parameters</dt><dd>
 271   <table class="params">
 272     <tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The FillSpread value.</td></tr>
 273   </table>
 274   </dd>
 275 </dl>
 276 <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>
 277
 278 </div>
 279 </div>
 280 <a id="a55f6de063e5ac8023243c9cef5cb9a12"></a>
 281 <h2 class="memtitle"><span class="permalink"><a href="#a55f6de063e5ac8023243c9cef5cb9a12">&#9670;&nbsp;</a></span>spread() <span class="overload">[2/2]</span></h2>
 282
 283 <div class="memitem">
 284 <div class="memproto">
 285 <table class="mlabels">
 286   <tr>
 287   <td class="mlabels-left">
 288       <table class="memname">
 289         <tr>
 290           <td class="memname"><a class="el" href="group__ThorVG.html#ga0cfa2c92260cca776292cc9e8964f2da">FillSpread</a> spread </td>
 291           <td>(</td>
 292           <td class="paramname"></td><td>)</td>
 293           <td> const</td>
 294         </tr>
 295       </table>
 296   </td>
 297   <td class="mlabels-right">
 298 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
 299   </tr>
 300 </table>
 301 </div><div class="memdoc">
 302
 303 <p>Gets the FillSpread value of the fill. </p>
 304 <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>
 305
 306 </div>
 307 </div>
 308 </div><!-- contents -->
 309 </div><!-- doc-content -->
 310 <!-- start footer part -->
 311 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 312   <ul>
 313     <li class="navelem"><b>tvg</b></li><li class="navelem"><a class="el" href="classtvg_1_1Fill.html">Fill</a></li>
 314     <li class="footer">Generated by
 315     <a href="http://www.doxygen.org/index.html">
 316     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
 317   </ul>
 318 </div>
 319 </body>
 320 </html>