514 lines
21 KiB
HTML
514 lines
21 KiB
HTML
|
<!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:20 CEST 2012 -->
|
||
|
|
<TITLE>
|
||
|
|
MouseState
|
||
|
|
</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="MouseState";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
</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> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MouseState.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
</TD>
|
||
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||
|
|
</EM>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR>
|
||
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Input/Mouse.html" title="class in Microsoft.Xna.Framework.Input"><B>PREV CLASS</B></A>
|
||
|
|
NEXT CLASS</FONT></TD>
|
||
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
|
<A HREF="../../../../index.html?Microsoft/Xna/Framework/Input/MouseState.html" target="_top"><B>FRAMES</B></A>
|
||
|
|
<A HREF="MouseState.html" target="_top"><B>NO FRAMES</B></A>
|
||
|
|
<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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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 MouseState</H2>
|
||
|
|
<PRE>
|
||
|
|
java.lang.Object
|
||
|
|
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../System/ValueType.html" title="class in System">System.ValueType</A>
|
||
|
|
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>Microsoft.Xna.Framework.Input.MouseState</B>
|
||
|
|
</PRE>
|
||
|
|
<HR>
|
||
|
|
<DL>
|
||
|
|
<DT><PRE>public final class <B>MouseState</B><DT>extends <A HREF="../../../../System/ValueType.html" title="class in System">ValueType</A></DL>
|
||
|
|
</PRE>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
Represents the state of a mouse input device, including mouse cursor position and buttons pressed.
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
<DT><B>Author:</B></DT>
|
||
|
|
<DD>Halofreak1990</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
||
|
|
|
||
|
|
<A NAME="field_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>Field Summary</B></FONT></TH>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/MouseState.html#LeftButton">LeftButton</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the state of the left mouse button.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/MouseState.html#MiddleButton">MiddleButton</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the state of the middle mouse button.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/MouseState.html#RightButton">RightButton</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the state of the right mouse button.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> int</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/MouseState.html#ScrollWheelValue">ScrollWheelValue</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the cumulative mouse scroll wheel value since the game was started.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> int</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/MouseState.html#X">X</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Specifies the horizontal position of the mouse cursor.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/MouseState.html#XButton1">XButton1</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the state of XBUTTON1.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> <A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/MouseState.html#XButton2">XButton2</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns the state of XBUTTON2.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> int</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/MouseState.html#Y">Y</A></B></CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Specifies the vertical position of the mouse cursor.</TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
<!-- ======== 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/MouseState.html#MouseState(int, int, int, Microsoft.Xna.Framework.Input.ButtonState, Microsoft.Xna.Framework.Input.ButtonState, Microsoft.Xna.Framework.Input.ButtonState, Microsoft.Xna.Framework.Input.ButtonState, Microsoft.Xna.Framework.Input.ButtonState)">MouseState</A></B>(int x,
|
||
|
|
int y,
|
||
|
|
int scrollWheel,
|
||
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A> leftButton,
|
||
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A> middleButton,
|
||
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A> rightButton,
|
||
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A> xButton1,
|
||
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A> xButton2)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Initializes a new instance of the MouseState class.</TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
<!-- ========== 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> boolean</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/MouseState.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object obj)</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Returns a value that indicates whether the current instance is equal to a specified object.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> int</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/MouseState.html#hashCode()">hashCode</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Gets the hash code for this instance.</TD>
|
||
|
|
</TR>
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> java.lang.String</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Input/MouseState.html#toString()">toString</A></B>()</CODE>
|
||
|
|
|
||
|
|
<BR>
|
||
|
|
Retrieves a string representation of this object.</TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
<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, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<!-- ============ FIELD DETAIL =========== -->
|
||
|
|
|
||
|
|
<A NAME="field_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>Field Detail</B></FONT></TH>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
<A NAME="X"><!-- --></A><H3>
|
||
|
|
X</H3>
|
||
|
|
<PRE>
|
||
|
|
public final int <B>X</B></PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Specifies the horizontal position of the mouse cursor.
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
</DL>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="Y"><!-- --></A><H3>
|
||
|
|
Y</H3>
|
||
|
|
<PRE>
|
||
|
|
public final int <B>Y</B></PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Specifies the vertical position of the mouse cursor.
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
</DL>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="ScrollWheelValue"><!-- --></A><H3>
|
||
|
|
ScrollWheelValue</H3>
|
||
|
|
<PRE>
|
||
|
|
public final int <B>ScrollWheelValue</B></PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the cumulative mouse scroll wheel value since the game was started.
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
</DL>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="LeftButton"><!-- --></A><H3>
|
||
|
|
LeftButton</H3>
|
||
|
|
<PRE>
|
||
|
|
public final <A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A> <B>LeftButton</B></PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the state of the left mouse button.
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
</DL>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="RightButton"><!-- --></A><H3>
|
||
|
|
RightButton</H3>
|
||
|
|
<PRE>
|
||
|
|
public final <A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A> <B>RightButton</B></PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the state of the right mouse button.
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
</DL>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="MiddleButton"><!-- --></A><H3>
|
||
|
|
MiddleButton</H3>
|
||
|
|
<PRE>
|
||
|
|
public final <A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A> <B>MiddleButton</B></PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the state of the middle mouse button.
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
</DL>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="XButton1"><!-- --></A><H3>
|
||
|
|
XButton1</H3>
|
||
|
|
<PRE>
|
||
|
|
public final <A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A> <B>XButton1</B></PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the state of XBUTTON1.
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
</DL>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="XButton2"><!-- --></A><H3>
|
||
|
|
XButton2</H3>
|
||
|
|
<PRE>
|
||
|
|
public final <A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A> <B>XButton2</B></PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns the state of XBUTTON2.
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
</DL>
|
||
|
|
</DL>
|
||
|
|
|
||
|
|
<!-- ========= 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="MouseState(int, int, int, Microsoft.Xna.Framework.Input.ButtonState, Microsoft.Xna.Framework.Input.ButtonState, Microsoft.Xna.Framework.Input.ButtonState, Microsoft.Xna.Framework.Input.ButtonState, Microsoft.Xna.Framework.Input.ButtonState)"><!-- --></A><H3>
|
||
|
|
MouseState</H3>
|
||
|
|
<PRE>
|
||
|
|
public <B>MouseState</B>(int x,
|
||
|
|
int y,
|
||
|
|
int scrollWheel,
|
||
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A> leftButton,
|
||
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A> middleButton,
|
||
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A> rightButton,
|
||
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A> xButton1,
|
||
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Input/ButtonState.html" title="enum in Microsoft.Xna.Framework.Input">ButtonState</A> xButton2)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Initializes a new instance of the MouseState class.
|
||
|
|
<P>
|
||
|
|
<DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>x</CODE> - Horizontal mouse position.<DD><CODE>y</CODE> - Vertical mouse position.<DD><CODE>scrollWheel</CODE> - Mouse scroll wheel value.<DD><CODE>leftButton</CODE> - Left mouse button state.<DD><CODE>middleButton</CODE> - Middle mouse button state.<DD><CODE>rightButton</CODE> - Right mouse button state.<DD><CODE>xButton1</CODE> - XBUTTON1 state.<DD><CODE>xButton2</CODE> - XBUTTON2 state.</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="equals(java.lang.Object)"><!-- --></A><H3>
|
||
|
|
equals</H3>
|
||
|
|
<PRE>
|
||
|
|
public boolean <B>equals</B>(java.lang.Object obj)</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Returns a value that indicates whether the current instance is equal to a specified object.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Parameters:</B><DD><CODE>obj</CODE> - Object with which to make the comparison.
|
||
|
|
<DT><B>Returns:</B><DD>true if the current instance is equal to the specified object; false otherwise.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="hashCode()"><!-- --></A><H3>
|
||
|
|
hashCode</H3>
|
||
|
|
<PRE>
|
||
|
|
public int <B>hashCode</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Gets the hash code for this instance.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>Hash code for this object.</DL>
|
||
|
|
</DD>
|
||
|
|
</DL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="toString()"><!-- --></A><H3>
|
||
|
|
toString</H3>
|
||
|
|
<PRE>
|
||
|
|
public java.lang.String <B>toString</B>()</PRE>
|
||
|
|
<DL>
|
||
|
|
<DD>Retrieves a string representation of this object.
|
||
|
|
<P>
|
||
|
|
<DD><DL>
|
||
|
|
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
|
||
|
|
</DD>
|
||
|
|
<DD><DL>
|
||
|
|
|
||
|
|
<DT><B>Returns:</B><DD>String representation of this object.</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> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MouseState.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
</TD>
|
||
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||
|
|
</EM>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR>
|
||
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Input/Mouse.html" title="class in Microsoft.Xna.Framework.Input"><B>PREV CLASS</B></A>
|
||
|
|
NEXT CLASS</FONT></TD>
|
||
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||
|
|
<A HREF="../../../../index.html?Microsoft/Xna/Framework/Input/MouseState.html" target="_top"><B>FRAMES</B></A>
|
||
|
|
<A HREF="MouseState.html" target="_top"><B>NO FRAMES</B></A>
|
||
|
|
<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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
<A NAME="skip-navbar_bottom"></A>
|
||
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||
|
|
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
</BODY>
|
||
|
|
</HTML>
|