Struct ActiveSurfaceWindow 

pub struct ActiveSurfaceWindow<'w> { /* private fields */ }

Available on crate features winit only.

A borrowed form of SurfaceWindow which guarantees that its surface exists & is configured, ready to be rendered to.

Only one instance is allowed at any time (per SurfaceWindow). wgpu panics if multiple wgpu::SurfaceTextures exist in specific conditions, so the safest thing to do is make sure only one can exist.

Implementations

impl ActiveSurfaceWindow<'_>

pub unsafe fn surface(&self) -> &Surface<'static>

Get the window’s wgpu::Surface.

This is unsafe because reconfiguring this surface while it has an active view will cause wgpu to panic. wgpu doesn’t enforce this so I gotta. In other words:
ABSOLUTELY DO NOT CALL wgpu::Surface::configure ON THIS SURFACE

pub fn config(&self) -> SurfaceConfiguration

Get the surface’s wgpu::SurfaceConfiguration.

Under the hood, self.surface().get_configuration().unwrap() - the surface is guaranteed to be configured if it made it into this struct.

pub fn window(&self) -> &Window

Get the winit::window::Window.

pub fn get_size(&self) -> PhysicalSize<u32>

Convenience function to get the window’s inner size.

pub fn get_config_size(&self) -> PhysicalSize<u32>

Convenience function to get the configured size of the surface.

Resize events may not be sent in time before a frame runs, leading to desyncs. This may cause a panic on wgpu’s side if you have a depth, which needs to always be kept the same size as the configured surface.
See also Self::resized.

pub fn texture(&self) -> &SurfaceTexture

Get the surface’s wgpu::SurfaceTexture.

pub fn view(&self) -> &TextureView

Get the surface texture’s wgpu::TextureView with default settings.

pub fn resized(&self) -> bool

Returns true if the surface has just been resized (reconfigured or rebuilt with a new size since last frame).

Useful to keep a depth stencil buffer in-sync.

pub fn as_colour_attachment<'a>( &'a self, clear: Option<Color>, ) -> RenderPassColorAttachment<'a>

Get a wgpu::RenderPassColorAttachment to attach this surface’s texture to a render pass, to draw to it using a specified clear colour.

pub fn present_texture(self)

Present the graphics operations to the surface. Consumes this struct, init a new one for next frame.