1170 lines
61 KiB
HTML
1170 lines
61 KiB
HTML
<!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>SDL Utility: 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>
|
|
<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">SDL Utility
|
|
</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&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&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>
|
|
</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">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('class_window.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</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-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="class_window-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Window Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Stores information about a window. You probably want <a class="el" href="class_render_window.html" title="A class that handles window related functionality.">RenderWindow</a>.
|
|
<a href="class_window.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_window_8hpp_source.html">Window.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for Window:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_window.png" usemap="#Window_map" alt=""/>
|
|
<map id="Window_map" name="Window_map">
|
|
<area href="class_render_window.html" title="A class that handles window related functionality." alt="RenderWindow" shape="rect" coords="0,56,97,80"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:aeafa59c8d05819c1ac68dfe53f6ff1b0"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#aeafa59c8d05819c1ac68dfe53f6ff1b0">Flags</a> { <br />
|
|
  <a class="el" href="class_window.html#aeafa59c8d05819c1ac68dfe53f6ff1b0ac226cd6214bef0cbdd11851d33f05fd7">Fullscreen</a> = ((Uint32)1 << 0)
|
|
, <a class="el" href="class_window.html#aeafa59c8d05819c1ac68dfe53f6ff1b0a13b8a4fd1b8a90ef9e8de021b17755f9">OpenGL</a> = ((Uint32)1 << 1)
|
|
, <a class="el" href="class_window.html#aeafa59c8d05819c1ac68dfe53f6ff1b0a158b8d2de885a5e6b34641e27d671b1a">Shown</a> = ((Uint32)1 << 2)
|
|
, <a class="el" href="class_window.html#aeafa59c8d05819c1ac68dfe53f6ff1b0a5ad727b9c4a7f111c6d68779e6a47268">Hidden</a> = ((Uint32)1 << 3)
|
|
, <br />
|
|
  <a class="el" href="class_window.html#aeafa59c8d05819c1ac68dfe53f6ff1b0acf5ef5faf4667e8aa320d4871f0b4d34">Borderless</a> = ((Uint32)1 << 4)
|
|
, <a class="el" href="class_window.html#aeafa59c8d05819c1ac68dfe53f6ff1b0ad4def267d331328e22f01a48433abda8">Resizable</a> = ((Uint32)1 << 5)
|
|
, <a class="el" href="class_window.html#aeafa59c8d05819c1ac68dfe53f6ff1b0ac470c191397add2ce2cab69fc7181022">Minimized</a> = ((Uint32)1 << 6)
|
|
, <a class="el" href="class_window.html#aeafa59c8d05819c1ac68dfe53f6ff1b0ada7cad3ff2d963a3553293b0ee9a2edf">Maximized</a> = ((Uint32)1 << 7)
|
|
, <br />
|
|
  <a class="el" href="class_window.html#aeafa59c8d05819c1ac68dfe53f6ff1b0a790604facb81515301798eac4b92ebbf">InputGrabbed</a> = ((Uint32)1 << 8)
|
|
, <a class="el" href="class_window.html#aeafa59c8d05819c1ac68dfe53f6ff1b0ab7454990a72bab393facd4b403281392">InputFocus</a> = ((Uint32)1 << 9)
|
|
, <a class="el" href="class_window.html#aeafa59c8d05819c1ac68dfe53f6ff1b0a9f9a38c289519845f9dc190ea85f54f4">MouseFocus</a> = ((Uint32)1 << 10)
|
|
, <a class="el" href="class_window.html#aeafa59c8d05819c1ac68dfe53f6ff1b0afd11a349ab38af120ea08b18ada7037d">Foregin</a> = ((Uint32)1 << 11)
|
|
, <br />
|
|
  <a class="el" href="class_window.html#aeafa59c8d05819c1ac68dfe53f6ff1b0a24df7d6f540442c630e02415c8ca24f4">FullscreenDesktop</a> = (Fullscreen | ((Uint32)1 << 12))
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:aeafa59c8d05819c1ac68dfe53f6ff1b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a74e6087da23d3c24e9fac0245e5ec92c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a74e6087da23d3c24e9fac0245e5ec92c">Window</a> ()</td></tr>
|
|
<tr class="memdesc:a74e6087da23d3c24e9fac0245e5ec92c"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. No window is created. <a href="class_window.html#a74e6087da23d3c24e9fac0245e5ec92c">More...</a><br /></td></tr>
|
|
<tr class="separator:a74e6087da23d3c24e9fac0245e5ec92c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07fdcde18ef213e1d6bf8417051de24e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a07fdcde18ef213e1d6bf8417051de24e">Window</a> (<a class="el" href="_vector2_8hpp.html#a36e88d2e65c41e97d7cd32ab4f5a2209">Vector2u</a> dimension, const std::string &title, <a class="el" href="_util_8hpp.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> windowFlags)</td></tr>
|
|
<tr class="memdesc:a07fdcde18ef213e1d6bf8417051de24e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a window with the given parameters. <a href="class_window.html#a07fdcde18ef213e1d6bf8417051de24e">More...</a><br /></td></tr>
|
|
<tr class="separator:a07fdcde18ef213e1d6bf8417051de24e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a362fb58d60e3254edddfe71e546e6993"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a362fb58d60e3254edddfe71e546e6993">Window</a> (const <a class="el" href="class_window.html">Window</a> &other)=delete</td></tr>
|
|
<tr class="separator:a362fb58d60e3254edddfe71e546e6993"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5692be0678fcf6721cec66cb97f7a66a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a5692be0678fcf6721cec66cb97f7a66a">Window</a> (<a class="el" href="class_window.html">Window</a> &&other)=delete</td></tr>
|
|
<tr class="separator:a5692be0678fcf6721cec66cb97f7a66a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a62b4a97b3c2e492f1d9a46092011e2d9"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a62b4a97b3c2e492f1d9a46092011e2d9">~Window</a> ()</td></tr>
|
|
<tr class="separator:a62b4a97b3c2e492f1d9a46092011e2d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af74d004bddf986f316fe54269f733fca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#af74d004bddf986f316fe54269f733fca">Create</a> (<a class="el" href="_vector2_8hpp.html#a36e88d2e65c41e97d7cd32ab4f5a2209">Vector2u</a> dimension, const std::string &title, <a class="el" href="_util_8hpp.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> windowFlags)</td></tr>
|
|
<tr class="memdesc:af74d004bddf986f316fe54269f733fca"><td class="mdescLeft"> </td><td class="mdescRight">Creates the window. <a href="class_window.html#af74d004bddf986f316fe54269f733fca">More...</a><br /></td></tr>
|
|
<tr class="separator:af74d004bddf986f316fe54269f733fca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ef67808752d9e9b618859e698f31362"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a4ef67808752d9e9b618859e698f31362">Close</a> ()</td></tr>
|
|
<tr class="memdesc:a4ef67808752d9e9b618859e698f31362"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the window. <a href="class_window.html#a4ef67808752d9e9b618859e698f31362">More...</a><br /></td></tr>
|
|
<tr class="separator:a4ef67808752d9e9b618859e698f31362"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad735ec09123e1633186b3bbcfcb8365d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#ad735ec09123e1633186b3bbcfcb8365d">IsOpen</a> () const</td></tr>
|
|
<tr class="memdesc:ad735ec09123e1633186b3bbcfcb8365d"><td class="mdescLeft"> </td><td class="mdescRight">Wether or not the window object is created. <a href="class_window.html#ad735ec09123e1633186b3bbcfcb8365d">More...</a><br /></td></tr>
|
|
<tr class="separator:ad735ec09123e1633186b3bbcfcb8365d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a122d7cdf6dc109cc0555c69341a7a329"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a122d7cdf6dc109cc0555c69341a7a329">PollEvent</a> (SDL_Event *event)</td></tr>
|
|
<tr class="memdesc:a122d7cdf6dc109cc0555c69341a7a329"><td class="mdescLeft"> </td><td class="mdescRight">A non-blocking event polling function. <a href="class_window.html#a122d7cdf6dc109cc0555c69341a7a329">More...</a><br /></td></tr>
|
|
<tr class="separator:a122d7cdf6dc109cc0555c69341a7a329"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4421c838374771e6b9c8681a69e25daf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a4421c838374771e6b9c8681a69e25daf">WaitEvent</a> (SDL_Event *event)</td></tr>
|
|
<tr class="memdesc:a4421c838374771e6b9c8681a69e25daf"><td class="mdescLeft"> </td><td class="mdescRight">A blocking event polling function. <a href="class_window.html#a4421c838374771e6b9c8681a69e25daf">More...</a><br /></td></tr>
|
|
<tr class="separator:a4421c838374771e6b9c8681a69e25daf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85002103c92958c59fc21bcf7041403d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_vector2_8hpp.html#aa83d444bd6cbecb112158663c2e0c213">Vector2i</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a85002103c92958c59fc21bcf7041403d">GetPosition</a> () const</td></tr>
|
|
<tr class="memdesc:a85002103c92958c59fc21bcf7041403d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current position of the window. <a href="class_window.html#a85002103c92958c59fc21bcf7041403d">More...</a><br /></td></tr>
|
|
<tr class="separator:a85002103c92958c59fc21bcf7041403d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8fd53d315aa4c9c38be8e8f920f7eb10"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a8fd53d315aa4c9c38be8e8f920f7eb10">SetPosition</a> (<a class="el" href="_vector2_8hpp.html#aa83d444bd6cbecb112158663c2e0c213">Vector2i</a> position)</td></tr>
|
|
<tr class="memdesc:a8fd53d315aa4c9c38be8e8f920f7eb10"><td class="mdescLeft"> </td><td class="mdescRight">Sets a new window position. <a href="class_window.html#a8fd53d315aa4c9c38be8e8f920f7eb10">More...</a><br /></td></tr>
|
|
<tr class="separator:a8fd53d315aa4c9c38be8e8f920f7eb10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e6641f14a62a9b2a4853e10e0ffe5fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a2e6641f14a62a9b2a4853e10e0ffe5fb">SetPosition</a> (int x, int y)</td></tr>
|
|
<tr class="memdesc:a2e6641f14a62a9b2a4853e10e0ffe5fb"><td class="mdescLeft"> </td><td class="mdescRight">Sets a new window position. <a href="class_window.html#a2e6641f14a62a9b2a4853e10e0ffe5fb">More...</a><br /></td></tr>
|
|
<tr class="separator:a2e6641f14a62a9b2a4853e10e0ffe5fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afde66bf9b3762c0300c8212dd18e474d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_vector2_8hpp.html#a36e88d2e65c41e97d7cd32ab4f5a2209">Vector2u</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#afde66bf9b3762c0300c8212dd18e474d">GetSize</a> () const</td></tr>
|
|
<tr class="memdesc:afde66bf9b3762c0300c8212dd18e474d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current window size. <a href="class_window.html#afde66bf9b3762c0300c8212dd18e474d">More...</a><br /></td></tr>
|
|
<tr class="separator:afde66bf9b3762c0300c8212dd18e474d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ab72b2f7bfc9a8fdbe9fd75bbea8654"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a5ab72b2f7bfc9a8fdbe9fd75bbea8654">SetSize</a> (<a class="el" href="_vector2_8hpp.html#a36e88d2e65c41e97d7cd32ab4f5a2209">Vector2u</a> size)</td></tr>
|
|
<tr class="memdesc:a5ab72b2f7bfc9a8fdbe9fd75bbea8654"><td class="mdescLeft"> </td><td class="mdescRight">Sets a new window size. <a href="class_window.html#a5ab72b2f7bfc9a8fdbe9fd75bbea8654">More...</a><br /></td></tr>
|
|
<tr class="separator:a5ab72b2f7bfc9a8fdbe9fd75bbea8654"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3ac9c3ea21fa54a4b38fe7993a10b7d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#aa3ac9c3ea21fa54a4b38fe7993a10b7d">SetSize</a> (unsigned int width, unsigned int height)</td></tr>
|
|
<tr class="memdesc:aa3ac9c3ea21fa54a4b38fe7993a10b7d"><td class="mdescLeft"> </td><td class="mdescRight">Sets a new window size. <a href="class_window.html#aa3ac9c3ea21fa54a4b38fe7993a10b7d">More...</a><br /></td></tr>
|
|
<tr class="separator:aa3ac9c3ea21fa54a4b38fe7993a10b7d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae66865d49d16710c1cb11fd39ab7564f"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#ae66865d49d16710c1cb11fd39ab7564f">GetTitle</a> () const</td></tr>
|
|
<tr class="memdesc:ae66865d49d16710c1cb11fd39ab7564f"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current window title. <a href="class_window.html#ae66865d49d16710c1cb11fd39ab7564f">More...</a><br /></td></tr>
|
|
<tr class="separator:ae66865d49d16710c1cb11fd39ab7564f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b2829cb820c5a7232e641c571faccb3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a4b2829cb820c5a7232e641c571faccb3">SetTitle</a> (std::string title)</td></tr>
|
|
<tr class="memdesc:a4b2829cb820c5a7232e641c571faccb3"><td class="mdescLeft"> </td><td class="mdescRight">Sets a new window title. <a href="class_window.html#a4b2829cb820c5a7232e641c571faccb3">More...</a><br /></td></tr>
|
|
<tr class="separator:a4b2829cb820c5a7232e641c571faccb3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5c5abd7cfe7b2287cf9a0ad0e95c1a5"><td class="memItemLeft" align="right" valign="top">SDL_Window *const </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#af5c5abd7cfe7b2287cf9a0ad0e95c1a5">GetWindow</a> () const</td></tr>
|
|
<tr class="memdesc:af5c5abd7cfe7b2287cf9a0ad0e95c1a5"><td class="mdescLeft"> </td><td class="mdescRight">Returns a constant pointer to the SDL_Window. <a href="class_window.html#af5c5abd7cfe7b2287cf9a0ad0e95c1a5">More...</a><br /></td></tr>
|
|
<tr class="separator:af5c5abd7cfe7b2287cf9a0ad0e95c1a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f02b192d076a98b72916e45ff5c40fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a5f02b192d076a98b72916e45ff5c40fe">SetVisible</a> (bool visible)</td></tr>
|
|
<tr class="memdesc:a5f02b192d076a98b72916e45ff5c40fe"><td class="mdescLeft"> </td><td class="mdescRight">Set the windows visibility. <a href="class_window.html#a5f02b192d076a98b72916e45ff5c40fe">More...</a><br /></td></tr>
|
|
<tr class="separator:a5f02b192d076a98b72916e45ff5c40fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a883027178d805d82c6bead962ee5fcea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a883027178d805d82c6bead962ee5fcea">SetVsync</a> (bool vsync)</td></tr>
|
|
<tr class="memdesc:a883027178d805d82c6bead962ee5fcea"><td class="mdescLeft"> </td><td class="mdescRight">(De)activates VSync !globally! <a href="class_window.html#a883027178d805d82c6bead962ee5fcea">More...</a><br /></td></tr>
|
|
<tr class="separator:a883027178d805d82c6bead962ee5fcea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb93384307a3e4b2bbda7ca7d241ebed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#aeb93384307a3e4b2bbda7ca7d241ebed">SetMouseCursorVisible</a> (bool visible)</td></tr>
|
|
<tr class="memdesc:aeb93384307a3e4b2bbda7ca7d241ebed"><td class="mdescLeft"> </td><td class="mdescRight">Hides/Shows the mouse cursor inside the windos. <a href="class_window.html#aeb93384307a3e4b2bbda7ca7d241ebed">More...</a><br /></td></tr>
|
|
<tr class="separator:aeb93384307a3e4b2bbda7ca7d241ebed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3514e6471ef00a3a109855b5408caac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#ae3514e6471ef00a3a109855b5408caac">SetMouseCursorGrabbed</a> (bool grabbed)</td></tr>
|
|
<tr class="memdesc:ae3514e6471ef00a3a109855b5408caac"><td class="mdescLeft"> </td><td class="mdescRight">Traps the mouse cursor inside the window. <a href="class_window.html#ae3514e6471ef00a3a109855b5408caac">More...</a><br /></td></tr>
|
|
<tr class="separator:ae3514e6471ef00a3a109855b5408caac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a501612c893d5e0e32fe43af476f9624c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a501612c893d5e0e32fe43af476f9624c">SetIcon</a> (<a class="el" href="_util_8hpp.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> width, <a class="el" href="_util_8hpp.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> height, const <a class="el" href="_util_8hpp.html#a2944638813a090aa23e62f4da842c3e2">Uint8</a> *pixels)</td></tr>
|
|
<tr class="memdesc:a501612c893d5e0e32fe43af476f9624c"><td class="mdescLeft"> </td><td class="mdescRight">Sets the window icon to an array of RGBA values. <a href="class_window.html#a501612c893d5e0e32fe43af476f9624c">More...</a><br /></td></tr>
|
|
<tr class="separator:a501612c893d5e0e32fe43af476f9624c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49a1afc39f915f0477b434974bc0eefc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a49a1afc39f915f0477b434974bc0eefc">SetIcon</a> (<a class="el" href="_util_8hpp.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> width, <a class="el" href="_util_8hpp.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> height, const <a class="el" href="_util_8hpp.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> *pixels)</td></tr>
|
|
<tr class="memdesc:a49a1afc39f915f0477b434974bc0eefc"><td class="mdescLeft"> </td><td class="mdescRight">Sets the window icon to an array of RGBA values. <a href="class_window.html#a49a1afc39f915f0477b434974bc0eefc">More...</a><br /></td></tr>
|
|
<tr class="separator:a49a1afc39f915f0477b434974bc0eefc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf5ca853594504788e13789e8018bbac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#aaf5ca853594504788e13789e8018bbac">SetIcon</a> (SDL_Surface *icon)</td></tr>
|
|
<tr class="memdesc:aaf5ca853594504788e13789e8018bbac"><td class="mdescLeft"> </td><td class="mdescRight">Sets the window icon to a SDL_Surface. <a href="class_window.html#aaf5ca853594504788e13789e8018bbac">More...</a><br /></td></tr>
|
|
<tr class="separator:aaf5ca853594504788e13789e8018bbac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c6529cd07516c53c3c446c0637a5ebd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a4c6529cd07516c53c3c446c0637a5ebd">SetMouseCursor</a> (SDL_Cursor *cursor)</td></tr>
|
|
<tr class="memdesc:a4c6529cd07516c53c3c446c0637a5ebd"><td class="mdescLeft"> </td><td class="mdescRight">Changes the mouse cursor. <a href="class_window.html#a4c6529cd07516c53c3c446c0637a5ebd">More...</a><br /></td></tr>
|
|
<tr class="separator:a4c6529cd07516c53c3c446c0637a5ebd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae4e84683ba72d48cc2a7d49dd47be1aa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#ae4e84683ba72d48cc2a7d49dd47be1aa">SetMouseCursor</a> (const <a class="el" href="class_cursor.html">Cursor</a> &cursor)</td></tr>
|
|
<tr class="memdesc:ae4e84683ba72d48cc2a7d49dd47be1aa"><td class="mdescLeft"> </td><td class="mdescRight">Changes the mouse cursor. <a href="class_window.html#ae4e84683ba72d48cc2a7d49dd47be1aa">More...</a><br /></td></tr>
|
|
<tr class="separator:ae4e84683ba72d48cc2a7d49dd47be1aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a1b32c581ae9b570faca395e5d23e9abf"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a1b32c581ae9b570faca395e5d23e9abf">OnCreate</a> ()</td></tr>
|
|
<tr class="memdesc:a1b32c581ae9b570faca395e5d23e9abf"><td class="mdescLeft"> </td><td class="mdescRight">This function is called after <a class="el" href="class_window.html#af74d004bddf986f316fe54269f733fca" title="Creates the window.">Create()</a> finishes. <a href="class_window.html#a1b32c581ae9b570faca395e5d23e9abf">More...</a><br /></td></tr>
|
|
<tr class="separator:a1b32c581ae9b570faca395e5d23e9abf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ff3b3bd30b3121801089910e7f6a757"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a6ff3b3bd30b3121801089910e7f6a757">OnResize</a> ()</td></tr>
|
|
<tr class="memdesc:a6ff3b3bd30b3121801089910e7f6a757"><td class="mdescLeft"> </td><td class="mdescRight">This function is called after a SDL_WINDOWEVENT_RESIZED is polled. (<a class="el" href="class_window.html#a122d7cdf6dc109cc0555c69341a7a329" title="A non-blocking event polling function.">PollEvent()</a> must be called for this to work) <a href="class_window.html#a6ff3b3bd30b3121801089910e7f6a757">More...</a><br /></td></tr>
|
|
<tr class="separator:a6ff3b3bd30b3121801089910e7f6a757"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25b97b17c457a41e233e7213077d8487"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#a25b97b17c457a41e233e7213077d8487">OnClose</a> ()</td></tr>
|
|
<tr class="memdesc:a25b97b17c457a41e233e7213077d8487"><td class="mdescLeft"> </td><td class="mdescRight">This function is called after <a class="el" href="class_window.html#a4ef67808752d9e9b618859e698f31362" title="Destroys the window.">Close()</a> finishes. <a href="class_window.html#a25b97b17c457a41e233e7213077d8487">More...</a><br /></td></tr>
|
|
<tr class="separator:a25b97b17c457a41e233e7213077d8487"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:ae39a7755a5a6ab74bcbdbe3e2e206820"><td class="memItemLeft" align="right" valign="top">SDL_Window * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_window.html#ae39a7755a5a6ab74bcbdbe3e2e206820">window</a></td></tr>
|
|
<tr class="separator:ae39a7755a5a6ab74bcbdbe3e2e206820"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Stores information about a window. You probably want <a class="el" href="class_render_window.html" title="A class that handles window related functionality.">RenderWindow</a>. </p>
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a id="aeafa59c8d05819c1ac68dfe53f6ff1b0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeafa59c8d05819c1ac68dfe53f6ff1b0">◆ </a></span>Flags</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="class_window.html#aeafa59c8d05819c1ac68dfe53f6ff1b0">Window::Flags</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aeafa59c8d05819c1ac68dfe53f6ff1b0ac226cd6214bef0cbdd11851d33f05fd7"></a>Fullscreen </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="aeafa59c8d05819c1ac68dfe53f6ff1b0a13b8a4fd1b8a90ef9e8de021b17755f9"></a>OpenGL </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="aeafa59c8d05819c1ac68dfe53f6ff1b0a158b8d2de885a5e6b34641e27d671b1a"></a>Shown </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="aeafa59c8d05819c1ac68dfe53f6ff1b0a5ad727b9c4a7f111c6d68779e6a47268"></a>Hidden </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="aeafa59c8d05819c1ac68dfe53f6ff1b0acf5ef5faf4667e8aa320d4871f0b4d34"></a>Borderless </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="aeafa59c8d05819c1ac68dfe53f6ff1b0ad4def267d331328e22f01a48433abda8"></a>Resizable </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="aeafa59c8d05819c1ac68dfe53f6ff1b0ac470c191397add2ce2cab69fc7181022"></a>Minimized </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="aeafa59c8d05819c1ac68dfe53f6ff1b0ada7cad3ff2d963a3553293b0ee9a2edf"></a>Maximized </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="aeafa59c8d05819c1ac68dfe53f6ff1b0a790604facb81515301798eac4b92ebbf"></a>InputGrabbed </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="aeafa59c8d05819c1ac68dfe53f6ff1b0ab7454990a72bab393facd4b403281392"></a>InputFocus </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="aeafa59c8d05819c1ac68dfe53f6ff1b0a9f9a38c289519845f9dc190ea85f54f4"></a>MouseFocus </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="aeafa59c8d05819c1ac68dfe53f6ff1b0afd11a349ab38af120ea08b18ada7037d"></a>Foregin </td><td class="fielddoc"></td></tr>
|
|
<tr><td class="fieldname"><a id="aeafa59c8d05819c1ac68dfe53f6ff1b0a24df7d6f540442c630e02415c8ca24f4"></a>FullscreenDesktop </td><td class="fielddoc"></td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a74e6087da23d3c24e9fac0245e5ec92c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a74e6087da23d3c24e9fac0245e5ec92c">◆ </a></span>Window() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Window::Window </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default Constructor. No window is created. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a07fdcde18ef213e1d6bf8417051de24e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a07fdcde18ef213e1d6bf8417051de24e">◆ </a></span>Window() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Window::Window </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_vector2_8hpp.html#a36e88d2e65c41e97d7cd32ab4f5a2209">Vector2u</a> </td>
|
|
<td class="paramname"><em>dimension</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>title</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_util_8hpp.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> </td>
|
|
<td class="paramname"><em>windowFlags</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a window with the given parameters. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dimension</td><td>A vector containing the width and height </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">title</td><td>The title of the create window </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a362fb58d60e3254edddfe71e546e6993"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a362fb58d60e3254edddfe71e546e6993">◆ </a></span>Window() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Window::Window </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_window.html">Window</a> & </td>
|
|
<td class="paramname"><em>other</em></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="a5692be0678fcf6721cec66cb97f7a66a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5692be0678fcf6721cec66cb97f7a66a">◆ </a></span>Window() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Window::Window </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_window.html">Window</a> && </td>
|
|
<td class="paramname"><em>other</em></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="a62b4a97b3c2e492f1d9a46092011e2d9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a62b4a97b3c2e492f1d9a46092011e2d9">◆ </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">virtual 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">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a4ef67808752d9e9b618859e698f31362"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ef67808752d9e9b618859e698f31362">◆ </a></span>Close()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::Close </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destroys the window. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af74d004bddf986f316fe54269f733fca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af74d004bddf986f316fe54269f733fca">◆ </a></span>Create()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::Create </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_vector2_8hpp.html#a36e88d2e65c41e97d7cd32ab4f5a2209">Vector2u</a> </td>
|
|
<td class="paramname"><em>dimension</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>title</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_util_8hpp.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> </td>
|
|
<td class="paramname"><em>windowFlags</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates the window. </p>
|
|
<p>This function creates the SDL_Window object. If they were already created the function does nothing and returns. If it fails to create either, an ObjectCreationException is thrown.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dimension</td><td>A vector containing the width and height </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">title</td><td>The title of the create window </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a85002103c92958c59fc21bcf7041403d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a85002103c92958c59fc21bcf7041403d">◆ </a></span>GetPosition()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_vector2_8hpp.html#aa83d444bd6cbecb112158663c2e0c213">Vector2i</a> Window::GetPosition </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the current position of the window. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A vector with the current position relative to the top left corner of the display </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afde66bf9b3762c0300c8212dd18e474d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afde66bf9b3762c0300c8212dd18e474d">◆ </a></span>GetSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_vector2_8hpp.html#a36e88d2e65c41e97d7cd32ab4f5a2209">Vector2u</a> Window::GetSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current window size. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A vector with the windows size </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae66865d49d16710c1cb11fd39ab7564f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae66865d49d16710c1cb11fd39ab7564f">◆ </a></span>GetTitle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string Window::GetTitle </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current window title. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The title of the widnow </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af5c5abd7cfe7b2287cf9a0ad0e95c1a5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af5c5abd7cfe7b2287cf9a0ad0e95c1a5">◆ </a></span>GetWindow()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">SDL_Window* const Window::GetWindow </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns a constant pointer to the SDL_Window. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A constant pointer to SDL_Window </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad735ec09123e1633186b3bbcfcb8365d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad735ec09123e1633186b3bbcfcb8365d">◆ </a></span>IsOpen()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Window::IsOpen </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Wether or not the window object is created. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the window is open, False if not </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a25b97b17c457a41e233e7213077d8487"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25b97b17c457a41e233e7213077d8487">◆ </a></span>OnClose()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void Window::OnClose </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This function is called after <a class="el" href="class_window.html#a4ef67808752d9e9b618859e698f31362" title="Destroys the window.">Close()</a> finishes. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_render_window.html#af15b3acc63e48d82a512e16455d47ef0">RenderWindow</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1b32c581ae9b570faca395e5d23e9abf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b32c581ae9b570faca395e5d23e9abf">◆ </a></span>OnCreate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void Window::OnCreate </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This function is called after <a class="el" href="class_window.html#af74d004bddf986f316fe54269f733fca" title="Creates the window.">Create()</a> finishes. </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_render_window.html#a5b54652402d9eafb0677045cc54bb5ab">RenderWindow</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6ff3b3bd30b3121801089910e7f6a757"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6ff3b3bd30b3121801089910e7f6a757">◆ </a></span>OnResize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool Window::OnResize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This function is called after a SDL_WINDOWEVENT_RESIZED is polled. (<a class="el" href="class_window.html#a122d7cdf6dc109cc0555c69341a7a329" title="A non-blocking event polling function.">PollEvent()</a> must be called for this to work) </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the resize event should be popped from the event queue before returning the polled event to the user </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_render_window.html#ab73b98b3d1b7336243e3f782d00b9884">RenderWindow</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a122d7cdf6dc109cc0555c69341a7a329"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a122d7cdf6dc109cc0555c69341a7a329">◆ </a></span>PollEvent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Window::PollEvent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SDL_Event * </td>
|
|
<td class="paramname"><em>event</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A non-blocking event polling function. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An object to write the latest event to </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if there was an event, False if there wasn't </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaf5ca853594504788e13789e8018bbac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf5ca853594504788e13789e8018bbac">◆ </a></span>SetIcon() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::SetIcon </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SDL_Surface * </td>
|
|
<td class="paramname"><em>icon</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the window icon to a SDL_Surface. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">icon</td><td>A SDL_Surface* holding the icon data </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a49a1afc39f915f0477b434974bc0eefc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a49a1afc39f915f0477b434974bc0eefc">◆ </a></span>SetIcon() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::SetIcon </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_util_8hpp.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> </td>
|
|
<td class="paramname"><em>width</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_util_8hpp.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> </td>
|
|
<td class="paramname"><em>height</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_util_8hpp.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> * </td>
|
|
<td class="paramname"><em>pixels</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the window icon to an array of RGBA values. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>Width of the icon (in px) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>Height of the icon (in px) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pixels</td><td>Array of color data (RGBA as one 32-Bit integer value) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a501612c893d5e0e32fe43af476f9624c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a501612c893d5e0e32fe43af476f9624c">◆ </a></span>SetIcon() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::SetIcon </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_util_8hpp.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> </td>
|
|
<td class="paramname"><em>width</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_util_8hpp.html#add440eff171ea5f55cb00c4a9ab8672d">Uint32</a> </td>
|
|
<td class="paramname"><em>height</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="_util_8hpp.html#a2944638813a090aa23e62f4da842c3e2">Uint8</a> * </td>
|
|
<td class="paramname"><em>pixels</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the window icon to an array of RGBA values. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>Width of the icon (in px) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>Height of the icon (in px) </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pixels</td><td>Array of color data (RGBA as seperate 8-Bit integer values) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae4e84683ba72d48cc2a7d49dd47be1aa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae4e84683ba72d48cc2a7d49dd47be1aa">◆ </a></span>SetMouseCursor() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::SetMouseCursor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_cursor.html">Cursor</a> & </td>
|
|
<td class="paramname"><em>cursor</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Changes the mouse cursor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">cursor</td><td>The cursor object holding cursor data </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4c6529cd07516c53c3c446c0637a5ebd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4c6529cd07516c53c3c446c0637a5ebd">◆ </a></span>SetMouseCursor() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::SetMouseCursor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SDL_Cursor * </td>
|
|
<td class="paramname"><em>cursor</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Changes the mouse cursor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">cursor</td><td>A pointer to a SDL_Cursor containing cursor data </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae3514e6471ef00a3a109855b5408caac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae3514e6471ef00a3a109855b5408caac">◆ </a></span>SetMouseCursorGrabbed()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::SetMouseCursorGrabbed </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>grabbed</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Traps the mouse cursor inside the window. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">grabbed</td><td>Wether to (un)trap the cursor </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeb93384307a3e4b2bbda7ca7d241ebed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeb93384307a3e4b2bbda7ca7d241ebed">◆ </a></span>SetMouseCursorVisible()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::SetMouseCursorVisible </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>visible</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Hides/Shows the mouse cursor inside the windos. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">visible</td><td>The new visibility of the cursor </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2e6641f14a62a9b2a4853e10e0ffe5fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2e6641f14a62a9b2a4853e10e0ffe5fb">◆ </a></span>SetPosition() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::SetPosition </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets a new window position. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>The new x position </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>The new y position </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8fd53d315aa4c9c38be8e8f920f7eb10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8fd53d315aa4c9c38be8e8f920f7eb10">◆ </a></span>SetPosition() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::SetPosition </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_vector2_8hpp.html#aa83d444bd6cbecb112158663c2e0c213">Vector2i</a> </td>
|
|
<td class="paramname"><em>position</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets a new window position. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">position</td><td>A vector with the new position </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa3ac9c3ea21fa54a4b38fe7993a10b7d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa3ac9c3ea21fa54a4b38fe7993a10b7d">◆ </a></span>SetSize() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::SetSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>width</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>height</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets a new window size. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>The new width of the window </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>The new height of the window </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5ab72b2f7bfc9a8fdbe9fd75bbea8654"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5ab72b2f7bfc9a8fdbe9fd75bbea8654">◆ </a></span>SetSize() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::SetSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_vector2_8hpp.html#a36e88d2e65c41e97d7cd32ab4f5a2209">Vector2u</a> </td>
|
|
<td class="paramname"><em>size</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets a new window size. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>A vector with the new size </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4b2829cb820c5a7232e641c571faccb3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b2829cb820c5a7232e641c571faccb3">◆ </a></span>SetTitle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::SetTitle </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::string </td>
|
|
<td class="paramname"><em>title</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets a new window title. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">title</td><td>The new window title </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5f02b192d076a98b72916e45ff5c40fe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5f02b192d076a98b72916e45ff5c40fe">◆ </a></span>SetVisible()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::SetVisible </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>visible</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the windows visibility. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">visible</td><td>The new visibility setting </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a883027178d805d82c6bead962ee5fcea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a883027178d805d82c6bead962ee5fcea">◆ </a></span>SetVsync()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Window::SetVsync </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>vsync</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>(De)activates VSync !globally! </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">vsync</td><td>Wether to enable or disable vsync </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4421c838374771e6b9c8681a69e25daf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4421c838374771e6b9c8681a69e25daf">◆ </a></span>WaitEvent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Window::WaitEvent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">SDL_Event * </td>
|
|
<td class="paramname"><em>event</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A blocking event polling function. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An object to write the latest event to </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if an event was polled </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="ae39a7755a5a6ab74bcbdbe3e2e206820"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae39a7755a5a6ab74bcbdbe3e2e206820">◆ </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* Window::window</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>C:/Users/Robert/source/repos/SDLU/include/structures/<a class="el" href="_window_8hpp_source.html">Window.hpp</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="class_window.html">Window</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|