backup/JavaXNA
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
JavaXNA/Microsoft.Xna.Framework/doc/Microsoft/Xna/Framework/Input/GamePad.html
Tom Lint 0c477bd97a First commit of existing code to GitHub
2013-06-13 19:57:30 +02:00

336 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_24) on Sun Apr 15 20:18:19 CEST 2012 -->
<TITLE>
GamePad
</TITLE>
<META NAME="date" CONTENT="2012-04-15">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="GamePad";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GamePad.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../Microsoft/Xna/Framework/Input/GamePadButtons.html" title="class in Microsoft.Xna.Framework.Input"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?Microsoft/Xna/Framework/Input/GamePad.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="GamePad.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
Microsoft.Xna.Framework.Input</FONT>
<BR>
Class GamePad</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>Microsoft.Xna.Framework.Input.GamePad</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>GamePad</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
Allows retrieval of user interaction with an Xbox 360 Controller and setting of controller vibration motors.
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>Halofreak1990</DD>
</DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/GamePad.html#GamePad()">GamePad</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../../Microsoft/Xna/Framework/Input/GamePadCapabilities.html" title="class in Microsoft.Xna.Framework.Input">GamePadCapabilities</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/GamePad.html#GetCapabilities(Microsoft.Xna.Framework.PlayerIndex)">GetCapabilities</A></B>(<A HREF="../../../../Microsoft/Xna/Framework/PlayerIndex.html" title="enum in Microsoft.Xna.Framework">PlayerIndex</A>&nbsp;playerIndex)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves the capabilities of an Xbox 360 Controller.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../../Microsoft/Xna/Framework/Input/GamePadState.html" title="class in Microsoft.Xna.Framework.Input">GamePadState</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/GamePad.html#GetState(Microsoft.Xna.Framework.PlayerIndex)">GetState</A></B>(<A HREF="../../../../Microsoft/Xna/Framework/PlayerIndex.html" title="enum in Microsoft.Xna.Framework">PlayerIndex</A>&nbsp;playerIndex)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the current state of an Xbox 360 Controller.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../../../../Microsoft/Xna/Framework/Input/GamePadState.html" title="class in Microsoft.Xna.Framework.Input">GamePadState</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/GamePad.html#GetState(Microsoft.Xna.Framework.PlayerIndex, Microsoft.Xna.Framework.Input.GamePadDeadZone)">GetState</A></B>(<A HREF="../../../../Microsoft/Xna/Framework/PlayerIndex.html" title="enum in Microsoft.Xna.Framework">PlayerIndex</A>&nbsp;playerIndex,
<A HREF="../../../../Microsoft/Xna/Framework/Input/GamePadDeadZone.html" title="enum in Microsoft.Xna.Framework.Input">GamePadDeadZone</A>&nbsp;deadZoneMode)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the current state of an Xbox 360 Controller, using a specified dead zone on analog stick positions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/GamePad.html#SetVibration(Microsoft.Xna.Framework.PlayerIndex, float, float)">SetVibration</A></B>(<A HREF="../../../../Microsoft/Xna/Framework/PlayerIndex.html" title="enum in Microsoft.Xna.Framework">PlayerIndex</A>&nbsp;playerIndex,
float&nbsp;leftMotor,
float&nbsp;rightMotor)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the vibration motor speeds on an Xbox 360 Controller.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="GamePad()"><!-- --></A><H3>
GamePad</H3>
<PRE>
public <B>GamePad</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="GetCapabilities(Microsoft.Xna.Framework.PlayerIndex)"><!-- --></A><H3>
GetCapabilities</H3>
<PRE>
public static <A HREF="../../../../Microsoft/Xna/Framework/Input/GamePadCapabilities.html" title="class in Microsoft.Xna.Framework.Input">GamePadCapabilities</A> <B>GetCapabilities</B>(<A HREF="../../../../Microsoft/Xna/Framework/PlayerIndex.html" title="enum in Microsoft.Xna.Framework">PlayerIndex</A>&nbsp;playerIndex)</PRE>
<DL>
<DD>Retrieves the capabilities of an Xbox 360 Controller.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>playerIndex</CODE> - Index of the controller to query.
<DT><B>Returns:</B><DD>The capabilities of the controller.</DL>
</DD>
</DL>
<HR>
<A NAME="GetState(Microsoft.Xna.Framework.PlayerIndex)"><!-- --></A><H3>
GetState</H3>
<PRE>
public static <A HREF="../../../../Microsoft/Xna/Framework/Input/GamePadState.html" title="class in Microsoft.Xna.Framework.Input">GamePadState</A> <B>GetState</B>(<A HREF="../../../../Microsoft/Xna/Framework/PlayerIndex.html" title="enum in Microsoft.Xna.Framework">PlayerIndex</A>&nbsp;playerIndex)</PRE>
<DL>
<DD>Gets the current state of an Xbox 360 Controller.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>playerIndex</CODE> - Player index for the controller you want to query.
<DT><B>Returns:</B><DD>The current state of the controller.</DL>
</DD>
</DL>
<HR>
<A NAME="GetState(Microsoft.Xna.Framework.PlayerIndex, Microsoft.Xna.Framework.Input.GamePadDeadZone)"><!-- --></A><H3>
GetState</H3>
<PRE>
public static <A HREF="../../../../Microsoft/Xna/Framework/Input/GamePadState.html" title="class in Microsoft.Xna.Framework.Input">GamePadState</A> <B>GetState</B>(<A HREF="../../../../Microsoft/Xna/Framework/PlayerIndex.html" title="enum in Microsoft.Xna.Framework">PlayerIndex</A>&nbsp;playerIndex,
<A HREF="../../../../Microsoft/Xna/Framework/Input/GamePadDeadZone.html" title="enum in Microsoft.Xna.Framework.Input">GamePadDeadZone</A>&nbsp;deadZoneMode)</PRE>
<DL>
<DD>Gets the current state of an Xbox 360 Controller, using a specified dead zone on analog stick positions.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>playerIndex</CODE> - Player index for the controller you want to query.<DD><CODE>deadZoneMode</CODE> - Enumerated value that specifies what dead zone type to use.
<DT><B>Returns:</B><DD>The current state of the controller.</DL>
</DD>
</DL>
<HR>
<A NAME="SetVibration(Microsoft.Xna.Framework.PlayerIndex, float, float)"><!-- --></A><H3>
SetVibration</H3>
<PRE>
public static boolean <B>SetVibration</B>(<A HREF="../../../../Microsoft/Xna/Framework/PlayerIndex.html" title="enum in Microsoft.Xna.Framework">PlayerIndex</A>&nbsp;playerIndex,
float&nbsp;leftMotor,
float&nbsp;rightMotor)</PRE>
<DL>
<DD>Sets the vibration motor speeds on an Xbox 360 Controller. Reference page contains links to related code samples.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>playerIndex</CODE> - Player index that identifies the controller to set.<DD><CODE>leftMotor</CODE> - The speed of the left motor, between 0.0 and 1.0. This motor is a low-frequency motor.<DD><CODE>rightMotor</CODE> - The speed of the right motor, between 0.0 and 1.0. This motor is a high-frequency motor.
<DT><B>Returns:</B><DD>true if successful, false otherwise.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/GamePad.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../Microsoft/Xna/Framework/Input/GamePadButtons.html" title="class in Microsoft.Xna.Framework.Input"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?Microsoft/Xna/Framework/Input/GamePad.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="GamePad.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink