diff options
Diffstat (limited to 'doc/html/classsf_1_1Context.htm')
| -rwxr-xr-x | doc/html/classsf_1_1Context.htm | 193 |
1 files changed, 193 insertions, 0 deletions
diff --git a/doc/html/classsf_1_1Context.htm b/doc/html/classsf_1_1Context.htm new file mode 100755 index 0000000..c2d5c44 --- /dev/null +++ b/doc/html/classsf_1_1Context.htm @@ -0,0 +1,193 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> + <head> + <title>SFML - Simple and Fast Multimedia Library</title> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" /> + <link href="doxygen.css" rel="stylesheet" type="text/css" /> + <link href="tabs.css" rel="stylesheet" type="text/css" /> + </head> + <body> + <div id="logo"> + <img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" /> + </div> +<!-- Generated by Doxygen 1.5.2 --> +<div class="tabs"> + <ul> + <li><a href="index.htm"><span>Main Page</span></a></li> + <li><a href="namespaces.htm"><span>Namespaces</span></a></li> + <li class="current"><a href="classes.htm"><span>Classes</span></a></li> + <li><a href="files.htm"><span>Files</span></a></li> + </ul> +</div> +<div class="tabs"> + <ul> + <li><a href="classes.htm"><span>Alphabetical List</span></a></li> + <li><a href="annotated.htm"><span>Class List</span></a></li> + <li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li> + <li><a href="functions.htm"><span>Class Members</span></a></li> + </ul> +</div> +<div class="nav"> +<a class="el" href="namespacesf.htm">sf</a>::<a class="el" href="classsf_1_1Context.htm">Context</a></div> +<h1>sf::Context Class Reference</h1><!-- doxytag: class="sf::Context" --><!-- doxytag: inherits="sf::NonCopyable" -->Class wrapping an OpenGL context. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="Context_8hpp-source.htm">Context.hpp</a>></code> +<p> +<p>Inheritance diagram for sf::Context: +<p><center><img src="classsf_1_1Context.png" usemap="#sf::Context_map" border="0" alt=""></center> +<map name="sf::Context_map"> +<area href="structsf_1_1NonCopyable.htm" alt="sf::NonCopyable" shape="rect" coords="0,0,105,24"> +</map> +<a href="classsf_1_1Context-members.htm">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Context.htm#ba22797a790706ca2c5c04ee39f2b555">Context</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor, create the context. <a href="#ba22797a790706ca2c5c04ee39f2b555"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Context.htm#805b1bbdb3e52b1fda7c9bf2cd6ca86b">~Context</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor, destroy the context. <a href="#805b1bbdb3e52b1fda7c9bf2cd6ca86b"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Context.htm#b1d95acf0b2e5f1464c3a0471a54a8f7">SetActive</a> (bool Active)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Activate or deactivate the context. <a href="#b1d95acf0b2e5f1464c3a0471a54a8f7"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Context.htm#04f1ee1fa35169aae7b941e0d9a99bf3">IsContextActive</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if there's a context bound to the current thread. <a href="#04f1ee1fa35169aae7b941e0d9a99bf3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classsf_1_1Context.htm">Context</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Context.htm#0b5e14e9d48c6ef888b88a5729ee34e4">GetGlobal</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the global context. <a href="#0b5e14e9d48c6ef888b88a5729ee34e4"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Class wrapping an OpenGL context. +<p> +All SFML windows already have their own context, so this class is more a helper for specific issues involving OpenGL and multi-threading. It's meant to be used internally. +<p> + +<p> +Definition at line <a class="el" href="Context_8hpp-source.htm#l00049">49</a> of file <a class="el" href="Context_8hpp-source.htm">Context.hpp</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="ba22797a790706ca2c5c04ee39f2b555"></a><!-- doxytag: member="sf::Context::Context" ref="ba22797a790706ca2c5c04ee39f2b555" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">sf::Context::Context </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Default constructor, create the context. +<p> + +</div> +</div><p> +<a class="anchor" name="805b1bbdb3e52b1fda7c9bf2cd6ca86b"></a><!-- doxytag: member="sf::Context::~Context" ref="805b1bbdb3e52b1fda7c9bf2cd6ca86b" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">sf::Context::~Context </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Destructor, destroy the context. +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="b1d95acf0b2e5f1464c3a0471a54a8f7"></a><!-- doxytag: member="sf::Context::SetActive" ref="b1d95acf0b2e5f1464c3a0471a54a8f7" args="(bool Active)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void sf::Context::SetActive </td> + <td>(</td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>Active</em> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Activate or deactivate the context. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>Active</em> </td><td>: True to activate the context, false to deactivate it </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="04f1ee1fa35169aae7b941e0d9a99bf3"></a><!-- doxytag: member="sf::Context::IsContextActive" ref="04f1ee1fa35169aae7b941e0d9a99bf3" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static bool sf::Context::IsContextActive </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Check if there's a context bound to the current thread. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if there's a context bound to the current thread </dd></dl> + +</div> +</div><p> +<a class="anchor" name="0b5e14e9d48c6ef888b88a5729ee34e4"></a><!-- doxytag: member="sf::Context::GetGlobal" ref="0b5e14e9d48c6ef888b88a5729ee34e4" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classsf_1_1Context.htm">Context</a>& sf::Context::GetGlobal </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the global context. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to the global context </dd></dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="Context_8hpp-source.htm">Context.hpp</a></ul> + + <p id="footer"> + :: Copyright © 2007-2008 Laurent Gomila, all rights reserved :: + Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> :: + </p> + + </body> +</html> |