docs/html/classtvg_1_1SwCanvas.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: SwCanvas</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="search/search.css" rel="stylesheet" type="text/css"/>
  13 <script type="text/javascript" src="search/searchdata.js"></script>
  14 <script type="text/javascript" src="search/search.js"></script>
  15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16 <link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
  17 </head>
  18 <body>
  19 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20 <div id="titlearea">
  21 <table cellspacing="0" cellpadding="0">
  22  <tbody>
  23  <tr style="height: 56px;">
  24   <td id="projectlogo"><img alt="Logo" src="small_logo.svg"/></td>
  25   <td id="projectalign" style="padding-left: 0.5em;">
  26    <div id="projectname">ThorVG
  27    &#160;<span id="projectnumber">v0.1</span>
  28    </div>
  29   </td>
  30  </tr>
  31  </tbody>
  32 </table>
  33 </div>
  34 <!-- end header part -->
  35 <!-- Generated by Doxygen 1.8.13 -->
  36 <script type="text/javascript">
  37 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38 </script>
  39 <script type="text/javascript" src="menudata.js"></script>
  40 <script type="text/javascript" src="menu.js"></script>
  41 <script type="text/javascript">
  42 $(function() {
  43   initMenu('',true,false,'search.php','Search');
  44   $(document).ready(function() { init_search(); });
  45 });
  46 </script>
  47 <div id="main-nav"></div>
  48 <!-- window showing the filter options -->
  49 <div id="MSearchSelectWindow"
  50      onmouseover="return searchBox.OnSearchSelectShow()"
  51      onmouseout="return searchBox.OnSearchSelectHide()"
  52      onkeydown="return searchBox.OnSearchSelectKey(event)">
  53 </div>
  54
  55 <!-- iframe showing the search results (closed by default) -->
  56 <div id="MSearchResultsWindow">
  57 <iframe src="javascript:void(0)" frameborder="0"
  58         name="MSearchResults" id="MSearchResults">
  59 </iframe>
  60 </div>
  61
  62 <div id="nav-path" class="navpath">
  63   <ul>
  64 <li class="navelem"><b>tvg</b></li><li class="navelem"><a class="el" href="classtvg_1_1SwCanvas.html">SwCanvas</a></li>  </ul>
  65 </div>
  66 </div><!-- top -->
  67 <div class="header">
  68   <div class="summary">
  69 <a href="#pub-types">Public Types</a> &#124;
  70 <a href="#pub-methods">Public Member Functions</a> &#124;
  71 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  72 <a href="classtvg_1_1SwCanvas-members.html">List of all members</a>  </div>
  73   <div class="headertitle">
  74 <div class="title">SwCanvas<span class="mlabels"><span class="mlabel">final</span></span><div class="ingroups"><a class="el" href="group__ThorVG.html">ThorVG</a></div></div>  </div>
  75 </div><!--header-->
  76 <div class="contents">
  77
  78 <p>A class for the rendering graphical elements with a software raster engine.
  79  <a href="classtvg_1_1SwCanvas.html#details">More...</a></p>
  80 <div class="dynheader">
  81 Inheritance diagram for SwCanvas:</div>
  82 <div class="dyncontent">
  83 <div class="center"><img src="classtvg_1_1SwCanvas__inherit__graph.png" border="0" usemap="#SwCanvas_inherit__map" alt="Inheritance graph"/></div>
  84 <map name="SwCanvas_inherit__map" id="SwCanvas_inherit__map">
  85 <area shape="rect" id="node2" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements. " alt="" coords="15,5,82,32"/>
  86 </map>
  87 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  88 <table class="memberdecls">
  89 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  90 Public Types</h2></td></tr>
  91 <tr class="memitem:a7a7e24cdb2a27271343f0adceff89f65"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1SwCanvas.html#a7a7e24cdb2a27271343f0adceff89f65">Colorspace</a> { <a class="el" href="classtvg_1_1SwCanvas.html#a7a7e24cdb2a27271343f0adceff89f65adb1b146d65c52857a5a4af54e5006101">ABGR8888</a> = 0,
  92 <a class="el" href="classtvg_1_1SwCanvas.html#a7a7e24cdb2a27271343f0adceff89f65af540c373a71dee269827b0d12026de80">ARGB8888</a>
  93  }<tr class="memdesc:a7a7e24cdb2a27271343f0adceff89f65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration specifying the methods of combining the 8-bit color channels into 32-bit color.  <a href="classtvg_1_1SwCanvas.html#a7a7e24cdb2a27271343f0adceff89f65">More...</a><br /></td></tr>
  94 </td></tr>
  95 <tr class="separator:a7a7e24cdb2a27271343f0adceff89f65"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96 <tr class="memitem:a9b9770837f0171b15f0cd86f94e8e22b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1SwCanvas.html#a9b9770837f0171b15f0cd86f94e8e22b">MempoolPolicy</a> { <a class="el" href="classtvg_1_1SwCanvas.html#a9b9770837f0171b15f0cd86f94e8e22ba79935518a3889663d8688b6b01fff051">Default</a> = 0,
  97 <a class="el" href="classtvg_1_1SwCanvas.html#a9b9770837f0171b15f0cd86f94e8e22ba4652dcff02024c6e4cba53124ddb5dd5">Shareable</a>,
  98 <a class="el" href="classtvg_1_1SwCanvas.html#a9b9770837f0171b15f0cd86f94e8e22bab0257211e60ed5eb6767ec8ed3ec2524">Individual</a>
  99  }<tr class="memdesc:a9b9770837f0171b15f0cd86f94e8e22b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration specifying the methods of Memory Pool behavior policy.  <a href="classtvg_1_1SwCanvas.html#a9b9770837f0171b15f0cd86f94e8e22b">More...</a><br /></td></tr>
 100 </td></tr>
 101 <tr class="separator:a9b9770837f0171b15f0cd86f94e8e22b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 102 </table><table class="memberdecls">
 103 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 104 Public Member Functions</h2></td></tr>
 105 <tr class="memitem:a2d4c80a0ba45465b073ee0c279e8c8dc"><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_1SwCanvas.html#a2d4c80a0ba45465b073ee0c279e8c8dc">target</a> (uint32_t *buffer, uint32_t stride, uint32_t w, uint32_t h, <a class="el" href="classtvg_1_1SwCanvas.html#a7a7e24cdb2a27271343f0adceff89f65">Colorspace</a> cs) noexcept</td></tr>
 106 <tr class="memdesc:a2d4c80a0ba45465b073ee0c279e8c8dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the target buffer for the rasterization.  <a href="#a2d4c80a0ba45465b073ee0c279e8c8dc">More...</a><br /></td></tr>
 107 <tr class="separator:a2d4c80a0ba45465b073ee0c279e8c8dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 108 <tr class="memitem:a3486268541200559f16847cbe714a72c"><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_1SwCanvas.html#a3486268541200559f16847cbe714a72c">mempool</a> (<a class="el" href="classtvg_1_1SwCanvas.html#a9b9770837f0171b15f0cd86f94e8e22b">MempoolPolicy</a> policy) noexcept</td></tr>
 109 <tr class="memdesc:a3486268541200559f16847cbe714a72c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set sw engine memory pool behavior policy.  <a href="#a3486268541200559f16847cbe714a72c">More...</a><br /></td></tr>
 110 <tr class="separator:a3486268541200559f16847cbe714a72c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 111 <tr class="inherit_header pub_methods_classtvg_1_1Canvas"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classtvg_1_1Canvas')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classtvg_1_1Canvas.html">Canvas</a></td></tr>
 112 <tr class="memitem:a4cff0ab757e1db9077bbecaf25f012ba inherit pub_methods_classtvg_1_1Canvas"><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_1Canvas.html#a4cff0ab757e1db9077bbecaf25f012ba">reserve</a> (uint32_t n) noexcept</td></tr>
 113 <tr class="memdesc:a4cff0ab757e1db9077bbecaf25f012ba inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the size of the container, where all the paints pushed into the <a class="el" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements. ">Canvas</a> are stored.  <a href="classtvg_1_1Canvas.html#a4cff0ab757e1db9077bbecaf25f012ba">More...</a><br /></td></tr>
 114 <tr class="separator:a4cff0ab757e1db9077bbecaf25f012ba inherit pub_methods_classtvg_1_1Canvas"><td class="memSeparator" colspan="2">&#160;</td></tr>
 115 <tr class="memitem:a82c5ec1c1ba93cf7671642400074201e inherit pub_methods_classtvg_1_1Canvas"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#a82c5ec1c1ba93cf7671642400074201e">push</a> (std::unique_ptr&lt; <a class="el" href="classtvg_1_1Paint.html">Paint</a> &gt; paint) noexcept</td></tr>
 116 <tr class="memdesc:a82c5ec1c1ba93cf7671642400074201e inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Passes drawing elements to the <a class="el" href="classtvg_1_1Canvas.html" title="An abstract class for drawing graphical elements. ">Canvas</a> using <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements. ">Paint</a> objects.  <a href="classtvg_1_1Canvas.html#a82c5ec1c1ba93cf7671642400074201e">More...</a><br /></td></tr>
 117 <tr class="separator:a82c5ec1c1ba93cf7671642400074201e inherit pub_methods_classtvg_1_1Canvas"><td class="memSeparator" colspan="2">&#160;</td></tr>
 118 <tr class="memitem:a99cdb01cd893f4199b521b754d21aefd inherit pub_methods_classtvg_1_1Canvas"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd">clear</a> (bool free=true) noexcept</td></tr>
 119 <tr class="memdesc:a99cdb01cd893f4199b521b754d21aefd inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the total number of the paints pushed into the canvas to be zero. Depending on the value of the <code>free</code> argument, the paints are freed or not.  <a href="classtvg_1_1Canvas.html#a99cdb01cd893f4199b521b754d21aefd">More...</a><br /></td></tr>
 120 <tr class="separator:a99cdb01cd893f4199b521b754d21aefd inherit pub_methods_classtvg_1_1Canvas"><td class="memSeparator" colspan="2">&#160;</td></tr>
 121 <tr class="memitem:acf6e6748e3d4f218e920c380b4950355 inherit pub_methods_classtvg_1_1Canvas"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#acf6e6748e3d4f218e920c380b4950355">update</a> (<a class="el" href="classtvg_1_1Paint.html">Paint</a> *paint) noexcept</td></tr>
 122 <tr class="memdesc:acf6e6748e3d4f218e920c380b4950355 inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the canvas to update the paint objects.  <a href="classtvg_1_1Canvas.html#acf6e6748e3d4f218e920c380b4950355">More...</a><br /></td></tr>
 123 <tr class="separator:acf6e6748e3d4f218e920c380b4950355 inherit pub_methods_classtvg_1_1Canvas"><td class="memSeparator" colspan="2">&#160;</td></tr>
 124 <tr class="memitem:aabf9e5a14da3b4bfd5883c2b4459abd0 inherit pub_methods_classtvg_1_1Canvas"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#aabf9e5a14da3b4bfd5883c2b4459abd0">draw</a> () noexcept</td></tr>
 125 <tr class="memdesc:aabf9e5a14da3b4bfd5883c2b4459abd0 inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the canvas to draw the <a class="el" href="classtvg_1_1Paint.html" title="An abstract class for managing graphical elements. ">Paint</a> objects.  <a href="classtvg_1_1Canvas.html#aabf9e5a14da3b4bfd5883c2b4459abd0">More...</a><br /></td></tr>
 126 <tr class="separator:aabf9e5a14da3b4bfd5883c2b4459abd0 inherit pub_methods_classtvg_1_1Canvas"><td class="memSeparator" colspan="2">&#160;</td></tr>
 127 <tr class="memitem:adbca600af79f9a0b8e8366e3be7450e9 inherit pub_methods_classtvg_1_1Canvas"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Canvas.html#adbca600af79f9a0b8e8366e3be7450e9">sync</a> () noexcept</td></tr>
 128 <tr class="memdesc:adbca600af79f9a0b8e8366e3be7450e9 inherit pub_methods_classtvg_1_1Canvas"><td class="mdescLeft">&#160;</td><td class="mdescRight">Guarantees that drawing task is finished.  <a href="classtvg_1_1Canvas.html#adbca600af79f9a0b8e8366e3be7450e9">More...</a><br /></td></tr>
 129 <tr class="separator:adbca600af79f9a0b8e8366e3be7450e9 inherit pub_methods_classtvg_1_1Canvas"><td class="memSeparator" colspan="2">&#160;</td></tr>
 130 </table><table class="memberdecls">
 131 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
 132 Static Public Member Functions</h2></td></tr>
 133 <tr class="memitem:aba83ff17ba357417c8bbe62cf5141c96"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr&lt; <a class="el" href="classtvg_1_1SwCanvas.html">SwCanvas</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1SwCanvas.html#aba83ff17ba357417c8bbe62cf5141c96">gen</a> () noexcept</td></tr>
 134 <tr class="memdesc:aba83ff17ba357417c8bbe62cf5141c96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new <a class="el" href="classtvg_1_1SwCanvas.html" title="A class for the rendering graphical elements with a software raster engine. ">SwCanvas</a> object.  <a href="#aba83ff17ba357417c8bbe62cf5141c96">More...</a><br /></td></tr>
 135 <tr class="separator:aba83ff17ba357417c8bbe62cf5141c96"><td class="memSeparator" colspan="2">&#160;</td></tr>
 136 </table>
 137 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 138 <div class="textblock"><p>A class for the rendering graphical elements with a software raster engine. </p>
 139 </div><h2 class="groupheader">Member Enumeration Documentation</h2>
 140 <a id="a7a7e24cdb2a27271343f0adceff89f65"></a>
 141 <h2 class="memtitle"><span class="permalink"><a href="#a7a7e24cdb2a27271343f0adceff89f65">&#9670;&nbsp;</a></span>Colorspace</h2>
 142
 143 <div class="memitem">
 144 <div class="memproto">
 145       <table class="memname">
 146         <tr>
 147           <td class="memname">enum <a class="el" href="classtvg_1_1SwCanvas.html#a7a7e24cdb2a27271343f0adceff89f65">Colorspace</a></td>
 148         </tr>
 149       </table>
 150 </div><div class="memdoc">
 151
 152 <p>Enumeration specifying the methods of combining the 8-bit color channels into 32-bit color. </p>
 153 <table class="fieldtable">
 154 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7a7e24cdb2a27271343f0adceff89f65adb1b146d65c52857a5a4af54e5006101"></a>ABGR8888&#160;</td><td class="fielddoc"><p>The channels are joined in the order: alpha, blue, green, red. </p>
 155 </td></tr>
 156 <tr><td class="fieldname"><a id="a7a7e24cdb2a27271343f0adceff89f65af540c373a71dee269827b0d12026de80"></a>ARGB8888&#160;</td><td class="fielddoc"><p>The channels are joined in the order: alpha, red, green, blue. </p>
 157 </td></tr>
 158 </table>
 159
 160 </div>
 161 </div>
 162 <a id="a9b9770837f0171b15f0cd86f94e8e22b"></a>
 163 <h2 class="memtitle"><span class="permalink"><a href="#a9b9770837f0171b15f0cd86f94e8e22b">&#9670;&nbsp;</a></span>MempoolPolicy</h2>
 164
 165 <div class="memitem">
 166 <div class="memproto">
 167       <table class="memname">
 168         <tr>
 169           <td class="memname">enum <a class="el" href="classtvg_1_1SwCanvas.html#a9b9770837f0171b15f0cd86f94e8e22b">MempoolPolicy</a></td>
 170         </tr>
 171       </table>
 172 </div><div class="memdoc">
 173
 174 <p>Enumeration specifying the methods of Memory Pool behavior policy. </p>
 175 <table class="fieldtable">
 176 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9b9770837f0171b15f0cd86f94e8e22ba79935518a3889663d8688b6b01fff051"></a>Default&#160;</td><td class="fielddoc"><p>Default behavior that ThorVG is designed to. </p>
 177 </td></tr>
 178 <tr><td class="fieldname"><a id="a9b9770837f0171b15f0cd86f94e8e22ba4652dcff02024c6e4cba53124ddb5dd5"></a>Shareable&#160;</td><td class="fielddoc"><p>Memory Pool is shared among the SwCanvases. </p>
 179 </td></tr>
 180 <tr><td class="fieldname"><a id="a9b9770837f0171b15f0cd86f94e8e22bab0257211e60ed5eb6767ec8ed3ec2524"></a>Individual&#160;</td><td class="fielddoc"><p>Allocate designated memory pool that is only used by current instance. </p>
 181 </td></tr>
 182 </table>
 183
 184 </div>
 185 </div>
 186 <h2 class="groupheader">Member Function Documentation</h2>
 187 <a id="aba83ff17ba357417c8bbe62cf5141c96"></a>
 188 <h2 class="memtitle"><span class="permalink"><a href="#aba83ff17ba357417c8bbe62cf5141c96">&#9670;&nbsp;</a></span>gen()</h2>
 189
 190 <div class="memitem">
 191 <div class="memproto">
 192 <table class="mlabels">
 193   <tr>
 194   <td class="mlabels-left">
 195       <table class="memname">
 196         <tr>
 197           <td class="memname">static std::unique_ptr&lt;<a class="el" href="classtvg_1_1SwCanvas.html">SwCanvas</a>&gt; gen </td>
 198           <td>(</td>
 199           <td class="paramname"></td><td>)</td>
 200           <td></td>
 201         </tr>
 202       </table>
 203   </td>
 204   <td class="mlabels-right">
 205 <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span>  </td>
 206   </tr>
 207 </table>
 208 </div><div class="memdoc">
 209
 210 <p>Creates a new <a class="el" href="classtvg_1_1SwCanvas.html" title="A class for the rendering graphical elements with a software raster engine. ">SwCanvas</a> object. </p>
 211 <dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="classtvg_1_1SwCanvas.html" title="A class for the rendering graphical elements with a software raster engine. ">SwCanvas</a> object. </dd></dl>
 212
 213 </div>
 214 </div>
 215 <a id="a3486268541200559f16847cbe714a72c"></a>
 216 <h2 class="memtitle"><span class="permalink"><a href="#a3486268541200559f16847cbe714a72c">&#9670;&nbsp;</a></span>mempool()</h2>
 217
 218 <div class="memitem">
 219 <div class="memproto">
 220 <table class="mlabels">
 221   <tr>
 222   <td class="mlabels-left">
 223       <table class="memname">
 224         <tr>
 225           <td class="memname"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> mempool </td>
 226           <td>(</td>
 227           <td class="paramtype"><a class="el" href="classtvg_1_1SwCanvas.html#a9b9770837f0171b15f0cd86f94e8e22b">MempoolPolicy</a>&#160;</td>
 228           <td class="paramname"><em>policy</em></td><td>)</td>
 229           <td></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>Set sw engine memory pool behavior policy. </p>
 240 <p>Basically ThorVG draws a lot of shapes, it allocates/deallocates a few chunk of memory while processing rendering. It internally uses one shared memory pool which can be reused among the canvases in order to avoid memory overhead.</p>
 241 <p>Thus ThorVG suggests memory pool policy to satisfy user demands, if it needs to guarantee the thread-safety of the internal data access.</p>
 242 <dl class="params"><dt>Parameters</dt><dd>
 243   <table class="params">
 244     <tr><td class="paramdir">[in]</td><td class="paramname">policy</td><td>Use the shared cache memory. The default value is <code>true</code> </td></tr>
 245   </table>
 246   </dd>
 247 </dl>
 248 <dl class="retval"><dt>Return values</dt><dd>
 249   <table class="retval">
 250     <tr><td class="paramname"><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution. ">Result::Success</a></td><td>When succeed. </td></tr>
 251     <tr><td class="paramname"><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a119732ff568bf103d744e930ae2404f1" title="The value returned in case the request cannot be processed - e.g. asking for properties of an object...">Result::InsufficientCondition</a></td><td>If the canvas has any paints. </td></tr>
 252     <tr><td class="paramname"><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066aa0cfd518e4385f31d38720579321ed29" title="The value returned in case of choosing unsupported options. ">Result::NonSupport</a></td><td>In case the software engine is not supported.</td></tr>
 253   </table>
 254   </dd>
 255 </dl>
 256 <dl class="section note"><dt>Note</dt><dd>When <code>policy</code> is set as <code>MempoolPolicy::Individual</code>, current instance of canvas uses its own individual memory data that is not shared with others. This is necessary when the canvas is accessed on a worker-thread.</dd></dl>
 257 <dl class="section warning"><dt>Warning</dt><dd>It's not allowed after pushing any paints.</dd></dl>
 258
 259 </div>
 260 </div>
 261 <a id="a2d4c80a0ba45465b073ee0c279e8c8dc"></a>
 262 <h2 class="memtitle"><span class="permalink"><a href="#a2d4c80a0ba45465b073ee0c279e8c8dc">&#9670;&nbsp;</a></span>target()</h2>
 263
 264 <div class="memitem">
 265 <div class="memproto">
 266 <table class="mlabels">
 267   <tr>
 268   <td class="mlabels-left">
 269       <table class="memname">
 270         <tr>
 271           <td class="memname"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> target </td>
 272           <td>(</td>
 273           <td class="paramtype">uint32_t *&#160;</td>
 274           <td class="paramname"><em>buffer</em>, </td>
 275         </tr>
 276         <tr>
 277           <td class="paramkey"></td>
 278           <td></td>
 279           <td class="paramtype">uint32_t&#160;</td>
 280           <td class="paramname"><em>stride</em>, </td>
 281         </tr>
 282         <tr>
 283           <td class="paramkey"></td>
 284           <td></td>
 285           <td class="paramtype">uint32_t&#160;</td>
 286           <td class="paramname"><em>w</em>, </td>
 287         </tr>
 288         <tr>
 289           <td class="paramkey"></td>
 290           <td></td>
 291           <td class="paramtype">uint32_t&#160;</td>
 292           <td class="paramname"><em>h</em>, </td>
 293         </tr>
 294         <tr>
 295           <td class="paramkey"></td>
 296           <td></td>
 297           <td class="paramtype"><a class="el" href="classtvg_1_1SwCanvas.html#a7a7e24cdb2a27271343f0adceff89f65">Colorspace</a>&#160;</td>
 298           <td class="paramname"><em>cs</em>&#160;</td>
 299         </tr>
 300         <tr>
 301           <td></td>
 302           <td>)</td>
 303           <td></td><td></td>
 304         </tr>
 305       </table>
 306   </td>
 307   <td class="mlabels-right">
 308 <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
 309   </tr>
 310 </table>
 311 </div><div class="memdoc">
 312
 313 <p>Sets the target buffer for the rasterization. </p>
 314 <p>The buffer of a desirable size should be allocated and owned by the caller.</p>
 315 <dl class="params"><dt>Parameters</dt><dd>
 316   <table class="params">
 317     <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>A pointer to a memory block of the size <code>stride</code> x <code>h</code>, where the raster data are stored. </td></tr>
 318     <tr><td class="paramdir">[in]</td><td class="paramname">stride</td><td>The stride of the raster image - greater than or equal to <code>w</code>. </td></tr>
 319     <tr><td class="paramdir">[in]</td><td class="paramname">w</td><td>The width of the raster image. </td></tr>
 320     <tr><td class="paramdir">[in]</td><td class="paramname">h</td><td>The height of the raster image. </td></tr>
 321     <tr><td class="paramdir">[in]</td><td class="paramname">cs</td><td>The value specifying the way the 32-bits colors should be read/written.</td></tr>
 322   </table>
 323   </dd>
 324 </dl>
 325 <dl class="retval"><dt>Return values</dt><dd>
 326   <table class="retval">
 327     <tr><td class="paramname"><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution. ">Result::Success</a></td><td>When succeed. </td></tr>
 328     <tr><td class="paramname"><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066ae8c0c653fcac575c31470f0f800991c6" title="The value returned in the event of bad memory handling - e.g. failing in pointer releasing or casting...">Result::MemoryCorruption</a></td><td>When casting in the internal function implementation failed. </td></tr>
 329     <tr><td class="paramname"><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></td><td>In case no valid pointer is provided or the width, or the height or the stride is zero. </td></tr>
 330     <tr><td class="paramname"><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066aa0cfd518e4385f31d38720579321ed29" title="The value returned in case of choosing unsupported options. ">Result::NonSupport</a></td><td>In case the software engine is not supported.</td></tr>
 331   </table>
 332   </dd>
 333 </dl>
 334 <dl class="section warning"><dt>Warning</dt><dd>Do not access <code>buffer</code> during <a class="el" href="classtvg_1_1Canvas.html#aabf9e5a14da3b4bfd5883c2b4459abd0" title="Request the canvas to draw the Paint objects. ">Canvas::draw()</a> - <a class="el" href="classtvg_1_1Canvas.html#adbca600af79f9a0b8e8366e3be7450e9" title="Guarantees that drawing task is finished. ">Canvas::sync()</a>. It should not be accessed while TVG is writing on it. </dd></dl>
 335
 336 </div>
 337 </div>
 338 </div><!-- contents -->
 339 <!-- start footer part -->
 340 <hr class="footer"/><address class="footer"><small>
 341 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 342 <img class="footer" src="doxygen.png" alt="doxygen"/>
 343 </a> 1.8.13
 344 </small></address>
 345 </body>
 346 </html>