Module OcsfmlWindow.Mouse

module Mouse: sig .. end
Give access to the real-time state of the mouse.

Mouse provides an interface to the state of the mouse.

A single mouse is assumed.

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 set_position and get_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).


type button = OcsfmlWindow.Event.mouseButton 
Mouse buttons
val is_button_pressed : button -> bool
Check if a mouse button is pressed.
Returns True if the button is pressed, false otherwise
val get_position : unit -> int * int
Get the current position of the mouse in desktop coordinates.

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

val get_relative_position : #OcsfmlWindow.window -> int * int
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.
Returns Current position of the mouse

val set_position : int * int -> unit
Set the current position of the mouse in desktop coordinates.

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

val set_relative_position : int * int -> #OcsfmlWindow.window -> unit
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.