[[tags: allegro game]]
== allegro
This document pertains to event related items found in the Allegro egg.
Please see the main [allegro] wiki page for more information.
[[toc:]]
== Enums
=== event-type
(event-type->int event-type)
{{event-type}} may be one of the following symbols:
* joystick-axis
* joystick-button-down
* joystick-button-up
* joystick-configuration
* key-down
* key-char
* key-up
* mouse-axes
* mouse-button-down
* mouse-button-up
* mouse-enter-display
* mouse-leave-display
* mouse-warped
* timer
* display-expose
* display-resize
* display-close
* display-lost
* display-found
* display-switch-in
* display-switch-out
* display-orientation
* audio-stream-fragment
* audio-stream-finished
(int->event-type integer)
== Records
=== any-event
any-event
(any-event-type any-event)
(any-event-source any-event)
(any-event-timestamp any-event)
=== display-event
display-event
(display-event-type display-event)
(display-event-source display-event)
(display-event-timestamp display-event)
(display-event-x display-event)
(display-event-y display-event)
(display-event-width display-event)
(display-event-height display-event)
(display-event-orientation display-event)
=== event
event
(make-event)
(make-event*)
(free-event! event)
=== event-source
event-source
=== event-queue
event-queue
=== joystick-event
joystick-event
(joystick-event-type joystick-event)
(joystick-event-source joystick-event)
(joystick-event-timestamp joystick-event)
(joystick-event-id joystick-event)
(joystick-event-stick joystick-event)
(joystick-event-axis joystick-event)
(joystick-event-position joystick-event)
(joystick-event-button joystick-event)
=== keyboard-event
keyboard-event
(keyboard-event-type keyboard-event)
(keyboard-event-source keyboard-event)
(keyboard-event-timestamp keyboard-event)
(keyboard-event-display keyboard-event)
(keyboard-event-keycode keyboard-event)
(keyboard-event-unichar keyboard-event)
(keyboard-event-modifiers keyboard-event)
(keyboard-event-repeat keyboard-event)
=== mouse-event
mouse-event
(mouse-event-type mouse-event)
(mouse-event-source mouse-event)
(mouse-event-timestamp mouse-event)
(mouse-event-display mouse-event)
(mouse-event-x mouse-event)
(mouse-event-y mouse-event)
(mouse-event-z mouse-event)
(mouse-event-w mouse-event)
(mouse-event-dx mouse-event)
(mouse-event-dy mouse-event)
(mouse-event-dz mouse-event)
(mouse-event-dw mouse-event)
(mouse-event-button mouse-event)
(mouse-event-pressure mouse-event)
=== timer-event
timer-event
(timer-event-type timer-event)
(timer-event-source timer-event)
(timer-event-timestamp timer-event)
(timer-event-count timer-event)
(timer-event-error timer-event)
=== user-event
user-event
(user-event-type user-event)
(user-event-source user-event)
(user-event-timestamp user-event)
(user-event-data1 user-event)
(user-event-data1-set! user-event integer)
(user-event-data2 user-event)
(user-event-data2-set! user-event integer)
(user-event-data3 user-event)
(user-event-data3-set! user-event integer)
(user-event-data4 user-event)
(user-event-data4-set! user-event integer)
== Functions
(user-event-type? integer)
Implements ALLEGRO_EVENT_TYPE_IS_USER.
(make-event-type (integer a) (integer b) (integer c) (integer d))
Implements ALLEGRO_GET_EVENT_TYPE.
(event-type event)
Returns the type of a given event struct.
(event->any-event event)
Converts an event to an any-event.
(event->display-event event)
Converts an event to a display-event.
(event->joystick-event event)
Converts an event to a joystick-event.
(event->keyboard-event event)
Converts an event to a keyboard-event.
(event->mouse-event event)
Converts an event to a mouse-event.
(event->timer-event event)
Converts an event to a timer-event.
(event->user-event event)
Converts an event to a user-event.
(user-event-source-init! event-source)
Implements al_init_user_event_source.
(free-user-event-source! event-source)
Implements al_destroy_user_event_source.
(emit-user-event! event-source event (function void (user-event)))
Implements al_emit_user_event.
(user-event-unref! user-event)
Implements al_unref_user_event.
(event-source-data event-source)
Implements al_get_event_source_data.
(event-source-data-set! event-source integer)
Implements al_set_event_source_data.
(make-event-queue*)
Implements al_create_event_queue.
(make-event-queue)
Implements al_create_event_queue, with (free-event-queue!) declared as a finalizer.
(free-event-queue! event-queue)
Implements al_destroy_event_queue.
(event-queue-register-source! event-queue event-source)
Implements al_register_event_source.
(event-queue-unregister-source! event-queue event-source)
Implements al_unregister_event_source.
(event-queue-empty? event-queue)
Implements al_is_event_queue_empty.
(event-queue-next! event-queue event)
Implements al_get_next_event.
(event-queue-peek! event-queue event)
Implements al_peek_next_event.
(event-queue-drop-next! event-queue)
Implements al_drop_next_event_queue.
(event-queue-flush! event-queue)
Implements al_drop_next_event.
(event-queue-wait! event-queue event)
Implements al_wait_for_event.
(event-queue-timed-wait! event-queue event float)
Implements al_wait_for_event_timed.
(event-queue-wait-until! event-queue event timeout)
Implements al_wait_for_event_until.