Lighweight Java Game Library 2.9.3 · org.lwjgl.input.Mouse

Field Summary

Modifier and Type	Field and Description
private static int	absolute_x Mouse absolute X position in pixels without any clipping
private static int	absolute_y Mouse absolute Y position in pixels without any clipping
private static final int	BUFFER_SIZE Buffer size in events
private static int	buttonCount Number of buttons supported by the mouse
private static final Map<String, Integer>	buttonMap hashmap of button names, for fast lookup
private static String[]	buttonName Button names.
private static ByteBuffer	buttons The mouse buttons status from the last poll
private static boolean	clipMouseCoordinatesToWindow
private static IntBuffer	coord_buffer Buffer to hold the deltas dx, dy and dwheel
private static boolean	created Has the mouse been created?
private static Cursor	currentCursor The current native cursor, if any
private static int	dwheel Delta Z
private static int	dx Delta X
private static int	dy Delta Y
private static final boolean	emulateCursorAnimation Whether we need cursor animation emulation
private static int	event_dwheel
private static int	event_dx The current delta of the mouse in the event queue
private static int	event_dy
private static long	event_nanos
public static final int	EVENT_SIZE Internal use - event size in bytes
private static int	event_x The current absolute position of the mouse in the event queue
private static int	event_y
private static int	eventButton The current mouse event button being examined
private static boolean	eventState The current state of the button being examined in the event queue
private static int	grab_x The position of the mouse it was grabbed at
private static int	grab_y
private static boolean	hasWheel Does this mouse support a scroll wheel
private static InputImplementation	implementation
private static boolean	initialized Lazy initialization
private static boolean	isGrabbed
private static int	last_event_raw_x The last absolute mouse event position (before clipping) for delta computation
private static int	last_event_raw_y
private static ByteBuffer	readBuffer The mouse button events from the last read
private static int	x Mouse absolute X position in pixels
private static int	y Mouse absolute Y position in pixels

Constructor Summary

Access	Constructor and Description
private	Mouse() Mouse cannot be constructed.

Method Summary

Modifier and Type	Method and Description
private static void	create(InputImplementation impl) "Create" the mouse with the given custom implementation.
public static void	create() "Create" the mouse.
public static void	destroy() "Destroy" the mouse.
public static int	Returns: Number of buttons on this mouse getButtonCount()
public static int	getButtonIndex(String The button name buttonName) Get's a button's index.
public static String	Returns: a String with the button's human readable name in it or null if the button is unnamed getButtonName(int The button button) Gets a button's name
public static int	Returns: Movement of the wheel since last time getDWheel() was called getDWheel()
public static int	Returns: Movement on the x axis since last time getDX() was called. getDX()
public static int	Returns: Movement on the y axis since last time getDY() was called. getDY()
public static int	Returns: Current events button. Returns -1 if no button state was changed getEventButton()
public static boolean	Returns: Current events button state. getEventButtonState() Get the current events button state.
public static int	Returns: Current events delta z getEventDWheel()
public static int	Returns: Current events delta x. getEventDX()
public static int	Returns: Current events delta y. getEventDY()
public static long	Returns: The time in nanoseconds of the current event getEventNanoseconds() Gets the time in nanoseconds of the current event.
public static int	Returns: Current events absolute x. getEventX()
public static int	Returns: Current events absolute y. getEventY()
pack-priv static InputImplementation	getImplementation()
public static Cursor	Returns: the currently bound native cursor, if any. getNativeCursor() Gets the currently bound native cursor, if any.
pack-priv static boolean	getPrivilegedBoolean(final String property_name) Gets a boolean property as a privileged action.
public static int	Returns: Absolute x axis position of mouse getX() Retrieves the absolute position.
public static int	Returns: Absolute y axis position of mouse getY() Retrieves the absolute position.
public static boolean	Returns: Whether or not this mouse has wheel support hasWheel()
private static void	initialize() Static initialization
public static boolean	Returns: true if the specified button is down isButtonDown(int The index of the button you wish to test (0..getButtonCount-1) button) See if a particular mouse button is down.
public static boolean	isClipMouseCoordinatesToWindow()
public static boolean	Returns: true if the mouse has been created isCreated()
public static boolean	Returns: whether or not the mouse has grabbed the cursor isGrabbed()
public static boolean	Returns: true if mouse is inside display, false otherwise. isInsideWindow() Retrieves whether or not the mouse cursor is within the bounds of the window.
public static boolean	Returns: true if a mouse event was read, false otherwise next() Gets the next mouse event.
public static void	poll() Polls the mouse for its current state.
private static void	read()
private static void	resetMouse()
public static void	setClipMouseCoordinatesToWindow(boolean clip)
public static void	setCursorPosition(int The x coordinate of the new cursor position in OpenGL coordinates relative to the window origin. new_x, int The y coordinate of the new cursor position in OpenGL coordinates relative to the window origin. new_y) Set the position of the cursor.
public static void	setGrabbed(boolean whether the mouse should be grabbed grab) Sets whether or not the mouse has grabbed the cursor (and thus hidden).
public static Cursor	Returns: The previous Cursor object set, or null. setNativeCursor(Cursor the native cursor object to bind. May be null. cursor) Binds a native cursor.
public static void	updateCursor() Updates the cursor, so that animation can be changed if needed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

absolute_x	back to summary
private static int absolute_x Mouse absolute X position in pixels without any clipping

absolute_y	back to summary
private static int absolute_y Mouse absolute Y position in pixels without any clipping

BUFFER_SIZE	back to summary
private static final int BUFFER_SIZE Buffer size in events

buttonCount	back to summary
private static int buttonCount Number of buttons supported by the mouse

buttonMap	back to summary
private static final Map<String, Integer> buttonMap hashmap of button names, for fast lookup

buttonName	back to summary
private static String[] buttonName Button names. These are set upon create(), to names like BUTTON0, BUTTON1, etc.

buttons	back to summary
private static ByteBuffer buttons The mouse buttons status from the last poll

clipMouseCoordinatesToWindow	back to summary
private static boolean clipMouseCoordinatesToWindow

coord_buffer	back to summary
private static IntBuffer coord_buffer Buffer to hold the deltas dx, dy and dwheel

created	back to summary
private static boolean created Has the mouse been created?

currentCursor	back to summary
private static Cursor currentCursor The current native cursor, if any

dwheel	back to summary
private static int dwheel Delta Z

dx	back to summary
private static int dx Delta X

dy	back to summary
private static int dy Delta Y

emulateCursorAnimation	back to summary
private static final boolean emulateCursorAnimation Whether we need cursor animation emulation

event_dwheel	back to summary
private static int event_dwheel

event_dx	back to summary
private static int event_dx The current delta of the mouse in the event queue

event_dy	back to summary
private static int event_dy

event_nanos	back to summary
private static long event_nanos

EVENT_SIZE	back to summary
public static final int EVENT_SIZE Internal use - event size in bytes

event_x	back to summary
private static int event_x The current absolute position of the mouse in the event queue

event_y	back to summary
private static int event_y

eventButton	back to summary
private static int eventButton The current mouse event button being examined

eventState	back to summary
private static boolean eventState The current state of the button being examined in the event queue

grab_x	back to summary
private static int grab_x The position of the mouse it was grabbed at

grab_y	back to summary
private static int grab_y

hasWheel	back to summary
private static boolean hasWheel Does this mouse support a scroll wheel

implementation	back to summary
private static InputImplementation implementation

initialized	back to summary
private static boolean initialized Lazy initialization

isGrabbed	back to summary
private static boolean isGrabbed

last_event_raw_x	back to summary
private static int last_event_raw_x The last absolute mouse event position (before clipping) for delta computation

last_event_raw_y	back to summary
private static int last_event_raw_y

readBuffer	back to summary
private static ByteBuffer readBuffer The mouse button events from the last read

x	back to summary
private static int x Mouse absolute X position in pixels

y	back to summary
private static int y Mouse absolute Y position in pixels

Constructor Detail

Mouse	back to summary
private Mouse() Mouse cannot be constructed.

Method Detail

create	back to summary
private static void create(InputImplementation impl) throws LWJGLException "Create" the mouse with the given custom implementation. This is used reflectively by AWTInputAdapter. Exceptions LWJGLException: if the mouse could not be created for any reason

create

back to summary

private static void create(InputImplementation impl) throws LWJGLException

"Create" the mouse with the given custom implementation. This is used reflectively by AWTInputAdapter.

Exceptions

LWJGLException:: if the mouse could not be created for any reason

create	back to summary
public static void create() throws LWJGLException "Create" the mouse. The display must first have been created. Initially, the mouse is not grabbed and the delta values are reported with respect to the center of the display. Exceptions LWJGLException: if the mouse could not be created for any reason

create

back to summary

public static void create() throws LWJGLException

"Create" the mouse. The display must first have been created. Initially, the mouse is not grabbed and the delta values are reported with respect to the center of the display.

Exceptions

LWJGLException:: if the mouse could not be created for any reason

destroy	back to summary
public static void destroy() "Destroy" the mouse.

getButtonCount	back to summary
public static int getButtonCount() Returns:int Number of buttons on this mouse

getButtonIndex	back to summary
public static int getButtonIndex(String buttonName) Get's a button's index. If the button is unrecognised then -1 is returned. Parameters buttonName:String The button name

getButtonIndex

back to summary

public static int getButtonIndex(String buttonName)

Get's a button's index. If the button is unrecognised then -1 is returned.

Parameters

buttonName:String: The button name

getButtonName	back to summary
public static String getButtonName(int button) Gets a button's name Parameters button:int The button Returns:String a String with the button's human readable name in it or null if the button is unnamed

getButtonName

back to summary

public static String getButtonName(int button)

Gets a button's name

Parameters

button:int: The button

Returns:String

a String with the button's human readable name in it or null if the button is unnamed

getDWheel	back to summary
public static int getDWheel() Returns:int Movement of the wheel since last time getDWheel() was called

getDX	back to summary
public static int getDX() Returns:int Movement on the x axis since last time getDX() was called.

getDY	back to summary
public static int getDY() Returns:int Movement on the y axis since last time getDY() was called.

getEventButton	back to summary
public static int getEventButton() Returns:int Current events button. Returns -1 if no button state was changed

getEventButtonState	back to summary
public static boolean getEventButtonState() Get the current events button state. Returns:boolean Current events button state.

getEventButtonState

back to summary

public static boolean getEventButtonState()

Get the current events button state.

Returns:boolean: Current events button state.

getEventDWheel	back to summary
public static int getEventDWheel() Returns:int Current events delta z

getEventDX	back to summary
public static int getEventDX() Returns:int Current events delta x.

getEventDY	back to summary
public static int getEventDY() Returns:int Current events delta y.

getEventNanoseconds

back to summary

public static long getEventNanoseconds()

Gets the time in nanoseconds of the current event. Only useful for relative comparisons with other Mouse events, as the absolute time has no defined origin.

Returns:long: The time in nanoseconds of the current event

getEventX	back to summary
public static int getEventX() Returns:int Current events absolute x.

getEventY	back to summary
public static int getEventY() Returns:int Current events absolute y.

getImplementation	back to summary
pack-priv static InputImplementation getImplementation()

getNativeCursor

back to summary

public static Cursor getNativeCursor()

Gets the currently bound native cursor, if any.

Returns:Cursor: the currently bound native cursor, if any.

getPrivilegedBoolean	back to summary
pack-priv static boolean getPrivilegedBoolean(final String property_name) Gets a boolean property as a privileged action.

getX

back to summary

public static int getX()

Retrieves the absolute position. It will be clamped to 0...width-1.

Returns:int: Absolute x axis position of mouse

getY

back to summary

public static int getY()

Retrieves the absolute position. It will be clamped to 0...height-1.

Returns:int: Absolute y axis position of mouse

hasWheel	back to summary
public static boolean hasWheel() Returns:boolean Whether or not this mouse has wheel support

initialize	back to summary
private static void initialize() Static initialization

isButtonDown

back to summary

public static boolean isButtonDown(int button)

See if a particular mouse button is down.

Parameters

button:int: The index of the button you wish to test (0..getButtonCount-1)

Returns:boolean

true if the specified button is down

isClipMouseCoordinatesToWindow	back to summary
public static boolean isClipMouseCoordinatesToWindow()

isCreated	back to summary
public static boolean isCreated() Returns:boolean true if the mouse has been created

isGrabbed	back to summary
public static boolean isGrabbed() Returns:boolean whether or not the mouse has grabbed the cursor

isInsideWindow

back to summary

public static boolean isInsideWindow()

Retrieves whether or not the mouse cursor is within the bounds of the window. If the mouse cursor was moved outside the display during a drag, then the result of calling this method will be true until the button is released.

Returns:boolean: true if mouse is inside display, false otherwise.

next back to summary

public static boolean next()

Gets the next mouse event. You can query which button caused the event by using getEventButton() (if any). To get the state of that key, for that event, use getEventButtonState. To get the current mouse delta values use getEventDX() and getEventDY().

Returns:boolean: true if a mouse event was read, false otherwise
See Also: org.lwjgl.input.Mouse#getEventButton(), org.lwjgl.input.Mouse#getEventButtonState()

poll back to summary

public static void poll()

Polls the mouse for its current state. Access the polled values using the get methods. By using this method, it is possible to "miss" mouse click events if you don't poll fast enough. To use buffered values, you have to call next for each event you want to read. You can query which button caused the event by using getEventButton. To get the state of that button, for that event, use getEventButtonState.

Note

This method does not query the operating system for new events. To do that, Display.processMessages() (or Display.update()) must be called first.

See Also: org.lwjgl.input.Mouse#next(), org.lwjgl.input.Mouse#getEventButton(), org.lwjgl.input.Mouse#getEventButtonState(), org.lwjgl.input.Mouse#isButtonDown(int button), org.lwjgl.input.Mouse#getX(), org.lwjgl.input.Mouse#getY(), org.lwjgl.input.Mouse#getDX(), org.lwjgl.input.Mouse#getDY(), org.lwjgl.input.Mouse#getDWheel()

read	back to summary
private static void read()

resetMouse	back to summary
private static void resetMouse()

setClipMouseCoordinatesToWindow	back to summary
public static void setClipMouseCoordinatesToWindow(boolean clip)

setCursorPosition

back to summary

public static void setCursorPosition(int new_x, int new_y)

Set the position of the cursor. If the cursor is not grabbed, the native cursor is moved to the new position.

Parameters

new_x:int: The x coordinate of the new cursor position in OpenGL coordinates relative to the window origin.
new_y:int: The y coordinate of the new cursor position in OpenGL coordinates relative to the window origin.

setGrabbed

back to summary

public static void setGrabbed(boolean grab)

Sets whether or not the mouse has grabbed the cursor (and thus hidden). If grab is false, the getX() and getY() will return delta movement in pixels clamped to the display dimensions, from the center of the display.

Parameters

grab:boolean: whether the mouse should be grabbed

setNativeCursor

back to summary

public static Cursor setNativeCursor(Cursor cursor) throws LWJGLException

Binds a native cursor. If the cursor argument is null, any currently bound native cursor is disabled, and the cursor reverts to the default operating system supplied cursor.

Note

The native cursor is not constrained to the window, but relative events will not be generated if the cursor is outside.

Parameters

cursor:Cursor: the native cursor object to bind. May be null.

Returns:Cursor

The previous Cursor object set, or null.

Exceptions

LWJGLException:: if the cursor could not be set for any reason

updateCursor	back to summary
public static void updateCursor() Updates the cursor, so that animation can be changed if needed. This method is called automatically by the window on its update, and shouldn't be called otherwise

public Class Mouse

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail