diff options
author | Christoph Egger <Christoph.Egger@gmx.de> | 2008-05-20 13:58:13 +0200 |
---|---|---|
committer | Christoph Egger <Christoph.Egger@gmx.de> | 2008-05-20 13:58:13 +0200 |
commit | ff2dd2d0218cea258446af2c781298192404aa68 (patch) | |
tree | d36a5a7e71af593c65882d46619716cb0d82789d /doc/html/classsf_1_1Input.htm |
Imported Upstream version 1.2
Diffstat (limited to 'doc/html/classsf_1_1Input.htm')
-rwxr-xr-x | doc/html/classsf_1_1Input.htm | 283 |
1 files changed, 283 insertions, 0 deletions
diff --git a/doc/html/classsf_1_1Input.htm b/doc/html/classsf_1_1Input.htm new file mode 100755 index 0000000..1ad25e9 --- /dev/null +++ b/doc/html/classsf_1_1Input.htm @@ -0,0 +1,283 @@ +<!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_1Input.htm">Input</a></div> +<h1>sf::Input Class Reference</h1><!-- doxytag: class="sf::Input" --><!-- doxytag: inherits="sf::WindowListener,sf::NonCopyable" --><a class="el" href="classsf_1_1Input.htm" title="Input handles real-time input from keyboard and mouse.">Input</a> handles real-time input from keyboard and mouse. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="Input_8hpp-source.htm">Input.hpp</a>></code> +<p> +<p>Inheritance diagram for sf::Input: +<p><center><img src="classsf_1_1Input.png" usemap="#sf::Input_map" border="0" alt=""></center> +<map name="sf::Input_map"> +<area href="classsf_1_1WindowListener.htm" alt="sf::WindowListener" shape="rect" coords="0,0,117,24"> +<area href="classsf_1_1NonCopyable.htm" alt="sf::NonCopyable" shape="rect" coords="127,0,244,24"> +</map> +<a href="classsf_1_1Input-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_1Input.htm#35393e09fc92f7523e52af1c203b958f">Input</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#35393e09fc92f7523e52af1c203b958f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Input.htm#5312ed524e1f2837aa4597978553876a">IsKeyDown</a> (<a class="el" href="namespacesf_1_1Key.htm#d32ed01d3448273340bd25af5cdd9c81">Key::Code</a> KeyCode) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the state of a key. <a href="#5312ed524e1f2837aa4597978553876a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Input.htm#28c36d05d76f2263faf803e29ffa9dea">IsMouseButtonDown</a> (<a class="el" href="namespacesf_1_1Mouse.htm#4fb128be433f9aafe66bc0c605daaa90">Mouse::Button</a> Button) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the state of a mouse button. <a href="#28c36d05d76f2263faf803e29ffa9dea"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Input.htm#715d9533617ef9fc25152ebd6b7ece08">IsJoystickButtonDown</a> (unsigned int JoyId, unsigned int Button) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the state of a joystick button. <a href="#715d9533617ef9fc25152ebd6b7ece08"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Input.htm#818dd698fdc06826a3f13123ac322353">GetMouseX</a> () const</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the mouse X position. <a href="#818dd698fdc06826a3f13123ac322353"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Input.htm#37dc9b6aa5a007415c74e44b3c9696d9">GetMouseY</a> () const</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the mouse Y position. <a href="#37dc9b6aa5a007415c74e44b3c9696d9"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Input.htm#7b0af3ad1f8d4e9203b45b6e56293669">GetJoystickAxis</a> (unsigned int JoyId, <a class="el" href="namespacesf_1_1Joy.htm#e7ae4bc4af23f012e5667f18d4aa1039">Joy::Axis</a> Axis) const</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a joystick axis position. <a href="#7b0af3ad1f8d4e9203b45b6e56293669"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +<a class="el" href="classsf_1_1Input.htm" title="Input handles real-time input from keyboard and mouse.">Input</a> handles real-time input from keyboard and mouse. +<p> +Use it instead of events to handle continuous moves and more game-friendly inputs +<p> + +<p> +Definition at line <a class="el" href="Input_8hpp-source.htm#l00044">44</a> of file <a class="el" href="Input_8hpp-source.htm">Input.hpp</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="35393e09fc92f7523e52af1c203b958f"></a><!-- doxytag: member="sf::Input::Input" ref="35393e09fc92f7523e52af1c203b958f" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">sf::Input::Input </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Default constructor. +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="5312ed524e1f2837aa4597978553876a"></a><!-- doxytag: member="sf::Input::IsKeyDown" ref="5312ed524e1f2837aa4597978553876a" args="(Key::Code KeyCode) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool sf::Input::IsKeyDown </td> + <td>(</td> + <td class="paramtype"><a class="el" href="namespacesf_1_1Key.htm#d32ed01d3448273340bd25af5cdd9c81">Key::Code</a> </td> + <td class="paramname"> <em>KeyCode</em> </td> + <td> ) </td> + <td width="100%"> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the state of a key. +<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>KeyCode</em> </td><td>: <a class="el" href="namespacesf_1_1Key.htm" title="Definition of key codes for keyboard events.">Key</a> to check</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if key is down, false if key is up </dd></dl> + +</div> +</div><p> +<a class="anchor" name="28c36d05d76f2263faf803e29ffa9dea"></a><!-- doxytag: member="sf::Input::IsMouseButtonDown" ref="28c36d05d76f2263faf803e29ffa9dea" args="(Mouse::Button Button) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool sf::Input::IsMouseButtonDown </td> + <td>(</td> + <td class="paramtype"><a class="el" href="namespacesf_1_1Mouse.htm#4fb128be433f9aafe66bc0c605daaa90">Mouse::Button</a> </td> + <td class="paramname"> <em>Button</em> </td> + <td> ) </td> + <td width="100%"> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the state of a mouse button. +<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>Button</em> </td><td>: Button to check</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if button is down, false if button is up </dd></dl> + +</div> +</div><p> +<a class="anchor" name="715d9533617ef9fc25152ebd6b7ece08"></a><!-- doxytag: member="sf::Input::IsJoystickButtonDown" ref="715d9533617ef9fc25152ebd6b7ece08" args="(unsigned int JoyId, unsigned int Button) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool sf::Input::IsJoystickButtonDown </td> + <td>(</td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>JoyId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>Button</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td width="100%"> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the state of a joystick button. +<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>JoyId</em> </td><td>: Identifier of the joystick to check (0 or 1) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>Button</em> </td><td>: Button to check</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if button is down, false if button is up </dd></dl> + +</div> +</div><p> +<a class="anchor" name="818dd698fdc06826a3f13123ac322353"></a><!-- doxytag: member="sf::Input::GetMouseX" ref="818dd698fdc06826a3f13123ac322353" args="() const" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">unsigned int sf::Input::GetMouseX </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the mouse X position. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Current mouse left position, relative to owner window </dd></dl> + +</div> +</div><p> +<a class="anchor" name="37dc9b6aa5a007415c74e44b3c9696d9"></a><!-- doxytag: member="sf::Input::GetMouseY" ref="37dc9b6aa5a007415c74e44b3c9696d9" args="() const" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">unsigned int sf::Input::GetMouseY </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the mouse Y position. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Current mouse top position, relative to owner window </dd></dl> + +</div> +</div><p> +<a class="anchor" name="7b0af3ad1f8d4e9203b45b6e56293669"></a><!-- doxytag: member="sf::Input::GetJoystickAxis" ref="7b0af3ad1f8d4e9203b45b6e56293669" args="(unsigned int JoyId, Joy::Axis Axis) const" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float sf::Input::GetJoystickAxis </td> + <td>(</td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>JoyId</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="namespacesf_1_1Joy.htm#e7ae4bc4af23f012e5667f18d4aa1039">Joy::Axis</a> </td> + <td class="paramname"> <em>Axis</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td width="100%"> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get a joystick axis position. +<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>JoyId</em> </td><td>: Identifier of the joystick to check (0 or 1) </td></tr> + <tr><td valign="top"></td><td valign="top"><em>Axis</em> </td><td>: Axis to get</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Current axis position, in the range [-100, 100] (except for POV, which is [0, 360]) </dd></dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="Input_8hpp-source.htm">Input.hpp</a></ul> + + <p id="footer"> + :: Copyright © 2007 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> |