Struct Window

pub struct Window { /* private fields */ }

Represents the “shell” of a Window.

You can set get and set many of the SDL_Window properties (i.e., border, size, PixelFormat, etc)

However, you cannot directly access the pixels of the Window. It needs to be converted to a Canvas to access the rendering functions.

Note: If a Window goes out of scope but it cloned its context, then the SDL_Window will not be destroyed until there are no more references to the WindowContext. This may happen when a TextureCreator<Window> outlives the Canvas<Window>

Implementations

impl Window

pub fn raw(&self) -> *mut SDL_Window

pub unsafe fn from_ll(subsystem: VideoSubsystem, raw: *mut SDL_Window) -> Window

pub unsafe fn from_ref(context: Rc<WindowContext>) -> Window

Create a new Window without taking ownership of the WindowContext

pub fn subsystem(&self) -> &VideoSubsystem

pub fn into_canvas(self) -> CanvasBuilder

Initializes a new CanvasBuilder; a convenience method that calls CanvasBuilder::new().

pub fn context(&self) -> Rc<WindowContext>

pub fn id(&self) -> u32

pub fn gl_create_context(&self) -> Result<GLContext, String>

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

Set the window’s OpenGL context to the current context on the thread.

pub fn gl_make_current(&self, context: &GLContext) -> Result<(), String>

pub fn gl_swap_window(&self)

pub fn display_index(&self) -> Result<i32, String>

pub fn set_display_mode<D>(&mut self, display_mode: D) -> Result<(), String>

where D: Into<Option<DisplayMode>>,

pub fn display_mode(&self) -> Result<DisplayMode, String>

pub fn window_pixel_format(&self) -> PixelFormatEnum

pub fn window_flags(&self) -> u32

pub fn set_title(&mut self, title: &str) -> Result<(), NulError>

pub fn title(&self) -> &str

pub fn set_icon<S>(&mut self, icon: S)

where S: AsRef<SurfaceRef>,

pub fn set_position(&mut self, x: WindowPos, y: WindowPos)

pub fn position(&self) -> (i32, i32)

pub fn set_size( &mut self, width: u32, height: u32, ) -> Result<(), IntegerOrSdlError>

pub fn size(&self) -> (u32, u32)

pub fn drawable_size(&self) -> (u32, u32)

pub fn set_minimum_size( &mut self, width: u32, height: u32, ) -> Result<(), IntegerOrSdlError>

pub fn minimum_size(&self) -> (u32, u32)

pub fn set_maximum_size( &mut self, width: u32, height: u32, ) -> Result<(), IntegerOrSdlError>

pub fn maximum_size(&self) -> (u32, u32)

pub fn set_bordered(&mut self, bordered: bool)

pub fn show(&mut self)

pub fn hide(&mut self)

pub fn raise(&mut self)

pub fn maximize(&mut self)

pub fn minimize(&mut self)

pub fn restore(&mut self)

pub fn fullscreen_state(&self) -> FullscreenType

pub fn set_fullscreen( &mut self, fullscreen_type: FullscreenType, ) -> Result<(), String>

pub fn surface<'a>( &'a self, _e: &'a EventPump, ) -> Result<WindowSurfaceRef<'a>, String>

Returns a WindowSurfaceRef, which can be used like a regular Surface. This is an alternative way to the Renderer (Canvas) way to modify pixels directly in the Window.

For this to happen, simply create a WindowSurfaceRef via this method, use the underlying Surface however you like, and when the changes of the Surface must be applied to the screen, call update_window if you intend to keep using the WindowSurfaceRef afterwards, or finish if you don’t intend to use it afterwards.

The Renderer way is of course much more flexible and recommended; even though you only want to support Software Rendering (which is what using Surface is), you can still create a Renderer which renders in a Software-based manner, so try to rely on a Renderer as much as possible !

pub fn set_grab(&mut self, grabbed: bool)

pub fn grab(&self) -> bool

pub fn set_brightness(&mut self, brightness: f64) -> Result<(), String>

pub fn brightness(&self) -> f64

pub fn set_gamma_ramp<'a, 'b, 'c, R, G, B>( &mut self, red: R, green: G, blue: B, ) -> Result<(), String>

where R: Into<Option<&'a [u16; 256]>>, G: Into<Option<&'b [u16; 256]>>, B: Into<Option<&'c [u16; 256]>>,

pub fn gamma_ramp(&self) -> Result<(Vec<u16>, Vec<u16>, Vec<u16>), String>

Trait Implementations

impl From<WindowContext> for Window

fn from(context: WindowContext) -> Window

Converts to this type from the input type.

impl RenderTarget for Window

type Context = WindowContext