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


			
				
					
						
						
							
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DISTRHO Plugin Framework: Window::ScopedGraphicsContext Struct 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">DISTRHO Plugin Framework
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="classWindow.html">Window</a></li><li class="navelem"><a class="el" href="structWindow_1_1ScopedGraphicsContext.html">ScopedGraphicsContext</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structWindow_1_1ScopedGraphicsContext-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Window::ScopedGraphicsContext Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="Window_8hpp_source.html">Window.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:a05761155e7d7de67f5a593968f581607"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWindow_1_1ScopedGraphicsContext.html#a05761155e7d7de67f5a593968f581607">ScopedGraphicsContext</a> (<a class="el" href="classWindow.html">Window</a> &amp;window)</td></tr>
<tr class="separator:a05761155e7d7de67f5a593968f581607"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ac64bc28d2fdd1dba5a65ae5dfab5ff"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWindow_1_1ScopedGraphicsContext.html#a4ac64bc28d2fdd1dba5a65ae5dfab5ff">ScopedGraphicsContext</a> (<a class="el" href="classWindow.html">Window</a> &amp;window, <a class="el" href="classWindow.html">Window</a> &amp;transientParentWindow)</td></tr>
<tr class="separator:a4ac64bc28d2fdd1dba5a65ae5dfab5ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18fa5edc2ecfeafcc0849094ab49996e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWindow_1_1ScopedGraphicsContext.html#a18fa5edc2ecfeafcc0849094ab49996e">~ScopedGraphicsContext</a> ()</td></tr>
<tr class="separator:a18fa5edc2ecfeafcc0849094ab49996e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4647e1da0c4477f021f668459fb3221f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWindow_1_1ScopedGraphicsContext.html#a4647e1da0c4477f021f668459fb3221f">done</a> ()</td></tr>
<tr class="separator:a4647e1da0c4477f021f668459fb3221f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe259111bbf09fcf95995b0e447de221"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWindow_1_1ScopedGraphicsContext.html#afe259111bbf09fcf95995b0e447de221">reinit</a> ()</td></tr>
<tr class="separator:afe259111bbf09fcf95995b0e447de221"><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="classWindow.html">Window</a> graphics context as a scoped struct. This class gives graphics context drawing time to a window's widgets. Typically used for allowing OpenGL drawing operations during a window + widget constructor.</p>
<p>Unless you are subclassing the <a class="el" href="classWindow.html">Window</a> or <a class="el" href="classStandaloneWindow.html">StandaloneWindow</a> classes, you do not need to care. In such cases you will need to use this struct as a way to get a valid OpenGL context. For example in a standalone application: </p><div class="fragment"><div class="line"><span class="keywordtype">int</span> main()</div>
<div class="line">{</div>
<div class="line">    <a class="code" href="classApplication.html">Application</a> app;</div>
<div class="line">    <a class="code" href="classWindow.html">Window</a> win(app);</div>
<div class="line">    <a class="code" href="classScopedPointer.html">ScopedPointer&lt;MyCustomTopLevelWidget&gt;</a> widget;</div>
<div class="line">    {</div>
<div class="line">        <span class="keyword">const</span> <a class="code" href="structWindow_1_1ScopedGraphicsContext.html">Window::ScopedGraphicsContext</a> sgc(win);</div>
<div class="line">        widget = <span class="keyword">new</span> MyCustomTopLevelWidget(win);</div>
<div class="line">    }</div>
<div class="line">    app.<a class="code" href="classApplication.html#a805dd37af3b9adfc1d0ee1e734ad81e3">exec</a>();</div>
<div class="line">    <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
<div class="ttc" id="aclassApplication_html"><div class="ttname"><a href="classApplication.html">Application</a></div><div class="ttdef"><b>Definition:</b> Application.hpp:43</div></div>
<div class="ttc" id="aclassApplication_html_a805dd37af3b9adfc1d0ee1e734ad81e3"><div class="ttname"><a href="classApplication.html#a805dd37af3b9adfc1d0ee1e734ad81e3">Application::exec</a></div><div class="ttdeci">void exec(uint idleTimeInMs=30)</div></div>
<div class="ttc" id="aclassScopedPointer_html"><div class="ttname"><a href="classScopedPointer.html">ScopedPointer</a></div><div class="ttdef"><b>Definition:</b> ScopedPointer.hpp:83</div></div>
<div class="ttc" id="aclassWindow_html"><div class="ttname"><a href="classWindow.html">Window</a></div><div class="ttdef"><b>Definition:</b> Window.hpp:63</div></div>
<div class="ttc" id="astructWindow_1_1ScopedGraphicsContext_html"><div class="ttname"><a href="structWindow_1_1ScopedGraphicsContext.html">Window::ScopedGraphicsContext</a></div><div class="ttdef"><b>Definition:</b> Window.hpp:95</div></div>
</div><!-- fragment --><p>This struct is necessary because we cannot automatically make the window leave the OpenGL context in custom code. And we must always cleanly enter and leave the OpenGL context. So in order to avoid messing up the global host context, this class is used around widget creation. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a05761155e7d7de67f5a593968f581607"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05761155e7d7de67f5a593968f581607">&#9670;&nbsp;</a></span>ScopedGraphicsContext() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Window::ScopedGraphicsContext::ScopedGraphicsContext </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classWindow.html">Window</a> &amp;&#160;</td>
          <td class="paramname"><em>window</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Constructor that will make the <em>window</em> graphics context the current one </p>

</div>
</div>
<a id="a4ac64bc28d2fdd1dba5a65ae5dfab5ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ac64bc28d2fdd1dba5a65ae5dfab5ff">&#9670;&nbsp;</a></span>ScopedGraphicsContext() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Window::ScopedGraphicsContext::ScopedGraphicsContext </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classWindow.html">Window</a> &amp;&#160;</td>
          <td class="paramname"><em>window</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classWindow.html">Window</a> &amp;&#160;</td>
          <td class="paramname"><em>transientParentWindow</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Overloaded constructor, gives back context to its transient parent when done </p>

</div>
</div>
<a id="a18fa5edc2ecfeafcc0849094ab49996e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18fa5edc2ecfeafcc0849094ab49996e">&#9670;&nbsp;</a></span>~ScopedGraphicsContext()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Window::ScopedGraphicsContext::~ScopedGraphicsContext </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Desstructor for clearing current context, if not done yet </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4647e1da0c4477f021f668459fb3221f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4647e1da0c4477f021f668459fb3221f">&#9670;&nbsp;</a></span>done()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Window::ScopedGraphicsContext::done </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Early context clearing, useful for standalone windows not created by you. </p>

</div>
</div>
<a id="afe259111bbf09fcf95995b0e447de221"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe259111bbf09fcf95995b0e447de221">&#9670;&nbsp;</a></span>reinit()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Window::ScopedGraphicsContext::reinit </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get a valid context back again. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>dgl/<a class="el" href="Window_8hpp_source.html">Window.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>