Struct WindowBuilder

pub struct WindowBuilder { /* private fields */ }

Available on crate feature dep_sdl2 only.

The type that allows you to build windows.

Implementations

impl WindowBuilder

pub fn new( v: &VideoSubsystem, title: &str, width: u32, height: u32, ) -> WindowBuilder

Initializes a new WindowBuilder.

pub fn build(&self) -> Result<Window, WindowBuildError>

Builds the window.

pub fn window_flags(&self) -> u32

Gets the underlying window flags.

pub fn set_window_flags(&mut self, flags: u32) -> &mut WindowBuilder

Sets the underlying window flags. This will effectively undo any previous build operations, excluding window size and position.

pub fn position(&mut self, x: i32, y: i32) -> &mut WindowBuilder

Sets the window position.

pub fn position_centered(&mut self) -> &mut WindowBuilder

Centers the window.

pub fn fullscreen(&mut self) -> &mut WindowBuilder

Sets the window to fullscreen.

pub fn fullscreen_desktop(&mut self) -> &mut WindowBuilder

Sets the window to fullscreen at the current desktop resolution.

pub fn opengl(&mut self) -> &mut WindowBuilder

Sets the window to be usable with an OpenGL context

pub fn vulkan(&mut self) -> &mut WindowBuilder

Sets the window to be usable with a Vulkan instance

pub fn hidden(&mut self) -> &mut WindowBuilder

Hides the window.

pub fn borderless(&mut self) -> &mut WindowBuilder

Removes the window decoration.

pub fn resizable(&mut self) -> &mut WindowBuilder

Sets the window to be resizable.

pub fn minimized(&mut self) -> &mut WindowBuilder

Minimizes the window.

pub fn maximized(&mut self) -> &mut WindowBuilder

Maximizes the window.

pub fn input_grabbed(&mut self) -> &mut WindowBuilder

Sets the window to have grabbed input focus.

pub fn allow_highdpi(&mut self) -> &mut WindowBuilder

Creates the window in high-DPI mode if supported (>= SDL 2.0.1)

pub fn always_on_top(&mut self) -> &mut WindowBuilder

Window should always above others (>= SDL 2.0.5)

pub fn metal_view(&mut self) -> &mut WindowBuilder

Create a SDL_MetalView when constructing the window. This is required when using the raw_window_handle feature on MacOS. Has no effect no other platforms.

pub fn set_shaped(&mut self) -> &mut WindowBuilder

Sets shaped state, to create via SDL_CreateShapedWindow instead of SDL_CreateWindow

Trait Implementations

impl Debug for WindowBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.