Struct swsurface::SwWindow

pub struct SwWindow { /* fields omitted */ }

A software-rendered window.

This is a safe wrapper around Surface and winit::window::Window. For each method, only a synopsis is provided here. See Surface's documentation for a full documentation.

Methods

impl SwWindow

pub fn new(window: Window, context: &Context, config: &Config) -> Self

Construct a SwWindow by wrapping an existing Window.

pub fn into_window(self) -> Window

Detach the surface and get the wrapped winit::window::Window.

pub unsafe fn split(self) -> (Surface, Window)

Split the Window apart from the Surface.

Unsafety: The Surface must be dropped before the Window.

pub fn window(&self) -> &Window

Get a reference to the wrapped winit::window::Window.

pub fn update_surface(&self, extent: [u32; 2], format: Format)

Update the properties of the surface.

pub fn update_surface_to_fit(&self, format: Format)

Update the properties of the surface. The surface size is automatically derived based on the window size.

pub fn supported_formats(&self) -> impl Iterator<Item = Format> + '_

Enumerate supported pixel formats.

pub fn image_info(&self) -> ImageInfo

Get the ImageInfo describing the current swapchain images.

pub fn num_images(&self) -> usize

Get the number of swapchain images.

pub fn does_preserve_image(&self) -> bool

Get a flag indicating whether swapchain images preserve their contents when their indices are used again.

pub fn poll_next_image(&self) -> Option<usize>

Get the index of the next available swapchain image. Blocks the current thread.

pub fn lock_image(&self, i: usize) -> impl Deref<Target = [u8]> + DerefMut + '_

Lock a swapchain image at index i to access its contents.

pub fn present_image(&self, i: usize)

Enqueue the presentation of a swapchain image at index i.

Trait Implementations

impl Debug for SwWindow

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

Formats the value using the given formatter.

impl Drop for SwWindow

fn drop(&mut self)

Executes the destructor for this type.