diff options
Diffstat (limited to 'doc/html/classsf_1_1Thread.htm')
| -rwxr-xr-x | doc/html/classsf_1_1Thread.htm | 110 |
1 files changed, 65 insertions, 45 deletions
diff --git a/doc/html/classsf_1_1Thread.htm b/doc/html/classsf_1_1Thread.htm index 554c059..db0dc69 100755 --- a/doc/html/classsf_1_1Thread.htm +++ b/doc/html/classsf_1_1Thread.htm @@ -10,31 +10,37 @@ <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_1Thread.htm">Thread</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_1Thread.htm">Thread</a></div> +<div class="contents"> <h1>sf::Thread Class Reference</h1><!-- doxytag: class="sf::Thread" --><!-- doxytag: inherits="sf::NonCopyable" --><a class="el" href="classsf_1_1Thread.htm" title="Thread defines an easy way to manipulate a thread.">Thread</a> defines an easy way to manipulate a thread. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="Win32_2Thread_8hpp-source.htm">Thread.hpp</a>></code> <p> -<p>Inheritance diagram for sf::Thread: +<div class="dynheader"> +Inheritance diagram for sf::Thread:</div> +<div class="dynsection"> + <p><center><img src="classsf_1_1Thread.png" usemap="#sf::Thread_map" border="0" alt=""></center> <map name="sf::Thread_map"> <area href="structsf_1_1NonCopyable.htm" alt="sf::NonCopyable" shape="rect" coords="81,0,233,24"> @@ -43,19 +49,22 @@ <area href="classsf_1_1SoundBufferRecorder.htm" alt="sf::SoundBufferRecorder" shape="rect" coords="0,168,152,192"> <area href="classsf_1_1Music.htm" alt="sf::Music" shape="rect" coords="162,168,314,192"> </map> +</div> + +<p> <a href="classsf_1_1Thread-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 Types</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4d5107cbba1e7dd574f58552931e54ce"></a><!-- doxytag: member="sf::Thread::FuncType" ref="4d5107cbba1e7dd574f58552931e54ce" args="(void *)" --> -typedef void(*) </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Thread.htm#4d5107cbba1e7dd574f58552931e54ce">FuncType</a> (void *)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ab6e6f11eb38f106cd7c1149763a11b8"></a><!-- doxytag: member="sf::Thread::FuncType" ref="ab6e6f11eb38f106cd7c1149763a11b8" args=")(void *)" --> +typedef void(* </td><td class="memItemRight" valign="bottom"><b>FuncType</b> )(void *)</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_1Thread.htm#5a5f6a41323c0983d6c0f4e496f4a173">Thread</a> (<a class="el" href="classsf_1_1Thread.htm#4d5107cbba1e7dd574f58552931e54ce">FuncType</a> Function, void *UserData=NULL)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Thread.htm#5a5f6a41323c0983d6c0f4e496f4a173">Thread</a> (FuncType Function, void *UserData=NULL)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct the thread from a function pointer. <a href="#5a5f6a41323c0983d6c0f4e496f4a173"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Thread.htm#8ba00c004839bdd93fbe1cda69eaff77">~Thread</a> ()</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Thread.htm#f77942fc1730af7c31bc4c3a913a9c1d">~Thread</a> ()</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#8ba00c004839bdd93fbe1cda69eaff77"></a><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#f77942fc1730af7c31bc4c3a913a9c1d"></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_1Thread.htm#046df871f73d3cf452d1c72bcc143642">Launch</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create and run the thread. <a href="#046df871f73d3cf452d1c72bcc143642"></a><br></td></tr> @@ -76,10 +85,8 @@ typedef void(*) </td><td class="memItemRight" valign="bottom"><a class="el" There are two ways to use <a class="el" href="classsf_1_1Thread.htm" title="Thread defines an easy way to manipulate a thread.">Thread</a> :<ul> <li>Inherit from it and override the Run() virtual function</li><li>Construct a <a class="el" href="classsf_1_1Thread.htm" title="Thread defines an easy way to manipulate a thread.">Thread</a> instance and pass it a function pointer to call </li></ul> -<p> - -<p> -Definition at line <a class="el" href="Win32_2Thread_8hpp-source.htm#l00044">44</a> of file <a class="el" href="Win32_2Thread_8hpp-source.htm">Win32/Thread.hpp</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<p>Definition at line <a class="el" href="Win32_2Thread_8hpp-source.htm#l00044">44</a> of file <a class="el" href="Win32_2Thread_8hpp-source.htm">Win32/Thread.hpp</a>.</p> +<hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="5a5f6a41323c0983d6c0f4e496f4a173"></a><!-- doxytag: member="sf::Thread::Thread" ref="5a5f6a41323c0983d6c0f4e496f4a173" args="(FuncType Function, void *UserData=NULL)" --> <div class="memitem"> <div class="memproto"> @@ -87,7 +94,7 @@ Definition at line <a class="el" href="Win32_2Thread_8hpp-source.htm#l00044">44< <tr> <td class="memname">sf::Thread::Thread </td> <td>(</td> - <td class="paramtype"><a class="el" href="classsf_1_1Thread.htm#4d5107cbba1e7dd574f58552931e54ce">FuncType</a> </td> + <td class="paramtype">Thread::FuncType </td> <td class="paramname"> <em>Function</em>, </td> </tr> <tr> @@ -99,7 +106,7 @@ Definition at line <a class="el" href="Win32_2Thread_8hpp-source.htm#l00044">44< <tr> <td></td> <td>)</td> - <td></td><td></td><td width="100%"></td> + <td></td><td></td><td></td> </tr> </table> </div> @@ -115,18 +122,20 @@ Construct the thread from a function pointer. </table> </dl> +<p>Definition at line <a class="el" href="Thread_8cpp-source.htm#l00050">50</a> of file <a class="el" href="Thread_8cpp-source.htm">Thread.cpp</a>.</p> + </div> </div><p> -<a class="anchor" name="8ba00c004839bdd93fbe1cda69eaff77"></a><!-- doxytag: member="sf::Thread::~Thread" ref="8ba00c004839bdd93fbe1cda69eaff77" args="()" --> +<a class="anchor" name="f77942fc1730af7c31bc4c3a913a9c1d"></a><!-- doxytag: member="sf::Thread::~Thread" ref="f77942fc1730af7c31bc4c3a913a9c1d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">virtual sf::Thread::~Thread </td> + <td class="memname">sf::Thread::~Thread </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"><code> [virtual]</code></td> + <td><code> [virtual]</code></td> </tr> </table> </div> @@ -136,6 +145,8 @@ Construct the thread from a function pointer. Virtual destructor. <p> +<p>Definition at line <a class="el" href="Thread_8cpp-source.htm#l00062">62</a> of file <a class="el" href="Thread_8cpp-source.htm">Thread.cpp</a>.</p> + </div> </div><p> <a class="anchor" name="d719b83ce7b02b56db919d423a69f1a2"></a><!-- doxytag: member="sf::Thread::Thread" ref="d719b83ce7b02b56db919d423a69f1a2" args="()" --> @@ -147,7 +158,7 @@ Virtual destructor. <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"><code> [protected]</code></td> + <td><code> [protected]</code></td> </tr> </table> </div> @@ -157,6 +168,8 @@ Virtual destructor. Default constructor. <p> +<p>Definition at line <a class="el" href="Thread_8cpp-source.htm#l00038">38</a> of file <a class="el" href="Thread_8cpp-source.htm">Thread.cpp</a>.</p> + </div> </div><p> <hr><h2>Member Function Documentation</h2> @@ -169,7 +182,7 @@ Default constructor. <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> @@ -179,52 +192,59 @@ Default constructor. Create and run the thread. <p> +<p>Definition at line <a class="el" href="Thread_8cpp-source.htm#l00073">73</a> of file <a class="el" href="Thread_8cpp-source.htm">Thread.cpp</a>.</p> + </div> </div><p> -<a class="anchor" name="67f3c609fdf99688531dbfae461ea4d2"></a><!-- doxytag: member="sf::Thread::Wait" ref="67f3c609fdf99688531dbfae461ea4d2" args="()" --> +<a class="anchor" name="603d9493c6a845188f05c2eca48dc41b"></a><!-- doxytag: member="sf::Thread::Terminate" ref="603d9493c6a845188f05c2eca48dc41b" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">void sf::Thread::Wait </td> + <td class="memname">void sf::Thread::Terminate </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -Wait until the thread finishes. +Terminate the thread Terminating a thread with this function is not safe, you should rather try to make the thread function terminate by itself. <p> +Terminate the thread Terminating a thread with this function is not safe, you should rather try to make the thread function terminate by itself. +<p>Definition at line <a class="el" href="Thread_8cpp-source.htm#l00107">107</a> of file <a class="el" href="Thread_8cpp-source.htm">Thread.cpp</a>.</p> </div> </div><p> -<a class="anchor" name="603d9493c6a845188f05c2eca48dc41b"></a><!-- doxytag: member="sf::Thread::Terminate" ref="603d9493c6a845188f05c2eca48dc41b" args="()" --> +<a class="anchor" name="67f3c609fdf99688531dbfae461ea4d2"></a><!-- doxytag: member="sf::Thread::Wait" ref="67f3c609fdf99688531dbfae461ea4d2" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">void sf::Thread::Terminate </td> + <td class="memname">void sf::Thread::Wait </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -Terminate the thread Terminating a thread with this function is not safe, you should rather try to make the thread function terminate by itself. +Wait until the thread finishes. <p> +<p>Definition at line <a class="el" href="Thread_8cpp-source.htm#l00087">87</a> of file <a class="el" href="Thread_8cpp-source.htm">Thread.cpp</a>.</p> + </div> </div><p> -<hr>The documentation for this class was generated from the following file:<ul> -<li><a class="el" href="Win32_2Thread_8hpp-source.htm">Win32/Thread.hpp</a></ul> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="Win32_2Thread_8hpp-source.htm">Win32/Thread.hpp</a><li><a class="el" href="Thread_8cpp-source.htm">Thread.cpp</a></ul> +</div> <p id="footer"> :: Copyright © 2007-2008 Laurent Gomila, all rights reserved :: |