Struct wgpu::SurfaceTexture

pub struct SurfaceTexture {
    pub texture: Texture,
    pub suboptimal: bool,
    /* private fields */
}

Surface texture that can be rendered to. Result of a successful call to Surface::get_current_texture.

This type is unique to the Rust API of wgpu. In the WebGPU specification, the GPUCanvasContext provides a texture without any additional information.

Fields

texture: Texture

Accessible view of the frame.

suboptimal: bool

true if the acquired buffer can still be used for rendering, but should be recreated for maximum performance.

Implementations

impl SurfaceTexture

pub fn present(self)

Schedule this texture to be presented on the owning surface.

Needs to be called after any work on the texture is scheduled via Queue::submit.

Platform dependent behavior

On Wayland, present will attach a wl_buffer to the underlying wl_surface and commit the new surface state. If it is desired to do things such as request a frame callback, scale the surface using the viewporter or synchronize other double buffered state, then these operations should be done before the call to present.

Trait Implementations

impl Debug for SurfaceTexture

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for SurfaceTexture

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for SurfaceTexture

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SurfaceTexture

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for SurfaceTexture

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SurfaceTexture

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for SurfaceTexture