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.

622 lines
27KB

  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.9.1"/>
  7. <title>DISTRHO Plugin Framework: Image Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td style="padding-left: 0.5em;">
  26. <div id="projectname">DISTRHO Plugin Framework
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.9.1 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="modules.html"><span>Modules</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  65. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. </div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. </div><!-- top -->
  83. <div class="header">
  84. <div class="summary">
  85. <a href="#pub-methods">Public Member Functions</a> &#124;
  86. <a href="classImage-members.html">List of all members</a> </div>
  87. <div class="headertitle">
  88. <div class="title">Image Class Reference</div> </div>
  89. </div><!--header-->
  90. <div class="contents">
  91. <p><code>#include &lt;<a class="el" href="Image_8hpp_source.html">Image.hpp</a>&gt;</code></p>
  92. <table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  94. Public Member Functions</h2></td></tr>
  95. <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>
  96. <tr class="separator:a58edd1c45b4faeb5f789b0d036d02313"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <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>
  98. <tr class="separator:ad351054c0c6ebc0df99a7f8df12c8920"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <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>
  100. <tr class="separator:a4587a30e65bacb349bc2d351d2fe49eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <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>
  102. <tr class="separator:a34410a36b132ab597a8878d45facc89a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <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>
  104. <tr class="separator:a0294f63700543e11c0f0da85601c7ae5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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>
  106. <tr class="separator:a097350feb2b30fd9289c346039298394"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <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>
  108. <tr class="separator:a2851a65c5885085be1d96878762fd860"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <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>
  110. <tr class="separator:a761214d2fa016e3e793b5a2d6b8b85ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <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>
  112. <tr class="separator:a695d30afad2b73bc0e4208a94d052aea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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>
  114. <tr class="separator:a464a18561e9d49b9af42f007113d55f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <tr class="separator:a86b31865bfa07b98b61f503699f5c5d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <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>
  118. <tr class="separator:a638e0d75e9dff587f028639aaae8981b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <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>
  120. <tr class="separator:ac02e8bb7bfcc4adefc1f00557cc40e86"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <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>
  122. <tr class="separator:aafdd618cccc80f83a438b0c335de6205"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <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>
  124. <tr class="separator:ae1e16dcef3072e4e49ec2887a9c1245a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <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>
  126. <tr class="separator:ab63094dc07e6d62624827bca904b5cdd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <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>
  128. <tr class="separator:aed2dc99624de978eade8124d2c099cfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ab23271a6bf92330d04c84146bfa81641"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab23271a6bf92330d04c84146bfa81641"></a>
  130. <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>
  131. <tr class="separator:ab23271a6bf92330d04c84146bfa81641"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a775663b153fb5d21bca622739d881631"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a775663b153fb5d21bca622739d881631"></a>
  133. 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>
  134. <tr class="separator:a775663b153fb5d21bca622739d881631"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:abb67912deb6a20ea1c5a5b4d5a71c0ee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb67912deb6a20ea1c5a5b4d5a71c0ee"></a>
  136. 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>
  137. <tr class="separator:abb67912deb6a20ea1c5a5b4d5a71c0ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. </table>
  139. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  140. <div class="textblock"><p>Base DGL <a class="el" href="classImage.html">Image</a> class.</p>
  141. <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>
  142. <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>
  143. <p>Images are drawn on screen via 2D textures. </p>
  144. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  145. <a class="anchor" id="a58edd1c45b4faeb5f789b0d036d02313"></a>
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname">Image::Image </td>
  151. <td>(</td>
  152. <td class="paramname"></td><td>)</td>
  153. <td></td>
  154. </tr>
  155. </table>
  156. </div><div class="memdoc">
  157. <p>Constructor for a null <a class="el" href="classImage.html">Image</a>. </p>
  158. </div>
  159. </div>
  160. <a class="anchor" id="ad351054c0c6ebc0df99a7f8df12c8920"></a>
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">Image::Image </td>
  166. <td>(</td>
  167. <td class="paramtype">const char *const&#160;</td>
  168. <td class="paramname"><em>rawData</em>, </td>
  169. </tr>
  170. <tr>
  171. <td class="paramkey"></td>
  172. <td></td>
  173. <td class="paramtype">const uint&#160;</td>
  174. <td class="paramname"><em>width</em>, </td>
  175. </tr>
  176. <tr>
  177. <td class="paramkey"></td>
  178. <td></td>
  179. <td class="paramtype">const uint&#160;</td>
  180. <td class="paramname"><em>height</em>, </td>
  181. </tr>
  182. <tr>
  183. <td class="paramkey"></td>
  184. <td></td>
  185. <td class="paramtype">const GLenum&#160;</td>
  186. <td class="paramname"><em>format</em> = <code>GL_BGRA</code>, </td>
  187. </tr>
  188. <tr>
  189. <td class="paramkey"></td>
  190. <td></td>
  191. <td class="paramtype">const GLenum&#160;</td>
  192. <td class="paramname"><em>type</em> = <code>GL_UNSIGNED_BYTE</code>&#160;</td>
  193. </tr>
  194. <tr>
  195. <td></td>
  196. <td>)</td>
  197. <td></td><td></td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. <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>
  202. </div>
  203. </div>
  204. <a class="anchor" id="a4587a30e65bacb349bc2d351d2fe49eb"></a>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">Image::Image </td>
  210. <td>(</td>
  211. <td class="paramtype">const char *const&#160;</td>
  212. <td class="paramname"><em>rawData</em>, </td>
  213. </tr>
  214. <tr>
  215. <td class="paramkey"></td>
  216. <td></td>
  217. <td class="paramtype">const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;&#160;</td>
  218. <td class="paramname"><em>size</em>, </td>
  219. </tr>
  220. <tr>
  221. <td class="paramkey"></td>
  222. <td></td>
  223. <td class="paramtype">const GLenum&#160;</td>
  224. <td class="paramname"><em>format</em> = <code>GL_BGRA</code>, </td>
  225. </tr>
  226. <tr>
  227. <td class="paramkey"></td>
  228. <td></td>
  229. <td class="paramtype">const GLenum&#160;</td>
  230. <td class="paramname"><em>type</em> = <code>GL_UNSIGNED_BYTE</code>&#160;</td>
  231. </tr>
  232. <tr>
  233. <td></td>
  234. <td>)</td>
  235. <td></td><td></td>
  236. </tr>
  237. </table>
  238. </div><div class="memdoc">
  239. <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>
  240. </div>
  241. </div>
  242. <a class="anchor" id="a34410a36b132ab597a8878d45facc89a"></a>
  243. <div class="memitem">
  244. <div class="memproto">
  245. <table class="memname">
  246. <tr>
  247. <td class="memname">Image::Image </td>
  248. <td>(</td>
  249. <td class="paramtype">const <a class="el" href="classImage.html">Image</a> &amp;&#160;</td>
  250. <td class="paramname"><em>image</em></td><td>)</td>
  251. <td></td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. <p>Constructor using another image data. </p>
  256. </div>
  257. </div>
  258. <a class="anchor" id="a0294f63700543e11c0f0da85601c7ae5"></a>
  259. <div class="memitem">
  260. <div class="memproto">
  261. <table class="memname">
  262. <tr>
  263. <td class="memname">Image::~Image </td>
  264. <td>(</td>
  265. <td class="paramname"></td><td>)</td>
  266. <td></td>
  267. </tr>
  268. </table>
  269. </div><div class="memdoc">
  270. <p>Destructor. </p>
  271. </div>
  272. </div>
  273. <h2 class="groupheader">Member Function Documentation</h2>
  274. <a class="anchor" id="a097350feb2b30fd9289c346039298394"></a>
  275. <div class="memitem">
  276. <div class="memproto">
  277. <table class="mlabels">
  278. <tr>
  279. <td class="mlabels-left">
  280. <table class="memname">
  281. <tr>
  282. <td class="memname">void Image::loadFromMemory </td>
  283. <td>(</td>
  284. <td class="paramtype">const char *const&#160;</td>
  285. <td class="paramname"><em>rawData</em>, </td>
  286. </tr>
  287. <tr>
  288. <td class="paramkey"></td>
  289. <td></td>
  290. <td class="paramtype">const uint&#160;</td>
  291. <td class="paramname"><em>width</em>, </td>
  292. </tr>
  293. <tr>
  294. <td class="paramkey"></td>
  295. <td></td>
  296. <td class="paramtype">const uint&#160;</td>
  297. <td class="paramname"><em>height</em>, </td>
  298. </tr>
  299. <tr>
  300. <td class="paramkey"></td>
  301. <td></td>
  302. <td class="paramtype">const GLenum&#160;</td>
  303. <td class="paramname"><em>format</em> = <code>GL_BGRA</code>, </td>
  304. </tr>
  305. <tr>
  306. <td class="paramkey"></td>
  307. <td></td>
  308. <td class="paramtype">const GLenum&#160;</td>
  309. <td class="paramname"><em>type</em> = <code>GL_UNSIGNED_BYTE</code>&#160;</td>
  310. </tr>
  311. <tr>
  312. <td></td>
  313. <td>)</td>
  314. <td></td><td></td>
  315. </tr>
  316. </table>
  317. </td>
  318. <td class="mlabels-right">
  319. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  320. </tr>
  321. </table>
  322. </div><div class="memdoc">
  323. <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>
  324. </div>
  325. </div>
  326. <a class="anchor" id="a2851a65c5885085be1d96878762fd860"></a>
  327. <div class="memitem">
  328. <div class="memproto">
  329. <table class="mlabels">
  330. <tr>
  331. <td class="mlabels-left">
  332. <table class="memname">
  333. <tr>
  334. <td class="memname">void Image::loadFromMemory </td>
  335. <td>(</td>
  336. <td class="paramtype">const char *const&#160;</td>
  337. <td class="paramname"><em>rawData</em>, </td>
  338. </tr>
  339. <tr>
  340. <td class="paramkey"></td>
  341. <td></td>
  342. <td class="paramtype">const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;&#160;</td>
  343. <td class="paramname"><em>size</em>, </td>
  344. </tr>
  345. <tr>
  346. <td class="paramkey"></td>
  347. <td></td>
  348. <td class="paramtype">const GLenum&#160;</td>
  349. <td class="paramname"><em>format</em> = <code>GL_BGRA</code>, </td>
  350. </tr>
  351. <tr>
  352. <td class="paramkey"></td>
  353. <td></td>
  354. <td class="paramtype">const GLenum&#160;</td>
  355. <td class="paramname"><em>type</em> = <code>GL_UNSIGNED_BYTE</code>&#160;</td>
  356. </tr>
  357. <tr>
  358. <td></td>
  359. <td>)</td>
  360. <td></td><td></td>
  361. </tr>
  362. </table>
  363. </td>
  364. <td class="mlabels-right">
  365. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  366. </tr>
  367. </table>
  368. </div><div class="memdoc">
  369. <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>
  370. </div>
  371. </div>
  372. <a class="anchor" id="a761214d2fa016e3e793b5a2d6b8b85ec"></a>
  373. <div class="memitem">
  374. <div class="memproto">
  375. <table class="mlabels">
  376. <tr>
  377. <td class="mlabels-left">
  378. <table class="memname">
  379. <tr>
  380. <td class="memname">bool Image::isValid </td>
  381. <td>(</td>
  382. <td class="paramname"></td><td>)</td>
  383. <td> const</td>
  384. </tr>
  385. </table>
  386. </td>
  387. <td class="mlabels-right">
  388. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  389. </tr>
  390. </table>
  391. </div><div class="memdoc">
  392. <p>Check if this image is valid. </p>
  393. </div>
  394. </div>
  395. <a class="anchor" id="a695d30afad2b73bc0e4208a94d052aea"></a>
  396. <div class="memitem">
  397. <div class="memproto">
  398. <table class="mlabels">
  399. <tr>
  400. <td class="mlabels-left">
  401. <table class="memname">
  402. <tr>
  403. <td class="memname">uint Image::getWidth </td>
  404. <td>(</td>
  405. <td class="paramname"></td><td>)</td>
  406. <td> const</td>
  407. </tr>
  408. </table>
  409. </td>
  410. <td class="mlabels-right">
  411. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  412. </tr>
  413. </table>
  414. </div><div class="memdoc">
  415. <p>Get width. </p>
  416. </div>
  417. </div>
  418. <a class="anchor" id="a464a18561e9d49b9af42f007113d55f6"></a>
  419. <div class="memitem">
  420. <div class="memproto">
  421. <table class="mlabels">
  422. <tr>
  423. <td class="mlabels-left">
  424. <table class="memname">
  425. <tr>
  426. <td class="memname">uint Image::getHeight </td>
  427. <td>(</td>
  428. <td class="paramname"></td><td>)</td>
  429. <td> const</td>
  430. </tr>
  431. </table>
  432. </td>
  433. <td class="mlabels-right">
  434. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. <p>Get height. </p>
  439. </div>
  440. </div>
  441. <a class="anchor" id="a86b31865bfa07b98b61f503699f5c5d1"></a>
  442. <div class="memitem">
  443. <div class="memproto">
  444. <table class="mlabels">
  445. <tr>
  446. <td class="mlabels-left">
  447. <table class="memname">
  448. <tr>
  449. <td class="memname">const <a class="el" href="classSize.html">Size</a>&lt;uint&gt;&amp; Image::getSize </td>
  450. <td>(</td>
  451. <td class="paramname"></td><td>)</td>
  452. <td> const</td>
  453. </tr>
  454. </table>
  455. </td>
  456. <td class="mlabels-right">
  457. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  458. </tr>
  459. </table>
  460. </div><div class="memdoc">
  461. <p>Get size. </p>
  462. </div>
  463. </div>
  464. <a class="anchor" id="a638e0d75e9dff587f028639aaae8981b"></a>
  465. <div class="memitem">
  466. <div class="memproto">
  467. <table class="mlabels">
  468. <tr>
  469. <td class="mlabels-left">
  470. <table class="memname">
  471. <tr>
  472. <td class="memname">const char* Image::getRawData </td>
  473. <td>(</td>
  474. <td class="paramname"></td><td>)</td>
  475. <td> const</td>
  476. </tr>
  477. </table>
  478. </td>
  479. <td class="mlabels-right">
  480. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  481. </tr>
  482. </table>
  483. </div><div class="memdoc">
  484. <p>Get the raw image data. </p>
  485. </div>
  486. </div>
  487. <a class="anchor" id="ac02e8bb7bfcc4adefc1f00557cc40e86"></a>
  488. <div class="memitem">
  489. <div class="memproto">
  490. <table class="mlabels">
  491. <tr>
  492. <td class="mlabels-left">
  493. <table class="memname">
  494. <tr>
  495. <td class="memname">GLenum Image::getFormat </td>
  496. <td>(</td>
  497. <td class="paramname"></td><td>)</td>
  498. <td> const</td>
  499. </tr>
  500. </table>
  501. </td>
  502. <td class="mlabels-right">
  503. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  504. </tr>
  505. </table>
  506. </div><div class="memdoc">
  507. <p>Get the image format. </p>
  508. </div>
  509. </div>
  510. <a class="anchor" id="aafdd618cccc80f83a438b0c335de6205"></a>
  511. <div class="memitem">
  512. <div class="memproto">
  513. <table class="mlabels">
  514. <tr>
  515. <td class="mlabels-left">
  516. <table class="memname">
  517. <tr>
  518. <td class="memname">GLenum Image::getType </td>
  519. <td>(</td>
  520. <td class="paramname"></td><td>)</td>
  521. <td> const</td>
  522. </tr>
  523. </table>
  524. </td>
  525. <td class="mlabels-right">
  526. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  527. </tr>
  528. </table>
  529. </div><div class="memdoc">
  530. <p>Get the image type. </p>
  531. </div>
  532. </div>
  533. <a class="anchor" id="ae1e16dcef3072e4e49ec2887a9c1245a"></a>
  534. <div class="memitem">
  535. <div class="memproto">
  536. <table class="memname">
  537. <tr>
  538. <td class="memname">void Image::draw </td>
  539. <td>(</td>
  540. <td class="paramname"></td><td>)</td>
  541. <td></td>
  542. </tr>
  543. </table>
  544. </div><div class="memdoc">
  545. <p>Draw this image at (0, 0) point. </p>
  546. </div>
  547. </div>
  548. <a class="anchor" id="ab63094dc07e6d62624827bca904b5cdd"></a>
  549. <div class="memitem">
  550. <div class="memproto">
  551. <table class="memname">
  552. <tr>
  553. <td class="memname">void Image::drawAt </td>
  554. <td>(</td>
  555. <td class="paramtype">const int&#160;</td>
  556. <td class="paramname"><em>x</em>, </td>
  557. </tr>
  558. <tr>
  559. <td class="paramkey"></td>
  560. <td></td>
  561. <td class="paramtype">const int&#160;</td>
  562. <td class="paramname"><em>y</em>&#160;</td>
  563. </tr>
  564. <tr>
  565. <td></td>
  566. <td>)</td>
  567. <td></td><td></td>
  568. </tr>
  569. </table>
  570. </div><div class="memdoc">
  571. <p>Draw this image at (x, y) point. </p>
  572. </div>
  573. </div>
  574. <a class="anchor" id="aed2dc99624de978eade8124d2c099cfa"></a>
  575. <div class="memitem">
  576. <div class="memproto">
  577. <table class="memname">
  578. <tr>
  579. <td class="memname">void Image::drawAt </td>
  580. <td>(</td>
  581. <td class="paramtype">const <a class="el" href="classPoint.html">Point</a>&lt; int &gt; &amp;&#160;</td>
  582. <td class="paramname"><em>pos</em></td><td>)</td>
  583. <td></td>
  584. </tr>
  585. </table>
  586. </div><div class="memdoc">
  587. <p>Draw this image at position <em>pos</em>. </p>
  588. </div>
  589. </div>
  590. <hr/>The documentation for this class was generated from the following file:<ul>
  591. <li>dgl/<a class="el" href="Image_8hpp_source.html">Image.hpp</a></li>
  592. </ul>
  593. </div><!-- contents -->
  594. <!-- start footer part -->
  595. <hr class="footer"/><address class="footer"><small>
  596. Generated on Wed Jun 17 2015 11:36:22 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
  597. <img class="footer" src="doxygen.png" alt="doxygen"/>
  598. </a> 1.8.9.1
  599. </small></address>
  600. </body>
  601. </html>