java-game-lib-cvs Mailing List for Lightweight Java Game Library

Update of /cvsroot/java-game-lib/LWJGL/src/java/org/lwjgl/input
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18391

Modified Files:
	Mouse.java Keyboard.java 
Log Message:
updated javadoc

Index: Mouse.java
===================================================================
RCS file: /cvsroot/java-game-lib/LWJGL/src/java/org/lwjgl/input/Mouse.java,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -d -r1.35 -r1.36
--- Mouse.java	12 Feb 2004 07:00:16 -0000	1.35
+++ Mouse.java	12 Feb 2004 07:10:06 -0000	1.36
@@ -401,9 +401,10 @@
 	 * 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>getEventButton</code>. To get the state of that button, for that event, use
    * <code>getEventButtonState</code>.
    * 
+   * @see org.lwjgl.input.Mouse#next()
    * @see org.lwjgl.input.Mouse#enableBuffer()
    * @see org.lwjgl.input.Mouse#getEventButton()
    * @see org.lwjgl.input.Mouse#getEventButtonState()

Index: Keyboard.java
===================================================================
RCS file: /cvsroot/java-game-lib/LWJGL/src/java/org/lwjgl/input/Keyboard.java,v
retrieving revision 1.34
retrieving revision 1.35
diff -u -d -r1.34 -r1.35
--- Keyboard.java	5 Feb 2004 16:33:31 -0000	1.34
+++ Keyboard.java	12 Feb 2004 07:10:06 -0000	1.35
@@ -1,5 +1,5 @@
 /* 
- * Copyright (c) 2002 Lightweight Java Game Library Project
+ * Copyright (c) 2002-2004 Lightweight Java Game Library Project
  * All rights reserved.
  * 
  * Redistribution and use in source and binary forms, with or without
@@ -44,13 +44,15 @@
 
 /**
  * $Id$
- *
+ * <br>
  * A raw Keyboard interface. This can be used to poll the current state of the
  * keys, or read all the keyboard presses / releases since the last read.
  * Buffering must be explicitly enabled; the size of the buffer is determined
  * by the native implementation at its discretion.
  * 
  * @author cix_foo <ci...@us...>
+ * @author elias_naur <eli...@us...>
+ * @author Brian Matzon <br...@ma...>
  * @version $Revision$
  */
 public class Keyboard {
@@ -320,7 +322,16 @@
 	private static native void nDestroy();
 
 	/**
-	 * Polls the keyboard.
+   * Polls the keyboard for its current state. Access the polled values using the
+   * <code>isKeyDown</code> method.
+   * By using this method, it is possible to "miss" keyboard keys if you don't
+   * poll fast enough. To receive all events, enable buffering by calling 
+   * <code>enableBuffer</code>, and read those events by calling <code>read</code>
+   * 
+   * @see org.lwjgl.input.Keyboard#isKeyDown(int key) 
+   * @see org.lwjgl.input.Keyboard#isStateKeySet(int key) 
+   * @see org.lwjgl.input.Keyboard#enableBuffer()
+   * @see org.lwjgl.input.Keyboard#read() 
 	 */
 	public static void poll() {
 		assert created : "The keyboard has not been created.";
@@ -336,7 +347,18 @@
 	private static native void nPoll(ByteBuffer keyDownBuffer);
 	
 	/**
-	 * Reads the keyboard buffer.
+   * Reads all keyboard 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 key caused the event by using 
+   * <code>getEventKey</code>. To get the state of that key, for that event, use
+   * <code>getEventKeyState</code> - finally use <code>getEventCharacter</code> to get the
+   * character for that event.
+   * 
+   * @see org.lwjgl.input.Keyboard#next()
+   * @see org.lwjgl.input.Keyboard#enableBuffer()
+   * @see org.lwjgl.input.Keyboard#getEventKey()
+   * @see org.lwjgl.input.Keyboard#getEventKeyState()
+   * @see org.lwjgl.input.Keyboard#getEventCharacter()
 	 */
 	public static void read() {
 		assert created : "The keyboard has not been created.";
@@ -447,9 +469,15 @@
 	}
 	
 	/**
-	 * Gets the next keyboard event. This is stored in the publicly accessible
-	 * static fields key and state.
-	 * @return true if a keyboard event was read, false otherwise
+   * Gets the next keyboard event. You can query which key caused the event by using 
+   * <code>getEventKey</code>. To get the state of that key, for that event, use
+   * <code>getEventKeyState</code> - finally use <code>getEventCharacter</code> to get the
+   * character for that event.
+   * 
+   * @see org.lwjgl.input.Keyboard#getEventKey()
+   * @see org.lwjgl.input.Keyboard#getEventKeyState()
+   * @see org.lwjgl.input.Keyboard#getEventCharacter()
+   * @return true if a keyboard event was read, false otherwise
 	 */
 	public static boolean next() {
 		assert created : "The keyboard has not been created.";

Update of /cvsroot/java-game-lib/LWJGL/src/java/org/lwjgl/input
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv16949

Modified Files:
	Mouse.java 
Log Message:
updated javadoc

Index: Mouse.java
===================================================================
RCS file: /cvsroot/java-game-lib/LWJGL/src/java/org/lwjgl/input/Mouse.java,v
retrieving revision 1.34
retrieving revision 1.35
diff -u -d -r1.34 -r1.35
--- Mouse.java	8 Feb 2004 20:38:33 -0000	1.34
+++ Mouse.java	12 Feb 2004 07:00:16 -0000	1.35
@@ -42,7 +42,7 @@
 
 /**
  * $Id$
- *
+ * <br>
  * 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.
  * 
@@ -294,7 +294,20 @@
 	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() {
 		assert created : "The mouse has not been created.";
@@ -329,7 +342,7 @@
 	/**
 	 * 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
 	 */
 	public static boolean isButtonDown(int button) {
@@ -385,7 +398,15 @@
 	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() {
 		assert created : "The mouse has not been created.";
@@ -402,8 +423,11 @@
 	private static native int nRead();
 
 	/**
-	 * Gets the next mouse event. This is stored in the publicly accessible
-	 * static fields button and state.
+	 * Gets the next mouse event. 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#getEventButton()
+   * @see org.lwjgl.input.Mouse#getEventButtonState()
 	 * @return true if a mouse event was read, false otherwise
 	 */
 	public static boolean next() {