michael/lwjgl
michael
/
lwjgl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updated javadoc

This commit is contained in:
Brian Matzon 2004-02-12 07:00:16 +00:00
parent ceca66cd6d
commit bbf0f46226
1 changed files with 30 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/java/org/lwjgl/input/Mouse.java
View File

@ -42,7 +42,7 @@ import org.lwjgl.opengl.Window;
/** /**
* $Id$ * $Id$
* * <br>
* A raw Mouse interface. This can be used to poll the current state of the * A raw Mouse interface. This can be used to poll the current state of the
* mouse buttons, and determine the mouse movement delta since the last poll. * mouse buttons, and determine the mouse movement delta since the last poll.
* *
@ -294,7 +294,20 @@ public class Mouse {
private static native void nDestroy(); private static native void nDestroy();
/** /**
* Polls the mouse. * Polls the mouse for its current state. Access the polled values using the
* get<value> methods.
* By using this method, it is possible to "miss" mouse click events if you don't
* poll fast enough. To receive all button events, enable buffering by calling
* <code>enableBuffer</code>, and read those events by calling <code>read</code>
*
* @see org.lwjgl.input.Mouse#isButtonDown(int button)
* @see org.lwjgl.input.Mouse#getX()
* @see org.lwjgl.input.Mouse#getY()
* @see org.lwjgl.input.Mouse#getDX()
* @see org.lwjgl.input.Mouse#getDY()
* @see org.lwjgl.input.Mouse#getDWheel()
* @see org.lwjgl.input.Mouse#enableBuffer()
* @see org.lwjgl.input.Mouse#read()
*/ */
public static void poll() { public static void poll() {
assert created : "The mouse has not been created."; assert created : "The mouse has not been created.";
@ -329,7 +342,7 @@ public class Mouse {
/** /**
* See if a particular mouse button is down. * See if a particular mouse button is down.
* *
* @param button The index of the button you wish to test (0..buttonCount-1) * @param button The index of the button you wish to test (0..getButtonCount-1)
* @return true if the specified button is down * @return true if the specified button is down
*/ */
public static boolean isButtonDown(int button) { public static boolean isButtonDown(int button) {
@ -385,7 +398,15 @@ public class Mouse {
private static native ByteBuffer nEnableBuffer() throws Exception; private static native ByteBuffer nEnableBuffer() throws Exception;
/** /**
* Reads the mouse buffer. * Reads all button events since last read.
* To use these values, you have to call <code>next</code> for each event you
* want to read. You can query which button caused the event by using
* <code>getEventButton</code>. To get the state of that key, for that event, use
* <code>getEventButtonState</code>.
*
* @see org.lwjgl.input.Mouse#enableBuffer()
* @see org.lwjgl.input.Mouse#getEventButton()
* @see org.lwjgl.input.Mouse#getEventButtonState()
*/ */
public static void read() { public static void read() {
assert created : "The mouse has not been created."; assert created : "The mouse has not been created.";
@ -402,8 +423,11 @@ public class Mouse {
private static native int nRead(); private static native int nRead();
/** /**
* Gets the next mouse event. This is stored in the publicly accessible * Gets the next mouse event. You can query which button caused the event by using
* static fields button and state. * <code>getEventButton()</code>. To get the state of that key, for that event, use
* <code>getEventButtonState</code>.
* @see org.lwjgl.input.Mouse#getEventButton()
* @see org.lwjgl.input.Mouse#getEventButtonState()
* @return true if a mouse event was read, false otherwise * @return true if a mouse event was read, false otherwise
*/ */
public static boolean next() { public static boolean next() {