org.jsfml.window

Class Mouse

java.lang.Object

org.jsfml.window.Mouse

public final class Mouse
extends Object

Provides access to the the real-time state of the mouse.

The methods in this class provide direct access to the mouse state, that means that they work independently of a window's focus. In order to react to window based events, use the Window.pollEvents() method instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Mouse.Button Enumeration of supported mouse buttons.

Method Summary

Methods

Modifier and Type	Method and Description
static Vector2i	getPosition() Retrieves the absolute position of the mouse cursor on the screen.
static Vector2i	getPosition(Window relativeTo) Retrieves the position of the mouse cursor relative to a window.
static boolean	isButtonPressed(Mouse.Button button) Checks if a mouse button is currently pressed.
static void	setPosition(Vector2i position) Sets the absolute position of the mouse cursor on the screen.
static void	setPosition(Vector2i position, Window relativeTo) Sets the position of the mouse cursor relative to a window.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isButtonPressed

public static boolean isButtonPressed(Mouse.Button button)

Checks if a mouse button is currently pressed.

Parameters:

button - the mouse button in question.

Returns:

true if the button is currently being pressed, false otherwise.

getPosition

public static Vector2i getPosition()

Retrieves the absolute position of the mouse cursor on the screen.

Returns:

the absolute position of the mouse cursor on the screen.

getPosition

public static Vector2i getPosition(Window relativeTo)

Retrieves the position of the mouse cursor relative to a window.

Parameters:

relativeTo - the window in question.

Returns:

the position of the mouse cursor relative to the window's top left corner.

setPosition

public static void setPosition(Vector2i position)

Sets the absolute position of the mouse cursor on the screen.

Parameters:

position - the new absolute position of the mouse cursor on the screen.

setPosition

public static void setPosition(Vector2i position,
               Window relativeTo)

Sets the position of the mouse cursor relative to a window.

Parameters:

position - the new position of the mouse cursor relative to the window's top left corner.

relativeTo - the window in question.