Skip to main content

SurfaceState

Struct SurfaceState 

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

A configured wgpu surface, ready for frame acquisition.

Does NOT own the wgpu::Surface — the consumer creates the surface from their windowing system and passes it in. This struct manages configuration, resize, and frame acquisition.

§Examples

let mut state = SurfaceState::configure(
    &surface, &adapter, &device, width, height,
    PresentModePreference::Vsync,
)?;

// On window resize:
state.resize(&surface, &device, new_width, new_height);

// Each frame:
let frame = state.get_current_texture(&surface)?;

Implementations§

Source§

impl SurfaceState

Source

pub fn configure( surface: &Surface<'_>, adapter: &Adapter, device: &Device, width: u32, height: u32, present_mode: PresentModePreference, ) -> Result<Self>

Configure a surface for rendering.

Selects the best available format (preferring sRGB) and alpha mode.

Source

pub fn resize( &mut self, surface: &Surface<'_>, device: &Device, width: u32, height: u32, )

Reconfigure the surface after a resize.

Silently skips zero-size dimensions (common during window minimize).

Source

pub fn acquire(&self, surface: &Surface<'_>) -> Result<SurfaceTexture>

Acquire the next frame texture.

Source

pub fn format(&self) -> TextureFormat

The surface texture format.

Source

pub fn size(&self) -> (u32, u32)

Current surface dimensions.

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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