Skip to main content

SurfaceFactory

Struct SurfaceFactory 

Source
pub struct SurfaceFactory { /* private fields */ }
Expand description

A cheap, cloneable handle to a wgpu::Instance used to create a surface on a different thread than the one that owns the renderer.

§Why this exists

wgpu surface creation reads the platform window handle, which several windowing backends (notably winit on macOS/AppKit) only make available on the main/UI thread. A render-thread split therefore cannot create the surface where the renderer lives; instead the UI thread creates a DetachedSurface via this factory and hands it across to the render thread, which configures it there. A wgpu::Instance is Send + Sync + Clone (Arc-backed) and a Surface it produces stays compatible with any adapter/device the cloned instance requests, so the two threads share one instance with no unsafe.

The mobile shells do not need this: they receive a platform-created surface pointer and go through create_android_surface / create_metal_surface instead.

Implementations§

Source§

impl SurfaceFactory

Source

pub fn new(instance: &Instance) -> SurfaceFactory

Clones instance into a factory that can be moved to the UI thread.

Source

pub fn create_detached_surface( &self, target: impl Into<SurfaceTarget<'static>>, ) -> Result<DetachedSurface, Error>

Create a DetachedSurface from a window handle on the calling thread — call this on the thread the windowing backend requires (the main/UI thread for winit). The returned surface is Send and may then be moved to the render thread and configured there.

This performs only the window-handle-dependent step (surface creation); the device and the swapchain configuration are both built later, on the configuring thread, so nothing here touches a GPU device.

Trait Implementations§

Source§

impl Clone for SurfaceFactory

Source§

fn clone(&self) -> SurfaceFactory

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,