Struct Window

Source

pub struct Window { /* private fields */ }

Expand description

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§

Source §

impl Window

Source

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

Source

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

Source

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

Create a new Window without taking ownership of the WindowContext

Source

pub fn subsystem(&self) -> &VideoSubsystem

Source

pub fn into_canvas(self) -> CanvasBuilder

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

Source

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

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

Source

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

Source

pub fn gl_swap_window(&self)

Source

pub fn vulkan_instance_extensions(&self) -> Result<Vec<&'static str>, String>

Get the names of the Vulkan instance extensions needed to create a surface with vulkan_create_surface.

Source

pub fn vulkan_create_surface( &self, instance: VkInstance, ) -> Result<VkSurfaceKHR, String>

Create a Vulkan rendering surface for a window.

The VkInstance must be created using a prior call to the vkCreateInstance function in the Vulkan library.

Source

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

Source

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

Source

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

Source

pub fn icc_profile(&self) -> Result<Vec<u8>, String>

Source

pub fn window_pixel_format(&self) -> PixelFormatEnum

Source

pub fn window_flags(&self) -> u32

Source

pub fn has_input_focus(&self) -> bool

Does the window have input focus?

Source

pub fn has_input_grabbed(&self) -> bool

Has the window grabbed input focus?

Source

pub fn has_mouse_focus(&self) -> bool

Does the window have mouse focus?

Source

pub fn is_maximized(&self) -> bool

Is the window maximized?

Source

pub fn is_minimized(&self) -> bool

Is the window minimized?

Source

pub fn is_always_on_top(&self) -> bool

Is the window always on top?

Source

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

Source

pub fn set_resizable(&mut self, resizable: bool)

Source

pub fn set_window_shape_alpha<S: AsRef<SurfaceRef>>( &mut self, shape: S, binarization_cutoff: u8, ) -> Result<(), i32>

Set the shape of the window To be effective:

shaped must have been set using windows builder
binarizationCutoff: specify the cutoff value for the shape’s alpha channel: At or above that cutoff value, a pixel is visible in the shape. Below that, it’s not part of the shape.

Source

pub fn title(&self) -> &str

Source

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

Use this function to set the icon for a window.

§Example:

// requires "--features 'image'"
use sdl2::surface::Surface;

let window_icon = Surface::from_file("/path/to/icon.png")?;
window.set_icon(window_icon);

Source

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

Source

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

Source

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

Use this function to get the size of a window’s borders (decorations) around the client area.

§Remarks

This function is only supported on X11, otherwise an error is returned.

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn show(&mut self)

Source

pub fn hide(&mut self)

Source

pub fn raise(&mut self)

Source

pub fn maximize(&mut self)

Source

pub fn minimize(&mut self)

Source

pub fn restore(&mut self)

Source

pub fn fullscreen_state(&self) -> FullscreenType

Source

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

Source

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 !

Source