Module Sdl.Event

module Event: sig .. end

Query, Enable or Disable flags

On\Off flags

type pointer 

Pointer for user-defined event data

Application state: application has mouse focus, input focus, active

val get_app_state : unit -> app_state list

get_app_state -> app_state list This function returns the current state of the application. The value returned is list containing one or more of: APPMOUSEFOCUS The application has mouse focus. APPINPUTFOCUS The application has keyboard focus APPACTIVE The application is visible

SDLKey enum An enumeration of keysym definitions. Note : A lot of the keysyms are unavailable on most keyboards. For example, the K_1 keysym can't be accessed on a french keyboard. You get the K_AMPERSAND instead. So, you should not hardcode any keysym unless it's one of the universal keys that are available on all keyboards. Also, remember that the position of the letters can vary and so, although all of them are available on most keyboards, their position might not be practical for your application. And at last, never ever ever write your own custom ASCII conversion table. If you do that, you'll get angry non US users that will pester you to fix the keyboard handling for them, one for each keyboard layout existing in the world. If you want to know the symbol entered by the user, the keyboard_event event is the good place to do it.

SDLMod enum An enumeration of key modifier definitions.

val enable_unicode : que_dis_ena -> off_on

enable_unicode query/disable/enable -> on/off Enables/Disables Unicode keyboard translation. To obtain the character codes corresponding to received keyboard events, Unicode translation must first be turned on using this function. The translation incurs a slight overhead for each keyboard event and is therefore disabled by default. For each subsequently received key down event, the unicode member of the keyboard_event structure will then contain the corresponding character code, or zero for key syms that do not correspond to any character code. ENABLE enables Unicode translation; DISABLE disables it, and QUERY leaves it unchanged (useful for querying the current translation mode). Note that only key press events will be translated, not release events.

val default_repeat_delay : int

Default keyboard repeat delay

val default_repeat_interval : int

Default keyboard repeat interval

val enable_key_repeat : int -> int -> unit

enable_key_repeat repeat_delay repeat_interval Enables or disables the keyboard repeat rate. delay specifies how long the key must be pressed before it begins repeating, it then repeats at the speed specified by interval. Both delay and interval are expressed in milliseconds. Setting delay to 0 disables key repeating completely. Good default values are default_repeat_delay and default_repeat_interval

val get_mod_state : unit -> key_mod list

get_mod_state -> key_mod list Returns a list of the current state of the modifier keys (CTRL, ALT, etc.).

val set_mod_state : key_mod list -> unit

set_mod_state key_mod list Sets the current state of the modifier keys (CTRL, ALT, etc.) in the input list.

val get_key_name : key -> string

get_key_name key keyname Returns the SDL-defined name of the key in key

Released/Pressed

Focus lost/gained

Active event type, containing the application state and focus

Keyboard event type

Mouse button types: left, right, middle, and the scroll wheel (up or down)

Mouse motion event

Mouse button event

Joystick axis event

Joystick ball event

Joystick hat event

Joystick button event

Window resize event

User defined SDL event type

type sys_wm_event 

tsyswmevent not implemented in trial version

event type

val pump_events : unit -> unit

pump_events Pumps the event loop, gathering events from the input devices. pump_events gathers all the pending input information from devices and places it on the event queue. Without calls to pump_events no events would ever be placed on the queue. Often the need for calls to pump_events is hidden from the user since poll_event and wait_event implicitly call pump_events. However, if you are not polling or waiting for events (e.g. you are filtering them), then you must call pump_events to force an event queue update. Note: You can only call this function in the thread that set the video mode.

val poll_event : unit -> event

poll_event -> event Polls for currently pending events. If there are any events, the next event is removed from the queue and stored in the event structure pointed to by event.

val wait_event : unit -> event

wait_event -> event Waits indefinitely for the next available event. If there are any events, the next event is removed from the queue and stored in that area.