Struct Sdl2Window

pub struct Sdl2Window {
    pub window: Window,
    pub context: GLContext,
    pub sdl_context: Sdl,
    pub video_subsystem: VideoSubsystem,
    /* private fields */
}

A window implemented by SDL2 back-end.

Fields

window: Window

SDL window handle.

context: GLContext

Allow dead code because this keeps track of the OpenGL context. Will be released on drop.

sdl_context: Sdl

SDL context.

video_subsystem: VideoSubsystem

Video subsystem.

Implementations

impl Sdl2Window

pub fn new(settings: &WindowSettings) -> Result<Self, Box<dyn Error>>

Creates a new game window for SDL2. This will initialize SDL and the video subsystem. You can retrieve both via the public fields on the Sdl2Window struct.

Examples found in repository

examples/window_settings.rs (lines 8-12)

fn main() {
    let _ = Sdl2Window::new(
        &WindowSettings::new("SDL Window", (640, 480))
            .fullscreen(false)
            .vsync(true), // etc
    )
    .unwrap();
}

examples/window_opengl.rs (lines 10-15)

fn main() {
    let _ = Sdl2Window::new(
        &WindowSettings::new("SDL Window", (640, 480))
            .fullscreen(false)
            .vsync(true)
            .graphics_api(OpenGL::V2_1), // etc
    )
    .unwrap();
}

pub fn with_subsystem( video_subsystem: VideoSubsystem, settings: &WindowSettings, ) -> Result<Self, Box<dyn Error>>

Creates a window with the supplied SDL Video subsystem.

Examples found in repository

examples/window_subsystem.rs (lines 12-17)

fn main() {
    let sdl = sdl2::init().unwrap();
    let video_subsystem = sdl.video().unwrap();

    let _ = Sdl2Window::with_subsystem(
        video_subsystem,
        &WindowSettings::new("SDL Window", (640, 480))
            .fullscreen(false)
            .vsync(true), // etc
    )
    .unwrap();
}

pub fn init_joysticks(&mut self) -> Result<u32, String>

Initialize the joystick subsystem. Required before joystick input events will be returned. Returns the number available or error.

Trait Implementations

impl AdvancedWindow for Sdl2Window

fn get_title(&self) -> String

Gets a copy of the title of the window.

fn set_title(&mut self, value: String)

Sets the title of the window.

fn get_automatic_close(&self) -> bool

Gets whether the window will automatically close when attempting to close it.

fn set_automatic_close(&mut self, value: bool)

Sets whether the window will automatically close when attempting to close it. If this is disabled, attempts to close the window can be detected via an Input::Close(..) event, and Window::set_should_close() can be called to actually close the window.

fn get_exit_on_esc(&self) -> bool

Gets whether to exit when pressing esc.

fn set_exit_on_esc(&mut self, value: bool)

Sets whether to exit when pressing esc.

fn set_capture_cursor(&mut self, value: bool)

Sets whether to capture/grab the cursor.

fn show(&mut self)

Shows the window.

fn hide(&mut self)

Hides the window.

fn get_position(&self) -> Option<Position>

Gets the position of window.

fn set_position<P: Into<Position>>(&mut self, pos: P)

Sets the position of window.

fn set_size<S: Into<Size>>(&mut self, size: S)

Sets the window size.

fn title(self, value: String) -> Self

Sets title on window.

fn exit_on_esc(self, value: bool) -> Self

Sets whether to exit when pressing the Esc button.

fn automatic_close(self, value: bool) -> Self

Sets whether the window will automatically close when attempting to close it. If this is disabled, attempts to close the window can be detected via an Input::Close(..) event, and Window::set_should_close() can be called to actually close the window.

fn capture_cursor(self, value: bool) -> Self

Sets whether to capture/grab the cursor.

fn position<P>(self, val: P) -> Self

where P: Into<Position>,

Sets the position of window.

impl BuildFromWindowSettings for Sdl2Window

fn build_from_window_settings( settings: &WindowSettings, ) -> Result<Self, Box<dyn Error>>

Builds the window from a WindowSettings object.

impl Drop for Sdl2Window

fn drop(&mut self)

Executes the destructor for this type.

impl OpenGLWindow for Sdl2Window

fn get_proc_address(&mut self, proc_name: &str) -> ProcAddress

Returns the address of the specified OpenGL function if it exists.

fn is_current(&self) -> bool

Returns true if this window’s gl context is the current gl context.

fn make_current(&mut self)

Make the window’s gl context the current gl context.

impl Window for Sdl2Window

fn should_close(&self) -> bool

Returns true if the window should close.

fn set_should_close(&mut self, value: bool)

Tells the window to close or stay open.

fn swap_buffers(&mut self)

Swaps render buffers.

fn size(&self) -> Size

Gets the size of the window.

fn wait_event(&mut self) -> Event

Wait indefinitely for an input event to be available from the window.

fn wait_event_timeout(&mut self, timeout: Duration) -> Option<Event>

Wait for an input event to be available from the window or for the specified timeout to be reached.

fn poll_event(&mut self) -> Option<Event>

Polls an input event from the window.

fn draw_size(&self) -> Size

Gets the draw size of the window.