Scala Native SFML/sfml/sfml.window/Mouse

Mouse

sfml.window.Mouse

object Mouse

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

sfml.window.Mouse provides an interface to the state of the mouse.

It only contains static functions (a single mouse is assumed), so it's not meant to be instantiated.

This class allows users to query the mouse state at any time and directly, without having to deal with a window and its events. Compared to the MouseMoved, MouseButtonPressed and MouseButtonReleased events, Mouse can retrieve the state of the cursor and the buttons at any time (you don't need to store and update a boolean on your side in order to know if a button is pressed or released), and you always get the real state of the mouse, even if it is moved, pressed or released when your window is out of focus and no event is triggered.

The position_= and position functions can be used to change or retrieve the current position of the mouse pointer. There are two versions: one that operates in global coordinates (relative to the desktop) and one that operates in window coordinates (relative to a specific window).

val window: Window = ???


if Mouse.Button.Left.isPressed() then
   // left click...
   ???

// get global mouse position
val position = Mouse.position

// set mouse position relative to a window
Mouse.position_=(window, (100, 200))

Attributes

Graph
Supertypes: class Object

trait Matchable

class Any
Self type: Mouse.type

Members list

Type members

Classlikes

Mouse buttons.

Attributes

Supertypes: trait Enum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Mouse wheels.

Attributes

Supertypes: trait Enum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Value members

Concrete methods

Get the current position of the mouse in desktop coordinates.

This function returns the global position of the mouse cursor on the desktop.

Attributes

Returns: Current position of the mouse

Get the current position of the mouse in window coordinates.

This function returns the current position of the mouse cursor, relative to the given window.

Value parameters

relativeTo: Reference window

Attributes

Returns: Current position of the mouse

Set the current position of the mouse in desktop coordinates.

This function sets the global position of the mouse cursor on the desktop.

Value parameters

position: New position of the mouse

Attributes

Set the current position of the mouse in window coordinates.

This function sets the current position of the mouse cursor, relative to the given window.

Value parameters

position: New position of the mouse
relativeTo: Reference window

Attributes

In this article

Generated with