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.