diff options
Diffstat (limited to 'doc/html/classsf_1_1Listener.htm')
| -rwxr-xr-x | doc/html/classsf_1_1Listener.htm | 316 |
1 files changed, 0 insertions, 316 deletions
diff --git a/doc/html/classsf_1_1Listener.htm b/doc/html/classsf_1_1Listener.htm deleted file mode 100755 index 03a93cf..0000000 --- a/doc/html/classsf_1_1Listener.htm +++ /dev/null @@ -1,316 +0,0 @@ -<!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_1Listener.htm">Listener</a></div> -<h1>sf::Listener Class Reference</h1><!-- doxytag: class="sf::Listener" --><a class="el" href="classsf_1_1Listener.htm" title="Listener is a global interface for defining the audio listener properties ; the audio...">Listener</a> is a global interface for defining the audio listener properties ; the audio listener is the point in the scene from where all the sounds are heard. -<a href="#_details">More...</a> -<p> -<code>#include <<a class="el" href="Listener_8hpp-source.htm">Listener.hpp</a>></code> -<p> -<a href="classsf_1_1Listener-members.htm">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> -<tr><td></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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#0a5a4fa643db5b1779dd995a76c4220b">SetGlobalVolume</a> (float Volume)</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the global volume of all the sounds. <a href="#0a5a4fa643db5b1779dd995a76c4220b"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">static float </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#9a709055477f1b4683262305e2f32ef3">GetGlobalVolume</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current value of the global volume of all the sounds. <a href="#9a709055477f1b4683262305e2f32ef3"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#77cbaa272e92c89694761c408129762a">SetPosition</a> (float X, float Y, float Z)</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the position of the listener (take 3 values). <a href="#77cbaa272e92c89694761c408129762a"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#922f139434950427905f7841cf280286">SetPosition</a> (const <a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> &Position)</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the position of the listener (take a 3D vector). <a href="#922f139434950427905f7841cf280286"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#49fe75889ad93f71d9239868530b5059">GetPosition</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current position of the listener. <a href="#49fe75889ad93f71d9239868530b5059"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#0e1f3cbca545c2365201c2f379b71401">SetTarget</a> (float X, float Y, float Z)</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the orientation of the listener (the point he must look at) (take 3 values). <a href="#0e1f3cbca545c2365201c2f379b71401"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#d76dfcf28e23b20a8153058e2be7f4e3">SetTarget</a> (const <a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> &Target)</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the orientation of the listener (the point he must look at) (take a 3D vector). <a href="#d76dfcf28e23b20a8153058e2be7f4e3"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Listener.htm#fd789b4f468f9b80763c8198cb4fb84c">GetTarget</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current orientation of the listener (the point he's looking at). <a href="#fd789b4f468f9b80763c8198cb4fb84c"></a><br></td></tr> -</table> -<hr><a name="_details"></a><h2>Detailed Description</h2> -<a class="el" href="classsf_1_1Listener.htm" title="Listener is a global interface for defining the audio listener properties ; the audio...">Listener</a> is a global interface for defining the audio listener properties ; the audio listener is the point in the scene from where all the sounds are heard. -<p> - -<p> -Definition at line <a class="el" href="Listener_8hpp-source.htm#l00042">42</a> of file <a class="el" href="Listener_8hpp-source.htm">Listener.hpp</a>.<hr><h2>Member Function Documentation</h2> -<a class="anchor" name="0a5a4fa643db5b1779dd995a76c4220b"></a><!-- doxytag: member="sf::Listener::SetGlobalVolume" ref="0a5a4fa643db5b1779dd995a76c4220b" args="(float Volume)" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">static void sf::Listener::SetGlobalVolume </td> - <td>(</td> - <td class="paramtype">float </td> - <td class="paramname"> <em>Volume</em> </td> - <td> ) </td> - <td width="100%"><code> [static]</code></td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Change the global volume of all the sounds. -<p> -The default volume is 100<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>Volume</em> </td><td>: New global volume, in the range [0, 100] </td></tr> - </table> -</dl> - -</div> -</div><p> -<a class="anchor" name="9a709055477f1b4683262305e2f32ef3"></a><!-- doxytag: member="sf::Listener::GetGlobalVolume" ref="9a709055477f1b4683262305e2f32ef3" args="()" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">static float sf::Listener::GetGlobalVolume </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 current value of the global volume of all the sounds. -<p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Current global volume, in the range [0, 100] </dd></dl> - -</div> -</div><p> -<a class="anchor" name="77cbaa272e92c89694761c408129762a"></a><!-- doxytag: member="sf::Listener::SetPosition" ref="77cbaa272e92c89694761c408129762a" args="(float X, float Y, float Z)" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">static void sf::Listener::SetPosition </td> - <td>(</td> - <td class="paramtype">float </td> - <td class="paramname"> <em>X</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">float </td> - <td class="paramname"> <em>Y</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">float </td> - <td class="paramname"> <em>Z</em></td><td> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td><td width="100%"><code> [static]</code></td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Change the position of the listener (take 3 values). -<p> -The default position is (0, 0, 0)<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>X,Y,Z</em> </td><td>: Position of the listener in the world </td></tr> - </table> -</dl> - -</div> -</div><p> -<a class="anchor" name="922f139434950427905f7841cf280286"></a><!-- doxytag: member="sf::Listener::SetPosition" ref="922f139434950427905f7841cf280286" args="(const Vector3f &Position)" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">static void sf::Listener::SetPosition </td> - <td>(</td> - <td class="paramtype">const <a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> & </td> - <td class="paramname"> <em>Position</em> </td> - <td> ) </td> - <td width="100%"><code> [static]</code></td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Change the position of the listener (take a 3D vector). -<p> -The default position is (0, 0, 0)<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>Position</em> </td><td>: Position of the listener in the world </td></tr> - </table> -</dl> - -</div> -</div><p> -<a class="anchor" name="49fe75889ad93f71d9239868530b5059"></a><!-- doxytag: member="sf::Listener::GetPosition" ref="49fe75889ad93f71d9239868530b5059" args="()" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">static <a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> sf::Listener::GetPosition </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 current position of the listener. -<p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Position of the listener in the world </dd></dl> - -</div> -</div><p> -<a class="anchor" name="0e1f3cbca545c2365201c2f379b71401"></a><!-- doxytag: member="sf::Listener::SetTarget" ref="0e1f3cbca545c2365201c2f379b71401" args="(float X, float Y, float Z)" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">static void sf::Listener::SetTarget </td> - <td>(</td> - <td class="paramtype">float </td> - <td class="paramname"> <em>X</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">float </td> - <td class="paramname"> <em>Y</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">float </td> - <td class="paramname"> <em>Z</em></td><td> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td><td width="100%"><code> [static]</code></td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Change the orientation of the listener (the point he must look at) (take 3 values). -<p> -The default target is (0, 0, -1)<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>X,Y,Z</em> </td><td>: Position of the point the listener must look at </td></tr> - </table> -</dl> - -</div> -</div><p> -<a class="anchor" name="d76dfcf28e23b20a8153058e2be7f4e3"></a><!-- doxytag: member="sf::Listener::SetTarget" ref="d76dfcf28e23b20a8153058e2be7f4e3" args="(const Vector3f &Target)" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">static void sf::Listener::SetTarget </td> - <td>(</td> - <td class="paramtype">const <a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> & </td> - <td class="paramname"> <em>Target</em> </td> - <td> ) </td> - <td width="100%"><code> [static]</code></td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Change the orientation of the listener (the point he must look at) (take a 3D vector). -<p> -The default target is (0, 0, -1)<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>Target</em> </td><td>: Position of the point the listener must look at </td></tr> - </table> -</dl> - -</div> -</div><p> -<a class="anchor" name="fd789b4f468f9b80763c8198cb4fb84c"></a><!-- doxytag: member="sf::Listener::GetTarget" ref="fd789b4f468f9b80763c8198cb4fb84c" args="()" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">static <a class="el" href="classsf_1_1Vector3.htm">Vector3f</a> sf::Listener::GetTarget </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 current orientation of the listener (the point he's looking at). -<p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>: Position of the point the listener is looking at </dd></dl> - -</div> -</div><p> -<hr>The documentation for this class was generated from the following file:<ul> -<li><a class="el" href="Listener_8hpp-source.htm">Listener.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> |