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

574 lines
30 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_1Context.html">Context</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="classsf_1_1Context-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">sf::Context Class Reference<div class="ingroups"><a class="el" href="group__window.html">Window module</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Class holding a valid drawing context.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Context_8hpp_source.html">SFML/Window/Context.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for sf::Context:</div>
<div class="dyncontent">
<div class="center">
<img src="classsf_1_1Context.png" usemap="#sf::Context_map" alt=""/>
<map id="sf::Context_map" name="sf::Context_map">
<area href="classsf_1_1GlResource.html" title="Base class for classes that require an OpenGL context." alt="sf::GlResource" shape="rect" coords="0,0,94,24"/>
</map>
</div></div>
<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:aba22797a790706ca2c5c04ee39f2b555" id="r_aba22797a790706ca2c5c04ee39f2b555"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aba22797a790706ca2c5c04ee39f2b555">Context</a> ()</td></tr>
<tr class="memdesc:aba22797a790706ca2c5c04ee39f2b555"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:aba22797a790706ca2c5c04ee39f2b555"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a805b1bbdb3e52b1fda7c9bf2cd6ca86b" id="r_a805b1bbdb3e52b1fda7c9bf2cd6ca86b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a805b1bbdb3e52b1fda7c9bf2cd6ca86b">~Context</a> ()</td></tr>
<tr class="memdesc:a805b1bbdb3e52b1fda7c9bf2cd6ca86b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a805b1bbdb3e52b1fda7c9bf2cd6ca86b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a440bf2797184d9b32e62d73a0ee25d5d" id="r_a440bf2797184d9b32e62d73a0ee25d5d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a440bf2797184d9b32e62d73a0ee25d5d">Context</a> (const <a class="el" href="classsf_1_1Context.html">Context</a> &amp;)=delete</td></tr>
<tr class="memdesc:a440bf2797184d9b32e62d73a0ee25d5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deleted copy constructor. <br /></td></tr>
<tr class="separator:a440bf2797184d9b32e62d73a0ee25d5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a097dbb40552a5668b48652a4c814aaaf" id="r_a097dbb40552a5668b48652a4c814aaaf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Context.html">Context</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a097dbb40552a5668b48652a4c814aaaf">operator=</a> (const <a class="el" href="classsf_1_1Context.html">Context</a> &amp;)=delete</td></tr>
<tr class="memdesc:a097dbb40552a5668b48652a4c814aaaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deleted copy assignment. <br /></td></tr>
<tr class="separator:a097dbb40552a5668b48652a4c814aaaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f3a0ea8319ab541e8f523343f411b79" id="r_a8f3a0ea8319ab541e8f523343f411b79"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8f3a0ea8319ab541e8f523343f411b79">Context</a> (<a class="el" href="classsf_1_1Context.html">Context</a> &amp;&amp;context) noexcept</td></tr>
<tr class="memdesc:a8f3a0ea8319ab541e8f523343f411b79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move constructor. <br /></td></tr>
<tr class="separator:a8f3a0ea8319ab541e8f523343f411b79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa185333dde2d69041b0c6ea37a9f4f98" id="r_aa185333dde2d69041b0c6ea37a9f4f98"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Context.html">Context</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa185333dde2d69041b0c6ea37a9f4f98">operator=</a> (<a class="el" href="classsf_1_1Context.html">Context</a> &amp;&amp;context) noexcept</td></tr>
<tr class="memdesc:aa185333dde2d69041b0c6ea37a9f4f98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move assignment. <br /></td></tr>
<tr class="separator:aa185333dde2d69041b0c6ea37a9f4f98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0806f915ea81ae1f4e8135a7a3696562" id="r_a0806f915ea81ae1f4e8135a7a3696562"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0806f915ea81ae1f4e8135a7a3696562">setActive</a> (bool active)</td></tr>
<tr class="memdesc:a0806f915ea81ae1f4e8135a7a3696562"><td class="mdescLeft">&#160;</td><td class="mdescRight">Activate or deactivate explicitly the context. <br /></td></tr>
<tr class="separator:a0806f915ea81ae1f4e8135a7a3696562"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5aace0ecfcf9552e97eed9ae88d01f71" id="r_a5aace0ecfcf9552e97eed9ae88d01f71"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structsf_1_1ContextSettings.html">ContextSettings</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5aace0ecfcf9552e97eed9ae88d01f71">getSettings</a> () const</td></tr>
<tr class="memdesc:a5aace0ecfcf9552e97eed9ae88d01f71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the settings of the context. <br /></td></tr>
<tr class="separator:a5aace0ecfcf9552e97eed9ae88d01f71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b76f5cb410f9b8180310daa759272f8" id="r_a6b76f5cb410f9b8180310daa759272f8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6b76f5cb410f9b8180310daa759272f8">Context</a> (const <a class="el" href="structsf_1_1ContextSettings.html">ContextSettings</a> &amp;settings, <a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a> size)</td></tr>
<tr class="memdesc:a6b76f5cb410f9b8180310daa759272f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a in-memory context. <br /></td></tr>
<tr class="separator:a6b76f5cb410f9b8180310daa759272f8"><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:a95a91e99cffafb0a2109efa28483246c" id="r_a95a91e99cffafb0a2109efa28483246c"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a95a91e99cffafb0a2109efa28483246c">isExtensionAvailable</a> (std::string_view name)</td></tr>
<tr class="memdesc:a95a91e99cffafb0a2109efa28483246c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether a given OpenGL extension is available. <br /></td></tr>
<tr class="separator:a95a91e99cffafb0a2109efa28483246c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a998980d311effdf6223ce40d934c23c3" id="r_a998980d311effdf6223ce40d934c23c3"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacesf.html#a321a688c79d6cac3be7640f6ecd594d3">GlFunctionPointer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a998980d311effdf6223ce40d934c23c3">getFunction</a> (const char *name)</td></tr>
<tr class="memdesc:a998980d311effdf6223ce40d934c23c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the address of an OpenGL function. <br /></td></tr>
<tr class="separator:a998980d311effdf6223ce40d934c23c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31bc6509779067b21d13208ffe85d5ca" id="r_a31bc6509779067b21d13208ffe85d5ca"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classsf_1_1Context.html">Context</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a31bc6509779067b21d13208ffe85d5ca">getActiveContext</a> ()</td></tr>
<tr class="memdesc:a31bc6509779067b21d13208ffe85d5ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the currently active context. <br /></td></tr>
<tr class="separator:a31bc6509779067b21d13208ffe85d5ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb15bd398a3b2995e48032ff74f5ad6e" id="r_adb15bd398a3b2995e48032ff74f5ad6e"><td class="memItemLeft" align="right" valign="top">static std::uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adb15bd398a3b2995e48032ff74f5ad6e">getActiveContextId</a> ()</td></tr>
<tr class="memdesc:adb15bd398a3b2995e48032ff74f5ad6e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the currently active context's ID. <br /></td></tr>
<tr class="separator:adb15bd398a3b2995e48032ff74f5ad6e"><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>Class holding a valid drawing context. </p>
<p>If you need to make OpenGL calls without having an active window (like in a thread), you can use an instance of this class to get a valid context.</p>
<p>Having a valid context is necessary for <em>every</em> OpenGL call.</p>
<p>Note that a context is only active in its current thread, if you create a new thread it will have no valid context by default.</p>
<p>To use a <code><a class="el" href="classsf_1_1Context.html" title="Class holding a valid drawing context.">sf::Context</a></code> instance, just construct it and let it live as long as you need a valid context. No explicit activation is needed, all it has to do is to exist. Its destructor will take care of deactivating and freeing all the attached resources.</p>
<p>Usage example: </p><div class="fragment"><div class="line"><span class="keywordtype">void</span> threadFunction(<span class="keywordtype">void</span>*)</div>
<div class="line">{</div>
<div class="line"> <a class="code hl_class" href="classsf_1_1Context.html">sf::Context</a> context;</div>
<div class="line"> <span class="comment">// from now on, you have a valid context</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">// you can make OpenGL calls</span></div>
<div class="line"> glClear(GL_DEPTH_BUFFER_BIT);</div>
<div class="line">}</div>
<div class="line"><span class="comment">// the context is automatically deactivated and destroyed</span></div>
<div class="line"><span class="comment">// by the sf::Context destructor</span></div>
<div class="ttc" id="aclasssf_1_1Context_html"><div class="ttname"><a href="classsf_1_1Context.html">sf::Context</a></div><div class="ttdoc">Class holding a valid drawing context.</div><div class="ttdef"><b>Definition</b> <a href="Context_8hpp_source.html#l00057">Context.hpp:58</a></div></div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="Context_8hpp_source.html#l00057">57</a> of file <a class="el" href="Context_8hpp_source.html">Context.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aba22797a790706ca2c5c04ee39f2b555" name="aba22797a790706ca2c5c04ee39f2b555"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba22797a790706ca2c5c04ee39f2b555">&#9670;&#160;</a></span>Context() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::Context::Context </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
<p>The constructor creates and activates the context </p>
</div>
</div>
<a id="a805b1bbdb3e52b1fda7c9bf2cd6ca86b" name="a805b1bbdb3e52b1fda7c9bf2cd6ca86b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a805b1bbdb3e52b1fda7c9bf2cd6ca86b">&#9670;&#160;</a></span>~Context()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::Context::~Context </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>The destructor deactivates and destroys the context </p>
</div>
</div>
<a id="a440bf2797184d9b32e62d73a0ee25d5d" name="a440bf2797184d9b32e62d73a0ee25d5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a440bf2797184d9b32e62d73a0ee25d5d">&#9670;&#160;</a></span>Context() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sf::Context::Context </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1Context.html">Context</a> &amp;</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">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deleted copy constructor. </p>
</div>
</div>
<a id="a8f3a0ea8319ab541e8f523343f411b79" name="a8f3a0ea8319ab541e8f523343f411b79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f3a0ea8319ab541e8f523343f411b79">&#9670;&#160;</a></span>Context() <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">sf::Context::Context </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1Context.html">Context</a> &amp;&amp;</td> <td class="paramname"><span class="paramname"><em>context</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move constructor. </p>
</div>
</div>
<a id="a6b76f5cb410f9b8180310daa759272f8" name="a6b76f5cb410f9b8180310daa759272f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b76f5cb410f9b8180310daa759272f8">&#9670;&#160;</a></span>Context() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::Context::Context </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structsf_1_1ContextSettings.html">ContextSettings</a> &amp;</td> <td class="paramname"><span class="paramname"><em>settings</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a></td> <td class="paramname"><span class="paramname"><em>size</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a in-memory context. </p>
<p>This constructor is for internal use, you don't need to bother with it.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>Creation parameters </td></tr>
<tr><td class="paramname">size</td><td>Back buffer size </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a31bc6509779067b21d13208ffe85d5ca" name="a31bc6509779067b21d13208ffe85d5ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a31bc6509779067b21d13208ffe85d5ca">&#9670;&#160;</a></span>getActiveContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static const <a class="el" href="classsf_1_1Context.html">Context</a> * sf::Context::getActiveContext </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 currently active context. </p>
<p>This function will only return <code><a class="el" href="classsf_1_1Context.html" title="Class holding a valid drawing context.">sf::Context</a></code> objects. Contexts created e.g. by RenderTargets or for internal use will not be returned by this function.</p>
<dl class="section return"><dt>Returns</dt><dd>The currently active context or <code>nullptr</code> if none is active </dd></dl>
</div>
</div>
<a id="adb15bd398a3b2995e48032ff74f5ad6e" name="adb15bd398a3b2995e48032ff74f5ad6e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb15bd398a3b2995e48032ff74f5ad6e">&#9670;&#160;</a></span>getActiveContextId()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::uint64_t sf::Context::getActiveContextId </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 currently active context's ID. </p>
<p>The context ID is used to identify contexts when managing unshareable OpenGL resources.</p>
<dl class="section return"><dt>Returns</dt><dd>The active context's ID or 0 if no context is currently active </dd></dl>
</div>
</div>
<a id="a998980d311effdf6223ce40d934c23c3" name="a998980d311effdf6223ce40d934c23c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a998980d311effdf6223ce40d934c23c3">&#9670;&#160;</a></span>getFunction()</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="namespacesf.html#a321a688c79d6cac3be7640f6ecd594d3">GlFunctionPointer</a> sf::Context::getFunction </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</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 address of an OpenGL function. </p>
<p>On Windows when not using OpenGL ES, a context must be active for this function to succeed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name of the function to get the address of</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Address of the OpenGL function, 0 on failure </dd></dl>
</div>
</div>
<a id="a5aace0ecfcf9552e97eed9ae88d01f71" name="a5aace0ecfcf9552e97eed9ae88d01f71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5aace0ecfcf9552e97eed9ae88d01f71">&#9670;&#160;</a></span>getSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structsf_1_1ContextSettings.html">ContextSettings</a> &amp; sf::Context::getSettings </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>Get the settings of the context. </p>
<p>Note that these settings may be different than the ones passed to the constructor; they are indeed adjusted if the original settings are not directly supported by the system.</p>
<dl class="section return"><dt>Returns</dt><dd>Structure containing the settings </dd></dl>
</div>
</div>
<a id="a95a91e99cffafb0a2109efa28483246c" name="a95a91e99cffafb0a2109efa28483246c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95a91e99cffafb0a2109efa28483246c">&#9670;&#160;</a></span>isExtensionAvailable()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool sf::Context::isExtensionAvailable </td>
<td>(</td>
<td class="paramtype">std::string_view</td> <td class="paramname"><span class="paramname"><em>name</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>Check whether a given OpenGL extension is available. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name of the extension to check for</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if available, <code>false</code> if unavailable </dd></dl>
</div>
</div>
<a id="a097dbb40552a5668b48652a4c814aaaf" name="a097dbb40552a5668b48652a4c814aaaf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a097dbb40552a5668b48652a4c814aaaf">&#9670;&#160;</a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Context.html">Context</a> &amp; sf::Context::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1Context.html">Context</a> &amp;</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">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Deleted copy assignment. </p>
</div>
</div>
<a id="aa185333dde2d69041b0c6ea37a9f4f98" name="aa185333dde2d69041b0c6ea37a9f4f98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa185333dde2d69041b0c6ea37a9f4f98">&#9670;&#160;</a></span>operator=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Context.html">Context</a> &amp; sf::Context::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1Context.html">Context</a> &amp;&amp;</td> <td class="paramname"><span class="paramname"><em>context</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move assignment. </p>
</div>
</div>
<a id="a0806f915ea81ae1f4e8135a7a3696562" name="a0806f915ea81ae1f4e8135a7a3696562"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0806f915ea81ae1f4e8135a7a3696562">&#9670;&#160;</a></span>setActive()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sf::Context::setActive </td>
<td>(</td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>active</em></span></td><td>)</td>
<td></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>Activate or deactivate explicitly the context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">active</td><td><code>true</code> to activate, <code>false</code> to deactivate</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success, <code>false</code> on failure </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Context_8hpp_source.html">Context.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