diff options
Diffstat (limited to 'doc/html/classsf_1_1Context.htm')
| -rwxr-xr-x | doc/html/classsf_1_1Context.htm | 120 |
1 files changed, 69 insertions, 51 deletions
diff --git a/doc/html/classsf_1_1Context.htm b/doc/html/classsf_1_1Context.htm index c2d5c44..f9a003a 100755 --- a/doc/html/classsf_1_1Context.htm +++ b/doc/html/classsf_1_1Context.htm @@ -10,35 +10,44 @@ <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> +<!-- Generated by Doxygen 1.5.8 --> +<div class="navigation" id="top"> + <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="annotated.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="annotated.htm"><span>Class List</span></a></li> + <li><a href="classes.htm"><span>Class Index</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="navpath"><b>sf</b>::<a class="el" href="classsf_1_1Context.htm">Context</a> + </div> </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> +<div class="contents"> <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: +<div class="dynheader"> +Inheritance diagram for sf::Context:</div> +<div class="dynsection"> + <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> +</div> + +<p> <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> @@ -52,21 +61,19 @@ <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="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Context.htm#73f11548c8501093558b6052f48f0e27">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">Check if there's a context bound to the current thread. <a href="#73f11548c8501093558b6052f48f0e27"></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#2a92bd6864df0f75d33bd38ac1b81692">GetGlobal</a> ()</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the global context. <a href="#0b5e14e9d48c6ef888b88a5729ee34e4"></a><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the global context. <a href="#2a92bd6864df0f75d33bd38ac1b81692"></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> +<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>.</p> +<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"> @@ -76,7 +83,7 @@ Definition at line <a class="el" href="Context_8hpp-source.htm#l00049">49</a> of <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> @@ -86,6 +93,8 @@ Definition at line <a class="el" href="Context_8hpp-source.htm#l00049">49</a> of Default constructor, create the context. <p> +<p>Definition at line <a class="el" href="Context_8cpp-source.htm#l00044">44</a> of file <a class="el" href="Context_8cpp-source.htm">Context.cpp</a>.</p> + </div> </div><p> <a class="anchor" name="805b1bbdb3e52b1fda7c9bf2cd6ca86b"></a><!-- doxytag: member="sf::Context::~Context" ref="805b1bbdb3e52b1fda7c9bf2cd6ca86b" args="()" --> @@ -97,7 +106,7 @@ Default constructor, create the context. <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> @@ -107,46 +116,45 @@ Default constructor, create the context. Destructor, destroy the context. <p> +<p>Definition at line <a class="el" href="Context_8cpp-source.htm#l00053">53</a> of file <a class="el" href="Context_8cpp-source.htm">Context.cpp</a>.</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)" --> +<a class="anchor" name="2a92bd6864df0f75d33bd38ac1b81692"></a><!-- doxytag: member="sf::Context::GetGlobal" ref="2a92bd6864df0f75d33bd38ac1b81692" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">void sf::Context::SetActive </td> + <td class="memname"><a class="el" href="classsf_1_1Context.htm">Context</a> & sf::Context::GetGlobal </td> <td>(</td> - <td class="paramtype">bool </td> - <td class="paramname"> <em>Active</em> </td> + <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> -Activate or deactivate the context. +Get the global 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> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to the global context </dd></dl> + +<p>Definition at line <a class="el" href="Context_8cpp-source.htm#l00080">80</a> of file <a class="el" href="Context_8cpp-source.htm">Context.cpp</a>.</p> </div> </div><p> -<a class="anchor" name="04f1ee1fa35169aae7b941e0d9a99bf3"></a><!-- doxytag: member="sf::Context::IsContextActive" ref="04f1ee1fa35169aae7b941e0d9a99bf3" args="()" --> +<a class="anchor" name="73f11548c8501093558b6052f48f0e27"></a><!-- doxytag: member="sf::Context::IsContextActive" ref="73f11548c8501093558b6052f48f0e27" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">static bool sf::Context::IsContextActive </td> + <td class="memname">bool sf::Context::IsContextActive </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"><code> [static]</code></td> + <td><code> [static]</code></td> </tr> </table> </div> @@ -157,32 +165,42 @@ 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> +<p>Definition at line <a class="el" href="Context_8cpp-source.htm#l00071">71</a> of file <a class="el" href="Context_8cpp-source.htm">Context.cpp</a>.</p> + </div> </div><p> -<a class="anchor" name="0b5e14e9d48c6ef888b88a5729ee34e4"></a><!-- doxytag: member="sf::Context::GetGlobal" ref="0b5e14e9d48c6ef888b88a5729ee34e4" args="()" --> +<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">static <a class="el" href="classsf_1_1Context.htm">Context</a>& sf::Context::GetGlobal </td> + <td class="memname">void sf::Context::SetActive </td> <td>(</td> - <td class="paramname"> </td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>Active</em> </td> <td> ) </td> - <td width="100%"><code> [static]</code></td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -Get the global context. +Activate or deactivate the context. <p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to the global context </dd></dl> +<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> + +<p>Definition at line <a class="el" href="Context_8cpp-source.htm#l00062">62</a> of file <a class="el" href="Context_8cpp-source.htm">Context.cpp</a>.</p> </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> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="Context_8hpp-source.htm">Context.hpp</a><li><a class="el" href="Context_8cpp-source.htm">Context.cpp</a></ul> +</div> <p id="footer"> :: Copyright © 2007-2008 Laurent Gomila, all rights reserved :: |