Struct Surface

pub struct Surface<'window> { /* private fields */ }

Handle to a presentable surface.

A Surface represents a platform-specific surface (e.g. a window) onto which rendered images may be presented. A Surface may be created with the function [Instance::create_surface].

This type is unique to the Rust API of wgpu. In the WebGPU specification, GPUCanvasContext serves a similar role.

Implementations

impl Surface<'_>

pub fn get_capabilities(&self, adapter: &Adapter) -> SurfaceCapabilities

Returns the capabilities of the surface when used with the given adapter.

Returns specified values (see [SurfaceCapabilities]) if surface is incompatible with the adapter.

pub fn get_default_config( &self, adapter: &Adapter, width: u32, height: u32, ) -> Option<SurfaceConfiguration<Vec<TextureFormat>>>

Return a default SurfaceConfiguration from width and height to use for the Surface with this adapter.

Returns None if the surface isn’t supported by this adapter

pub fn configure( &self, device: &Device, config: &SurfaceConfiguration<Vec<TextureFormat>>, )

Initializes Surface for presentation.

Panics

• A old [SurfaceTexture] is still alive referencing an old surface.
• Texture format requested is unsupported on the surface.
• config.width or config.height is zero.

pub fn get_current_texture(&self) -> Result<SurfaceTexture, SurfaceError>

Returns the next texture to be presented by the swapchain for drawing.

In order to present the [SurfaceTexture] returned by this method, first a [Queue::submit] needs to be done with some work rendering to this texture. Then [SurfaceTexture::present] needs to be called.

If a SurfaceTexture referencing this surface is alive when the swapchain is recreated, recreating the swapchain will panic.

pub unsafe fn as_hal<A, F, R>(&mut self, hal_surface_callback: F) -> Option<R>

where A: HalApi, F: FnOnce(Option<&<A as Api>::Surface>) -> R,

Available on wgpu_core only.

Returns the inner hal Surface using a callback. The hal surface will be None if the backend type argument does not match with this wgpu Surface

Safety

• The raw handle obtained from the hal Surface must not be manually destroyed

Trait Implementations

impl<'window> Debug for Surface<'window>

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

Formats the value using the given formatter.

impl Drop for Surface<'_>

fn drop(&mut self)

Executes the destructor for this type.