package tsdl

  1. Overview
  2. Docs
On This Page
  1. Event
  2. Event types and their fields
    1. Event type aliases and misc
    2. Common
    3. Application events
    4. Clipboard
    5. Controller events
      1. SDL_ControllerAxisEvent fields
      2. SDL_ControllerButtonEvent fields
      3. SDL_ControllerDeviceEvent fields
    6. Dollar gesture events
      1. SDL_DollarGestureEvent fields
    7. Drop events
      1. SDL_DropEvent fields
    8. Touch events
      1. SDL_TouchFingerEvent fields
    9. Joystick events
      1. SDL_JoyAxisEvent fields
      2. SDL_JoyBallEvent fields
      3. SDL_JoyButtonEvent fields
      4. SDL_JoyDeviceEvent fields
      5. SDL_JoyHatEventfields
    10. Keyboard event
      1. SDL_KeyboardEventfields
    11. Mouse events
      1. SDL_MouseButtonEvent fields
      2. SDL_MouseMotionEvent fields
      3. SDL_MouseWheelEvent fields
    12. Multi gesture events
      1. SDL_MultiGestureEvent fields
    13. Quit events
    14. System window manager events
    15. Text events
      1. SDL_TextEditingEvent fields
      2. SDL_TextInputEvent fields
    16. User events
      1. SDL_UserEvent fields
    17. Display events
      1. SDL_DisplayEvent fields
    18. Sensor events
      1. SDL_SensorEvent fields
    19. Window events
      1. SDL_WindowEvent fields
    20. Render target
    21. Audio hotplug events
      1. SDL_AudioDeviceEvent fields
  3. Event type enum

event accessors and event_type constants and enumeration.

Event

Once you have determined the typ you can access fields available for that type. Safe if you use the wrong accessors: you will just end with garbage data.

type 'b field

The type for event fields.

val create : unit -> event

create () is an uninitialized event structure.

val get : event -> 'b field -> 'b

get e f gets the field f of e.

val set : event -> 'b field -> 'b -> unit

set e f v sets the field f of e to v.

Event types and their fields

Event type aliases and misc

val first_event : event_type
val last_event : event_type

Common

These fields are common to all event types.

val typ : event_type field
val timestamp : uint32 field

Application events

val app_did_enter_background : event_type
val app_did_enter_foreground : event_type
val app_low_memory : event_type
val app_terminating : event_type
val app_will_enter_background : event_type
val app_will_enter_foreground : event_type

Clipboard

val clipboard_update : event_type

Controller events

val controller_axis_motion : event_type
val controller_button_down : event_type
val controller_button_up : event_type
val controller_device_added : event_type
val controller_device_remapped : event_type
val controller_device_removed : event_type

SDL_ControllerAxisEvent fields

val controller_axis_which : joystick_id field
val controller_axis_axis : Controller.axis field
val controller_axis_value : int16 field

SDL_ControllerButtonEvent fields

val controller_button_which : joystick_id field
val controller_button_button : Controller.button field
val controller_button_state : button_state field

SDL_ControllerDeviceEvent fields

val controller_device_which : joystick_id field

Dollar gesture events

val dollar_gesture : event_type
val dollar_record : event_type

SDL_DollarGestureEvent fields

val dollar_gesture_touch_id : touch_id field
val dollar_gesture_gesture_id : gesture_id field
val dollar_gesture_num_fingers : int field
val dollar_gesture_error : float field
val dollar_gesture_x : float field
val dollar_gesture_y : float field

Drop events

Warning If you enable this event drop_file_free must be called on the event after you have finished processing it.

val drop_file : event_type
val drop_text : event_type
val drop_begin : event_type
val drop_complete : event_type
val drop_file_free : event -> unit

SDL_DropEvent fields

val drop_file_file : event -> string option
val drop_window_id : int field

Touch events

val finger_down : event_type
val finger_motion : event_type
val finger_up : event_type

SDL_TouchFingerEvent fields

val touch_finger_touch_id : touch_id field
val touch_finger_finger_id : finger_id field
val touch_finger_x : float field
val touch_finger_y : float field
val touch_finger_dx : float field
val touch_finger_dy : float field
val touch_finger_pressure : float field

Joystick events

val joy_axis_motion : event_type
val joy_ball_motion : event_type
val joy_button_down : event_type
val joy_button_up : event_type
val joy_device_added : event_type
val joy_device_removed : event_type
val joy_hat_motion : event_type

SDL_JoyAxisEvent fields

val joy_axis_which : joystick_id field
val joy_axis_axis : uint8 field
val joy_axis_value : int16 field

SDL_JoyBallEvent fields

val joy_ball_which : joystick_id field
val joy_ball_ball : uint8 field
val joy_ball_xrel : int field
val joy_ball_yrel : int field

SDL_JoyButtonEvent fields

val joy_button_which : joystick_id field
val joy_button_button : uint8 field
val joy_button_state : button_state field

SDL_JoyDeviceEvent fields

val joy_device_which : joystick_id field

SDL_JoyHatEventfields

val joy_hat_which : joystick_id field
val joy_hat_hat : uint8 field
val joy_hat_value : Hat.t field

Keyboard event

val key_down : event_type
val key_up : event_type
val keymap_changed : event_type

SDL_KeyboardEventfields

val keyboard_window_id : int field
val keyboard_state : button_state field
val keyboard_repeat : int field
val keyboard_scancode : scancode field
val keyboard_keycode : keycode field
val keyboard_keymod : keymod field

Mouse events

val mouse_button_down : event_type
val mouse_button_up : event_type
val mouse_motion : event_type
val mouse_wheel : event_type

SDL_MouseButtonEvent fields

val mouse_button_window_id : int field
val mouse_button_which : uint32 field
val mouse_button_button : uint8 field
val mouse_button_state : button_state field
val mouse_button_clicks : uint8 field

SDL 2.0.2

val mouse_button_x : int field

SDL 2.0.2

val mouse_button_y : int field

SDL_MouseMotionEvent fields

val mouse_motion_window_id : int field
val mouse_motion_which : uint32 field
val mouse_motion_state : uint32 field
val mouse_motion_x : int field
val mouse_motion_y : int field
val mouse_motion_xrel : int field
val mouse_motion_yrel : int field

SDL_MouseWheelEvent fields

type mouse_wheel_direction

2.04

val mouse_wheel_normal : mouse_wheel_direction
val mouse_wheel_flipped : mouse_wheel_direction
val mouse_wheel_window_id : int field
val mouse_wheel_which : uint32 field
val mouse_wheel_x : int field
val mouse_wheel_y : int field
val mouse_wheel_direction : mouse_wheel_direction field

2.04

Multi gesture events

val multi_gesture : event_type

SDL_MultiGestureEvent fields

val multi_gesture_touch_id : touch_id field
val multi_gesture_dtheta : float field
val multi_gesture_ddist : float field
val multi_gesture_x : float field
val multi_gesture_y : float field
val multi_gesture_num_fingers : int field

Quit events

val quit : event_type

System window manager events

val sys_wm_event : event_type

Text events

val text_editing : event_type
val text_input : event_type

SDL_TextEditingEvent fields

val text_editing_window_id : int field
val text_editing_text : string field
val text_editing_start : int field
val text_editing_length : int field

SDL_TextInputEvent fields

val text_input_window_id : int field
val text_input_text : string field

User events

val user_event : event_type

SDL_UserEvent fields

val user_window_id : int field
val user_code : int field

Display events

val display_event : event_type

SDL_DisplayEvent fields

val display_display : int32 field
val display_event_id : int field
val display_data1 : int32 field

Sensor events

val sensor_update : event_type

SDL_SensorEvent fields

val sensor_which : int32 field
val sensor_data0 : float field
val sensor_data1 : float field
val sensor_data2 : float field
val sensor_data3 : float field
val sensor_data4 : float field
val sensor_data5 : float field

Window events

val window_event : event_type
type window_event_id = int

SDL_WindowEventID

type window_event_enum = [
  1. | `Close
  2. | `Enter
  3. | `Exposed
  4. | `Focus_gained
  5. | `Focus_lost
  6. | `Hidden
  7. | `Hit_test
  8. | `Leave
  9. | `Maximized
  10. | `Minimized
  11. | `Moved
  12. | `Resized
  13. | `Restored
  14. | `Shown
  15. | `Size_changed
  16. | `Take_focus
  17. | `Unknown of window_event_id
]
val window_event_enum : window_event_id -> window_event_enum
val window_event_shown : window_event_id
val window_event_hidden : window_event_id
val window_event_exposed : window_event_id
val window_event_moved : window_event_id
val window_event_resized : window_event_id
val window_event_size_changed : window_event_id
val window_event_minimized : window_event_id
val window_event_maximized : window_event_id
val window_event_restored : window_event_id
val window_event_enter : window_event_id
val window_event_leave : window_event_id
val window_event_focus_gained : window_event_id
val window_event_focus_lost : window_event_id
val window_event_close : window_event_id
val window_event_take_focus : window_event_id
val window_event_hit_test : window_event_id

SDL_WindowEvent fields

val window_window_id : int field
val window_event_id : window_event_id field
val window_data1 : int32 field
val window_data2 : int32 field

Render target

val render_targets_reset : event_type
val render_device_reset : event_type

Audio hotplug events

val audio_device_added : event_type
val audio_device_removed : event_type

SDL_AudioDeviceEvent fields

val audio_device_timestamp : uint32 field
val audio_device_which : uint32 field
val audio_device_is_capture : int field

Event type enum

type enum = [
  1. | `App_did_enter_background
  2. | `App_did_enter_foreground
  3. | `App_low_memory
  4. | `App_terminating
  5. | `App_will_enter_background
  6. | `App_will_enter_foreground
  7. | `Audio_device_added
  8. | `Audio_device_removed
  9. | `Clipboard_update
  10. | `Controller_axis_motion
  11. | `Controller_button_down
  12. | `Controller_button_up
  13. | `Controller_device_added
  14. | `Controller_device_remapped
  15. | `Controller_device_removed
  16. | `Dollar_gesture
  17. | `Dollar_record
  18. | `Drop_begin
  19. | `Drop_complete
  20. | `Drop_file
  21. | `Drop_text
  22. | `Finger_down
  23. | `Finger_motion
  24. | `Finger_up
  25. | `Keymap_changed
  26. | `Joy_axis_motion
  27. | `Joy_ball_motion
  28. | `Joy_button_down
  29. | `Joy_button_up
  30. | `Joy_device_added
  31. | `Joy_device_removed
  32. | `Joy_hat_motion
  33. | `Key_down
  34. | `Key_up
  35. | `Mouse_button_down
  36. | `Mouse_button_up
  37. | `Mouse_motion
  38. | `Mouse_wheel
  39. | `Multi_gesture
  40. | `Quit
  41. | `Render_targets_reset
  42. | `Render_device_reset
  43. | `Sys_wm_event
  44. | `Text_editing
  45. | `Text_input
  46. | `Unknown of int
  47. | `User_event
  48. | `Window_event
  49. | `Display_event
  50. | `Sensor_update
]
val enum : event_type -> enum
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct