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/GlResource_8hpp_source.html

196 lines
21 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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_c0a853e81d6f1c1f0a3eb7a27dc24256.html">SFML</a></li><li class="navelem"><a class="el" href="dir_5cf786e58cbf7297a26339ae6e44357c.html">Window</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">GlResource.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="GlResource_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">//</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// SFML - Simple and Fast Multimedia Library</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">//</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// This software is provided &#39;as-is&#39;, without any express or implied warranty.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">// In no event will the authors be held liable for any damages arising from the use of this software.</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">//</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// including commercial applications, and to alter it and redistribute it freely,</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// subject to the following restrictions:</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">//</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">// 1. The origin of this software must not be misrepresented;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">// you must not claim that you wrote the original software.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">// If you use this software in a product, an acknowledgment</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">// in the product documentation would be appreciated but is not required.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">//</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">// 2. Altered source versions must be plainly marked as such,</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">// and must not be misrepresented as being the original software.</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">//</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">// 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment">//</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">// Headers</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &lt;<a class="code" href="Window_2Export_8hpp.html">SFML/Window/Export.hpp</a>&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacesf.html">sf</a></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>{</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="namespacesf.html#aaa41cc1b21b8a8349a5b2a0ecd560962"> 37</a></span><span class="keyword">using </span><a class="code hl_typedef" href="namespacesf.html#aaa41cc1b21b8a8349a5b2a0ecd560962">ContextDestroyCallback</a> = void (*)(<span class="keywordtype">void</span>*);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="foldopen" id="foldopen00043" data-start="{" data-end="};">
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classsf_1_1GlResource.html"> 43</a></span><span class="keyword">class </span><a class="code hl_define" href="Window_2Export_8hpp.html#a1ab885b7907ee088350359516d68be64">SFML_WINDOW_API</a> <a class="code hl_class" href="classsf_1_1GlResource.html">GlResource</a></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>{</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classsf_1_1GlResource.html#ad8fb7a0674f0f77e530dacc2a3b0dc6a"> 50</a></span> <a class="code hl_function" href="classsf_1_1GlResource.html#ad8fb7a0674f0f77e530dacc2a3b0dc6a">GlResource</a>();</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="classsf_1_1GlResource.html#af505ffd2358a82c5476f17a55525cf49"> 62</a></span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classsf_1_1GlResource.html#af505ffd2358a82c5476f17a55525cf49">registerUnsharedGlObject</a>(std::shared_ptr&lt;void&gt; <span class="keywordtype">object</span>);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="classsf_1_1GlResource.html#abd97569347bc381cb98bbc792f2f81be"> 70</a></span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classsf_1_1GlResource.html#abd97569347bc381cb98bbc792f2f81be">unregisterUnsharedGlObject</a>(std::shared_ptr&lt;void&gt; <span class="keywordtype">object</span>);</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="foldopen" id="foldopen00076" data-start="{" data-end="};">
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classsf_1_1GlResource_1_1TransientContextLock.html"> 76</a></span> <span class="keyword">class </span><a class="code hl_define" href="Window_2Export_8hpp.html#a1ab885b7907ee088350359516d68be64">SFML_WINDOW_API</a> <a class="code hl_class" href="classsf_1_1GlResource_1_1TransientContextLock.html">TransientContextLock</a></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> {</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="classsf_1_1GlResource_1_1TransientContextLock.html#a6434ee8f0380c300b361be038f37123a"> 83</a></span> <a class="code hl_function" href="classsf_1_1GlResource_1_1TransientContextLock.html#a6434ee8f0380c300b361be038f37123a">TransientContextLock</a>();</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="classsf_1_1GlResource_1_1TransientContextLock.html#a169285281b252ac8d54523b0fcc4b814"> 89</a></span> <a class="code hl_function" href="classsf_1_1GlResource_1_1TransientContextLock.html#a169285281b252ac8d54523b0fcc4b814">~TransientContextLock</a>();</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="classsf_1_1GlResource_1_1TransientContextLock.html#a402271e62092c05c629326a28e853405"> 95</a></span> <a class="code hl_function" href="classsf_1_1GlResource_1_1TransientContextLock.html#a402271e62092c05c629326a28e853405">TransientContextLock</a>(<span class="keyword">const</span> <a class="code hl_class" href="classsf_1_1GlResource_1_1TransientContextLock.html">TransientContextLock</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"><a class="line" href="classsf_1_1GlResource_1_1TransientContextLock.html#adac2b561e93b4539ca8c0c153d48aa95"> 101</a></span> <a class="code hl_class" href="classsf_1_1GlResource_1_1TransientContextLock.html">TransientContextLock</a>&amp; <a class="code hl_function" href="classsf_1_1GlResource_1_1TransientContextLock.html#adac2b561e93b4539ca8c0c153d48aa95">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classsf_1_1GlResource_1_1TransientContextLock.html">TransientContextLock</a>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> };</div>
</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <span class="comment">// Member data</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> std::shared_ptr&lt;void&gt; m_sharedContext; </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span>};</div>
</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span>} <span class="comment">// namespace sf</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="ttc" id="aWindow_2Export_8hpp_html"><div class="ttname"><a href="Window_2Export_8hpp.html">Export.hpp</a></div></div>
<div class="ttc" id="aWindow_2Export_8hpp_html_a1ab885b7907ee088350359516d68be64"><div class="ttname"><a href="Window_2Export_8hpp.html#a1ab885b7907ee088350359516d68be64">SFML_WINDOW_API</a></div><div class="ttdeci">#define SFML_WINDOW_API</div><div class="ttdef"><b>Definition</b> <a href="Window_2Export_8hpp_source.html#l00042">Window/Export.hpp:42</a></div></div>
<div class="ttc" id="aclasssf_1_1GlResource_1_1TransientContextLock_html"><div class="ttname"><a href="classsf_1_1GlResource_1_1TransientContextLock.html">sf::GlResource::TransientContextLock</a></div><div class="ttdoc">RAII helper class to temporarily lock an available context for use.</div><div class="ttdef"><b>Definition</b> <a href="#l00076">GlResource.hpp:77</a></div></div>
<div class="ttc" id="aclasssf_1_1GlResource_1_1TransientContextLock_html_a169285281b252ac8d54523b0fcc4b814"><div class="ttname"><a href="classsf_1_1GlResource_1_1TransientContextLock.html#a169285281b252ac8d54523b0fcc4b814">sf::GlResource::TransientContextLock::~TransientContextLock</a></div><div class="ttdeci">~TransientContextLock()</div><div class="ttdoc">Destructor.</div></div>
<div class="ttc" id="aclasssf_1_1GlResource_1_1TransientContextLock_html_a402271e62092c05c629326a28e853405"><div class="ttname"><a href="classsf_1_1GlResource_1_1TransientContextLock.html#a402271e62092c05c629326a28e853405">sf::GlResource::TransientContextLock::TransientContextLock</a></div><div class="ttdeci">TransientContextLock(const TransientContextLock &amp;)=delete</div><div class="ttdoc">Deleted copy constructor.</div></div>
<div class="ttc" id="aclasssf_1_1GlResource_1_1TransientContextLock_html_a6434ee8f0380c300b361be038f37123a"><div class="ttname"><a href="classsf_1_1GlResource_1_1TransientContextLock.html#a6434ee8f0380c300b361be038f37123a">sf::GlResource::TransientContextLock::TransientContextLock</a></div><div class="ttdeci">TransientContextLock()</div><div class="ttdoc">Default constructor.</div></div>
<div class="ttc" id="aclasssf_1_1GlResource_1_1TransientContextLock_html_adac2b561e93b4539ca8c0c153d48aa95"><div class="ttname"><a href="classsf_1_1GlResource_1_1TransientContextLock.html#adac2b561e93b4539ca8c0c153d48aa95">sf::GlResource::TransientContextLock::operator=</a></div><div class="ttdeci">TransientContextLock &amp; operator=(const TransientContextLock &amp;)=delete</div><div class="ttdoc">Deleted copy assignment.</div></div>
<div class="ttc" id="aclasssf_1_1GlResource_html"><div class="ttname"><a href="classsf_1_1GlResource.html">sf::GlResource</a></div><div class="ttdoc">Base class for classes that require an OpenGL context.</div><div class="ttdef"><b>Definition</b> <a href="#l00043">GlResource.hpp:44</a></div></div>
<div class="ttc" id="aclasssf_1_1GlResource_html_abd97569347bc381cb98bbc792f2f81be"><div class="ttname"><a href="classsf_1_1GlResource.html#abd97569347bc381cb98bbc792f2f81be">sf::GlResource::unregisterUnsharedGlObject</a></div><div class="ttdeci">static void unregisterUnsharedGlObject(std::shared_ptr&lt; void &gt; object)</div><div class="ttdoc">Unregister an OpenGL object from its containing context.</div></div>
<div class="ttc" id="aclasssf_1_1GlResource_html_ad8fb7a0674f0f77e530dacc2a3b0dc6a"><div class="ttname"><a href="classsf_1_1GlResource.html#ad8fb7a0674f0f77e530dacc2a3b0dc6a">sf::GlResource::GlResource</a></div><div class="ttdeci">GlResource()</div><div class="ttdoc">Default constructor.</div></div>
<div class="ttc" id="aclasssf_1_1GlResource_html_af505ffd2358a82c5476f17a55525cf49"><div class="ttname"><a href="classsf_1_1GlResource.html#af505ffd2358a82c5476f17a55525cf49">sf::GlResource::registerUnsharedGlObject</a></div><div class="ttdeci">static void registerUnsharedGlObject(std::shared_ptr&lt; void &gt; object)</div><div class="ttdoc">Register an OpenGL object to be destroyed when its containing context is destroyed.</div></div>
<div class="ttc" id="anamespacesf_html"><div class="ttname"><a href="namespacesf.html">sf</a></div><div class="ttdef"><b>Definition</b> <a href="AudioResource_8hpp_source.html#l00035">AudioResource.hpp:36</a></div></div>
<div class="ttc" id="anamespacesf_html_aaa41cc1b21b8a8349a5b2a0ecd560962"><div class="ttname"><a href="namespacesf.html#aaa41cc1b21b8a8349a5b2a0ecd560962">sf::ContextDestroyCallback</a></div><div class="ttdeci">void(*)(void *) ContextDestroyCallback</div><div class="ttdef"><b>Definition</b> <a href="#l00037">GlResource.hpp:37</a></div></div>
</div><!-- fragment --></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