pub struct Surface { /* private fields */ }Expand description
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 unsafe function Instance::create_surface.
This type is unique to the Rust API of wgpu. In the WebGPU specification,
GPUCanvasContext
serves a similar role.
Implementations§
source§impl Surface
impl Surface
sourcepub fn get_capabilities(&self, adapter: &Adapter) -> SurfaceCapabilities
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.
sourcepub fn get_default_config(
&self,
adapter: &Adapter,
width: u32,
height: u32
) -> Option<SurfaceConfiguration>
pub fn get_default_config(
&self,
adapter: &Adapter,
width: u32,
height: u32
) -> Option<SurfaceConfiguration>
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
sourcepub fn configure(&self, device: &Device, config: &SurfaceConfiguration)
pub fn configure(&self, device: &Device, config: &SurfaceConfiguration)
Initializes Surface for presentation.
Panics
- A old
SurfaceTextureis still alive referencing an old surface. - Texture format requested is unsupported on the surface.
sourcepub fn get_current_texture(&self) -> Result<SurfaceTexture, SurfaceError>
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.
sourcepub unsafe fn as_hal_mut<A: HalApi, F: FnOnce(Option<&mut A::Surface>) -> R, R>(
&mut self,
hal_surface_callback: F
) -> R
Available on non-WebAssembly or crate feature emscripten only.
pub unsafe fn as_hal_mut<A: HalApi, F: FnOnce(Option<&mut A::Surface>) -> R, R>(
&mut self,
hal_surface_callback: F
) -> R
emscripten 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
source§impl Surface
impl Surface
sourcepub fn global_id(&self) -> Id
Available on crate feature expose-ids only.
pub fn global_id(&self) -> Id
expose-ids only.Returns a globally-unique identifier for this Surface.
Calling this method multiple times on the same object will always return the same value.
The returned value is guaranteed to be different for all resources created from the same Instance.