Messages

onQuit[in The SDL Falcon Module.]

Quit requested event.

...handler...

SDLEventHandler

See SDL_Quit description in SDL documentation.

Subscribe to this message method to receive SDL_Quit events.

This notification means that the user asked the application to terminate. The application should call exit(0) if no other cleanup routines are needed, or perform cleanup and notifications for clean exit to other threads/coroutines.

sdl_Active[in The SDL Falcon Module.]

Application visibility event handler.

...handler... ( gain, state )

gain0 if the event is a loss or 1 if it is a gain.
stateSDL.APPMOUSEFOCUS if mouse focus was gained or lost, SDL.APPINPUTFOCUS if input focus was gained or lost, or SDL.APPACTIVE if the application was iconified (gain=0) or restored (gain=1).

See SDL_ActiveEvent description in SDL documentation.

Subscribe to this message method to receive ActiveEvent notifications.

sdl_Expose[in The SDL Falcon Module.]

Window exposition (need redraw) notification.

...handler...

See SDL_ExposeEvent description in SDL documentation.

Subscribe to this message method to receive SDL_VIDEOEXPOSE notifications.

sdl_JoyAxisMotion[in The SDL Falcon Module.]

Joystick axis motion event handler

...handler... ( which, axis, value )

whichJoystick device index
axisJoystick axis index
valueAxis value (range: -32768 to 32767)

See SDL_JoyAxisEvent description in SDL documentation.

Subscribe to this message method to receive SDL_JOYAXISMOTION notifications.

sdl_JoyBallMotion[in The SDL Falcon Module.]

Joystick trackball motion event handler

...handler... ( which, ball, xrel, yrel )

whichJoystick device index
ballJoystick trackball index
xrelThe relative motion in the X direction
yrelThe relative motion in the Y direction

See SDL_JoyBallEvent description in SDL documentation.

Subscribe to this message method to receive SDL_JOYBALLMOTION notifications.

sdl_JoyButtonDown[in The SDL Falcon Module.]

Joystick button event handler

...handler... ( which, button, state )

whichJoystick device index
buttonJoystick button index
stateSDL_PRESSED or SDL_RELEASED

See SDL_JoyButtonEvent description in SDL documentation.

Subscribe to this message method to receive SDL_JOYBUTTONDOWN notifications.

sdl_JoyButtonUp[in The SDL Falcon Module.]

Joystick button event handler

...handler... ( which, button, state )

whichJoystick device index
buttonJoystick button index
stateSDL_PRESSED or SDL_RELEASED

See SDL_JoyButtonEvent description in SDL documentation.

Subscribe to this message method to receive SDL_JOYBUTTONUP notifications.

sdl_JoyHatMotion[in The SDL Falcon Module.]

Joystick hat position change event handler

...handler... ( which, hat, value )

whichJoystick device index
hatJoystick hat index
valuehat position.

See SDL_JoyHatEvent description in SDL documentation.

Subscribe to this message method to receive SDL_JOYHATMOTION notifications.

sdl_KeyDown[in The SDL Falcon Module.]

Keyboard key down event handler.

...handler... ( state, scancode, sym, mod, unicode )

stateSDL.PRESSED or SDL.RELEASED
scancodeHardware specific scancode
symSDL virtual keysym
modCurrent key modifiers
unicodeTranslated character

See SDL_KeyboardEvent description in SDL documentation.

Subscribe to this message method to receive SDL_KEYDOWN notifications.

sdl_KeyUp[in The SDL Falcon Module.]

Keyboard key down event handler.

...handler... ( state, scancode, sym, mod, unicode )

stateSDL.PRESSED or SDL.RELEASED
scancodeHardware specific scancode
symSDL virtual keysym
modCurrent key modifiers
unicodeTranslated character

See SDL_KeyboardEvent description in SDL documentation.

Subscribe to this message method to receive SDL_KEYUP notifications.

sdl_MouseButtonDown[in The SDL Falcon Module.]

Mouse button event handler

...handler... ( state, button, x, y )

stateThe current button state
buttonThe mouse button index (SDL_BUTTON_LEFT, SDL_BUTTON_MIDDLE, SDL_BUTTON_RIGHT)
xX coordinate of the mouse
yX coordinate of the mouse

See SDL_MouseButtonEvent description in SDL documentation.

Subscribe to this message method to receive SDL_MOUSEBUTTONDOWN notifications.

sdl_MouseButtonUp[in The SDL Falcon Module.]

Mouse button event handler

...handler... ( state, button, x, y )

stateThe current button state
buttonThe mouse button index (SDL_BUTTON_LEFT, SDL_BUTTON_MIDDLE, SDL_BUTTON_RIGHT)
xX coordinate of the mouse
yX coordinate of the mouse

See SDL_MouseButtonEvent description in SDL documentation.

Subscribe to this message method to receive SDL_MOUSEBUTTONUP notifications.

sdl_MouseMotion[in The SDL Falcon Module.]

Mouse motion event handler

...handler... ( state, x, y, xrel, yrel )

stateThe current button state
xX coordinate of the mouse
yX coordinate of the mouse
xrelrelative movement of mouse on the X axis with respect to last notification.
yrelrelative movement of mouse on the X axis with respect to last notification.

See SDL_MouseMotionEvent description in SDL documentation.

Subscribe to this message method to receive SDL_MOUSEMOTION notifications.

sdl_Resize[in The SDL Falcon Module.]

Window resize event handler

...handler... ( w, h )

wNew width of the window
hNew height of the window

See SDL_ResizeEvent description in SDL documentation.

Subscribe to this message method to receive SDL_VIDEORESIZE notifications.


Made with faldoc 2.0.0