DISTRHO
/
DPF
mirror of https://github.com/DISTRHO/DPF


			
				
					
						
						
							
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>DISTRHO Plugin Framework: NanoImage Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">DISTRHO Plugin Framework
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<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>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classNanoImage-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">NanoImage Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="NanoVG_8hpp_source.html">NanoVG.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5bf22d2002986c3b81f3b38ec8abf4a5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNanoImage.html#a5bf22d2002986c3b81f3b38ec8abf4a5">NanoImage</a> ()</td></tr>
<tr class="separator:a5bf22d2002986c3b81f3b38ec8abf4a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae822e33bed10563f4bd1898ae18afe8e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNanoImage.html#ae822e33bed10563f4bd1898ae18afe8e">NanoImage</a> (const Handle &amp;handle)</td></tr>
<tr class="separator:ae822e33bed10563f4bd1898ae18afe8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8915fb5eae1a0180edd3f5babf6a0091"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNanoImage.html#a8915fb5eae1a0180edd3f5babf6a0091">~NanoImage</a> ()</td></tr>
<tr class="separator:a8915fb5eae1a0180edd3f5babf6a0091"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50e5456835e48157abc365a1e095f591"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classNanoImage.html">NanoImage</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNanoImage.html#a50e5456835e48157abc365a1e095f591">operator=</a> (const Handle &amp;handle)</td></tr>
<tr class="separator:a50e5456835e48157abc365a1e095f591"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5095000052a0796ee0f944bed2503593"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNanoImage.html#a5095000052a0796ee0f944bed2503593">isValid</a> () const noexcept</td></tr>
<tr class="separator:a5095000052a0796ee0f944bed2503593"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a979cc37d8a10dc0642fcea2d64d3b58c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSize.html">Size</a>&lt; uint &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNanoImage.html#a979cc37d8a10dc0642fcea2d64d3b58c">getSize</a> () const noexcept</td></tr>
<tr class="separator:a979cc37d8a10dc0642fcea2d64d3b58c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c0f5b15005f825aba9685d7a9e7966a"><td class="memItemLeft" align="right" valign="top">GLuint&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNanoImage.html#a9c0f5b15005f825aba9685d7a9e7966a">getTextureHandle</a> () const </td></tr>
<tr class="separator:a9c0f5b15005f825aba9685d7a9e7966a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ac61a86a9dea09cc0800db0470bd94d26"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac61a86a9dea09cc0800db0470bd94d26"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>NanoVG</b></td></tr>
<tr class="separator:ac61a86a9dea09cc0800db0470bd94d26"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classNanoVG.html">NanoVG</a> <a class="el" href="classImage.html">Image</a> class.</p>
<p>This implements <a class="el" href="classNanoVG.html">NanoVG</a> images as a C++ class where deletion is handled automatically. Images need to be created within a <a class="el" href="classNanoVG.html">NanoVG</a> or <a class="el" href="classNanoWidget.html">NanoWidget</a> class. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5bf22d2002986c3b81f3b38ec8abf4a5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">NanoImage::NanoImage </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Constructor for an invalid/null image. </p>

</div>
</div>
<a class="anchor" id="ae822e33bed10563f4bd1898ae18afe8e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">NanoImage::NanoImage </td>
          <td>(</td>
          <td class="paramtype">const Handle &amp;&#160;</td>
          <td class="paramname"><em>handle</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Constructor. </p>

</div>
</div>
<a class="anchor" id="a8915fb5eae1a0180edd3f5babf6a0091"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">NanoImage::~NanoImage </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a50e5456835e48157abc365a1e095f591"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classNanoImage.html">NanoImage</a>&amp; NanoImage::operator= </td>
          <td>(</td>
          <td class="paramtype">const Handle &amp;&#160;</td>
          <td class="paramname"><em>handle</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create a new image without recreating the C++ class. </p>

</div>
</div>
<a class="anchor" id="a5095000052a0796ee0f944bed2503593"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool NanoImage::isValid </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Wherever this image is valid. </p>

</div>
</div>
<a class="anchor" id="a979cc37d8a10dc0642fcea2d64d3b58c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classSize.html">Size</a>&lt;uint&gt; NanoImage::getSize </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Get size. </p>

</div>
</div>
<a class="anchor" id="a9c0f5b15005f825aba9685d7a9e7966a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GLuint NanoImage::getTextureHandle </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the OpenGL texture handle. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>dgl/<a class="el" href="NanoVG_8hpp_source.html">NanoVG.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jun 24 2019 11:56:27 for DISTRHO Plugin Framework by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>