Struct rich_sdl2_rust::window::Window

pub struct Window<'video> { /* private fields */ }

A window made by SDL2.

Implementations

impl<'video> Window<'video>

pub fn from_id(id: u32, video: &'video Video<'_>) -> Option<Self>

Gets a window from the window id, or None if does not exist.

pub fn grabbed(video: &'video Video<'_>) -> Option<Self>

Gets a grabbed window, or None if does not exist.

pub fn mouse_focused(video: &'video Video<'_>) -> Option<Self>

Gets a focused window, or None if does not exist.

pub fn state(&self) -> WindowState

Returns the state of the window.

pub fn display(&self) -> Option<Display<'_>>

Returns the display at the window, or None if unavailable.

pub fn id(&self) -> u32

Returns the window id.

pub fn pixel_format(&self) -> PixelFormatKind

Returns the pixel format of the window context.

pub fn show(&self)

Shows the window.

pub fn hide(&self)

Hides the window.

pub fn raise(&self)

Raises the window.

pub fn set_input_focus(&self) -> Result<()>

Explicitly sets the input focus to the window.

You almost want to use Window::raise instead of this. This might give focus to a window that is completely obscured by other windows.

pub fn full_screen(&self) -> Result<()>

Make the window full screen.

Errors

Returns Err if failed to make it full screen.

pub fn maximize(&self)

Maximizes the window.

pub fn minimize(&self)

Minimizes the window.

pub fn restore(&self)

Restores the window from maximization/minimization.

pub fn set_icon(&self, icon: &impl Surface)

Sets an icon from a surface for the window.

pub fn is_screen_keyboard_shown(&self) -> bool

Returns whether the window is showing the screen keyboard.

pub fn surface(&self) -> WindowSurface<'_>

Makes the window surface.

pub fn subsystem_kind(&self) -> SubsystemKind

Gets a kind of the underlying subsystem.

Trait Implementations

impl BorderExt for Window<'_>

fn border_widths(&self) -> Result<BorderWidths>

Returns the border widths of the window.

impl BrightnessExt for Window<'_>

fn brightness(&self) -> Brightness

Returns the brightness of the window.

fn set_brightness(&self, brightness: Brightness) -> Result<()>

Sets the brightness of the Window.

impl ConfigExt for Window<'_>

fn max_size(&self) -> Size

Returns the maximum size of the window.

fn min_size(&self) -> Size

Returns the minimum size of the window.

fn size(&self) -> Size

Returns the current size of the window.

fn opacity(&self) -> Opacity

Returns the opacity of the window.

fn pos(&self) -> Point

Returns the position of the window.

fn title(&self) -> &str

Returns the title of the window.

fn set_max_size(&self, _: Size)

Sets the maximum size of the window.

fn set_min_size(&self, _: Size)

Sets the minimum size of the window.

fn set_size(&self, _: Size)

Sets the current size of the window.

fn set_opacity(&self, opacity: Opacity) -> Result<()>

Sets the opacity of the window.

fn set_pos(&self, _: Position)

Sets the position of the window.

fn set_title(&self, title: &str)

Sets the title of the window.

fn set_resizable(&self, resizable: bool)

Sets whether the window is resizable.

fn add_frame(&self)

Adds a frame to the window.

fn remove_frame(&self)

Removes a frame from the window.

impl<'window> ContextSwitchExt<'window> for Window<'window>

fn set_context<'context: 'window>(
    &'window self,
    context: GlContext<'context>
) -> Result<()>

Sets context to the window.

impl Debug for Window<'_>

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

Formats the value using the given formatter.

impl<'video> Drop for Window<'video>

fn drop(&mut self)

Executes the destructor for this type.

impl GammaExt for Window<'_>

fn gamma(&self) -> Result<Gamma>

Returns the gamma ramps of the window.

fn set_gamma(&self, _: GammaParam) -> Result<()>

Sets the gamma ramps of the window.

impl<'video> HasRawWindowHandle for Window<'video>

fn raw_window_handle(&self) -> RawWindowHandle

Downcasts into a raw window handle.

impl MouseGrabExt for Window<'_>

fn grab(&self)

Grabs the mouse.

fn ungrab(&self)

Ungrabs the mouse.

fn is_grabbed(&self) -> bool

Returns whether the window is grabbing the mouse.