Skip to main content

Backbuffer

Struct Backbuffer 

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

Manages a chain of backbuffers for rendering

This is essential for:

  • Glass effects that need to sample the backdrop
  • WASM targets where we can’t read from the swapchain
  • Post-processing pipelines

Implementations§

Source§

impl Backbuffer

Source

pub fn new( device: &Device, width: u32, height: u32, config: BackbufferConfig, ) -> Self

Create a new backbuffer chain

Source

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

Resize the backbuffers

Source

pub fn write_target(&self) -> &TextureView

Get the current write target (where we render to)

Source

pub fn read_target(&self) -> &TextureView

Get the current read target (previous frame, for glass effects)

Source

pub fn depth_target(&self) -> Option<&TextureView>

Get the depth buffer view (if enabled)

Source

pub fn sampler(&self) -> &Sampler

Get the sampler for reading backbuffers

Source

pub fn format(&self) -> TextureFormat

Get the texture format

Source

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

Get the current dimensions

Source

pub fn swap(&mut self)

Swap buffers - call after rendering a frame

This advances the write/read indices for the next frame

Source

pub fn copy_to_surface( &self, encoder: &mut CommandEncoder, surface_texture: &Texture, )

Copy the current write buffer to the swapchain

This is used to present the final rendered frame to the screen. Essential for WASM where we render to a backbuffer first.

Source

pub fn write_texture(&self) -> &Texture

Get the write buffer texture (for advanced use cases)

Source

pub fn read_texture(&self) -> &Texture

Get the read buffer texture (for advanced use cases)

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,