backup/JavaXNA
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
JavaXNA/Microsoft.Xna.Framework/doc/Microsoft/Xna/Framework/Input/KeyboardState.html
Tom Lint 92e29ba3dd Fixed compiler errors 
Regenerated JavaDoc
Updated whitespace usage
Added LWJGL libraries and binaries
2013-10-15 12:34:51 +02:00

395 lines
17 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="nl">
<head>
<!-- Generated by javadoc (version 1.7.0_40) on Tue Oct 15 12:25:32 CEST 2013 -->
<title>KeyboardState</title>
<meta name="date" content="2013-10-15">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="KeyboardState";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/KeyboardState.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../Microsoft/Xna/Framework/Input/Keyboard.html" title="class in Microsoft.Xna.Framework.Input"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../Microsoft/Xna/Framework/Input/Keys.html" title="enum in Microsoft.Xna.Framework.Input"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?Microsoft/Xna/Framework/Input/KeyboardState.html" target="_top">Frames</a></li>
<li><a href="KeyboardState.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">Microsoft.Xna.Framework.Input</div>
<h2 title="Class KeyboardState" class="title">Class KeyboardState</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../System/ValueType.html" title="class in System">System.ValueType</a></li>
<li>
<ul class="inheritance">
<li>Microsoft.Xna.Framework.Input.KeyboardState</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../System/IEquatable.html" title="interface in System">IEquatable</a>&lt;<a href="../../../../Microsoft/Xna/Framework/Input/KeyboardState.html" title="class in Microsoft.Xna.Framework.Input">KeyboardState</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public final class <span class="strong">KeyboardState</span>
extends <a href="../../../../System/ValueType.html" title="class in System">ValueType</a>
implements <a href="../../../../System/IEquatable.html" title="interface in System">IEquatable</a>&lt;<a href="../../../../Microsoft/Xna/Framework/Input/KeyboardState.html" title="class in Microsoft.Xna.Framework.Input">KeyboardState</a>&gt;</pre>
<div class="block">Represents a state of keystrokes recorded by a keyboard input device.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Halofreak1990</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/KeyboardState.html#KeyboardState(Microsoft.Xna.Framework.Input.Keys...)">KeyboardState</a></strong>(<a href="../../../../Microsoft/Xna/Framework/Input/Keys.html" title="enum in Microsoft.Xna.Framework.Input">Keys</a>...&nbsp;keys)</code>
<div class="block">Initializes a new instance of the KeyboardState class.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/KeyboardState.html#Equals(Microsoft.Xna.Framework.Input.KeyboardState)">Equals</a></strong>(<a href="../../../../Microsoft/Xna/Framework/Input/KeyboardState.html" title="class in Microsoft.Xna.Framework.Input">KeyboardState</a>&nbsp;other)</code>
<div class="block">Indicates whether the current object is equal to another object of the same type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/KeyboardState.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object&nbsp;obj)</code>
<div class="block">Returns a value that indicates whether the current instance is equal to a specified object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Input/KeyState.html" title="enum in Microsoft.Xna.Framework.Input">KeyState</a></code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/KeyboardState.html#get(Microsoft.Xna.Framework.Input.Keys)">get</a></strong>(<a href="../../../../Microsoft/Xna/Framework/Input/Keys.html" title="enum in Microsoft.Xna.Framework.Input">Keys</a>&nbsp;key)</code>
<div class="block">Returns the state of a particular key.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Input/Keys.html" title="enum in Microsoft.Xna.Framework.Input">Keys</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/KeyboardState.html#GetPressedKeys()">GetPressedKeys</a></strong>()</code>
<div class="block">Gets an array of values that correspond to the keyboard keys that are currently being pressed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/KeyboardState.html#hashCode()">hashCode</a></strong>()</code>
<div class="block">Gets the hash code for this instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/KeyboardState.html#IsKeyDown(Microsoft.Xna.Framework.Input.Keys)">IsKeyDown</a></strong>(<a href="../../../../Microsoft/Xna/Framework/Input/Keys.html" title="enum in Microsoft.Xna.Framework.Input">Keys</a>&nbsp;key)</code>
<div class="block">Returns whether a specified key is currently being pressed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Input/KeyboardState.html#IsKeyUp(Microsoft.Xna.Framework.Input.Keys)">IsKeyUp</a></strong>(<a href="../../../../Microsoft/Xna/Framework/Input/Keys.html" title="enum in Microsoft.Xna.Framework.Input">Keys</a>&nbsp;key)</code>
<div class="block">Returns whether a specified key is currently not pressed.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="KeyboardState(Microsoft.Xna.Framework.Input.Keys...)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>KeyboardState</h4>
<pre>public&nbsp;KeyboardState(<a href="../../../../Microsoft/Xna/Framework/Input/Keys.html" title="enum in Microsoft.Xna.Framework.Input">Keys</a>...&nbsp;keys)</pre>
<div class="block">Initializes a new instance of the KeyboardState class.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - Array or parameter list of Keys to initialize as pressed.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="get(Microsoft.Xna.Framework.Input.Keys)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public&nbsp;<a href="../../../../Microsoft/Xna/Framework/Input/KeyState.html" title="enum in Microsoft.Xna.Framework.Input">KeyState</a>&nbsp;get(<a href="../../../../Microsoft/Xna/Framework/Input/Keys.html" title="enum in Microsoft.Xna.Framework.Input">Keys</a>&nbsp;key)</pre>
<div class="block">Returns the state of a particular key.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - Enumerated value representing the key to query.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The state of the key specified by key.</dd></dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
<div class="block">Returns a value that indicates whether the current instance is equal to a specified object.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - Object to compare this object to.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the objects are the same; false otherwise.</dd></dl>
</li>
</ul>
<a name="Equals(Microsoft.Xna.Framework.Input.KeyboardState)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Equals</h4>
<pre>public&nbsp;boolean&nbsp;Equals(<a href="../../../../Microsoft/Xna/Framework/Input/KeyboardState.html" title="class in Microsoft.Xna.Framework.Input">KeyboardState</a>&nbsp;other)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../System/IEquatable.html#Equals(T)">IEquatable</a></code></strong></div>
<div class="block">Indicates whether the current object is equal to another object of the same type.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../System/IEquatable.html#Equals(T)">Equals</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../System/IEquatable.html" title="interface in System">IEquatable</a>&lt;<a href="../../../../Microsoft/Xna/Framework/Input/KeyboardState.html" title="class in Microsoft.Xna.Framework.Input">KeyboardState</a>&gt;</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>other</code> - An object to compare with this object.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the current object is equal to the other parameter; otherwise, false.</dd></dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<div class="block">Gets the hash code for this instance.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>Hash code for this object.</dd></dl>
</li>
</ul>
<a name="GetPressedKeys()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GetPressedKeys</h4>
<pre>public&nbsp;<a href="../../../../Microsoft/Xna/Framework/Input/Keys.html" title="enum in Microsoft.Xna.Framework.Input">Keys</a>[]&nbsp;GetPressedKeys()</pre>
<div class="block">Gets an array of values that correspond to the keyboard keys that are currently being pressed.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The keys that are currently pressed.</dd></dl>
</li>
</ul>
<a name="IsKeyDown(Microsoft.Xna.Framework.Input.Keys)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>IsKeyDown</h4>
<pre>public&nbsp;boolean&nbsp;IsKeyDown(<a href="../../../../Microsoft/Xna/Framework/Input/Keys.html" title="enum in Microsoft.Xna.Framework.Input">Keys</a>&nbsp;key)</pre>
<div class="block">Returns whether a specified key is currently being pressed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - Enumerated value that specifies the key to query.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the key specified by key is being held down; false otherwise.</dd></dl>
</li>
</ul>
<a name="IsKeyUp(Microsoft.Xna.Framework.Input.Keys)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IsKeyUp</h4>
<pre>public&nbsp;boolean&nbsp;IsKeyUp(<a href="../../../../Microsoft/Xna/Framework/Input/Keys.html" title="enum in Microsoft.Xna.Framework.Input">Keys</a>&nbsp;key)</pre>
<div class="block">Returns whether a specified key is currently not pressed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - Enumerated value that specifies the key to query.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the key specified by key is not pressed; false otherwise.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/KeyboardState.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../Microsoft/Xna/Framework/Input/Keyboard.html" title="class in Microsoft.Xna.Framework.Input"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../Microsoft/Xna/Framework/Input/Keys.html" title="enum in Microsoft.Xna.Framework.Input"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?Microsoft/Xna/Framework/Input/KeyboardState.html" target="_top">Frames</a></li>
<li><a href="KeyboardState.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink