DISTRHO Plugin Framework
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

257 lines
11KB

  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>DISTRHO Plugin Framework: NanoImage Class Reference</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. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">DISTRHO Plugin Framework
  25. </div>
  26. </td>
  27. </tr>
  28. </tbody>
  29. </table>
  30. </div>
  31. <!-- end header part -->
  32. <!-- Generated by Doxygen 1.8.13 -->
  33. <script type="text/javascript">
  34. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  35. </script>
  36. <script type="text/javascript" src="menudata.js"></script>
  37. <script type="text/javascript" src="menu.js"></script>
  38. <script type="text/javascript">
  39. $(function() {
  40. initMenu('',true,false,'search.php','Search');
  41. $(document).ready(function() { init_search(); });
  42. });
  43. </script>
  44. <div id="main-nav"></div>
  45. <!-- window showing the filter options -->
  46. <div id="MSearchSelectWindow"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. onkeydown="return searchBox.OnSearchSelectKey(event)">
  50. </div>
  51. <!-- iframe showing the search results (closed by default) -->
  52. <div id="MSearchResultsWindow">
  53. <iframe src="javascript:void(0)" frameborder="0"
  54. name="MSearchResults" id="MSearchResults">
  55. </iframe>
  56. </div>
  57. </div><!-- top -->
  58. <div class="header">
  59. <div class="summary">
  60. <a href="#nested-classes">Classes</a> &#124;
  61. <a href="#pub-methods">Public Member Functions</a> &#124;
  62. <a href="#friends">Friends</a> &#124;
  63. <a href="classNanoImage-members.html">List of all members</a> </div>
  64. <div class="headertitle">
  65. <div class="title">NanoImage Class Reference</div> </div>
  66. </div><!--header-->
  67. <div class="contents">
  68. <p><code>#include &lt;<a class="el" href="NanoVG_8hpp_source.html">NanoVG.hpp</a>&gt;</code></p>
  69. <table class="memberdecls">
  70. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  71. Public Member Functions</h2></td></tr>
  72. <tr class="memitem:a5bf22d2002986c3b81f3b38ec8abf4a5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNanoImage.html#a5bf22d2002986c3b81f3b38ec8abf4a5">NanoImage</a> ()</td></tr>
  73. <tr class="separator:a5bf22d2002986c3b81f3b38ec8abf4a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ae822e33bed10563f4bd1898ae18afe8e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNanoImage.html#ae822e33bed10563f4bd1898ae18afe8e">NanoImage</a> (const Handle &amp;handle)</td></tr>
  75. <tr class="separator:ae822e33bed10563f4bd1898ae18afe8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:a8915fb5eae1a0180edd3f5babf6a0091"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNanoImage.html#a8915fb5eae1a0180edd3f5babf6a0091">~NanoImage</a> ()</td></tr>
  77. <tr class="separator:a8915fb5eae1a0180edd3f5babf6a0091"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a50e5456835e48157abc365a1e095f591"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classNanoImage.html">NanoImage</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNanoImage.html#a50e5456835e48157abc365a1e095f591">operator=</a> (const Handle &amp;handle)</td></tr>
  79. <tr class="separator:a50e5456835e48157abc365a1e095f591"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a5095000052a0796ee0f944bed2503593"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNanoImage.html#a5095000052a0796ee0f944bed2503593">isValid</a> () const noexcept</td></tr>
  81. <tr class="separator:a5095000052a0796ee0f944bed2503593"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a979cc37d8a10dc0642fcea2d64d3b58c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSize.html">Size</a>&lt; uint &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNanoImage.html#a979cc37d8a10dc0642fcea2d64d3b58c">getSize</a> () const noexcept</td></tr>
  83. <tr class="separator:a979cc37d8a10dc0642fcea2d64d3b58c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a3c1396cb2794d0a2e2f5603f6399472b"><td class="memItemLeft" align="right" valign="top">GLuint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNanoImage.html#a3c1396cb2794d0a2e2f5603f6399472b">getTextureHandle</a> () const</td></tr>
  85. <tr class="separator:a3c1396cb2794d0a2e2f5603f6399472b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. </table><table class="memberdecls">
  87. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  88. Friends</h2></td></tr>
  89. <tr class="memitem:ac61a86a9dea09cc0800db0470bd94d26"><td class="memItemLeft" align="right" valign="top"><a id="ac61a86a9dea09cc0800db0470bd94d26"></a>
  90. class&#160;</td><td class="memItemRight" valign="bottom"><b>NanoVG</b></td></tr>
  91. <tr class="separator:ac61a86a9dea09cc0800db0470bd94d26"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. </table>
  93. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  94. <div class="textblock"><p><a class="el" href="classNanoVG.html">NanoVG</a> <a class="el" href="classImage.html">Image</a> class.</p>
  95. <p>This implements <a class="el" href="classNanoVG.html">NanoVG</a> images as a C++ class where deletion is handled automatically. Images need to be created within a <a class="el" href="classNanoVG.html">NanoVG</a> or <a class="el" href="classNanoWidget.html">NanoWidget</a> class. </p>
  96. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  97. <a id="a5bf22d2002986c3b81f3b38ec8abf4a5"></a>
  98. <h2 class="memtitle"><span class="permalink"><a href="#a5bf22d2002986c3b81f3b38ec8abf4a5">&#9670;&nbsp;</a></span>NanoImage() <span class="overload">[1/2]</span></h2>
  99. <div class="memitem">
  100. <div class="memproto">
  101. <table class="memname">
  102. <tr>
  103. <td class="memname">NanoImage::NanoImage </td>
  104. <td>(</td>
  105. <td class="paramname"></td><td>)</td>
  106. <td></td>
  107. </tr>
  108. </table>
  109. </div><div class="memdoc">
  110. <p>Constructor for an invalid/null image. </p>
  111. </div>
  112. </div>
  113. <a id="ae822e33bed10563f4bd1898ae18afe8e"></a>
  114. <h2 class="memtitle"><span class="permalink"><a href="#ae822e33bed10563f4bd1898ae18afe8e">&#9670;&nbsp;</a></span>NanoImage() <span class="overload">[2/2]</span></h2>
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname">NanoImage::NanoImage </td>
  120. <td>(</td>
  121. <td class="paramtype">const Handle &amp;&#160;</td>
  122. <td class="paramname"><em>handle</em></td><td>)</td>
  123. <td></td>
  124. </tr>
  125. </table>
  126. </div><div class="memdoc">
  127. <p>Constructor. </p>
  128. </div>
  129. </div>
  130. <a id="a8915fb5eae1a0180edd3f5babf6a0091"></a>
  131. <h2 class="memtitle"><span class="permalink"><a href="#a8915fb5eae1a0180edd3f5babf6a0091">&#9670;&nbsp;</a></span>~NanoImage()</h2>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">NanoImage::~NanoImage </td>
  137. <td>(</td>
  138. <td class="paramname"></td><td>)</td>
  139. <td></td>
  140. </tr>
  141. </table>
  142. </div><div class="memdoc">
  143. <p>Destructor. </p>
  144. </div>
  145. </div>
  146. <h2 class="groupheader">Member Function Documentation</h2>
  147. <a id="a50e5456835e48157abc365a1e095f591"></a>
  148. <h2 class="memtitle"><span class="permalink"><a href="#a50e5456835e48157abc365a1e095f591">&#9670;&nbsp;</a></span>operator=()</h2>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname"><a class="el" href="classNanoImage.html">NanoImage</a>&amp; NanoImage::operator= </td>
  154. <td>(</td>
  155. <td class="paramtype">const Handle &amp;&#160;</td>
  156. <td class="paramname"><em>handle</em></td><td>)</td>
  157. <td></td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>Create a new image without recreating the C++ class. </p>
  162. </div>
  163. </div>
  164. <a id="a5095000052a0796ee0f944bed2503593"></a>
  165. <h2 class="memtitle"><span class="permalink"><a href="#a5095000052a0796ee0f944bed2503593">&#9670;&nbsp;</a></span>isValid()</h2>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="mlabels">
  169. <tr>
  170. <td class="mlabels-left">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">bool NanoImage::isValid </td>
  174. <td>(</td>
  175. <td class="paramname"></td><td>)</td>
  176. <td> const</td>
  177. </tr>
  178. </table>
  179. </td>
  180. <td class="mlabels-right">
  181. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. <p>Wherever this image is valid. </p>
  186. </div>
  187. </div>
  188. <a id="a979cc37d8a10dc0642fcea2d64d3b58c"></a>
  189. <h2 class="memtitle"><span class="permalink"><a href="#a979cc37d8a10dc0642fcea2d64d3b58c">&#9670;&nbsp;</a></span>getSize()</h2>
  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"><a class="el" href="classSize.html">Size</a>&lt;uint&gt; NanoImage::getSize </td>
  198. <td>(</td>
  199. <td class="paramname"></td><td>)</td>
  200. <td> const</td>
  201. </tr>
  202. </table>
  203. </td>
  204. <td class="mlabels-right">
  205. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  206. </tr>
  207. </table>
  208. </div><div class="memdoc">
  209. <p>Get size. </p>
  210. </div>
  211. </div>
  212. <a id="a3c1396cb2794d0a2e2f5603f6399472b"></a>
  213. <h2 class="memtitle"><span class="permalink"><a href="#a3c1396cb2794d0a2e2f5603f6399472b">&#9670;&nbsp;</a></span>getTextureHandle()</h2>
  214. <div class="memitem">
  215. <div class="memproto">
  216. <table class="memname">
  217. <tr>
  218. <td class="memname">GLuint NanoImage::getTextureHandle </td>
  219. <td>(</td>
  220. <td class="paramname"></td><td>)</td>
  221. <td> const</td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. <p>Get the OpenGL texture handle. </p>
  226. </div>
  227. </div>
  228. <hr/>The documentation for this class was generated from the following file:<ul>
  229. <li>dgl/<a class="el" href="NanoVG_8hpp_source.html">NanoVG.hpp</a></li>
  230. </ul>
  231. </div><!-- contents -->
  232. <!-- start footer part -->
  233. <hr class="footer"/><address class="footer"><small>
  234. Generated on Sun Apr 7 2019 05:47:58 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  235. <img class="footer" src="doxygen.png" alt="doxygen"/>
  236. </a> 1.8.13
  237. </small></address>
  238. </body>
  239. </html>