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

621 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.8"/>

  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/search.js"></script>

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

  14.   $(document).ready(function() { searchBox.OnSelectItem(0); });

  15. </script>

  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />

  17. </head>

  18. <body>

  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->

  20. <div id="titlearea">

  21. <table cellspacing="0" cellpadding="0">

  22.  <tbody>

  23.  <tr style="height: 56px;">

  24.   <td style="padding-left: 0.5em;">

  25.    <div id="projectname">DISTRHO Plugin Framework

  26.    </div>

  27.   </td>

  28.  </tr>

  29.  </tbody>

  30. </table>

  31. </div>

  32. <!-- end header part -->

  33. <!-- Generated by Doxygen 1.8.8 -->

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

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

  36. </script>

  37.   <div id="navrow1" class="tabs">

  38.     <ul class="tablist">

  39.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  40.       <li><a href="modules.html"><span>Modules</span></a></li>

  41.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>

  42.       <li><a href="files.html"><span>Files</span></a></li>

  43.       <li>

  44.         <div id="MSearchBox" class="MSearchBoxInactive">

  45.         <span class="left">

  46.           <img id="MSearchSelect" src="search/mag_sel.png"

  47.                onmouseover="return searchBox.OnSearchSelectShow()"

  48.                onmouseout="return searchBox.OnSearchSelectHide()"

  49.                alt=""/>

  50.           <input type="text" id="MSearchField" value="Search" accesskey="S"

  51.                onfocus="searchBox.OnSearchFieldFocus(true)" 

  52.                onblur="searchBox.OnSearchFieldFocus(false)" 

  53.                onkeyup="searchBox.OnSearchFieldChange(event)"/>

  54.           </span><span class="right">

  55.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>

  56.           </span>

  57.         </div>

  58.       </li>

  59.     </ul>

  60.   </div>

  61.   <div id="navrow2" class="tabs2">

  62.     <ul class="tablist">

  63.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>

  64.       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>

  65.       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>

  66.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  67.     </ul>

  68.   </div>

  69. <!-- window showing the filter options -->

  70. <div id="MSearchSelectWindow"

  71.      onmouseover="return searchBox.OnSearchSelectShow()"

  72.      onmouseout="return searchBox.OnSearchSelectHide()"

  73.      onkeydown="return searchBox.OnSearchSelectKey(event)">

  74. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></div>

  75. 

  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. 

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

  84. <div class="header">

  85.   <div class="summary">

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

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

  88.   <div class="headertitle">

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

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

  91. <div class="contents">

  92. 

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

  94. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  140. </table>

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

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

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

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

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

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

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

  148. <div class="memitem">

  149. <div class="memproto">

  150.       <table class="memname">

  151.         <tr>

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

  153.           <td>(</td>

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

  155.           <td></td>

  156.         </tr>

  157.       </table>

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

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

  160. 

  161. </div>

  162. </div>

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

  164. <div class="memitem">

  165. <div class="memproto">

  166.       <table class="memname">

  167.         <tr>

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

  169.           <td>(</td>

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

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

  172.         </tr>

  173.         <tr>

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

  175.           <td></td>

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

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

  178.         </tr>

  179.         <tr>

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

  181.           <td></td>

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

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

  184.         </tr>

  185.         <tr>

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

  187.           <td></td>

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

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

  190.         </tr>

  191.         <tr>

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

  193.           <td></td>

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

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

  196.         </tr>

  197.         <tr>

  198.           <td></td>

  199.           <td>)</td>

  200.           <td></td><td></td>

  201.         </tr>

  202.       </table>

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

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

  205. 

  206. </div>

  207. </div>

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

  209. <div class="memitem">

  210. <div class="memproto">

  211.       <table class="memname">

  212.         <tr>

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

  214.           <td>(</td>

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

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

  217.         </tr>

  218.         <tr>

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

  220.           <td></td>

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

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

  223.         </tr>

  224.         <tr>

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

  226.           <td></td>

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

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

  229.         </tr>

  230.         <tr>

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

  232.           <td></td>

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

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

  235.         </tr>

  236.         <tr>

  237.           <td></td>

  238.           <td>)</td>

  239.           <td></td><td></td>

  240.         </tr>

  241.       </table>

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

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

  244. 

  245. </div>

  246. </div>

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

  248. <div class="memitem">

  249. <div class="memproto">

  250.       <table class="memname">

  251.         <tr>

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

  253.           <td>(</td>

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

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

  256.           <td></td>

  257.         </tr>

  258.       </table>

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

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

  261. 

  262. </div>

  263. </div>

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

  265. <div class="memitem">

  266. <div class="memproto">

  267.       <table class="memname">

  268.         <tr>

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

  270.           <td>(</td>

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

  272.           <td></td>

  273.         </tr>

  274.       </table>

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

  276. <p>Destructor. </p>

  277. 

  278. </div>

  279. </div>

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

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

  282. <div class="memitem">

  283. <div class="memproto">

  284. <table class="mlabels">

  285.   <tr>

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

  287.       <table class="memname">

  288.         <tr>

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

  290.           <td>(</td>

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

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

  293.         </tr>

  294.         <tr>

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

  296.           <td></td>

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

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

  299.         </tr>

  300.         <tr>

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

  302.           <td></td>

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

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

  305.         </tr>

  306.         <tr>

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

  308.           <td></td>

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

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

  311.         </tr>

  312.         <tr>

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

  314.           <td></td>

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

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

  317.         </tr>

  318.         <tr>

  319.           <td></td>

  320.           <td>)</td>

  321.           <td></td><td></td>

  322.         </tr>

  323.       </table>

  324.   </td>

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

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

  327.   </tr>

  328. </table>

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

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

  331. 

  332. </div>

  333. </div>

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

  335. <div class="memitem">

  336. <div class="memproto">

  337. <table class="mlabels">

  338.   <tr>

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

  340.       <table class="memname">

  341.         <tr>

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

  343.           <td>(</td>

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

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

  346.         </tr>

  347.         <tr>

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

  349.           <td></td>

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

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

  352.         </tr>

  353.         <tr>

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

  355.           <td></td>

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

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

  358.         </tr>

  359.         <tr>

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

  361.           <td></td>

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

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

  364.         </tr>

  365.         <tr>

  366.           <td></td>

  367.           <td>)</td>

  368.           <td></td><td></td>

  369.         </tr>

  370.       </table>

  371.   </td>

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

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

  374.   </tr>

  375. </table>

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

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

  378. 

  379. </div>

  380. </div>

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

  382. <div class="memitem">

  383. <div class="memproto">

  384. <table class="mlabels">

  385.   <tr>

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

  387.       <table class="memname">

  388.         <tr>

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

  390.           <td>(</td>

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

  392.           <td> const</td>

  393.         </tr>

  394.       </table>

  395.   </td>

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

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

  398.   </tr>

  399. </table>

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

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

  402. 

  403. </div>

  404. </div>

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

  406. <div class="memitem">

  407. <div class="memproto">

  408. <table class="mlabels">

  409.   <tr>

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

  411.       <table class="memname">

  412.         <tr>

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

  414.           <td>(</td>

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

  416.           <td> const</td>

  417.         </tr>

  418.       </table>

  419.   </td>

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

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

  422.   </tr>

  423. </table>

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

  425. <p>Get width. </p>

  426. 

  427. </div>

  428. </div>

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

  430. <div class="memitem">

  431. <div class="memproto">

  432. <table class="mlabels">

  433.   <tr>

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

  435.       <table class="memname">

  436.         <tr>

  437.           <td class="memname">uint Image::getHeight </td>

  438.           <td>(</td>

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

  440.           <td> const</td>

  441.         </tr>

  442.       </table>

  443.   </td>

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

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

  446.   </tr>

  447. </table>

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

  449. <p>Get height. </p>

  450. 

  451. </div>

  452. </div>

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

  454. <div class="memitem">

  455. <div class="memproto">

  456. <table class="mlabels">

  457.   <tr>

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

  459.       <table class="memname">

  460.         <tr>

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

  462.           <td>(</td>

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

  464.           <td> const</td>

  465.         </tr>

  466.       </table>

  467.   </td>

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

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

  470.   </tr>

  471. </table>

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

  473. <p>Get size. </p>

  474. 

  475. </div>

  476. </div>

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

  478. <div class="memitem">

  479. <div class="memproto">

  480. <table class="mlabels">

  481.   <tr>

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

  483.       <table class="memname">

  484.         <tr>

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

  486.           <td>(</td>

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

  488.           <td> const</td>

  489.         </tr>

  490.       </table>

  491.   </td>

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

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

  494.   </tr>

  495. </table>

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

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

  498. 

  499. </div>

  500. </div>

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

  502. <div class="memitem">

  503. <div class="memproto">

  504. <table class="mlabels">

  505.   <tr>

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

  507.       <table class="memname">

  508.         <tr>

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

  510.           <td>(</td>

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

  512.           <td> const</td>

  513.         </tr>

  514.       </table>

  515.   </td>

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

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

  518.   </tr>

  519. </table>

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

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

  522. 

  523. </div>

  524. </div>

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

  526. <div class="memitem">

  527. <div class="memproto">

  528. <table class="mlabels">

  529.   <tr>

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

  531.       <table class="memname">

  532.         <tr>

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

  534.           <td>(</td>

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

  536.           <td> const</td>

  537.         </tr>

  538.       </table>

  539.   </td>

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

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

  542.   </tr>

  543. </table>

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

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

  546. 

  547. </div>

  548. </div>

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

  550. <div class="memitem">

  551. <div class="memproto">

  552.       <table class="memname">

  553.         <tr>

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

  555.           <td>(</td>

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

  557.           <td></td>

  558.         </tr>

  559.       </table>

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

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

  562. 

  563. </div>

  564. </div>

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

  566. <div class="memitem">

  567. <div class="memproto">

  568.       <table class="memname">

  569.         <tr>

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

  571.           <td>(</td>

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

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

  574.         </tr>

  575.         <tr>

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

  577.           <td></td>

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

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

  580.         </tr>

  581.         <tr>

  582.           <td></td>

  583.           <td>)</td>

  584.           <td></td><td></td>

  585.         </tr>

  586.       </table>

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

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

  589. 

  590. </div>

  591. </div>

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

  593. <div class="memitem">

  594. <div class="memproto">

  595.       <table class="memname">

  596.         <tr>

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

  598.           <td>(</td>

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

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

  601.           <td></td>

  602.         </tr>

  603.       </table>

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

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

  606. 

  607. </div>

  608. </div>

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

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

  611. </ul>

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

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

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

  615. Generated on Sun Apr 26 2015 14:55:15 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  617. </a> 1.8.8

  618. </small></address>

  619. </body>

  620. </html>