Struct sdl2_window::Sdl2Window

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

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.

Methods

impl Sdl2Window

fn new(settings: &WindowSettings) -> Result<Self, String>

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.

fn with_subsystem(video_subsystem: VideoSubsystem,
                  settings: &WindowSettings)
                  -> Result<Self, String>

Creates a window with the supplied SDL Video subsystem.

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 BuildFromWindowSettings for Sdl2Window

fn build_from_window_settings(settings: &WindowSettings) -> Result<Self, String>

Builds the window from a WindowSettings object.

impl Drop for Sdl2Window

fn drop(&mut self)

A method called when the value goes out of scope.

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) -> Input

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

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

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<Input>

Polls an input event from the window.

fn draw_size(&self) -> Size

Gets the draw size of the window.

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_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 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 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 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.