Crate sdl3

Available on crate feature dep_sdl3 only.
Expand description

sdl3 SDL3 bindings for Rust.


§Getting started

extern crate sdl3;

use sdl3::pixels::Color;
use sdl3::event::Event;
use sdl3::keyboard::Keycode;
use std::time::Duration;

pub fn main() {
    let sdl_context = sdl3::init().unwrap();
    let video_subsystem = sdl_context.video().unwrap();

    let window = video_subsystem.window("rust-sdl3 demo", 800, 600)
        .position_centered()
        .build()
        .unwrap();

    let mut canvas = window.into_canvas();

    canvas.set_draw_color(Color::RGB(0, 255, 255));
    canvas.clear();
    canvas.present();
    let mut event_pump = sdl_context.event_pump().unwrap();
    let mut i = 0;
    'running: loop {
        i = (i + 1) % 255;
        canvas.set_draw_color(Color::RGB(i, 64, 255 - i));
        canvas.clear();
        for event in event_pump.poll_iter() {
            match event {
                Event::Quit {..} |
                Event::KeyDown { keycode: Some(Keycode::Escape), .. } => {
                    break 'running
                },
                _ => {}
            }
        }
        // The rest of the game loop goes here...

        canvas.present();
        ::std::thread::sleep(Duration::new(0, 1_000_000_000u32 / 60));
    }
}

Modules§

audio
Audio Functions
clipboard
cpuinfo
dialog
event
Event Handling
filesystem
gamepad
gpu
haptic
Haptic Functions
hint
iostream
joystick
keyboard
libc
libc - Raw FFI bindings to platforms’ system libraries
log
messagebox
mouse
pixels
properties
rect
Rectangles and points.
render
2D accelerated rendering
surface
sys
sdl3-sys: Low level Rust bindings for SDL 3
timer
touch
url
Opening URLs in default system handlers
version
Querying SDL Version
video

Structs§

AudioSubsystem
CameraSubsystem
Error
EventPump
A thread-safe type that encapsulates SDL event-pumping functions.
EventSubsystem
GamepadSubsystem
HapticSubsystem
JoystickSubsystem
Sdl
The SDL context type. Initialize with sdl3::init().
SensorSubsystem
VideoSubsystem

Enums§

IntegerOrSdlError
A given integer was so big that its representation as a C integer would be negative.

Functions§

clear_error
get_error
get_platform
Get platform name
init
Initializes the SDL library. This must be called before using any other SDL function.
set_error