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

517 lines
31KB
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.6"/>

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

  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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><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="#pro-methods">Protected 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. <div class="dynheader">

  96. Inheritance diagram for Image:</div>

  97. <div class="dyncontent">

  98.  <div class="center">

  99.   <img src="classImage.png" usemap="#Image_map" alt=""/>

  100.   <map id="Image_map" name="Image_map">

  101. <area href="classImageBase.html" alt="ImageBase" shape="rect" coords="0,0,73,24"/>

  102. </map>

  103.  </div></div>

  104. <table class="memberdecls">

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

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

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

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

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

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

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

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

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

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

  115. <tr class="memitem:a7b0235b2b5784ae92262dc7fd6c84c84"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#a7b0235b2b5784ae92262dc7fd6c84c84">~Image</a> () override</td></tr>

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

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

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

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

  120. <tr class="separator:a2851a65c5885085be1d96878762fd860"><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:ab23271a6bf92330d04c84146bfa81641"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classImage.html">Image</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#ab23271a6bf92330d04c84146bfa81641">operator=</a> (const <a class="el" href="classImage.html">Image</a> &amp;image) noexcept</td></tr>

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

  127. <tr class="inherit_header pub_methods_classImageBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classImageBase')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classImageBase.html">ImageBase</a></td></tr>

  128. <tr class="memitem:a247e1c3259d5943a5766c99f61da9309 inherit pub_methods_classImageBase"><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>

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

  130. <tr class="memitem:ab5b2bc7d68b0aff3452478f906aa960f inherit pub_methods_classImageBase"><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>

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

  132. <tr class="memitem:a82057493bae9af996a9a10b1aa731666 inherit pub_methods_classImageBase"><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>

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

  134. <tr class="memitem:aff56029a17822f19b518560e82aba878 inherit pub_methods_classImageBase"><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>

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

  136. <tr class="memitem:a7609a68efebd27587bb98e386db0e9e2 inherit pub_methods_classImageBase"><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>

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

  138. <tr class="memitem:aea60747a216159b14a8d020cb9b19546 inherit pub_methods_classImageBase"><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>

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

  140. <tr class="memitem:aac157862983291f94384b20e765de3d8 inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#aac157862983291f94384b20e765de3d8">draw</a> ()</td></tr>

  141. <tr class="separator:aac157862983291f94384b20e765de3d8 inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>

  142. <tr class="memitem:a80b1000794c650b8a40e3b31b7f1715a inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a80b1000794c650b8a40e3b31b7f1715a">drawAt</a> (const int x, const int y)</td></tr>

  143. <tr class="separator:a80b1000794c650b8a40e3b31b7f1715a inherit pub_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>

  144. <tr class="memitem:a8e2442b182ba3394e7a5889de5cace9d inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#a8e2442b182ba3394e7a5889de5cace9d">drawAt</a> (const <a class="el" href="classPoint.html">Point</a>&lt; int &gt; &amp;pos)</td></tr>

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

  146. <tr class="memitem:ac352a5a4291cd0945c663b17631598dc inherit pub_methods_classImageBase"><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>

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

  148. <tr class="memitem:a099b6d6fdd222d1fe20f09080ae3fb7c inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a099b6d6fdd222d1fe20f09080ae3fb7c"></a>

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

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

  151. <tr class="memitem:a77aceada26566e8e76699ef7abb3d1ad inherit pub_methods_classImageBase"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a77aceada26566e8e76699ef7abb3d1ad"></a>

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

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

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

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

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

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

  158. void&#160;</td><td class="memItemRight" valign="bottom"><b>_drawAt</b> (const <a class="el" href="classPoint.html">Point</a>&lt; int &gt; &amp;pos) override</td></tr>

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

  160. <tr class="inherit_header pro_methods_classImageBase"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classImageBase')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classImageBase.html">ImageBase</a></td></tr>

  161. <tr class="memitem:a1a1f82fcab01adea2f8783547e8a18aa inherit pro_methods_classImageBase"><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>

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

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

  164. <tr class="separator:a78d7171eb3c5173b4a8345093ae09a8e inherit pro_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>

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

  166. <tr class="separator:a958a7a22c513ac48b3c286d191760159 inherit pro_methods_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>

  167. <tr class="memitem:a56dd89a0a5c0abc604044e33c8b1db59 inherit pro_methods_classImageBase"><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>

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

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

  170. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>

  171. Additional Inherited Members</h2></td></tr>

  172. <tr class="inherit_header pro_attribs_classImageBase"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classImageBase')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classImageBase.html">ImageBase</a></td></tr>

  173. <tr class="memitem:ab6818e494243f0887f00469eb408dc3f inherit pro_attribs_classImageBase"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6818e494243f0887f00469eb408dc3f"></a>

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

  175. <tr class="separator:ab6818e494243f0887f00469eb408dc3f inherit pro_attribs_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>

  176. <tr class="memitem:a7df8928c7fe74d7a404576b053577989 inherit pro_attribs_classImageBase"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7df8928c7fe74d7a404576b053577989"></a>

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

  178. <tr class="separator:a7df8928c7fe74d7a404576b053577989 inherit pro_attribs_classImageBase"><td class="memSeparator" colspan="2">&#160;</td></tr>

  179. </table>

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

  181. <div class="textblock"><p>OpenGL <a class="el" href="classImage.html">Image</a> class.</p>

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

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

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

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

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

  187. <div class="memitem">

  188. <div class="memproto">

  189.       <table class="memname">

  190.         <tr>

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

  192.           <td>(</td>

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

  194.           <td></td>

  195.         </tr>

  196.       </table>

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

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

  199. 

  200. </div>

  201. </div>

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

  203. <div class="memitem">

  204. <div class="memproto">

  205.       <table class="memname">

  206.         <tr>

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

  208.           <td>(</td>

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

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

  211.         </tr>

  212.         <tr>

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

  214.           <td></td>

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

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

  217.         </tr>

  218.         <tr>

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

  220.           <td></td>

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

  222.           <td class="paramname"><em>height</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>

  244. <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="a4587a30e65bacb349bc2d351d2fe49eb"></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 char *const&#160;</td>

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

  257.         </tr>

  258.         <tr>

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

  260.           <td></td>

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

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

  263.         </tr>

  264.         <tr>

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

  266.           <td></td>

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

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

  269.         </tr>

  270.         <tr>

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

  272.           <td></td>

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

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

  275.         </tr>

  276.         <tr>

  277.           <td></td>

  278.           <td>)</td>

  279.           <td></td><td></td>

  280.         </tr>

  281.       </table>

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

  283. <p>Constructor using raw image data. </p>

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

  285. 

  286. </div>

  287. </div>

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

  289. <div class="memitem">

  290. <div class="memproto">

  291.       <table class="memname">

  292.         <tr>

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

  294.           <td>(</td>

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

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

  297.           <td></td>

  298.         </tr>

  299.       </table>

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

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

  302. 

  303. </div>

  304. </div>

  305. <a class="anchor" id="a7b0235b2b5784ae92262dc7fd6c84c84"></a>

  306. <div class="memitem">

  307. <div class="memproto">

  308. <table class="mlabels">

  309.   <tr>

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

  311.       <table class="memname">

  312.         <tr>

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

  314.           <td>(</td>

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

  316.           <td></td>

  317.         </tr>

  318.       </table>

  319.   </td>

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

  321. <span class="mlabels"><span class="mlabel">override</span></span>  </td>

  322.   </tr>

  323. </table>

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

  325. <p>Destructor. </p>

  326. 

  327. </div>

  328. </div>

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

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

  331. <div class="memitem">

  332. <div class="memproto">

  333. <table class="mlabels">

  334.   <tr>

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

  336.       <table class="memname">

  337.         <tr>

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

  339.           <td>(</td>

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

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

  342.         </tr>

  343.         <tr>

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

  345.           <td></td>

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

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

  348.         </tr>

  349.         <tr>

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

  351.           <td></td>

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

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

  354.         </tr>

  355.         <tr>

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

  357.           <td></td>

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

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

  360.         </tr>

  361.         <tr>

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

  363.           <td></td>

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

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

  366.         </tr>

  367.         <tr>

  368.           <td></td>

  369.           <td>)</td>

  370.           <td></td><td></td>

  371.         </tr>

  372.       </table>

  373.   </td>

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

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

  376.   </tr>

  377. </table>

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

  379. <p>Load image data from memory. </p>

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

  381. 

  382. </div>

  383. </div>

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

  385. <div class="memitem">

  386. <div class="memproto">

  387. <table class="mlabels">

  388.   <tr>

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

  390.       <table class="memname">

  391.         <tr>

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

  393.           <td>(</td>

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

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

  396.         </tr>

  397.         <tr>

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

  399.           <td></td>

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

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

  402.         </tr>

  403.         <tr>

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

  405.           <td></td>

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

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

  408.         </tr>

  409.         <tr>

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

  411.           <td></td>

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

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

  414.         </tr>

  415.         <tr>

  416.           <td></td>

  417.           <td>)</td>

  418.           <td></td><td></td>

  419.         </tr>

  420.       </table>

  421.   </td>

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

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

  424.   </tr>

  425. </table>

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

  427. <p>Load image data from memory. </p>

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

  429. 

  430. </div>

  431. </div>

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

  433. <div class="memitem">

  434. <div class="memproto">

  435. <table class="mlabels">

  436.   <tr>

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

  438.       <table class="memname">

  439.         <tr>

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

  441.           <td>(</td>

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

  443.           <td> const</td>

  444.         </tr>

  445.       </table>

  446.   </td>

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

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

  449.   </tr>

  450. </table>

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

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

  453. 

  454. </div>

  455. </div>

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

  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">GLenum Image::getType </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 image type. </p>

  477. 

  478. </div>

  479. </div>

  480. <a class="anchor" id="ab23271a6bf92330d04c84146bfa81641"></a>

  481. <div class="memitem">

  482. <div class="memproto">

  483. <table class="mlabels">

  484.   <tr>

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

  486.       <table class="memname">

  487.         <tr>

  488.           <td class="memname"><a class="el" href="classImage.html">Image</a>&amp; Image::operator= </td>

  489.           <td>(</td>

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

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

  492.           <td></td>

  493.         </tr>

  494.       </table>

  495.   </td>

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

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

  498.   </tr>

  499. </table>

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

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

  502. 

  503. </div>

  504. </div>

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

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

  507. </ul>

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

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

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

  511. Generated on Mon Jun 24 2019 12:02:37 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">

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

  513. </a> 1.8.6

  514. </small></address>

  515. </body>

  516. </html>