pub struct Surface<'window> {
pub(crate) inner: DispatchSurface,
pub(crate) config: Mutex<Option<SurfaceConfiguration>>,
pub(crate) _handle_source: Option<Box<dyn WindowHandle + 'window>>,
}
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 function Instance::create_surface
.
This type is unique to the Rust API of wgpu
. In the WebGPU specification,
GPUCanvasContext
serves a similar role.
Fields§
§inner: DispatchSurface
Additional surface data returned by [DynContext::instance_create_surface
].
config: Mutex<Option<SurfaceConfiguration>>
§_handle_source: Option<Box<dyn WindowHandle + 'window>>
Optionally, keep the source of the handle used for the surface alive.
This is useful for platforms where the surface is created from a window and the surface would become invalid when the window is dropped.
SAFETY: This field must be dropped after all other fields to ensure proper cleanup.
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.
If the surface is already configured, this will wait for the GPU to come idle before recreating the swapchain to prevent race conditions.
§Validation Errors
- Submissions that happen during the configure may cause the internal wait-for-idle to fail, raising a validation error.
§Panics
- A old
SurfaceTexture
is still alive referencing an old surface. - Texture format requested is unsupported on the surface.
config.width
orconfig.height
is zero.
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<A: HalApi>(
&self,
) -> Option<impl Deref<Target = A::Surface> + WasmNotSendSync>
Available on wgpu_core
only.
pub unsafe fn as_hal<A: HalApi>( &self, ) -> Option<impl Deref<Target = A::Surface> + WasmNotSendSync>
wgpu_core
only.Get the wgpu_hal
surface from this Surface
.
Find the Api struct corresponding to the active backend in wgpu_hal::api
,
and pass that struct to the to the A
type parameter.
Returns a guard that dereferences to the type of the hal backend
which implements A::Surface
.
§Errors
This method will return None if:
- The surface is not from the backend specified by
A
. - The surface is from the
webgpu
orcustom
backend.
§Safety
- The returned resource must not be destroyed unless the guard is the last reference to it and it is not in use by the GPU. The guard and handle may be dropped at any time however.
- All the safety requirements of wgpu-hal must be upheld.
Sourcepub fn as_custom<T: SurfaceInterface>(&self) -> Option<&T>
Available on custom
only.
pub fn as_custom<T: SurfaceInterface>(&self) -> Option<&T>
custom
only.Returns custom implementation of Surface (if custom backend and is internally T)
Trait Implementations§
Source§impl Ord for Surface<'_>
impl Ord for Surface<'_>
Source§impl PartialOrd for Surface<'_>
impl PartialOrd for Surface<'_>
impl Eq for Surface<'_>
Auto Trait Implementations§
impl<'window> !Freeze for Surface<'window>
impl<'window> !RefUnwindSafe for Surface<'window>
impl<'window> Send for Surface<'window>
impl<'window> Sync for Surface<'window>
impl<'window> Unpin for Surface<'window>
impl<'window> !UnwindSafe for Surface<'window>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.