<!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> <title>SFML - Simple and Fast Multimedia Library</title> <meta http-equiv="Content-Type" content="text/html;"/> <meta charset="utf-8"/> <!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>--> <link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" /> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> </head> <body> <div id="banner-container"> <div id="banner"> <span id="sfml">SFML 2.5.1</span> </div> </div> <div id="content"> <!-- Generated by Doxygen 1.8.14 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#typedef-members">Typedefs</a> | <a href="#enum-members">Enumerations</a> </div> <div class="headertitle"> <div class="title">Window module</div> </div> </div><!--header--> <div class="contents"> <p>Provides OpenGL-based windows, and abstractions for events and input handling. <a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Clipboard.html">sf::Clipboard</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Give access to the system clipboard. <a href="classsf_1_1Clipboard.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Context.html">sf::Context</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class holding a valid drawing context. <a href="classsf_1_1Context.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsf_1_1ContextSettings.html">sf::ContextSettings</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Structure defining the settings of the OpenGL context attached to a window. <a href="structsf_1_1ContextSettings.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Cursor.html">sf::Cursor</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classsf_1_1Cursor.html" title="Cursor defines the appearance of a system cursor. ">Cursor</a> defines the appearance of a system cursor. <a href="classsf_1_1Cursor.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Event.html">sf::Event</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Defines a system event and its parameters. <a href="classsf_1_1Event.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1GlResource.html">sf::GlResource</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base class for classes that require an OpenGL context. <a href="classsf_1_1GlResource.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Joystick.html">sf::Joystick</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Give access to the real-time state of the joysticks. <a href="classsf_1_1Joystick.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Keyboard.html">sf::Keyboard</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Give access to the real-time state of the keyboard. <a href="classsf_1_1Keyboard.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Mouse.html">sf::Mouse</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Give access to the real-time state of the mouse. <a href="classsf_1_1Mouse.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Sensor.html">sf::Sensor</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Give access to the real-time state of the sensors. <a href="classsf_1_1Sensor.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Touch.html">sf::Touch</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Give access to the real-time state of the touches. <a href="classsf_1_1Touch.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1VideoMode.html">sf::VideoMode</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classsf_1_1VideoMode.html" title="VideoMode defines a video mode (width, height, bpp) ">VideoMode</a> defines a video mode (width, height, bpp) <a href="classsf_1_1VideoMode.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Window.html">sf::Window</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classsf_1_1Window.html" title="Window that serves as a target for OpenGL rendering. ">Window</a> that serves as a target for OpenGL rendering. <a href="classsf_1_1Window.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:gaed947028b0698a812cad2f97bfe9caa3"><td class="memItemLeft" align="right" valign="top">typedef platform specific </td><td class="memItemRight" valign="bottom"><a class="el" href="group__window.html#gaed947028b0698a812cad2f97bfe9caa3">sf::WindowHandle</a></td></tr> <tr class="memdesc:gaed947028b0698a812cad2f97bfe9caa3"><td class="mdescLeft"> </td><td class="mdescRight">Define a low-level window handle type, specific to each platform. <a href="group__window.html#gaed947028b0698a812cad2f97bfe9caa3">More...</a><br /></td></tr> <tr class="separator:gaed947028b0698a812cad2f97bfe9caa3"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> Enumerations</h2></td></tr> <tr class="memitem:ga97d7ee508bea4507ab40271518c732ff"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br />   <a class="el" href="group__window.html#gga97d7ee508bea4507ab40271518c732ffa8c35a9c8507559e455387fc4a83ce422">sf::Style::None</a> = 0, <a class="el" href="group__window.html#gga97d7ee508bea4507ab40271518c732ffab4c8b32b05ed715928513787cb1e85b6">sf::Style::Titlebar</a> = 1 << 0, <a class="el" href="group__window.html#gga97d7ee508bea4507ab40271518c732ffaccff967648ebcd5db2007eff7352b50f">sf::Style::Resize</a> = 1 << 1, <a class="el" href="group__window.html#gga97d7ee508bea4507ab40271518c732ffae07a7d411d5acf28f4a9a4b76a3a9493">sf::Style::Close</a> = 1 << 2, <br />   <a class="el" href="group__window.html#gga97d7ee508bea4507ab40271518c732ffa6288ec86830245cf957e2d234f79f50d">sf::Style::Fullscreen</a> = 1 << 3, <a class="el" href="group__window.html#gga97d7ee508bea4507ab40271518c732ffa5597cd420fc461807e4a201c92adea37">sf::Style::Default</a> = Titlebar | Resize | Close <br /> }</td></tr> <tr class="memdesc:ga97d7ee508bea4507ab40271518c732ff"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration of the window styles. <a href="group__window.html#ga97d7ee508bea4507ab40271518c732ff">More...</a><br /></td></tr> <tr class="separator:ga97d7ee508bea4507ab40271518c732ff"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Provides OpenGL-based windows, and abstractions for events and input handling. </p> <h2 class="groupheader">Typedef Documentation</h2> <a id="gaed947028b0698a812cad2f97bfe9caa3"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaed947028b0698a812cad2f97bfe9caa3">◆ </a></span>WindowHandle</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__window.html#gaed947028b0698a812cad2f97bfe9caa3">sf::WindowHandle</a></td> </tr> </table> </div><div class="memdoc"> <p>Define a low-level window handle type, specific to each platform. </p> <table class="markdownTable"> <tr class="markdownTableHead"> <th class="markdownTableHeadNone">Platform </th><th class="markdownTableHeadNone">Type -------------— </th></tr> <tr class="markdownTableBody" class="markdownTableRowOdd"> <td class="markdownTableBodyNone">Windows </td><td class="markdownTableBodyNone"><code>HWND</code> </td></tr> <tr class="markdownTableBody" class="markdownTableRowEven"> <td class="markdownTableBodyNone">Linux/FreeBSD </td><td class="markdownTableBodyNone"><code>Window</code> </td></tr> <tr class="markdownTableBody" class="markdownTableRowOdd"> <td class="markdownTableBodyNone">Mac OS X </td><td class="markdownTableBodyNone">either <code>NSWindow*</code> or <code>NSView*</code>, disguised as <code>void*</code> </td></tr> <tr class="markdownTableBody" class="markdownTableRowEven"> <td class="markdownTableBodyNone">iOS </td><td class="markdownTableBodyNone"><code>UIWindow*</code> </td></tr> <tr class="markdownTableBody" class="markdownTableRowOdd"> <td class="markdownTableBodyNone">Android </td><td class="markdownTableBodyNone"><code>ANativeWindow*</code> </td></tr> </table> <dl class="section user"><dt>Mac OS X Specification</dt><dd></dd></dl> <p>On Mac OS X, a <a class="el" href="classsf_1_1Window.html" title="Window that serves as a target for OpenGL rendering. ">sf::Window</a> can be created either from an existing <code>NSWindow*</code> or an <code>NSView*</code>. When the window is created from a window, SFML will use its content view as the OpenGL area. <a class="el" href="classsf_1_1Window.html#ad2fa6be5104ec0bfe79af7a5f524ea90" title="Get the OS-specific handle of the window. ">sf::Window::getSystemHandle()</a> will return the handle that was used to create the window, which is a <code>NSWindow*</code> by default. </p> <p class="definition">Definition at line <a class="el" href="WindowHandle_8hpp_source.html#l00068">68</a> of file <a class="el" href="WindowHandle_8hpp_source.html">WindowHandle.hpp</a>.</p> </div> </div> <h2 class="groupheader">Enumeration Type Documentation</h2> <a id="ga97d7ee508bea4507ab40271518c732ff"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga97d7ee508bea4507ab40271518c732ff">◆ </a></span>anonymous enum</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">anonymous enum</td> </tr> </table> </div><div class="memdoc"> <p>Enumeration of the window styles. </p> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga97d7ee508bea4507ab40271518c732ffa8c35a9c8507559e455387fc4a83ce422"></a>None </td><td class="fielddoc"><p>No border / title bar (this flag and all others are mutually exclusive) </p> </td></tr> <tr><td class="fieldname"><a id="gga97d7ee508bea4507ab40271518c732ffab4c8b32b05ed715928513787cb1e85b6"></a>Titlebar </td><td class="fielddoc"><p>Title bar + fixed border. </p> </td></tr> <tr><td class="fieldname"><a id="gga97d7ee508bea4507ab40271518c732ffaccff967648ebcd5db2007eff7352b50f"></a>Resize </td><td class="fielddoc"><p>Title bar + resizable border + maximize button. </p> </td></tr> <tr><td class="fieldname"><a id="gga97d7ee508bea4507ab40271518c732ffae07a7d411d5acf28f4a9a4b76a3a9493"></a>Close </td><td class="fielddoc"><p>Title bar + close button. </p> </td></tr> <tr><td class="fieldname"><a id="gga97d7ee508bea4507ab40271518c732ffa6288ec86830245cf957e2d234f79f50d"></a>Fullscreen </td><td class="fielddoc"><p>Fullscreen mode (this flag and all others are mutually exclusive) </p> </td></tr> <tr><td class="fieldname"><a id="gga97d7ee508bea4507ab40271518c732ffa5597cd420fc461807e4a201c92adea37"></a>Default </td><td class="fielddoc"><p>Default window style. </p> </td></tr> </table> <p class="definition">Definition at line <a class="el" href="WindowStyle_8hpp_source.html#l00038">38</a> of file <a class="el" href="WindowStyle_8hpp_source.html">WindowStyle.hpp</a>.</p> </div> </div> </div><!-- contents --> </div> <div id="footer-container"> <div id="footer"> SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br> Copyright © Laurent Gomila :: Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> :: </div> </div> </body> </html>