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 widow 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 window from window settings.

impl Drop for Sdl2Window

fn drop(&mut self)

A method called when the value goes out of scope.

impl Window for Sdl2Window

type Event = Input

The event type emitted by poll_event

fn should_close(&self) -> bool

Returns true if 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 in user coordinates.

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

Polls event from window.

fn draw_size(&self) -> Size

Gets draw size of the window. This is equal to the size of the frame buffer of the inner window, excluding the title bar and borders.

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 cursor. This is used to lock and hide cursor to the window, for example in a first-person shooter game.

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

Sets title on window.

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

Sets whether to exit when pressing esc.

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

Sets whether to capture/grab cursor (see set_capture_cursor).

impl OpenGLWindow for Sdl2Window

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

Returns the address of an OpenGL function if it exist, else returns null pointer.

fn is_current(&self) -> bool

Returns true if this context is the current context.

fn make_current(&mut self)

Make this context current.