DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF
1
0
Fork 0
Code Releases 0 Activity
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.
417 Commits
7 Branches
91MB
Branch: gh-pages
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'gh-pages'
${ noResults }
DPF/classImageBase.html

730 lines
32KB
Raw Permalink Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>

  8. <title>DISTRHO Plugin Framework: ImageBase 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.9.1 -->

  33. <script type="text/javascript">

  34. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  35. var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');

  36. /* @license-end */

  37. </script>

  38. <script type="text/javascript" src="menudata.js"></script>

  39. <script type="text/javascript" src="menu.js"></script>

  40. <script type="text/javascript">

  41. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */

  42. $(function() {

  43.   initMenu('',true,false,'search.php','Search');

  44.   $(document).ready(function() { init_search(); });

  45. });

  46. /* @license-end */</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><!-- top -->

  63. <div class="header">

  64.   <div class="summary">

  65. <a href="#pub-methods">Public Member Functions</a> &#124;

  66. <a href="#pro-methods">Protected Member Functions</a> &#124;

  67. <a href="#pro-attribs">Protected Attributes</a> &#124;

  68. <a href="classImageBase-members.html">List of all members</a>  </div>

  69.   <div class="headertitle">

  70. <div class="title">ImageBase Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>

  71. </div><!--header-->

  72. <div class="contents">

  73. 

  74. <p><code>#include &lt;<a class="el" href="ImageBase_8hpp_source.html">ImageBase.hpp</a>&gt;</code></p>

  75. <div class="dynheader">

  76. Inheritance diagram for ImageBase:</div>

  77. <div class="dyncontent">

  78.  <div class="center">

  79.   <img src="classImageBase.png" usemap="#ImageBase_map" alt=""/>

  80.   <map id="ImageBase_map" name="ImageBase_map">

  81. <area href="classCairoImage.html" alt="CairoImage" shape="rect" coords="0,56,92,80"/>

  82. <area href="classOpenGLImage.html" alt="OpenGLImage" shape="rect" coords="102,56,194,80"/>

  83. <area href="classVulkanImage.html" alt="VulkanImage" shape="rect" coords="204,56,296,80"/>

  84.   </map>

  85. </div></div>

  86. <table class="memberdecls">

  87. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>

  88. Public Member Functions</h2></td></tr>

  89. <tr class="memitem:a247e1c3259d5943a5766c99f61da9309"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a247e1c3259d5943a5766c99f61da9309">~ImageBase</a> ()</td></tr>

  90. <tr class="separator:a247e1c3259d5943a5766c99f61da9309"><td class="memSeparator" colspan="2">&#160;</td></tr>

  91. <tr class="memitem:ab5b2bc7d68b0aff3452478f906aa960f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#ab5b2bc7d68b0aff3452478f906aa960f">isValid</a> () const noexcept</td></tr>

  92. <tr class="separator:ab5b2bc7d68b0aff3452478f906aa960f"><td class="memSeparator" colspan="2">&#160;</td></tr>

  93. <tr class="memitem:a83ea79fff6adfa0720985f2e9794ed2d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a83ea79fff6adfa0720985f2e9794ed2d">isInvalid</a> () const noexcept</td></tr>

  94. <tr class="separator:a83ea79fff6adfa0720985f2e9794ed2d"><td class="memSeparator" colspan="2">&#160;</td></tr>

  95. <tr class="memitem:a82057493bae9af996a9a10b1aa731666"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a82057493bae9af996a9a10b1aa731666">getWidth</a> () const noexcept</td></tr>

  96. <tr class="separator:a82057493bae9af996a9a10b1aa731666"><td class="memSeparator" colspan="2">&#160;</td></tr>

  97. <tr class="memitem:aff56029a17822f19b518560e82aba878"><td class="memItemLeft" align="right" valign="top">uint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#aff56029a17822f19b518560e82aba878">getHeight</a> () const noexcept</td></tr>

  98. <tr class="separator:aff56029a17822f19b518560e82aba878"><td class="memSeparator" colspan="2">&#160;</td></tr>

  99. <tr class="memitem:a7609a68efebd27587bb98e386db0e9e2"><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="classImageBase.html#a7609a68efebd27587bb98e386db0e9e2">getSize</a> () const noexcept</td></tr>

  100. <tr class="separator:a7609a68efebd27587bb98e386db0e9e2"><td class="memSeparator" colspan="2">&#160;</td></tr>

  101. <tr class="memitem:aea60747a216159b14a8d020cb9b19546"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#aea60747a216159b14a8d020cb9b19546">getRawData</a> () const noexcept</td></tr>

  102. <tr class="separator:aea60747a216159b14a8d020cb9b19546"><td class="memSeparator" colspan="2">&#160;</td></tr>

  103. <tr class="memitem:a4b0c40113f956eaf2f2e0e51395b0926"><td class="memItemLeft" align="right" valign="top">ImageFormat&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a4b0c40113f956eaf2f2e0e51395b0926">getFormat</a> () const noexcept</td></tr>

  104. <tr class="separator:a4b0c40113f956eaf2f2e0e51395b0926"><td class="memSeparator" colspan="2">&#160;</td></tr>

  105. <tr class="memitem:a1d7893360e704dff3f2da11e7750359c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a1d7893360e704dff3f2da11e7750359c">loadFromMemory</a> (const char *rawData, uint width, uint height, ImageFormat format=kImageFormatBGRA) noexcept</td></tr>

  106. <tr class="separator:a1d7893360e704dff3f2da11e7750359c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  107. <tr class="memitem:a2c922b2ba7133937e74e1629fdde4f0e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a2c922b2ba7133937e74e1629fdde4f0e">loadFromMemory</a> (const char *rawData, const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;size, ImageFormat format=kImageFormatBGRA) noexcept</td></tr>

  108. <tr class="separator:a2c922b2ba7133937e74e1629fdde4f0e"><td class="memSeparator" colspan="2">&#160;</td></tr>

  109. <tr class="memitem:a94fc564a4bb8c18cd576ee9b456887a9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a94fc564a4bb8c18cd576ee9b456887a9">draw</a> (const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> &amp;context)</td></tr>

  110. <tr class="separator:a94fc564a4bb8c18cd576ee9b456887a9"><td class="memSeparator" colspan="2">&#160;</td></tr>

  111. <tr class="memitem:a16d58063acd1a1e6ae8bc3afdea610f8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a16d58063acd1a1e6ae8bc3afdea610f8">drawAt</a> (const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> &amp;context, int x, int y)</td></tr>

  112. <tr class="separator:a16d58063acd1a1e6ae8bc3afdea610f8"><td class="memSeparator" colspan="2">&#160;</td></tr>

  113. <tr class="memitem:afef0b2e0d1baa305312435d0de2e027c"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#afef0b2e0d1baa305312435d0de2e027c">drawAt</a> (const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> &amp;context, const <a class="el" href="classPoint.html">Point</a>&lt; int &gt; &amp;pos)=0</td></tr>

  114. <tr class="separator:afef0b2e0d1baa305312435d0de2e027c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  115. <tr class="memitem:ac352a5a4291cd0945c663b17631598dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classImageBase.html">ImageBase</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#ac352a5a4291cd0945c663b17631598dc">operator=</a> (const <a class="el" href="classImageBase.html">ImageBase</a> &amp;image) noexcept</td></tr>

  116. <tr class="separator:ac352a5a4291cd0945c663b17631598dc"><td class="memSeparator" colspan="2">&#160;</td></tr>

  117. <tr class="memitem:a099b6d6fdd222d1fe20f09080ae3fb7c"><td class="memItemLeft" align="right" valign="top"><a id="a099b6d6fdd222d1fe20f09080ae3fb7c"></a>

  118. bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="classImageBase.html">ImageBase</a> &amp;image) const noexcept</td></tr>

  119. <tr class="separator:a099b6d6fdd222d1fe20f09080ae3fb7c"><td class="memSeparator" colspan="2">&#160;</td></tr>

  120. <tr class="memitem:a77aceada26566e8e76699ef7abb3d1ad"><td class="memItemLeft" align="right" valign="top"><a id="a77aceada26566e8e76699ef7abb3d1ad"></a>

  121. bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="classImageBase.html">ImageBase</a> &amp;image) const noexcept</td></tr>

  122. <tr class="separator:a77aceada26566e8e76699ef7abb3d1ad"><td class="memSeparator" colspan="2">&#160;</td></tr>

  123. </table><table class="memberdecls">

  124. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>

  125. Protected Member Functions</h2></td></tr>

  126. <tr class="memitem:a1a1f82fcab01adea2f8783547e8a18aa"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a1a1f82fcab01adea2f8783547e8a18aa">ImageBase</a> ()</td></tr>

  127. <tr class="separator:a1a1f82fcab01adea2f8783547e8a18aa"><td class="memSeparator" colspan="2">&#160;</td></tr>

  128. <tr class="memitem:a494cd9221fe88f34ce011f004eea7596"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a494cd9221fe88f34ce011f004eea7596">ImageBase</a> (const char *rawData, uint width, uint height, ImageFormat format)</td></tr>

  129. <tr class="separator:a494cd9221fe88f34ce011f004eea7596"><td class="memSeparator" colspan="2">&#160;</td></tr>

  130. <tr class="memitem:aa61181afeb3abd0253ae0a25712164ee"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#aa61181afeb3abd0253ae0a25712164ee">ImageBase</a> (const char *rawData, const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;size, ImageFormat format)</td></tr>

  131. <tr class="separator:aa61181afeb3abd0253ae0a25712164ee"><td class="memSeparator" colspan="2">&#160;</td></tr>

  132. <tr class="memitem:a56dd89a0a5c0abc604044e33c8b1db59"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a56dd89a0a5c0abc604044e33c8b1db59">ImageBase</a> (const <a class="el" href="classImageBase.html">ImageBase</a> &amp;image)</td></tr>

  133. <tr class="separator:a56dd89a0a5c0abc604044e33c8b1db59"><td class="memSeparator" colspan="2">&#160;</td></tr>

  134. </table><table class="memberdecls">

  135. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>

  136. Protected Attributes</h2></td></tr>

  137. <tr class="memitem:a152a43920a235644fb87bbb98c1efaf5"><td class="memItemLeft" align="right" valign="top"><a id="a152a43920a235644fb87bbb98c1efaf5"></a>

  138. const char *&#160;</td><td class="memItemRight" valign="bottom"><b>rawData</b></td></tr>

  139. <tr class="separator:a152a43920a235644fb87bbb98c1efaf5"><td class="memSeparator" colspan="2">&#160;</td></tr>

  140. <tr class="memitem:a2ff8c2d118d086a428bac3a7c7b1f5b0"><td class="memItemLeft" align="right" valign="top"><a id="a2ff8c2d118d086a428bac3a7c7b1f5b0"></a>

  141. <a class="el" href="classSize.html">Size</a>&lt; uint &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>size</b></td></tr>

  142. <tr class="separator:a2ff8c2d118d086a428bac3a7c7b1f5b0"><td class="memSeparator" colspan="2">&#160;</td></tr>

  143. <tr class="memitem:a8b3eba70f2f1d0b2d2543ab8867ed4ac"><td class="memItemLeft" align="right" valign="top"><a id="a8b3eba70f2f1d0b2d2543ab8867ed4ac"></a>

  144. ImageFormat&#160;</td><td class="memItemRight" valign="bottom"><b>format</b></td></tr>

  145. <tr class="separator:a8b3eba70f2f1d0b2d2543ab8867ed4ac"><td class="memSeparator" colspan="2">&#160;</td></tr>

  146. </table>

  147. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>

  148. <div class="textblock"><p>Base DGL Image class.</p>

  149. <p>This is an Image class that handles raw image data in pixels. It is an abstract class that provides the common methods to build on top. Cairo and OpenGL Image classes are based upon this one.</p>

  150. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classCairoImage.html">CairoImage</a>, <a class="el" href="classOpenGLImage.html">OpenGLImage</a> </dd></dl>

  151. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>

  152. <a id="a1a1f82fcab01adea2f8783547e8a18aa"></a>

  153. <h2 class="memtitle"><span class="permalink"><a href="#a1a1f82fcab01adea2f8783547e8a18aa">&#9670;&nbsp;</a></span>ImageBase() <span class="overload">[1/4]</span></h2>

  154. 

  155. <div class="memitem">

  156. <div class="memproto">

  157. <table class="mlabels">

  158.   <tr>

  159.   <td class="mlabels-left">

  160.       <table class="memname">

  161.         <tr>

  162.           <td class="memname">ImageBase::ImageBase </td>

  163.           <td>(</td>

  164.           <td class="paramname"></td><td>)</td>

  165.           <td></td>

  166.         </tr>

  167.       </table>

  168.   </td>

  169.   <td class="mlabels-right">

  170. <span class="mlabels"><span class="mlabel">protected</span></span>  </td>

  171.   </tr>

  172. </table>

  173. </div><div class="memdoc">

  174. <p>Constructor for a null Image. </p>

  175. 

  176. </div>

  177. </div>

  178. <a id="a494cd9221fe88f34ce011f004eea7596"></a>

  179. <h2 class="memtitle"><span class="permalink"><a href="#a494cd9221fe88f34ce011f004eea7596">&#9670;&nbsp;</a></span>ImageBase() <span class="overload">[2/4]</span></h2>

  180. 

  181. <div class="memitem">

  182. <div class="memproto">

  183. <table class="mlabels">

  184.   <tr>

  185.   <td class="mlabels-left">

  186.       <table class="memname">

  187.         <tr>

  188.           <td class="memname">ImageBase::ImageBase </td>

  189.           <td>(</td>

  190.           <td class="paramtype">const char *&#160;</td>

  191.           <td class="paramname"><em>rawData</em>, </td>

  192.         </tr>

  193.         <tr>

  194.           <td class="paramkey"></td>

  195.           <td></td>

  196.           <td class="paramtype">uint&#160;</td>

  197.           <td class="paramname"><em>width</em>, </td>

  198.         </tr>

  199.         <tr>

  200.           <td class="paramkey"></td>

  201.           <td></td>

  202.           <td class="paramtype">uint&#160;</td>

  203.           <td class="paramname"><em>height</em>, </td>

  204.         </tr>

  205.         <tr>

  206.           <td class="paramkey"></td>

  207.           <td></td>

  208.           <td class="paramtype">ImageFormat&#160;</td>

  209.           <td class="paramname"><em>format</em>&#160;</td>

  210.         </tr>

  211.         <tr>

  212.           <td></td>

  213.           <td>)</td>

  214.           <td></td><td></td>

  215.         </tr>

  216.       </table>

  217.   </td>

  218.   <td class="mlabels-right">

  219. <span class="mlabels"><span class="mlabel">protected</span></span>  </td>

  220.   </tr>

  221. </table>

  222. </div><div class="memdoc">

  223. <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 Image. </dd></dl>

  224. 

  225. </div>

  226. </div>

  227. <a id="aa61181afeb3abd0253ae0a25712164ee"></a>

  228. <h2 class="memtitle"><span class="permalink"><a href="#aa61181afeb3abd0253ae0a25712164ee">&#9670;&nbsp;</a></span>ImageBase() <span class="overload">[3/4]</span></h2>

  229. 

  230. <div class="memitem">

  231. <div class="memproto">

  232. <table class="mlabels">

  233.   <tr>

  234.   <td class="mlabels-left">

  235.       <table class="memname">

  236.         <tr>

  237.           <td class="memname">ImageBase::ImageBase </td>

  238.           <td>(</td>

  239.           <td class="paramtype">const char *&#160;</td>

  240.           <td class="paramname"><em>rawData</em>, </td>

  241.         </tr>

  242.         <tr>

  243.           <td class="paramkey"></td>

  244.           <td></td>

  245.           <td class="paramtype">const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;&#160;</td>

  246.           <td class="paramname"><em>size</em>, </td>

  247.         </tr>

  248.         <tr>

  249.           <td class="paramkey"></td>

  250.           <td></td>

  251.           <td class="paramtype">ImageFormat&#160;</td>

  252.           <td class="paramname"><em>format</em>&#160;</td>

  253.         </tr>

  254.         <tr>

  255.           <td></td>

  256.           <td>)</td>

  257.           <td></td><td></td>

  258.         </tr>

  259.       </table>

  260.   </td>

  261.   <td class="mlabels-right">

  262. <span class="mlabels"><span class="mlabel">protected</span></span>  </td>

  263.   </tr>

  264. </table>

  265. </div><div class="memdoc">

  266. <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 Image. </dd></dl>

  267. 

  268. </div>

  269. </div>

  270. <a id="a56dd89a0a5c0abc604044e33c8b1db59"></a>

  271. <h2 class="memtitle"><span class="permalink"><a href="#a56dd89a0a5c0abc604044e33c8b1db59">&#9670;&nbsp;</a></span>ImageBase() <span class="overload">[4/4]</span></h2>

  272. 

  273. <div class="memitem">

  274. <div class="memproto">

  275. <table class="mlabels">

  276.   <tr>

  277.   <td class="mlabels-left">

  278.       <table class="memname">

  279.         <tr>

  280.           <td class="memname">ImageBase::ImageBase </td>

  281.           <td>(</td>

  282.           <td class="paramtype">const <a class="el" href="classImageBase.html">ImageBase</a> &amp;&#160;</td>

  283.           <td class="paramname"><em>image</em></td><td>)</td>

  284.           <td></td>

  285.         </tr>

  286.       </table>

  287.   </td>

  288.   <td class="mlabels-right">

  289. <span class="mlabels"><span class="mlabel">protected</span></span>  </td>

  290.   </tr>

  291. </table>

  292. </div><div class="memdoc">

  293. <p>Constructor using another image data. </p>

  294. 

  295. </div>

  296. </div>

  297. <a id="a247e1c3259d5943a5766c99f61da9309"></a>

  298. <h2 class="memtitle"><span class="permalink"><a href="#a247e1c3259d5943a5766c99f61da9309">&#9670;&nbsp;</a></span>~ImageBase()</h2>

  299. 

  300. <div class="memitem">

  301. <div class="memproto">

  302. <table class="mlabels">

  303.   <tr>

  304.   <td class="mlabels-left">

  305.       <table class="memname">

  306.         <tr>

  307.           <td class="memname">virtual ImageBase::~ImageBase </td>

  308.           <td>(</td>

  309.           <td class="paramname"></td><td>)</td>

  310.           <td></td>

  311.         </tr>

  312.       </table>

  313.   </td>

  314.   <td class="mlabels-right">

  315. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>

  316.   </tr>

  317. </table>

  318. </div><div class="memdoc">

  319. <p>Destructor. </p>

  320. 

  321. </div>

  322. </div>

  323. <h2 class="groupheader">Member Function Documentation</h2>

  324. <a id="ab5b2bc7d68b0aff3452478f906aa960f"></a>

  325. <h2 class="memtitle"><span class="permalink"><a href="#ab5b2bc7d68b0aff3452478f906aa960f">&#9670;&nbsp;</a></span>isValid()</h2>

  326. 

  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">bool ImageBase::isValid </td>

  335.           <td>(</td>

  336.           <td class="paramname"></td><td>)</td>

  337.           <td> const</td>

  338.         </tr>

  339.       </table>

  340.   </td>

  341.   <td class="mlabels-right">

  342. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  343.   </tr>

  344. </table>

  345. </div><div class="memdoc">

  346. <p>Check if this image is valid. </p>

  347. 

  348. </div>

  349. </div>

  350. <a id="a83ea79fff6adfa0720985f2e9794ed2d"></a>

  351. <h2 class="memtitle"><span class="permalink"><a href="#a83ea79fff6adfa0720985f2e9794ed2d">&#9670;&nbsp;</a></span>isInvalid()</h2>

  352. 

  353. <div class="memitem">

  354. <div class="memproto">

  355. <table class="mlabels">

  356.   <tr>

  357.   <td class="mlabels-left">

  358.       <table class="memname">

  359.         <tr>

  360.           <td class="memname">bool ImageBase::isInvalid </td>

  361.           <td>(</td>

  362.           <td class="paramname"></td><td>)</td>

  363.           <td> const</td>

  364.         </tr>

  365.       </table>

  366.   </td>

  367.   <td class="mlabels-right">

  368. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  369.   </tr>

  370. </table>

  371. </div><div class="memdoc">

  372. <p>Check if this image is not valid. </p>

  373. 

  374. </div>

  375. </div>

  376. <a id="a82057493bae9af996a9a10b1aa731666"></a>

  377. <h2 class="memtitle"><span class="permalink"><a href="#a82057493bae9af996a9a10b1aa731666">&#9670;&nbsp;</a></span>getWidth()</h2>

  378. 

  379. <div class="memitem">

  380. <div class="memproto">

  381. <table class="mlabels">

  382.   <tr>

  383.   <td class="mlabels-left">

  384.       <table class="memname">

  385.         <tr>

  386.           <td class="memname">uint ImageBase::getWidth </td>

  387.           <td>(</td>

  388.           <td class="paramname"></td><td>)</td>

  389.           <td> const</td>

  390.         </tr>

  391.       </table>

  392.   </td>

  393.   <td class="mlabels-right">

  394. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  395.   </tr>

  396. </table>

  397. </div><div class="memdoc">

  398. <p>Get width. </p>

  399. 

  400. </div>

  401. </div>

  402. <a id="aff56029a17822f19b518560e82aba878"></a>

  403. <h2 class="memtitle"><span class="permalink"><a href="#aff56029a17822f19b518560e82aba878">&#9670;&nbsp;</a></span>getHeight()</h2>

  404. 

  405. <div class="memitem">

  406. <div class="memproto">

  407. <table class="mlabels">

  408.   <tr>

  409.   <td class="mlabels-left">

  410.       <table class="memname">

  411.         <tr>

  412.           <td class="memname">uint ImageBase::getHeight </td>

  413.           <td>(</td>

  414.           <td class="paramname"></td><td>)</td>

  415.           <td> const</td>

  416.         </tr>

  417.       </table>

  418.   </td>

  419.   <td class="mlabels-right">

  420. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  421.   </tr>

  422. </table>

  423. </div><div class="memdoc">

  424. <p>Get height. </p>

  425. 

  426. </div>

  427. </div>

  428. <a id="a7609a68efebd27587bb98e386db0e9e2"></a>

  429. <h2 class="memtitle"><span class="permalink"><a href="#a7609a68efebd27587bb98e386db0e9e2">&#9670;&nbsp;</a></span>getSize()</h2>

  430. 

  431. <div class="memitem">

  432. <div class="memproto">

  433. <table class="mlabels">

  434.   <tr>

  435.   <td class="mlabels-left">

  436.       <table class="memname">

  437.         <tr>

  438.           <td class="memname">const <a class="el" href="classSize.html">Size</a>&lt;uint&gt;&amp; ImageBase::getSize </td>

  439.           <td>(</td>

  440.           <td class="paramname"></td><td>)</td>

  441.           <td> const</td>

  442.         </tr>

  443.       </table>

  444.   </td>

  445.   <td class="mlabels-right">

  446. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  447.   </tr>

  448. </table>

  449. </div><div class="memdoc">

  450. <p>Get size. </p>

  451. 

  452. </div>

  453. </div>

  454. <a id="aea60747a216159b14a8d020cb9b19546"></a>

  455. <h2 class="memtitle"><span class="permalink"><a href="#aea60747a216159b14a8d020cb9b19546">&#9670;&nbsp;</a></span>getRawData()</h2>

  456. 

  457. <div class="memitem">

  458. <div class="memproto">

  459. <table class="mlabels">

  460.   <tr>

  461.   <td class="mlabels-left">

  462.       <table class="memname">

  463.         <tr>

  464.           <td class="memname">const char* ImageBase::getRawData </td>

  465.           <td>(</td>

  466.           <td class="paramname"></td><td>)</td>

  467.           <td> const</td>

  468.         </tr>

  469.       </table>

  470.   </td>

  471.   <td class="mlabels-right">

  472. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  473.   </tr>

  474. </table>

  475. </div><div class="memdoc">

  476. <p>Get the raw image data. </p>

  477. 

  478. </div>

  479. </div>

  480. <a id="a4b0c40113f956eaf2f2e0e51395b0926"></a>

  481. <h2 class="memtitle"><span class="permalink"><a href="#a4b0c40113f956eaf2f2e0e51395b0926">&#9670;&nbsp;</a></span>getFormat()</h2>

  482. 

  483. <div class="memitem">

  484. <div class="memproto">

  485. <table class="mlabels">

  486.   <tr>

  487.   <td class="mlabels-left">

  488.       <table class="memname">

  489.         <tr>

  490.           <td class="memname">ImageFormat ImageBase::getFormat </td>

  491.           <td>(</td>

  492.           <td class="paramname"></td><td>)</td>

  493.           <td> const</td>

  494.         </tr>

  495.       </table>

  496.   </td>

  497.   <td class="mlabels-right">

  498. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  499.   </tr>

  500. </table>

  501. </div><div class="memdoc">

  502. <p>Get the image format. </p>

  503. 

  504. </div>

  505. </div>

  506. <a id="a1d7893360e704dff3f2da11e7750359c"></a>

  507. <h2 class="memtitle"><span class="permalink"><a href="#a1d7893360e704dff3f2da11e7750359c">&#9670;&nbsp;</a></span>loadFromMemory() <span class="overload">[1/2]</span></h2>

  508. 

  509. <div class="memitem">

  510. <div class="memproto">

  511. <table class="mlabels">

  512.   <tr>

  513.   <td class="mlabels-left">

  514.       <table class="memname">

  515.         <tr>

  516.           <td class="memname">void ImageBase::loadFromMemory </td>

  517.           <td>(</td>

  518.           <td class="paramtype">const char *&#160;</td>

  519.           <td class="paramname"><em>rawData</em>, </td>

  520.         </tr>

  521.         <tr>

  522.           <td class="paramkey"></td>

  523.           <td></td>

  524.           <td class="paramtype">uint&#160;</td>

  525.           <td class="paramname"><em>width</em>, </td>

  526.         </tr>

  527.         <tr>

  528.           <td class="paramkey"></td>

  529.           <td></td>

  530.           <td class="paramtype">uint&#160;</td>

  531.           <td class="paramname"><em>height</em>, </td>

  532.         </tr>

  533.         <tr>

  534.           <td class="paramkey"></td>

  535.           <td></td>

  536.           <td class="paramtype">ImageFormat&#160;</td>

  537.           <td class="paramname"><em>format</em> = <code>kImageFormatBGRA</code>&#160;</td>

  538.         </tr>

  539.         <tr>

  540.           <td></td>

  541.           <td>)</td>

  542.           <td></td><td></td>

  543.         </tr>

  544.       </table>

  545.   </td>

  546.   <td class="mlabels-right">

  547. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  548.   </tr>

  549. </table>

  550. </div><div class="memdoc">

  551. <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 Image. </dd></dl>

  552. 

  553. </div>

  554. </div>

  555. <a id="a2c922b2ba7133937e74e1629fdde4f0e"></a>

  556. <h2 class="memtitle"><span class="permalink"><a href="#a2c922b2ba7133937e74e1629fdde4f0e">&#9670;&nbsp;</a></span>loadFromMemory() <span class="overload">[2/2]</span></h2>

  557. 

  558. <div class="memitem">

  559. <div class="memproto">

  560. <table class="mlabels">

  561.   <tr>

  562.   <td class="mlabels-left">

  563.       <table class="memname">

  564.         <tr>

  565.           <td class="memname">virtual void ImageBase::loadFromMemory </td>

  566.           <td>(</td>

  567.           <td class="paramtype">const char *&#160;</td>

  568.           <td class="paramname"><em>rawData</em>, </td>

  569.         </tr>

  570.         <tr>

  571.           <td class="paramkey"></td>

  572.           <td></td>

  573.           <td class="paramtype">const <a class="el" href="classSize.html">Size</a>&lt; uint &gt; &amp;&#160;</td>

  574.           <td class="paramname"><em>size</em>, </td>

  575.         </tr>

  576.         <tr>

  577.           <td class="paramkey"></td>

  578.           <td></td>

  579.           <td class="paramtype">ImageFormat&#160;</td>

  580.           <td class="paramname"><em>format</em> = <code>kImageFormatBGRA</code>&#160;</td>

  581.         </tr>

  582.         <tr>

  583.           <td></td>

  584.           <td>)</td>

  585.           <td></td><td></td>

  586.         </tr>

  587.       </table>

  588.   </td>

  589.   <td class="mlabels-right">

  590. <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">noexcept</span></span>  </td>

  591.   </tr>

  592. </table>

  593. </div><div class="memdoc">

  594. <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 Image. </dd></dl>

  595. 

  596. <p>Reimplemented in <a class="el" href="classVulkanImage.html#afdf45f3e60f4a5a4805402b312bc8d5f">VulkanImage</a>, <a class="el" href="classOpenGLImage.html#a5ee11a12fb84219cf5216396c1cf3c0a">OpenGLImage</a>, and <a class="el" href="classCairoImage.html#a861bdbb5cd592feaef43e2202397deed">CairoImage</a>.</p>

  597. 

  598. </div>

  599. </div>

  600. <a id="a94fc564a4bb8c18cd576ee9b456887a9"></a>

  601. <h2 class="memtitle"><span class="permalink"><a href="#a94fc564a4bb8c18cd576ee9b456887a9">&#9670;&nbsp;</a></span>draw()</h2>

  602. 

  603. <div class="memitem">

  604. <div class="memproto">

  605.       <table class="memname">

  606.         <tr>

  607.           <td class="memname">void ImageBase::draw </td>

  608.           <td>(</td>

  609.           <td class="paramtype">const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> &amp;&#160;</td>

  610.           <td class="paramname"><em>context</em></td><td>)</td>

  611.           <td></td>

  612.         </tr>

  613.       </table>

  614. </div><div class="memdoc">

  615. <p>Draw this image at (0, 0) point using the current OpenGL context. </p>

  616. 

  617. </div>

  618. </div>

  619. <a id="a16d58063acd1a1e6ae8bc3afdea610f8"></a>

  620. <h2 class="memtitle"><span class="permalink"><a href="#a16d58063acd1a1e6ae8bc3afdea610f8">&#9670;&nbsp;</a></span>drawAt() <span class="overload">[1/2]</span></h2>

  621. 

  622. <div class="memitem">

  623. <div class="memproto">

  624.       <table class="memname">

  625.         <tr>

  626.           <td class="memname">void ImageBase::drawAt </td>

  627.           <td>(</td>

  628.           <td class="paramtype">const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> &amp;&#160;</td>

  629.           <td class="paramname"><em>context</em>, </td>

  630.         </tr>

  631.         <tr>

  632.           <td class="paramkey"></td>

  633.           <td></td>

  634.           <td class="paramtype">int&#160;</td>

  635.           <td class="paramname"><em>x</em>, </td>

  636.         </tr>

  637.         <tr>

  638.           <td class="paramkey"></td>

  639.           <td></td>

  640.           <td class="paramtype">int&#160;</td>

  641.           <td class="paramname"><em>y</em>&#160;</td>

  642.         </tr>

  643.         <tr>

  644.           <td></td>

  645.           <td>)</td>

  646.           <td></td><td></td>

  647.         </tr>

  648.       </table>

  649. </div><div class="memdoc">

  650. <p>Draw this image at (x, y) point using the current OpenGL context. </p>

  651. 

  652. </div>

  653. </div>

  654. <a id="afef0b2e0d1baa305312435d0de2e027c"></a>

  655. <h2 class="memtitle"><span class="permalink"><a href="#afef0b2e0d1baa305312435d0de2e027c">&#9670;&nbsp;</a></span>drawAt() <span class="overload">[2/2]</span></h2>

  656. 

  657. <div class="memitem">

  658. <div class="memproto">

  659. <table class="mlabels">

  660.   <tr>

  661.   <td class="mlabels-left">

  662.       <table class="memname">

  663.         <tr>

  664.           <td class="memname">virtual void ImageBase::drawAt </td>

  665.           <td>(</td>

  666.           <td class="paramtype">const <a class="el" href="structGraphicsContext.html">GraphicsContext</a> &amp;&#160;</td>

  667.           <td class="paramname"><em>context</em>, </td>

  668.         </tr>

  669.         <tr>

  670.           <td class="paramkey"></td>

  671.           <td></td>

  672.           <td class="paramtype">const <a class="el" href="classPoint.html">Point</a>&lt; int &gt; &amp;&#160;</td>

  673.           <td class="paramname"><em>pos</em>&#160;</td>

  674.         </tr>

  675.         <tr>

  676.           <td></td>

  677.           <td>)</td>

  678.           <td></td><td></td>

  679.         </tr>

  680.       </table>

  681.   </td>

  682.   <td class="mlabels-right">

  683. <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>

  684.   </tr>

  685. </table>

  686. </div><div class="memdoc">

  687. <p>Draw this image at position <em>pos</em> using the current OpenGL context. </p>

  688. 

  689. <p>Implemented in <a class="el" href="classVulkanImage.html#a35ba9f546320a8b51c76f09f0d80845f">VulkanImage</a>, <a class="el" href="classOpenGLImage.html#ab97d09a7496436d2823c064708a61287">OpenGLImage</a>, and <a class="el" href="classCairoImage.html#aa60a5e3b68032170e8e59fb506c7d3b7">CairoImage</a>.</p>

  690. 

  691. </div>

  692. </div>

  693. <a id="ac352a5a4291cd0945c663b17631598dc"></a>

  694. <h2 class="memtitle"><span class="permalink"><a href="#ac352a5a4291cd0945c663b17631598dc">&#9670;&nbsp;</a></span>operator=()</h2>

  695. 

  696. <div class="memitem">

  697. <div class="memproto">

  698. <table class="mlabels">

  699.   <tr>

  700.   <td class="mlabels-left">

  701.       <table class="memname">

  702.         <tr>

  703.           <td class="memname"><a class="el" href="classImageBase.html">ImageBase</a>&amp; ImageBase::operator= </td>

  704.           <td>(</td>

  705.           <td class="paramtype">const <a class="el" href="classImageBase.html">ImageBase</a> &amp;&#160;</td>

  706.           <td class="paramname"><em>image</em></td><td>)</td>

  707.           <td></td>

  708.         </tr>

  709.       </table>

  710.   </td>

  711.   <td class="mlabels-right">

  712. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>

  713.   </tr>

  714. </table>

  715. </div><div class="memdoc">

  716. <p>TODO document this. </p>

  717. 

  718. </div>

  719. </div>

  720. <hr/>The documentation for this class was generated from the following file:<ul>

  721. <li>dgl/<a class="el" href="ImageBase_8hpp_source.html">ImageBase.hpp</a></li>

  722. </ul>

  723. </div><!-- contents -->

  724. <!-- start footer part -->

  725. <hr class="footer"/><address class="footer"><small>

  726. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1

  727. </small></address>

  728. </body>

  729. </html>