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.
385 Commits
7 Branches
89MB
Tree: 20d5006e9a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '20d5006e9a'
${ noResults }
DPF/classImage.html

622 lines
27KB
Raw Blame History 

  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. 

  77. <!-- iframe showing the search results (closed by default) -->

  78. <div id="MSearchResultsWindow">

  79. <iframe src="javascript:void(0)" frameborder="0" 

  80.         name="MSearchResults" id="MSearchResults">

  81. </iframe>

  82. </div>

  83. 

  84. </div><!-- top -->

  85. <div class="header">

  86.   <div class="summary">

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

  88. <a href="classImage-members.html">List of all members</a>  </div>

  89.   <div class="headertitle">

  90. <div class="title">Image Class Reference</div>  </div>

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

  92. <div class="contents">

  93. 

  94. <p><code>#include &lt;<a class="el" href="Image_8hpp_source.html">Image.hpp</a>&gt;</code></p>

  95. <table class="memberdecls">

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

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

  98. <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>

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

  100. <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>

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

  102. <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>

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

  104. <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>

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

  106. <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>

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

  108. <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>

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

  110. <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>

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

  112. <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>

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

  114. <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>

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

  116. <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>

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

  118. <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>

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

  120. <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>

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

  122. <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>

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

  124. <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>

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

  126. <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>

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

  128. <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>

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

  130. <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>

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

  132. <tr class="memitem:ab23271a6bf92330d04c84146bfa81641"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab23271a6bf92330d04c84146bfa81641"></a>

  133. <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>

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

  135. <tr class="memitem:a775663b153fb5d21bca622739d881631"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a775663b153fb5d21bca622739d881631"></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:a775663b153fb5d21bca622739d881631"><td class="memSeparator" colspan="2">&#160;</td></tr>

  138. <tr class="memitem:abb67912deb6a20ea1c5a5b4d5a71c0ee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb67912deb6a20ea1c5a5b4d5a71c0ee"></a>

  139. 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>

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

  141. </table>

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

  143. <div class="textblock"><p>Base DGL <a class="el" href="classImage.html">Image</a> class.</p>

  144. <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>

  145. <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>

  146. <p>Images are drawn on screen via 2D textures. </p>

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

  148. <a class="anchor" id="a58edd1c45b4faeb5f789b0d036d02313"></a>

  149. <div class="memitem">

  150. <div class="memproto">

  151.       <table class="memname">

  152.         <tr>

  153.           <td class="memname">Image::Image </td>

  154.           <td>(</td>

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

  156.           <td></td>

  157.         </tr>

  158.       </table>

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

  160. <p>Constructor for a null <a class="el" href="classImage.html">Image</a>. </p>

  161. 

  162. </div>

  163. </div>

  164. <a class="anchor" id="ad351054c0c6ebc0df99a7f8df12c8920"></a>

  165. <div class="memitem">

  166. <div class="memproto">

  167.       <table class="memname">

  168.         <tr>

  169.           <td class="memname">Image::Image </td>

  170.           <td>(</td>

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

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

  173.         </tr>

  174.         <tr>

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

  176.           <td></td>

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

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

  179.         </tr>

  180.         <tr>

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

  182.           <td></td>

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

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

  185.         </tr>

  186.         <tr>

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

  188.           <td></td>

  189.           <td class="paramtype">const GLenum&#160;</td>

  190.           <td class="paramname"><em>format</em> = <code>GL_BGRA</code>, </td>

  191.         </tr>

  192.         <tr>

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

  194.           <td></td>

  195.           <td class="paramtype">const GLenum&#160;</td>

  196.           <td class="paramname"><em>type</em> = <code>GL_UNSIGNED_BYTE</code>&#160;</td>

  197.         </tr>

  198.         <tr>

  199.           <td></td>

  200.           <td>)</td>

  201.           <td></td><td></td>

  202.         </tr>

  203.       </table>

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

  205. <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>

  206. 

  207. </div>

  208. </div>

  209. <a class="anchor" id="a4587a30e65bacb349bc2d351d2fe49eb"></a>

  210. <div class="memitem">

  211. <div class="memproto">

  212.       <table class="memname">

  213.         <tr>

  214.           <td class="memname">Image::Image </td>

  215.           <td>(</td>

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

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

  218.         </tr>

  219.         <tr>

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

  221.           <td></td>

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

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

  224.         </tr>

  225.         <tr>

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

  227.           <td></td>

  228.           <td class="paramtype">const GLenum&#160;</td>

  229.           <td class="paramname"><em>format</em> = <code>GL_BGRA</code>, </td>

  230.         </tr>

  231.         <tr>

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

  233.           <td></td>

  234.           <td class="paramtype">const GLenum&#160;</td>

  235.           <td class="paramname"><em>type</em> = <code>GL_UNSIGNED_BYTE</code>&#160;</td>

  236.         </tr>

  237.         <tr>

  238.           <td></td>

  239.           <td>)</td>

  240.           <td></td><td></td>

  241.         </tr>

  242.       </table>

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

  244. <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>

  245. 

  246. </div>

  247. </div>

  248. <a class="anchor" id="a34410a36b132ab597a8878d45facc89a"></a>

  249. <div class="memitem">

  250. <div class="memproto">

  251.       <table class="memname">

  252.         <tr>

  253.           <td class="memname">Image::Image </td>

  254.           <td>(</td>

  255.           <td class="paramtype">const <a class="el" href="classImage.html">Image</a> &amp;&#160;</td>

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

  257.           <td></td>

  258.         </tr>

  259.       </table>

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

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

  262. 

  263. </div>

  264. </div>

  265. <a class="anchor" id="a0294f63700543e11c0f0da85601c7ae5"></a>

  266. <div class="memitem">

  267. <div class="memproto">

  268.       <table class="memname">

  269.         <tr>

  270.           <td class="memname">Image::~Image </td>

  271.           <td>(</td>

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

  273.           <td></td>

  274.         </tr>

  275.       </table>

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

  277. <p>Destructor. </p>

  278. 

  279. </div>

  280. </div>

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

  282. <a class="anchor" id="a097350feb2b30fd9289c346039298394"></a>

  283. <div class="memitem">

  284. <div class="memproto">

  285. <table class="mlabels">

  286.   <tr>

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

  288.       <table class="memname">

  289.         <tr>

  290.           <td class="memname">void Image::loadFromMemory </td>

  291.           <td>(</td>

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

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

  294.         </tr>

  295.         <tr>

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

  297.           <td></td>

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

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

  300.         </tr>

  301.         <tr>

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

  303.           <td></td>

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

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

  306.         </tr>

  307.         <tr>

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

  309.           <td></td>

  310.           <td class="paramtype">const GLenum&#160;</td>

  311.           <td class="paramname"><em>format</em> = <code>GL_BGRA</code>, </td>

  312.         </tr>

  313.         <tr>

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

  315.           <td></td>

  316.           <td class="paramtype">const GLenum&#160;</td>

  317.           <td class="paramname"><em>type</em> = <code>GL_UNSIGNED_BYTE</code>&#160;</td>

  318.         </tr>

  319.         <tr>

  320.           <td></td>

  321.           <td>)</td>

  322.           <td></td><td></td>

  323.         </tr>

  324.       </table>

  325.   </td>

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

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

  328.   </tr>

  329. </table>

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

  331. <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>

  332. 

  333. </div>

  334. </div>

  335. <a class="anchor" id="a2851a65c5885085be1d96878762fd860"></a>

  336. <div class="memitem">

  337. <div class="memproto">

  338. <table class="mlabels">

  339.   <tr>

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

  341.       <table class="memname">

  342.         <tr>

  343.           <td class="memname">void Image::loadFromMemory </td>

  344.           <td>(</td>

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

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

  347.         </tr>

  348.         <tr>

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

  350.           <td></td>

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

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

  353.         </tr>

  354.         <tr>

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

  356.           <td></td>

  357.           <td class="paramtype">const GLenum&#160;</td>

  358.           <td class="paramname"><em>format</em> = <code>GL_BGRA</code>, </td>

  359.         </tr>

  360.         <tr>

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

  362.           <td></td>

  363.           <td class="paramtype">const GLenum&#160;</td>

  364.           <td class="paramname"><em>type</em> = <code>GL_UNSIGNED_BYTE</code>&#160;</td>

  365.         </tr>

  366.         <tr>

  367.           <td></td>

  368.           <td>)</td>

  369.           <td></td><td></td>

  370.         </tr>

  371.       </table>

  372.   </td>

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

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

  375.   </tr>

  376. </table>

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

  378. <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>

  379. 

  380. </div>

  381. </div>

  382. <a class="anchor" id="a761214d2fa016e3e793b5a2d6b8b85ec"></a>

  383. <div class="memitem">

  384. <div class="memproto">

  385. <table class="mlabels">

  386.   <tr>

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

  388.       <table class="memname">

  389.         <tr>

  390.           <td class="memname">bool Image::isValid </td>

  391.           <td>(</td>

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

  393.           <td> const</td>

  394.         </tr>

  395.       </table>

  396.   </td>

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

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

  399.   </tr>

  400. </table>

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

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

  403. 

  404. </div>

  405. </div>

  406. <a class="anchor" id="a695d30afad2b73bc0e4208a94d052aea"></a>

  407. <div class="memitem">

  408. <div class="memproto">

  409. <table class="mlabels">

  410.   <tr>

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

  412.       <table class="memname">

  413.         <tr>

  414.           <td class="memname">uint Image::getWidth </td>

  415.           <td>(</td>

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

  417.           <td> const</td>

  418.         </tr>

  419.       </table>

  420.   </td>

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

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

  423.   </tr>

  424. </table>

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

  426. <p>Get width. </p>

  427. 

  428. </div>

  429. </div>

  430. <a class="anchor" id="a464a18561e9d49b9af42f007113d55f6"></a>

  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">uint Image::getHeight </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 height. </p>

  451. 

  452. </div>

  453. </div>

  454. <a class="anchor" id="a86b31865bfa07b98b61f503699f5c5d1"></a>

  455. <div class="memitem">

  456. <div class="memproto">

  457. <table class="mlabels">

  458.   <tr>

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

  460.       <table class="memname">

  461.         <tr>

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

  463.           <td>(</td>

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

  465.           <td> const</td>

  466.         </tr>

  467.       </table>

  468.   </td>

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

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

  471.   </tr>

  472. </table>

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

  474. <p>Get size. </p>

  475. 

  476. </div>

  477. </div>

  478. <a class="anchor" id="a638e0d75e9dff587f028639aaae8981b"></a>

  479. <div class="memitem">

  480. <div class="memproto">

  481. <table class="mlabels">

  482.   <tr>

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

  484.       <table class="memname">

  485.         <tr>

  486.           <td class="memname">const char* Image::getRawData </td>

  487.           <td>(</td>

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

  489.           <td> const</td>

  490.         </tr>

  491.       </table>

  492.   </td>

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

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

  495.   </tr>

  496. </table>

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

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

  499. 

  500. </div>

  501. </div>

  502. <a class="anchor" id="ac02e8bb7bfcc4adefc1f00557cc40e86"></a>

  503. <div class="memitem">

  504. <div class="memproto">

  505. <table class="mlabels">

  506.   <tr>

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

  508.       <table class="memname">

  509.         <tr>

  510.           <td class="memname">GLenum Image::getFormat </td>

  511.           <td>(</td>

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

  513.           <td> const</td>

  514.         </tr>

  515.       </table>

  516.   </td>

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

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

  519.   </tr>

  520. </table>

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

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

  523. 

  524. </div>

  525. </div>

  526. <a class="anchor" id="aafdd618cccc80f83a438b0c335de6205"></a>

  527. <div class="memitem">

  528. <div class="memproto">

  529. <table class="mlabels">

  530.   <tr>

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

  532.       <table class="memname">

  533.         <tr>

  534.           <td class="memname">GLenum Image::getType </td>

  535.           <td>(</td>

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

  537.           <td> const</td>

  538.         </tr>

  539.       </table>

  540.   </td>

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

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

  543.   </tr>

  544. </table>

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

  546. <p>Get the image type. </p>

  547. 

  548. </div>

  549. </div>

  550. <a class="anchor" id="ae1e16dcef3072e4e49ec2887a9c1245a"></a>

  551. <div class="memitem">

  552. <div class="memproto">

  553.       <table class="memname">

  554.         <tr>

  555.           <td class="memname">void Image::draw </td>

  556.           <td>(</td>

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

  558.           <td></td>

  559.         </tr>

  560.       </table>

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

  562. <p>Draw this image at (0, 0) point. </p>

  563. 

  564. </div>

  565. </div>

  566. <a class="anchor" id="ab63094dc07e6d62624827bca904b5cdd"></a>

  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 int&#160;</td>

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

  575.         </tr>

  576.         <tr>

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

  578.           <td></td>

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

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

  581.         </tr>

  582.         <tr>

  583.           <td></td>

  584.           <td>)</td>

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

  586.         </tr>

  587.       </table>

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

  589. <p>Draw this image at (x, y) point. </p>

  590. 

  591. </div>

  592. </div>

  593. <a class="anchor" id="aed2dc99624de978eade8124d2c099cfa"></a>

  594. <div class="memitem">

  595. <div class="memproto">

  596.       <table class="memname">

  597.         <tr>

  598.           <td class="memname">void Image::drawAt </td>

  599.           <td>(</td>

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

  601.           <td class="paramname"><em>pos</em></td><td>)</td>

  602.           <td></td>

  603.         </tr>

  604.       </table>

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

  606. <p>Draw this image at position <em>pos</em>. </p>

  607. 

  608. </div>

  609. </div>

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

  611. <li>dgl/<a class="el" href="Image_8hpp_source.html">Image.hpp</a></li>

  612. </ul>

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

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

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

  616. Generated on Wed Jun 17 2015 11:36:22 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

  617. <img class="footer" src="doxygen.png" alt="doxygen"/>

  618. </a> 1.8.9.1

  619. </small></address>

  620. </body>

  621. </html>