Module ggez::event

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;

Modules

winit_event

winit events; nested in a module for re-export neatness.

Structs

EventLoop

winit event loop. Provides a way to retrieve events from the system and from the windows that were registered to the events loop.

Enums

Axis

An analog axis of some device (gamepad thumbstick, joystick…). Gamepad’s elements which state can be represented by value from -1.0 to 1.0.

Button

A button of some device (gamepad, joystick…). Gamepad’s elements which state can be represented by value from 0.0 to 1.0.

ControlFlow

winit event loop. Set by the user callback given to the EventLoop::run method.

ErrorOrigin

Used in EventHandler::on_error() to specify where an error originated

MouseButton

A mouse button. Describes a button of a mouse controller.

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_event

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.

request_quit

Attempts to terminate the ggez::event::run() loop by requesting a quit_event at the very start of the next frame. If this event returns Ok(false), then Context.continuing is set to false and the loop breaks.

run

Runs the game’s main loop, calling event callbacks on the given state object as events occur.

Type Definitions

ScanCode

A mouse button. Hardware-dependent keyboard scan code.