Skip to main content

SurfaceContext

Struct SurfaceContext 

Source
pub struct SurfaceContext {
    pub device: Device,
    pub queue: Queue,
    pub surface: Surface<'static>,
    pub surface_format: TextureFormat,
    /* private fields */
}
Expand description

A windowed GPU context: device, queue, surface, and swap-chain config.

Unlike crate::GpuContext (headless), SurfaceContext presents frames to an OS window via a wgpu swap-chain.

Fields§

§device: Device

The logical GPU device.

§queue: Queue

The command queue for the device.

§surface: Surface<'static>

The wgpu surface attached to the OS window.

§surface_format: TextureFormat

The texture format selected for the swap-chain.

Implementations§

Source§

impl SurfaceContext

Source

pub unsafe fn from_raw_handles( window_handle: RawWindowHandle, display_handle: RawDisplayHandle, config: SurfaceConfig, ) -> Result<Self, UiError>

Create a windowed surface context from raw OS window/display handles.

§Safety

The caller must ensure that both window_handle and display_handle refer to valid OS objects and remain valid for the entire lifetime of the returned SurfaceContext. Dropping the underlying window while a SurfaceContext is live is undefined behaviour.

Source

pub fn resize(&mut self, width: u32, height: u32)

Resize the swap-chain to new dimensions.

Dimensions are clamped to a minimum of 1×1 to avoid a wgpu validation error.

Source

pub fn acquire_frame(&self) -> Option<SurfaceTexture>

Acquire the next swap-chain frame.

Returns None on surface timeout, occlusion, or any other transient condition — the caller should skip the frame and try again next tick. Permanent errors (surface lost / outdated) are logged to stderr; the caller can recreate the SurfaceContext if needed.

Source

pub fn present_frame(&self, frame: SurfaceTexture)

Present a previously acquired frame to the display.

Source

pub fn width(&self) -> u32

Current swap-chain width in physical pixels.

Source

pub fn height(&self) -> u32

Current swap-chain height in physical pixels.

Source

pub fn format(&self) -> TextureFormat

The texture format used by the swap-chain.

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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