Module Sdlmouse

module Sdlmouse: sig .. end

Mouse event handling and cursors

Mouse state

type button =

`\|`	`BUTTON_LEFT`
`\|`	`BUTTON_MIDDLE`
`\|`	`BUTTON_RIGHT`
`\|`	`BUTTON_WHEELUP`
`\|`	`BUTTON_WHEELDOWN`
`\|`	`BUTTON_X of int`	`(*`	BUTTON_X is only seen in a Sdlevent.mousebutton_event, it is not returned by Sdlmouse.get_state	`*)`

val get_state : ?relative:bool -> unit -> int * int * button list

Retrieve the current state of the mouse : current mouse position and list of pressed buttons

relative : if true returns mouse delta instead of position

val warp : int -> int -> unit

Set the position of the mouse cursor (generates a mouse motion event)

Cursors

type cursor

abstract type for cursors

type cursor_data = {

`data : (int, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array2.t;`	`(*`	B/W cursor data	`*)`
`mask : (int, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array2.t;`	`(*`	B/W cursor mask	`*)`
`w : int;`	`(*`	width in pixels	`*)`
`h : int;`	`(*`	height in pixels	`*)`
`hot_x : int;`	`(*`	the "tip" of the cursor	`*)`
`hot_y : int;`	`(*`	the "tip" of the cursor	`*)`

}

val make_cursor : data:(int, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array2.t ->
       mask:(int, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array2.t ->
       hot_x:int -> hot_y:int -> cursor

Create a cursor using the specified data and mask (in MSB format).

The cursor is created in black and white according to the following:

data  mask     resulting pixel on screen
    0     1       White
    1     1       Black
    0     0       Transparent
    1     0       Inverted color if possible, black if not.

Cursors created with this function must be freed with Sdlmouse.free_cursor.

val free_cursor : cursor -> unit

Deallocates a cursor.

val set_cursor : cursor -> unit

Set the currently active cursor to the specified one. If the cursor is currently visible, the change will be immediately represented on the display.

val get_cursor : unit -> cursor

Returns the currently active cursor.

val cursor_visible : unit -> bool

Tests if cursor is shown on screen

val show_cursor : bool -> unit

Toggle cursor display

val cursor_data : cursor -> cursor_data

converts an abstract cursor value to concrete cursor data

val pprint_cursor : cursor -> unit

for debugging : prints on stdout

val convert_to_cursor : data:int array ->
       mask:int array -> w:int -> h:int -> hot_x:int -> hot_y:int -> cursor