joseph-aquino
/
2d-platformer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2d-platformer/vendor/SFML/doc/html/classsf_1_1VideoMode.html

641 lines
39 KiB
HTML
Raw Blame History

<!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;charset=UTF-8" />
<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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link rel="stylesheet" type="text/css" href="search/search.css" />
<link rel="stylesheet" type="text/css" href="searchOverrides.css" />
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">SFML 3.0.0</span>
</div>
</div>
<div id="content">
<div>
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="topics.html"><span>Topics</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacesf.html">sf</a></li><li class="navelem"><a class="el" href="classsf_1_1VideoMode.html">VideoMode</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#related">Related Symbols</a> &#124;
<a href="classsf_1_1VideoMode-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">sf::VideoMode Class Reference<div class="ingroups"><a class="el" href="group__window.html">Window module</a></div></div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classsf_1_1VideoMode.html" title="VideoMode defines a video mode (size, bpp)">VideoMode</a> defines a video mode (size, bpp)
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="VideoMode_8hpp_source.html">SFML/Window/VideoMode.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5ef80d3ae7eb90d71b4da37077f949bc" id="r_a5ef80d3ae7eb90d71b4da37077f949bc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5ef80d3ae7eb90d71b4da37077f949bc">VideoMode</a> ()=default</td></tr>
<tr class="memdesc:a5ef80d3ae7eb90d71b4da37077f949bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a5ef80d3ae7eb90d71b4da37077f949bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a958f45676f31f338e70b8f588c6ab767" id="r_a958f45676f31f338e70b8f588c6ab767"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a958f45676f31f338e70b8f588c6ab767">VideoMode</a> (<a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a> modeSize, unsigned int modeBitsPerPixel=32)</td></tr>
<tr class="memdesc:a958f45676f31f338e70b8f588c6ab767"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the video mode with its attributes. <br /></td></tr>
<tr class="separator:a958f45676f31f338e70b8f588c6ab767"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5e04c044b0925523c75ecb173d2129a" id="r_ad5e04c044b0925523c75ecb173d2129a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad5e04c044b0925523c75ecb173d2129a">isValid</a> () const</td></tr>
<tr class="memdesc:ad5e04c044b0925523c75ecb173d2129a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tell whether or not the video mode is valid. <br /></td></tr>
<tr class="separator:ad5e04c044b0925523c75ecb173d2129a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ac1be160a4342e6eafb2cb0e8c9b18d44" id="r_ac1be160a4342e6eafb2cb0e8c9b18d44"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac1be160a4342e6eafb2cb0e8c9b18d44">getDesktopMode</a> ()</td></tr>
<tr class="memdesc:ac1be160a4342e6eafb2cb0e8c9b18d44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current desktop video mode. <br /></td></tr>
<tr class="separator:ac1be160a4342e6eafb2cb0e8c9b18d44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f99e67ef2b51fbdc335d9991232609e" id="r_a0f99e67ef2b51fbdc335d9991232609e"><td class="memItemLeft" align="right" valign="top">static const std::vector&lt; <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0f99e67ef2b51fbdc335d9991232609e">getFullscreenModes</a> ()</td></tr>
<tr class="memdesc:a0f99e67ef2b51fbdc335d9991232609e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve all the video modes supported in fullscreen mode. <br /></td></tr>
<tr class="separator:a0f99e67ef2b51fbdc335d9991232609e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:afa7b60723adc1c39e43075a157d35d98" id="r_afa7b60723adc1c39e43075a157d35d98"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afa7b60723adc1c39e43075a157d35d98">size</a></td></tr>
<tr class="memdesc:afa7b60723adc1c39e43075a157d35d98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Video mode width and height, in pixels. <br /></td></tr>
<tr class="separator:afa7b60723adc1c39e43075a157d35d98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa080f1ef96a1008d58b1920eceb189df" id="r_aa080f1ef96a1008d58b1920eceb189df"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa080f1ef96a1008d58b1920eceb189df">bitsPerPixel</a> {}</td></tr>
<tr class="memdesc:aa080f1ef96a1008d58b1920eceb189df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Video mode pixel depth, in bits per pixels. <br /></td></tr>
<tr class="separator:aa080f1ef96a1008d58b1920eceb189df"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="related" name="related"></a>
Related Symbols</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member symbols.) </p>
</td></tr>
<tr class="memitem:aca24086fd94d11014f3a0b5ca9a3acd6" id="r_aca24086fd94d11014f3a0b5ca9a3acd6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aca24086fd94d11014f3a0b5ca9a3acd6">operator==</a> (const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;left, const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;right)</td></tr>
<tr class="memdesc:aca24086fd94d11014f3a0b5ca9a3acd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of <code>operator==</code> to compare two video modes. <br /></td></tr>
<tr class="separator:aca24086fd94d11014f3a0b5ca9a3acd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34b5c266a7b9cd5bc95de62f8beafc5a" id="r_a34b5c266a7b9cd5bc95de62f8beafc5a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a34b5c266a7b9cd5bc95de62f8beafc5a">operator!=</a> (const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;left, const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;right)</td></tr>
<tr class="memdesc:a34b5c266a7b9cd5bc95de62f8beafc5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of <code>operator!=</code> to compare two video modes. <br /></td></tr>
<tr class="separator:a34b5c266a7b9cd5bc95de62f8beafc5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54cc77c0b6c4b133e0147a43d6829b13" id="r_a54cc77c0b6c4b133e0147a43d6829b13"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a54cc77c0b6c4b133e0147a43d6829b13">operator&lt;</a> (const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;left, const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;right)</td></tr>
<tr class="memdesc:a54cc77c0b6c4b133e0147a43d6829b13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of <code>operator&lt;</code> to compare video modes. <br /></td></tr>
<tr class="separator:a54cc77c0b6c4b133e0147a43d6829b13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b894cab5f2a3a14597e4c6d200179a4" id="r_a5b894cab5f2a3a14597e4c6d200179a4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5b894cab5f2a3a14597e4c6d200179a4">operator&gt;</a> (const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;left, const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;right)</td></tr>
<tr class="memdesc:a5b894cab5f2a3a14597e4c6d200179a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of <code>operator&gt;</code> to compare video modes. <br /></td></tr>
<tr class="separator:a5b894cab5f2a3a14597e4c6d200179a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa094b7b9ae4c0194892ebda7b4b9bb37" id="r_aa094b7b9ae4c0194892ebda7b4b9bb37"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa094b7b9ae4c0194892ebda7b4b9bb37">operator&lt;=</a> (const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;left, const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;right)</td></tr>
<tr class="memdesc:aa094b7b9ae4c0194892ebda7b4b9bb37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of <code>operator&lt;=</code> to compare video modes. <br /></td></tr>
<tr class="separator:aa094b7b9ae4c0194892ebda7b4b9bb37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e3d91683fcabb88c5b640e9884fe3df" id="r_a6e3d91683fcabb88c5b640e9884fe3df"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6e3d91683fcabb88c5b640e9884fe3df">operator&gt;=</a> (const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;left, const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;right)</td></tr>
<tr class="memdesc:a6e3d91683fcabb88c5b640e9884fe3df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload of <code>operator&gt;=</code> to compare video modes. <br /></td></tr>
<tr class="separator:a6e3d91683fcabb88c5b640e9884fe3df"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classsf_1_1VideoMode.html" title="VideoMode defines a video mode (size, bpp)">VideoMode</a> defines a video mode (size, bpp) </p>
<p>A video mode is defined by a width and a height (in pixels) and a depth (in bits per pixel).</p>
<p>Video modes are used to setup windows (<code><a class="el" href="classsf_1_1Window.html" title="Window that serves as a target for OpenGL rendering.">sf::Window</a></code>) at creation time.</p>
<p>The main usage of video modes is for fullscreen mode: indeed you must use one of the valid video modes allowed by the OS (which are defined by what the monitor and the graphics card support), otherwise your window creation will just fail.</p>
<p><code><a class="el" href="classsf_1_1VideoMode.html" title="VideoMode defines a video mode (size, bpp)">sf::VideoMode</a></code> provides a static function for retrieving the list of all the video modes supported by the system: <code><a class="el" href="#a0f99e67ef2b51fbdc335d9991232609e" title="Retrieve all the video modes supported in fullscreen mode.">getFullscreenModes()</a></code>.</p>
<p>A custom video mode can also be checked directly for fullscreen compatibility with its <code><a class="el" href="#ad5e04c044b0925523c75ecb173d2129a" title="Tell whether or not the video mode is valid.">isValid()</a></code> function.</p>
<p>Additionally, <code><a class="el" href="classsf_1_1VideoMode.html" title="VideoMode defines a video mode (size, bpp)">sf::VideoMode</a></code> provides a static function to get the mode currently used by the desktop: <code><a class="el" href="#ac1be160a4342e6eafb2cb0e8c9b18d44" title="Get the current desktop video mode.">getDesktopMode()</a></code>. This allows to build windows with the same size or pixel depth as the current resolution.</p>
<p>Usage example: </p><div class="fragment"><div class="line"><span class="comment">// Display the list of all the video modes available for fullscreen</span></div>
<div class="line">std::vector&lt;sf::VideoMode&gt; modes = <a class="code hl_function" href="#a0f99e67ef2b51fbdc335d9991232609e">sf::VideoMode::getFullscreenModes</a>();</div>
<div class="line"><span class="keywordflow">for</span> (std::size_t i = 0; i &lt; modes.size(); ++i)</div>
<div class="line">{</div>
<div class="line"> <a class="code hl_class" href="classsf_1_1VideoMode.html">sf::VideoMode</a> mode = modes[i];</div>
<div class="line"> std::cout &lt;&lt; <span class="stringliteral">&quot;Mode #&quot;</span> &lt;&lt; i &lt;&lt; <span class="stringliteral">&quot;: &quot;</span></div>
<div class="line"> &lt;&lt; mode.<a class="code hl_variable" href="#afa7b60723adc1c39e43075a157d35d98">size</a>.<a class="code hl_variable" href="classsf_1_1Vector2.html#a1e6ad77fa155f3753bfb92699bd28141">x</a> &lt;&lt; <span class="stringliteral">&quot;x&quot;</span> &lt;&lt; mode.<a class="code hl_variable" href="#afa7b60723adc1c39e43075a157d35d98">size</a>.<a class="code hl_variable" href="classsf_1_1Vector2.html#a420f2481b015f4eb929c75f2af564299">y</a> &lt;&lt; <span class="stringliteral">&quot; - &quot;</span></div>
<div class="line"> &lt;&lt; mode.<a class="code hl_variable" href="#aa080f1ef96a1008d58b1920eceb189df">bitsPerPixel</a> &lt;&lt; <span class="stringliteral">&quot; bpp&quot;</span> &lt;&lt; std::endl;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Create a window with the same pixel depth as the desktop</span></div>
<div class="line"><a class="code hl_class" href="classsf_1_1VideoMode.html">sf::VideoMode</a> desktop = <a class="code hl_function" href="#ac1be160a4342e6eafb2cb0e8c9b18d44">sf::VideoMode::getDesktopMode</a>();</div>
<div class="line">window.create(<a class="code hl_class" href="classsf_1_1VideoMode.html">sf::VideoMode</a>({1024, 768}, desktop.<a class="code hl_variable" href="#aa080f1ef96a1008d58b1920eceb189df">bitsPerPixel</a>), <span class="stringliteral">&quot;SFML window&quot;</span>);</div>
<div class="ttc" id="aclasssf_1_1Vector2_html_a1e6ad77fa155f3753bfb92699bd28141"><div class="ttname"><a href="classsf_1_1Vector2.html#a1e6ad77fa155f3753bfb92699bd28141">sf::Vector2::x</a></div><div class="ttdeci">T x</div><div class="ttdoc">X coordinate of the vector.</div><div class="ttdef"><b>Definition</b> <a href="Vector2_8hpp_source.html#l00203">Vector2.hpp:203</a></div></div>
<div class="ttc" id="aclasssf_1_1Vector2_html_a420f2481b015f4eb929c75f2af564299"><div class="ttname"><a href="classsf_1_1Vector2.html#a420f2481b015f4eb929c75f2af564299">sf::Vector2::y</a></div><div class="ttdeci">T y</div><div class="ttdoc">Y coordinate of the vector.</div><div class="ttdef"><b>Definition</b> <a href="Vector2_8hpp_source.html#l00204">Vector2.hpp:204</a></div></div>
<div class="ttc" id="aclasssf_1_1VideoMode_html"><div class="ttname"><a href="classsf_1_1VideoMode.html">sf::VideoMode</a></div><div class="ttdoc">VideoMode defines a video mode (size, bpp)</div><div class="ttdef"><b>Definition</b> <a href="VideoMode_8hpp_source.html#l00043">VideoMode.hpp:44</a></div></div>
<div class="ttc" id="aclasssf_1_1VideoMode_html_a0f99e67ef2b51fbdc335d9991232609e"><div class="ttname"><a href="#a0f99e67ef2b51fbdc335d9991232609e">sf::VideoMode::getFullscreenModes</a></div><div class="ttdeci">static const std::vector&lt; VideoMode &gt; &amp; getFullscreenModes()</div><div class="ttdoc">Retrieve all the video modes supported in fullscreen mode.</div></div>
<div class="ttc" id="aclasssf_1_1VideoMode_html_aa080f1ef96a1008d58b1920eceb189df"><div class="ttname"><a href="#aa080f1ef96a1008d58b1920eceb189df">sf::VideoMode::bitsPerPixel</a></div><div class="ttdeci">unsigned int bitsPerPixel</div><div class="ttdoc">Video mode pixel depth, in bits per pixels.</div><div class="ttdef"><b>Definition</b> <a href="VideoMode_8hpp_source.html#l00103">VideoMode.hpp:103</a></div></div>
<div class="ttc" id="aclasssf_1_1VideoMode_html_ac1be160a4342e6eafb2cb0e8c9b18d44"><div class="ttname"><a href="#ac1be160a4342e6eafb2cb0e8c9b18d44">sf::VideoMode::getDesktopMode</a></div><div class="ttdeci">static VideoMode getDesktopMode()</div><div class="ttdoc">Get the current desktop video mode.</div></div>
<div class="ttc" id="aclasssf_1_1VideoMode_html_afa7b60723adc1c39e43075a157d35d98"><div class="ttname"><a href="#afa7b60723adc1c39e43075a157d35d98">sf::VideoMode::size</a></div><div class="ttdeci">Vector2u size</div><div class="ttdoc">Video mode width and height, in pixels.</div><div class="ttdef"><b>Definition</b> <a href="VideoMode_8hpp_source.html#l00102">VideoMode.hpp:102</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="VideoMode_8hpp_source.html#l00043">43</a> of file <a class="el" href="VideoMode_8hpp_source.html">VideoMode.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5ef80d3ae7eb90d71b4da37077f949bc" name="a5ef80d3ae7eb90d71b4da37077f949bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ef80d3ae7eb90d71b4da37077f949bc">&#9670;&#160;</a></span>VideoMode() <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">sf::VideoMode::VideoMode </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></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">
<p>Default constructor. </p>
<p>This constructors initializes all members to 0. </p>
</div>
</div>
<a id="a958f45676f31f338e70b8f588c6ab767" name="a958f45676f31f338e70b8f588c6ab767"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a958f45676f31f338e70b8f588c6ab767">&#9670;&#160;</a></span>VideoMode() <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">sf::VideoMode::VideoMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a></td> <td class="paramname"><span class="paramname"><em>modeSize</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>modeBitsPerPixel</em></span><span class="paramdefsep"> = </span><span class="paramdefval">32</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct the video mode with its attributes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">modeSize</td><td>Width and height in pixels </td></tr>
<tr><td class="paramname">modeBitsPerPixel</td><td>Pixel depths in bits per pixel </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac1be160a4342e6eafb2cb0e8c9b18d44" name="ac1be160a4342e6eafb2cb0e8c9b18d44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1be160a4342e6eafb2cb0e8c9b18d44">&#9670;&#160;</a></span>getDesktopMode()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> sf::VideoMode::getDesktopMode </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current desktop video mode. </p>
<dl class="section return"><dt>Returns</dt><dd>Current desktop video mode </dd></dl>
</div>
</div>
<a id="a0f99e67ef2b51fbdc335d9991232609e" name="a0f99e67ef2b51fbdc335d9991232609e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f99e67ef2b51fbdc335d9991232609e">&#9670;&#160;</a></span>getFullscreenModes()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static const std::vector&lt; <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &gt; &amp; sf::VideoMode::getFullscreenModes </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve all the video modes supported in fullscreen mode. </p>
<p>When creating a fullscreen window, the video mode is restricted to be compatible with what the graphics driver and monitor support. This function returns the complete list of all video modes that can be used in fullscreen mode. The returned array is sorted from best to worst, so that the first element will always give the best mode (higher width, height and bits-per-pixel).</p>
<dl class="section return"><dt>Returns</dt><dd>Array containing all the supported fullscreen modes </dd></dl>
</div>
</div>
<a id="ad5e04c044b0925523c75ecb173d2129a" name="ad5e04c044b0925523c75ecb173d2129a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5e04c044b0925523c75ecb173d2129a">&#9670;&#160;</a></span>isValid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sf::VideoMode::isValid </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Tell whether or not the video mode is valid. </p>
<p>The validity of video modes is only relevant when using fullscreen windows; otherwise any video mode can be used with no restriction.</p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the video mode is valid for fullscreen mode </dd></dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="a34b5c266a7b9cd5bc95de62f8beafc5a" name="a34b5c266a7b9cd5bc95de62f8beafc5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34b5c266a7b9cd5bc95de62f8beafc5a">&#9670;&#160;</a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;</td> <td class="paramname"><span class="paramname"><em>right</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Overload of <code>operator!=</code> to compare two video modes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">left</td><td>Left operand (a video mode) </td></tr>
<tr><td class="paramname">right</td><td>Right operand (a video mode)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if modes are different </dd></dl>
</div>
</div>
<a id="a54cc77c0b6c4b133e0147a43d6829b13" name="a54cc77c0b6c4b133e0147a43d6829b13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54cc77c0b6c4b133e0147a43d6829b13">&#9670;&#160;</a></span>operator&lt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator&lt; </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;</td> <td class="paramname"><span class="paramname"><em>right</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Overload of <code>operator&lt;</code> to compare video modes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">left</td><td>Left operand (a video mode) </td></tr>
<tr><td class="paramname">right</td><td>Right operand (a video mode)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if <code>left</code> is lesser than <code>right</code> </dd></dl>
</div>
</div>
<a id="aa094b7b9ae4c0194892ebda7b4b9bb37" name="aa094b7b9ae4c0194892ebda7b4b9bb37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa094b7b9ae4c0194892ebda7b4b9bb37">&#9670;&#160;</a></span>operator&lt;=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator&lt;= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;</td> <td class="paramname"><span class="paramname"><em>right</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Overload of <code>operator&lt;=</code> to compare video modes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">left</td><td>Left operand (a video mode) </td></tr>
<tr><td class="paramname">right</td><td>Right operand (a video mode)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if <code>left</code> is lesser or equal than <code>right</code> </dd></dl>
</div>
</div>
<a id="aca24086fd94d11014f3a0b5ca9a3acd6" name="aca24086fd94d11014f3a0b5ca9a3acd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca24086fd94d11014f3a0b5ca9a3acd6">&#9670;&#160;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;</td> <td class="paramname"><span class="paramname"><em>right</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Overload of <code>operator==</code> to compare two video modes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">left</td><td>Left operand (a video mode) </td></tr>
<tr><td class="paramname">right</td><td>Right operand (a video mode)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if modes are equal </dd></dl>
</div>
</div>
<a id="a5b894cab5f2a3a14597e4c6d200179a4" name="a5b894cab5f2a3a14597e4c6d200179a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b894cab5f2a3a14597e4c6d200179a4">&#9670;&#160;</a></span>operator&gt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator&gt; </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;</td> <td class="paramname"><span class="paramname"><em>right</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Overload of <code>operator&gt;</code> to compare video modes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">left</td><td>Left operand (a video mode) </td></tr>
<tr><td class="paramname">right</td><td>Right operand (a video mode)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if <code>left</code> is greater than <code>right</code> </dd></dl>
</div>
</div>
<a id="a6e3d91683fcabb88c5b640e9884fe3df" name="a6e3d91683fcabb88c5b640e9884fe3df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e3d91683fcabb88c5b640e9884fe3df">&#9670;&#160;</a></span>operator&gt;=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool operator&gt;= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;</td> <td class="paramname"><span class="paramname"><em>left</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classsf_1_1VideoMode.html">VideoMode</a> &amp;</td> <td class="paramname"><span class="paramname"><em>right</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Overload of <code>operator&gt;=</code> to compare video modes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">left</td><td>Left operand (a video mode) </td></tr>
<tr><td class="paramname">right</td><td>Right operand (a video mode)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if <code>left</code> is greater or equal than <code>right</code> </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aa080f1ef96a1008d58b1920eceb189df" name="aa080f1ef96a1008d58b1920eceb189df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa080f1ef96a1008d58b1920eceb189df">&#9670;&#160;</a></span>bitsPerPixel</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int sf::VideoMode::bitsPerPixel {}</td>
</tr>
</table>
</div><div class="memdoc">
<p>Video mode pixel depth, in bits per pixels. </p>
<p class="definition">Definition at line <a class="el" href="VideoMode_8hpp_source.html#l00103">103</a> of file <a class="el" href="VideoMode_8hpp_source.html">VideoMode.hpp</a>.</p>
</div>
</div>
<a id="afa7b60723adc1c39e43075a157d35d98" name="afa7b60723adc1c39e43075a157d35d98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa7b60723adc1c39e43075a157d35d98">&#9670;&#160;</a></span>size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a> sf::VideoMode::size</td>
</tr>
</table>
</div><div class="memdoc">
<p>Video mode width and height, in pixels. </p>
<p class="definition">Definition at line <a class="el" href="VideoMode_8hpp_source.html#l00102">102</a> of file <a class="el" href="VideoMode_8hpp_source.html">VideoMode.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="VideoMode_8hpp_source.html">VideoMode.hpp</a></li>
</ul>
</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 &copy; Laurent Gomila &nbsp;::&nbsp;
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> &nbsp;::&nbsp;
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink