diff options
author | Yann Herklotz <ymherklotz@gmail.com> | 2017-08-23 22:56:53 +0100 |
---|---|---|
committer | Yann Herklotz <ymherklotz@gmail.com> | 2017-08-23 22:56:53 +0100 |
commit | c7dad1e929c0101386fbcdaa194e402d68f74752 (patch) | |
tree | b6b7160dbb1e4312d05d96c1f24d7db7d3b57d9f /classyage_1_1Window.html | |
parent | 41b27388646a8159de3830dc21dcf3ac2519bd8e (diff) | |
download | YAGE-c7dad1e929c0101386fbcdaa194e402d68f74752.tar.gz YAGE-c7dad1e929c0101386fbcdaa194e402d68f74752.zip |
Updating docs
Diffstat (limited to 'classyage_1_1Window.html')
-rw-r--r-- | classyage_1_1Window.html | 387 |
1 files changed, 387 insertions, 0 deletions
diff --git a/classyage_1_1Window.html b/classyage_1_1Window.html new file mode 100644 index 00000000..a0f74388 --- /dev/null +++ b/classyage_1_1Window.html @@ -0,0 +1,387 @@ +<!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.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>YAGE: yage::Window 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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</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">YAGE +  <span id="projectnumber">0.02</span> + </div> + <div id="projectbrief">Yet Another Game Engine</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('classyage_1_1Window.html','');}); +</script> +<div id="doc-content"> +<!-- 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 class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pri-attribs">Private Attributes</a> | +<a href="classyage_1_1Window-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">yage::Window Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="window_8hpp_source.html">window.hpp</a>></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:a7d7bd2f22e095df387e8b5cda2bb484e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Window.html#a7d7bd2f22e095df387e8b5cda2bb484e">Window</a> ()</td></tr> +<tr class="separator:a7d7bd2f22e095df387e8b5cda2bb484e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1225a2b5eff6d44a6bce3f0f5f10e2bf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Window.html#a1225a2b5eff6d44a6bce3f0f5f10e2bf">Window</a> (const <a class="el" href="classyage_1_1Window.html">Window</a> &)=delete</td></tr> +<tr class="separator:a1225a2b5eff6d44a6bce3f0f5f10e2bf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4be115daea6c7473fca81623c547d821"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Window.html#a4be115daea6c7473fca81623c547d821">Window</a> (<a class="el" href="classyage_1_1Window.html">Window</a> &&)=delete</td></tr> +<tr class="separator:a4be115daea6c7473fca81623c547d821"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9a8dd109e145c459e52abb3a8861e3a0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Window.html#a9a8dd109e145c459e52abb3a8861e3a0">~Window</a> ()</td></tr> +<tr class="memdesc:a9a8dd109e145c459e52abb3a8861e3a0"><td class="mdescLeft"> </td><td class="mdescRight">destroys the window handle <a href="#a9a8dd109e145c459e52abb3a8861e3a0">More...</a><br /></td></tr> +<tr class="separator:a9a8dd109e145c459e52abb3a8861e3a0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5247a4164bf0006fe9f034cd27c5b6db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classyage_1_1Window.html">Window</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Window.html#a5247a4164bf0006fe9f034cd27c5b6db">operator=</a> (const <a class="el" href="classyage_1_1Window.html">Window</a> &)=delete</td></tr> +<tr class="separator:a5247a4164bf0006fe9f034cd27c5b6db"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a98c07656f90a6205f24dfe85ef1137de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classyage_1_1Window.html">Window</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Window.html#a98c07656f90a6205f24dfe85ef1137de">operator=</a> (<a class="el" href="classyage_1_1Window.html">Window</a> &&)=delete</td></tr> +<tr class="separator:a98c07656f90a6205f24dfe85ef1137de"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abfb5ae5e5abf22133e59097fc8aae5fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Window.html#abfb5ae5e5abf22133e59097fc8aae5fe">create</a> (const std::string &window_name, int width, int height, unsigned flags=WindowFlags::SHOWN)</td></tr> +<tr class="memdesc:abfb5ae5e5abf22133e59097fc8aae5fe"><td class="mdescLeft"> </td><td class="mdescRight">create the window, initialize the handle and update the width and height <a href="#abfb5ae5e5abf22133e59097fc8aae5fe">More...</a><br /></td></tr> +<tr class="separator:abfb5ae5e5abf22133e59097fc8aae5fe"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a86d0aa8e9896850b9acfc720b5615359"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Window.html#a86d0aa8e9896850b9acfc720b5615359">swapBuffer</a> ()</td></tr> +<tr class="memdesc:a86d0aa8e9896850b9acfc720b5615359"><td class="mdescLeft"> </td><td class="mdescRight">swap the buffer <a href="#a86d0aa8e9896850b9acfc720b5615359">More...</a><br /></td></tr> +<tr class="separator:a86d0aa8e9896850b9acfc720b5615359"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a98e2a33820ad63b2c94c56e203ff6e58"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Window.html#a98e2a33820ad63b2c94c56e203ff6e58">clearBuffer</a> ()</td></tr> +<tr class="memdesc:a98e2a33820ad63b2c94c56e203ff6e58"><td class="mdescLeft"> </td><td class="mdescRight">clear buffer <a href="#a98e2a33820ad63b2c94c56e203ff6e58">More...</a><br /></td></tr> +<tr class="separator:a98e2a33820ad63b2c94c56e203ff6e58"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a> +Private Attributes</h2></td></tr> +<tr class="memitem:acebbf824fbe3bb6afa32f2f33817050b"><td class="memItemLeft" align="right" valign="top">SDL_Window * </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1Window.html#acebbf824fbe3bb6afa32f2f33817050b">window_</a> = nullptr</td></tr> +<tr class="memdesc:acebbf824fbe3bb6afa32f2f33817050b"><td class="mdescLeft"> </td><td class="mdescRight">window handle <a href="#acebbf824fbe3bb6afa32f2f33817050b">More...</a><br /></td></tr> +<tr class="separator:acebbf824fbe3bb6afa32f2f33817050b"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a7d7bd2f22e095df387e8b5cda2bb484e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7d7bd2f22e095df387e8b5cda2bb484e">◆ </a></span>Window() <span class="overload">[1/3]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">yage::Window::Window </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">default</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a1225a2b5eff6d44a6bce3f0f5f10e2bf"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1225a2b5eff6d44a6bce3f0f5f10e2bf">◆ </a></span>Window() <span class="overload">[2/3]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">yage::Window::Window </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classyage_1_1Window.html">Window</a> & </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">delete</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a4be115daea6c7473fca81623c547d821"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4be115daea6c7473fca81623c547d821">◆ </a></span>Window() <span class="overload">[3/3]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">yage::Window::Window </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classyage_1_1Window.html">Window</a> && </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">delete</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a9a8dd109e145c459e52abb3a8861e3a0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9a8dd109e145c459e52abb3a8861e3a0">◆ </a></span>~Window()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">yage::Window::~Window </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a98e2a33820ad63b2c94c56e203ff6e58"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a98e2a33820ad63b2c94c56e203ff6e58">◆ </a></span>clearBuffer()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void yage::Window::clearBuffer </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="abfb5ae5e5abf22133e59097fc8aae5fe"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abfb5ae5e5abf22133e59097fc8aae5fe">◆ </a></span>create()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void yage::Window::create </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>window_name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>width</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>height</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned </td> + <td class="paramname"><em>flags</em> = <code>WindowFlags::SHOWN</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a5247a4164bf0006fe9f034cd27c5b6db"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5247a4164bf0006fe9f034cd27c5b6db">◆ </a></span>operator=() <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"><a class="el" href="classyage_1_1Window.html">Window</a>& yage::Window::operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classyage_1_1Window.html">Window</a> & </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">delete</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a98c07656f90a6205f24dfe85ef1137de"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a98c07656f90a6205f24dfe85ef1137de">◆ </a></span>operator=() <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"><a class="el" href="classyage_1_1Window.html">Window</a>& yage::Window::operator= </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classyage_1_1Window.html">Window</a> && </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">delete</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a86d0aa8e9896850b9acfc720b5615359"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a86d0aa8e9896850b9acfc720b5615359">◆ </a></span>swapBuffer()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void yage::Window::swapBuffer </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="acebbf824fbe3bb6afa32f2f33817050b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#acebbf824fbe3bb6afa32f2f33817050b">◆ </a></span>window_</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">SDL_Window* yage::Window::window_ = nullptr</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">private</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>include/YAGE/<a class="el" href="window_8hpp_source.html">window.hpp</a></li> +<li>src/<a class="el" href="window_8cpp.html">window.cpp</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespaceyage.html">yage</a></li><li class="navelem"><a class="el" href="classyage_1_1Window.html">Window</a></li> + <li class="footer">Generated on Wed Aug 23 2017 22:56:51 for YAGE by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |