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.

631 lines
28KB

  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: Image 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="#pub-methods">Public Member Functions</a> &#124;
  61. <a href="classImage-members.html">List of all members</a> </div>
  62. <div class="headertitle">
  63. <div class="title">Image Class Reference</div> </div>
  64. </div><!--header-->
  65. <div class="contents">
  66. <p><code>#include &lt;<a class="el" href="Image_8hpp_source.html">Image.hpp</a>&gt;</code></p>
  67. <table class="memberdecls">
  68. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  69. Public Member Functions</h2></td></tr>
  70. <tr class="memitem:a58edd1c45b4faeb5f789b0d036d02313"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a58edd1c45b4faeb5f789b0d036d02313">Image</a> ()</td></tr>
  71. <tr class="separator:a58edd1c45b4faeb5f789b0d036d02313"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:ad351054c0c6ebc0df99a7f8df12c8920"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#ad351054c0c6ebc0df99a7f8df12c8920">Image</a> (const char *const rawData, const uint width, const uint height, const GLenum format=GL_BGRA, const GLenum type=GL_UNSIGNED_BYTE)</td></tr>
  73. <tr class="separator:ad351054c0c6ebc0df99a7f8df12c8920"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a4587a30e65bacb349bc2d351d2fe49eb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a4587a30e65bacb349bc2d351d2fe49eb">Image</a> (const char *const rawData, const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;size, const GLenum format=GL_BGRA, const GLenum type=GL_UNSIGNED_BYTE)</td></tr>
  75. <tr class="separator:a4587a30e65bacb349bc2d351d2fe49eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:a34410a36b132ab597a8878d45facc89a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a34410a36b132ab597a8878d45facc89a">Image</a> (const <a class="el" href="classImage.html">Image</a> &amp;image)</td></tr>
  77. <tr class="separator:a34410a36b132ab597a8878d45facc89a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a0294f63700543e11c0f0da85601c7ae5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a0294f63700543e11c0f0da85601c7ae5">~Image</a> ()</td></tr>
  79. <tr class="separator:a0294f63700543e11c0f0da85601c7ae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a097350feb2b30fd9289c346039298394"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a097350feb2b30fd9289c346039298394">loadFromMemory</a> (const char *const rawData, const uint width, const uint height, const GLenum format=GL_BGRA, const GLenum type=GL_UNSIGNED_BYTE) noexcept</td></tr>
  81. <tr class="separator:a097350feb2b30fd9289c346039298394"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a2851a65c5885085be1d96878762fd860"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a2851a65c5885085be1d96878762fd860">loadFromMemory</a> (const char *const rawData, const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;size, const GLenum format=GL_BGRA, const GLenum type=GL_UNSIGNED_BYTE) noexcept</td></tr>
  83. <tr class="separator:a2851a65c5885085be1d96878762fd860"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a761214d2fa016e3e793b5a2d6b8b85ec"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a761214d2fa016e3e793b5a2d6b8b85ec">isValid</a> () const noexcept</td></tr>
  85. <tr class="separator:a761214d2fa016e3e793b5a2d6b8b85ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a695d30afad2b73bc0e4208a94d052aea"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a695d30afad2b73bc0e4208a94d052aea">getWidth</a> () const noexcept</td></tr>
  87. <tr class="separator:a695d30afad2b73bc0e4208a94d052aea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a464a18561e9d49b9af42f007113d55f6"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a464a18561e9d49b9af42f007113d55f6">getHeight</a> () const noexcept</td></tr>
  89. <tr class="separator:a464a18561e9d49b9af42f007113d55f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a86b31865bfa07b98b61f503699f5c5d1"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a86b31865bfa07b98b61f503699f5c5d1">getSize</a> () const noexcept</td></tr>
  91. <tr class="separator:a86b31865bfa07b98b61f503699f5c5d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a638e0d75e9dff587f028639aaae8981b"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a638e0d75e9dff587f028639aaae8981b">getRawData</a> () const noexcept</td></tr>
  93. <tr class="separator:a638e0d75e9dff587f028639aaae8981b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:ac02e8bb7bfcc4adefc1f00557cc40e86"><td class="memItemLeft" align="right" valign="top">GLenum&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#ac02e8bb7bfcc4adefc1f00557cc40e86">getFormat</a> () const noexcept</td></tr>
  95. <tr class="separator:ac02e8bb7bfcc4adefc1f00557cc40e86"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:aafdd618cccc80f83a438b0c335de6205"><td class="memItemLeft" align="right" valign="top">GLenum&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#aafdd618cccc80f83a438b0c335de6205">getType</a> () const noexcept</td></tr>
  97. <tr class="separator:aafdd618cccc80f83a438b0c335de6205"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:ae1e16dcef3072e4e49ec2887a9c1245a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#ae1e16dcef3072e4e49ec2887a9c1245a">draw</a> ()</td></tr>
  99. <tr class="separator:ae1e16dcef3072e4e49ec2887a9c1245a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:ab63094dc07e6d62624827bca904b5cdd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#ab63094dc07e6d62624827bca904b5cdd">drawAt</a> (const int x, const int y)</td></tr>
  101. <tr class="separator:ab63094dc07e6d62624827bca904b5cdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:aed2dc99624de978eade8124d2c099cfa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#aed2dc99624de978eade8124d2c099cfa">drawAt</a> (const <a class="el" href="classPoint.html">Point</a>&lt; int &gt; &amp;pos)</td></tr>
  103. <tr class="separator:aed2dc99624de978eade8124d2c099cfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:ab23271a6bf92330d04c84146bfa81641"><td class="memItemLeft" align="right" valign="top"><a id="ab23271a6bf92330d04c84146bfa81641"></a>
  105. <a class="el" href="classImage.html">Image</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classImage.html">Image</a> &amp;image) noexcept</td></tr>
  106. <tr class="separator:ab23271a6bf92330d04c84146bfa81641"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a775663b153fb5d21bca622739d881631"><td class="memItemLeft" align="right" valign="top"><a id="a775663b153fb5d21bca622739d881631"></a>
  108. bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classImage.html">Image</a> &amp;image) const noexcept</td></tr>
  109. <tr class="separator:a775663b153fb5d21bca622739d881631"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:abb67912deb6a20ea1c5a5b4d5a71c0ee"><td class="memItemLeft" align="right" valign="top"><a id="abb67912deb6a20ea1c5a5b4d5a71c0ee"></a>
  111. bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="classImage.html">Image</a> &amp;image) const noexcept</td></tr>
  112. <tr class="separator:abb67912deb6a20ea1c5a5b4d5a71c0ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. </table>
  114. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  115. <div class="textblock"><p>Base DGL <a class="el" href="classImage.html">Image</a> class.</p>
  116. <p>This is an <a class="el" href="classImage.html">Image</a> class that handles raw image data in pixels. You can init the image data on the contructor or later on by calling <a class="el" href="classImage.html#a097350feb2b30fd9289c346039298394">loadFromMemory()</a>.</p>
  117. <p>To generate raw data useful for this class see the utils/png2rgba.py script. Be careful when using a PNG without alpha channel, for those the format is 'GL_BGR' instead of the default 'GL_BGRA'.</p>
  118. <p>Images are drawn on screen via 2D textures. </p>
  119. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  120. <a id="a58edd1c45b4faeb5f789b0d036d02313"></a>
  121. <h2 class="memtitle"><span class="permalink"><a href="#a58edd1c45b4faeb5f789b0d036d02313">&#9670;&nbsp;</a></span>Image() <span class="overload">[1/4]</span></h2>
  122. <div class="memitem">
  123. <div class="memproto">
  124. <table class="memname">
  125. <tr>
  126. <td class="memname">Image::Image </td>
  127. <td>(</td>
  128. <td class="paramname"></td><td>)</td>
  129. <td></td>
  130. </tr>
  131. </table>
  132. </div><div class="memdoc">
  133. <p>Constructor for a null <a class="el" href="classImage.html">Image</a>. </p>
  134. </div>
  135. </div>
  136. <a id="ad351054c0c6ebc0df99a7f8df12c8920"></a>
  137. <h2 class="memtitle"><span class="permalink"><a href="#ad351054c0c6ebc0df99a7f8df12c8920">&#9670;&nbsp;</a></span>Image() <span class="overload">[2/4]</span></h2>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">Image::Image </td>
  143. <td>(</td>
  144. <td class="paramtype">const char *const&#160;</td>
  145. <td class="paramname"><em>rawData</em>, </td>
  146. </tr>
  147. <tr>
  148. <td class="paramkey"></td>
  149. <td></td>
  150. <td class="paramtype">const uint&#160;</td>
  151. <td class="paramname"><em>width</em>, </td>
  152. </tr>
  153. <tr>
  154. <td class="paramkey"></td>
  155. <td></td>
  156. <td class="paramtype">const uint&#160;</td>
  157. <td class="paramname"><em>height</em>, </td>
  158. </tr>
  159. <tr>
  160. <td class="paramkey"></td>
  161. <td></td>
  162. <td class="paramtype">const GLenum&#160;</td>
  163. <td class="paramname"><em>format</em> = <code>GL_BGRA</code>, </td>
  164. </tr>
  165. <tr>
  166. <td class="paramkey"></td>
  167. <td></td>
  168. <td class="paramtype">const GLenum&#160;</td>
  169. <td class="paramname"><em>type</em> = <code>GL_UNSIGNED_BYTE</code>&#160;</td>
  170. </tr>
  171. <tr>
  172. <td></td>
  173. <td>)</td>
  174. <td></td><td></td>
  175. </tr>
  176. </table>
  177. </div><div class="memdoc">
  178. <p>Constructor using raw image data. </p><dl class="section note"><dt>Note</dt><dd><em>rawData</em> must remain valid for the lifetime of this <a class="el" href="classImage.html">Image</a>. </dd></dl>
  179. </div>
  180. </div>
  181. <a id="a4587a30e65bacb349bc2d351d2fe49eb"></a>
  182. <h2 class="memtitle"><span class="permalink"><a href="#a4587a30e65bacb349bc2d351d2fe49eb">&#9670;&nbsp;</a></span>Image() <span class="overload">[3/4]</span></h2>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="memname">
  186. <tr>
  187. <td class="memname">Image::Image </td>
  188. <td>(</td>
  189. <td class="paramtype">const char *const&#160;</td>
  190. <td class="paramname"><em>rawData</em>, </td>
  191. </tr>
  192. <tr>
  193. <td class="paramkey"></td>
  194. <td></td>
  195. <td class="paramtype">const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;&#160;</td>
  196. <td class="paramname"><em>size</em>, </td>
  197. </tr>
  198. <tr>
  199. <td class="paramkey"></td>
  200. <td></td>
  201. <td class="paramtype">const GLenum&#160;</td>
  202. <td class="paramname"><em>format</em> = <code>GL_BGRA</code>, </td>
  203. </tr>
  204. <tr>
  205. <td class="paramkey"></td>
  206. <td></td>
  207. <td class="paramtype">const GLenum&#160;</td>
  208. <td class="paramname"><em>type</em> = <code>GL_UNSIGNED_BYTE</code>&#160;</td>
  209. </tr>
  210. <tr>
  211. <td></td>
  212. <td>)</td>
  213. <td></td><td></td>
  214. </tr>
  215. </table>
  216. </div><div class="memdoc">
  217. <p>Constructor using raw image data. </p><dl class="section note"><dt>Note</dt><dd><em>rawData</em> must remain valid for the lifetime of this <a class="el" href="classImage.html">Image</a>. </dd></dl>
  218. </div>
  219. </div>
  220. <a id="a34410a36b132ab597a8878d45facc89a"></a>
  221. <h2 class="memtitle"><span class="permalink"><a href="#a34410a36b132ab597a8878d45facc89a">&#9670;&nbsp;</a></span>Image() <span class="overload">[4/4]</span></h2>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname">Image::Image </td>
  227. <td>(</td>
  228. <td class="paramtype">const <a class="el" href="classImage.html">Image</a> &amp;&#160;</td>
  229. <td class="paramname"><em>image</em></td><td>)</td>
  230. <td></td>
  231. </tr>
  232. </table>
  233. </div><div class="memdoc">
  234. <p>Constructor using another image data. </p>
  235. </div>
  236. </div>
  237. <a id="a0294f63700543e11c0f0da85601c7ae5"></a>
  238. <h2 class="memtitle"><span class="permalink"><a href="#a0294f63700543e11c0f0da85601c7ae5">&#9670;&nbsp;</a></span>~Image()</h2>
  239. <div class="memitem">
  240. <div class="memproto">
  241. <table class="memname">
  242. <tr>
  243. <td class="memname">Image::~Image </td>
  244. <td>(</td>
  245. <td class="paramname"></td><td>)</td>
  246. <td></td>
  247. </tr>
  248. </table>
  249. </div><div class="memdoc">
  250. <p>Destructor. </p>
  251. </div>
  252. </div>
  253. <h2 class="groupheader">Member Function Documentation</h2>
  254. <a id="a097350feb2b30fd9289c346039298394"></a>
  255. <h2 class="memtitle"><span class="permalink"><a href="#a097350feb2b30fd9289c346039298394">&#9670;&nbsp;</a></span>loadFromMemory() <span class="overload">[1/2]</span></h2>
  256. <div class="memitem">
  257. <div class="memproto">
  258. <table class="mlabels">
  259. <tr>
  260. <td class="mlabels-left">
  261. <table class="memname">
  262. <tr>
  263. <td class="memname">void Image::loadFromMemory </td>
  264. <td>(</td>
  265. <td class="paramtype">const char *const&#160;</td>
  266. <td class="paramname"><em>rawData</em>, </td>
  267. </tr>
  268. <tr>
  269. <td class="paramkey"></td>
  270. <td></td>
  271. <td class="paramtype">const uint&#160;</td>
  272. <td class="paramname"><em>width</em>, </td>
  273. </tr>
  274. <tr>
  275. <td class="paramkey"></td>
  276. <td></td>
  277. <td class="paramtype">const uint&#160;</td>
  278. <td class="paramname"><em>height</em>, </td>
  279. </tr>
  280. <tr>
  281. <td class="paramkey"></td>
  282. <td></td>
  283. <td class="paramtype">const GLenum&#160;</td>
  284. <td class="paramname"><em>format</em> = <code>GL_BGRA</code>, </td>
  285. </tr>
  286. <tr>
  287. <td class="paramkey"></td>
  288. <td></td>
  289. <td class="paramtype">const GLenum&#160;</td>
  290. <td class="paramname"><em>type</em> = <code>GL_UNSIGNED_BYTE</code>&#160;</td>
  291. </tr>
  292. <tr>
  293. <td></td>
  294. <td>)</td>
  295. <td></td><td></td>
  296. </tr>
  297. </table>
  298. </td>
  299. <td class="mlabels-right">
  300. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  301. </tr>
  302. </table>
  303. </div><div class="memdoc">
  304. <p>Load image data from memory. </p><dl class="section note"><dt>Note</dt><dd><em>rawData</em> must remain valid for the lifetime of this <a class="el" href="classImage.html">Image</a>. </dd></dl>
  305. </div>
  306. </div>
  307. <a id="a2851a65c5885085be1d96878762fd860"></a>
  308. <h2 class="memtitle"><span class="permalink"><a href="#a2851a65c5885085be1d96878762fd860">&#9670;&nbsp;</a></span>loadFromMemory() <span class="overload">[2/2]</span></h2>
  309. <div class="memitem">
  310. <div class="memproto">
  311. <table class="mlabels">
  312. <tr>
  313. <td class="mlabels-left">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname">void Image::loadFromMemory </td>
  317. <td>(</td>
  318. <td class="paramtype">const char *const&#160;</td>
  319. <td class="paramname"><em>rawData</em>, </td>
  320. </tr>
  321. <tr>
  322. <td class="paramkey"></td>
  323. <td></td>
  324. <td class="paramtype">const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;&#160;</td>
  325. <td class="paramname"><em>size</em>, </td>
  326. </tr>
  327. <tr>
  328. <td class="paramkey"></td>
  329. <td></td>
  330. <td class="paramtype">const GLenum&#160;</td>
  331. <td class="paramname"><em>format</em> = <code>GL_BGRA</code>, </td>
  332. </tr>
  333. <tr>
  334. <td class="paramkey"></td>
  335. <td></td>
  336. <td class="paramtype">const GLenum&#160;</td>
  337. <td class="paramname"><em>type</em> = <code>GL_UNSIGNED_BYTE</code>&#160;</td>
  338. </tr>
  339. <tr>
  340. <td></td>
  341. <td>)</td>
  342. <td></td><td></td>
  343. </tr>
  344. </table>
  345. </td>
  346. <td class="mlabels-right">
  347. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  348. </tr>
  349. </table>
  350. </div><div class="memdoc">
  351. <p>Load image data from memory. </p><dl class="section note"><dt>Note</dt><dd><em>rawData</em> must remain valid for the lifetime of this <a class="el" href="classImage.html">Image</a>. </dd></dl>
  352. </div>
  353. </div>
  354. <a id="a761214d2fa016e3e793b5a2d6b8b85ec"></a>
  355. <h2 class="memtitle"><span class="permalink"><a href="#a761214d2fa016e3e793b5a2d6b8b85ec">&#9670;&nbsp;</a></span>isValid()</h2>
  356. <div class="memitem">
  357. <div class="memproto">
  358. <table class="mlabels">
  359. <tr>
  360. <td class="mlabels-left">
  361. <table class="memname">
  362. <tr>
  363. <td class="memname">bool Image::isValid </td>
  364. <td>(</td>
  365. <td class="paramname"></td><td>)</td>
  366. <td> const</td>
  367. </tr>
  368. </table>
  369. </td>
  370. <td class="mlabels-right">
  371. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  372. </tr>
  373. </table>
  374. </div><div class="memdoc">
  375. <p>Check if this image is valid. </p>
  376. </div>
  377. </div>
  378. <a id="a695d30afad2b73bc0e4208a94d052aea"></a>
  379. <h2 class="memtitle"><span class="permalink"><a href="#a695d30afad2b73bc0e4208a94d052aea">&#9670;&nbsp;</a></span>getWidth()</h2>
  380. <div class="memitem">
  381. <div class="memproto">
  382. <table class="mlabels">
  383. <tr>
  384. <td class="mlabels-left">
  385. <table class="memname">
  386. <tr>
  387. <td class="memname">uint Image::getWidth </td>
  388. <td>(</td>
  389. <td class="paramname"></td><td>)</td>
  390. <td> const</td>
  391. </tr>
  392. </table>
  393. </td>
  394. <td class="mlabels-right">
  395. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  396. </tr>
  397. </table>
  398. </div><div class="memdoc">
  399. <p>Get width. </p>
  400. </div>
  401. </div>
  402. <a id="a464a18561e9d49b9af42f007113d55f6"></a>
  403. <h2 class="memtitle"><span class="permalink"><a href="#a464a18561e9d49b9af42f007113d55f6">&#9670;&nbsp;</a></span>getHeight()</h2>
  404. <div class="memitem">
  405. <div class="memproto">
  406. <table class="mlabels">
  407. <tr>
  408. <td class="mlabels-left">
  409. <table class="memname">
  410. <tr>
  411. <td class="memname">uint Image::getHeight </td>
  412. <td>(</td>
  413. <td class="paramname"></td><td>)</td>
  414. <td> const</td>
  415. </tr>
  416. </table>
  417. </td>
  418. <td class="mlabels-right">
  419. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  420. </tr>
  421. </table>
  422. </div><div class="memdoc">
  423. <p>Get height. </p>
  424. </div>
  425. </div>
  426. <a id="a86b31865bfa07b98b61f503699f5c5d1"></a>
  427. <h2 class="memtitle"><span class="permalink"><a href="#a86b31865bfa07b98b61f503699f5c5d1">&#9670;&nbsp;</a></span>getSize()</h2>
  428. <div class="memitem">
  429. <div class="memproto">
  430. <table class="mlabels">
  431. <tr>
  432. <td class="mlabels-left">
  433. <table class="memname">
  434. <tr>
  435. <td class="memname">const <a class="el" href="classSize.html">Size</a>&lt;uint&gt;&amp; Image::getSize </td>
  436. <td>(</td>
  437. <td class="paramname"></td><td>)</td>
  438. <td> const</td>
  439. </tr>
  440. </table>
  441. </td>
  442. <td class="mlabels-right">
  443. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  444. </tr>
  445. </table>
  446. </div><div class="memdoc">
  447. <p>Get size. </p>
  448. </div>
  449. </div>
  450. <a id="a638e0d75e9dff587f028639aaae8981b"></a>
  451. <h2 class="memtitle"><span class="permalink"><a href="#a638e0d75e9dff587f028639aaae8981b">&#9670;&nbsp;</a></span>getRawData()</h2>
  452. <div class="memitem">
  453. <div class="memproto">
  454. <table class="mlabels">
  455. <tr>
  456. <td class="mlabels-left">
  457. <table class="memname">
  458. <tr>
  459. <td class="memname">const char* Image::getRawData </td>
  460. <td>(</td>
  461. <td class="paramname"></td><td>)</td>
  462. <td> const</td>
  463. </tr>
  464. </table>
  465. </td>
  466. <td class="mlabels-right">
  467. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  468. </tr>
  469. </table>
  470. </div><div class="memdoc">
  471. <p>Get the raw image data. </p>
  472. </div>
  473. </div>
  474. <a id="ac02e8bb7bfcc4adefc1f00557cc40e86"></a>
  475. <h2 class="memtitle"><span class="permalink"><a href="#ac02e8bb7bfcc4adefc1f00557cc40e86">&#9670;&nbsp;</a></span>getFormat()</h2>
  476. <div class="memitem">
  477. <div class="memproto">
  478. <table class="mlabels">
  479. <tr>
  480. <td class="mlabels-left">
  481. <table class="memname">
  482. <tr>
  483. <td class="memname">GLenum Image::getFormat </td>
  484. <td>(</td>
  485. <td class="paramname"></td><td>)</td>
  486. <td> const</td>
  487. </tr>
  488. </table>
  489. </td>
  490. <td class="mlabels-right">
  491. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  492. </tr>
  493. </table>
  494. </div><div class="memdoc">
  495. <p>Get the image format. </p>
  496. </div>
  497. </div>
  498. <a id="aafdd618cccc80f83a438b0c335de6205"></a>
  499. <h2 class="memtitle"><span class="permalink"><a href="#aafdd618cccc80f83a438b0c335de6205">&#9670;&nbsp;</a></span>getType()</h2>
  500. <div class="memitem">
  501. <div class="memproto">
  502. <table class="mlabels">
  503. <tr>
  504. <td class="mlabels-left">
  505. <table class="memname">
  506. <tr>
  507. <td class="memname">GLenum Image::getType </td>
  508. <td>(</td>
  509. <td class="paramname"></td><td>)</td>
  510. <td> const</td>
  511. </tr>
  512. </table>
  513. </td>
  514. <td class="mlabels-right">
  515. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  516. </tr>
  517. </table>
  518. </div><div class="memdoc">
  519. <p>Get the image type. </p>
  520. </div>
  521. </div>
  522. <a id="ae1e16dcef3072e4e49ec2887a9c1245a"></a>
  523. <h2 class="memtitle"><span class="permalink"><a href="#ae1e16dcef3072e4e49ec2887a9c1245a">&#9670;&nbsp;</a></span>draw()</h2>
  524. <div class="memitem">
  525. <div class="memproto">
  526. <table class="memname">
  527. <tr>
  528. <td class="memname">void Image::draw </td>
  529. <td>(</td>
  530. <td class="paramname"></td><td>)</td>
  531. <td></td>
  532. </tr>
  533. </table>
  534. </div><div class="memdoc">
  535. <p>Draw this image at (0, 0) point. </p>
  536. </div>
  537. </div>
  538. <a id="ab63094dc07e6d62624827bca904b5cdd"></a>
  539. <h2 class="memtitle"><span class="permalink"><a href="#ab63094dc07e6d62624827bca904b5cdd">&#9670;&nbsp;</a></span>drawAt() <span class="overload">[1/2]</span></h2>
  540. <div class="memitem">
  541. <div class="memproto">
  542. <table class="memname">
  543. <tr>
  544. <td class="memname">void Image::drawAt </td>
  545. <td>(</td>
  546. <td class="paramtype">const int&#160;</td>
  547. <td class="paramname"><em>x</em>, </td>
  548. </tr>
  549. <tr>
  550. <td class="paramkey"></td>
  551. <td></td>
  552. <td class="paramtype">const int&#160;</td>
  553. <td class="paramname"><em>y</em>&#160;</td>
  554. </tr>
  555. <tr>
  556. <td></td>
  557. <td>)</td>
  558. <td></td><td></td>
  559. </tr>
  560. </table>
  561. </div><div class="memdoc">
  562. <p>Draw this image at (x, y) point. </p>
  563. </div>
  564. </div>
  565. <a id="aed2dc99624de978eade8124d2c099cfa"></a>
  566. <h2 class="memtitle"><span class="permalink"><a href="#aed2dc99624de978eade8124d2c099cfa">&#9670;&nbsp;</a></span>drawAt() <span class="overload">[2/2]</span></h2>
  567. <div class="memitem">
  568. <div class="memproto">
  569. <table class="memname">
  570. <tr>
  571. <td class="memname">void Image::drawAt </td>
  572. <td>(</td>
  573. <td class="paramtype">const <a class="el" href="classPoint.html">Point</a>&lt; int &gt; &amp;&#160;</td>
  574. <td class="paramname"><em>pos</em></td><td>)</td>
  575. <td></td>
  576. </tr>
  577. </table>
  578. </div><div class="memdoc">
  579. <p>Draw this image at position <em>pos</em>. </p>
  580. </div>
  581. </div>
  582. <hr/>The documentation for this class was generated from the following file:<ul>
  583. <li>dgl/<a class="el" href="Image_8hpp_source.html">Image.hpp</a></li>
  584. </ul>
  585. </div><!-- contents -->
  586. <!-- start footer part -->
  587. <hr class="footer"/><address class="footer"><small>
  588. Generated on Sun Apr 7 2019 05:47:58 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  589. <img class="footer" src="doxygen.png" alt="doxygen"/>
  590. </a> 1.8.13
  591. </small></address>
  592. </body>
  593. </html>