Skip to main content

Module event

Module event 

Source
Expand description

The event module contains traits and structs to actually run your game mainloop and handle top-level state, as well as handle input events such as keyboard and mouse.

If you don’t want to use ggez’s built in event loop, you can write your own mainloop and check for events on your own. This is not particularly hard, there’s nothing special about the EventHandler trait. It just tries to simplify the process a little. For examples of how to write your own main loop, see the source code for this module, or the eventloop example.

Re-exports§

pub use crate::input::gamepad::GamepadId;

Enums§

Axis
Gamepad’s elements which state can be represented by value from -1.0 to 1.0.
Button
Gamepad’s elements which state can be represented by value from 0.0 to 1.0.
ErrorOrigin
Used in EventHandler::on_error() to specify where an error originated

Traits§

EventHandler
A trait defining event callbacks. This is your primary interface with ggez’s event loop. Implement this trait for a type and override at least the update() and draw() methods, then pass it to event::run() to run the game’s mainloop.

Functions§

process_device_event
Feeds a DeviceEvent into the Context so it can update any internal state it needs to, such as detecting mouse movements. If you are rolling your own event loop, you should call this on the events you receive before processing them yourself.
process_eventDeprecated
Feeds an Event into the Context so it can update any internal state it needs to, such as detecting window resizes. If you are rolling your own event loop, you should call this on the events you receive before processing them yourself.
process_window_event
Feeds a WindowEvent into the Context so it can update any internal state it needs to, such as detecting window resizes. If you are rolling your own event loop, you should call this on the events you receive before processing them yourself.
run
Runs the game’s main loop, calling event callbacks on the given state object as events occur.