Struct sdl2::Sdl

pub struct Sdl { /* fields omitted */ }

The SDL context type. Initialize with sdl2::init().

From a thread-safety perspective, Sdl represents the main thread. As such, Sdl is a useful type for ensuring that SDL types that can only be used on the main thread are initialized that way.

For instance, SDL_PumpEvents() is not thread safe, and may only be called on the main thread. All functionality that calls SDL_PumpEvents() is thus put into an EventPump type, which can only be obtained through Sdl. This guarantees that the only way to call event-pumping functions is on the main thread.

Methods

impl Sdl

pub fn keyboard(&self) -> KeyboardUtil

impl Sdl

pub fn mouse(&self) -> MouseUtil

impl Sdl

pub fn audio(&self) -> Result<AudioSubsystem, String>

Initializes the audio subsystem.

pub fn event(&self) -> Result<EventSubsystem, String>

Initializes the event subsystem.

pub fn joystick(&self) -> Result<JoystickSubsystem, String>

Initializes the joystick subsystem.

pub fn haptic(&self) -> Result<HapticSubsystem, String>

Initializes the haptic subsystem.

pub fn game_controller(&self) -> Result<GameControllerSubsystem, String>

Initializes the game controller subsystem.

pub fn timer(&self) -> Result<TimerSubsystem, String>

Initializes the timer subsystem.

pub fn video(&self) -> Result<VideoSubsystem, String>

Initializes the video subsystem.

pub fn event_pump(&self) -> Result<EventPump, String>

Obtains the SDL event pump.

At most one EventPump is allowed to be alive during the program's execution. If this function is called while an EventPump instance is alive, the function will return an error.

Trait Implementations

impl Clone for Sdl

fn clone(&self) -> Sdl

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.