Struct ScratchTexture 

pub struct ScratchTexture { /* private fields */ }

A pooled texture. Work recorded after it is dropped may reuse it, so keep it until all work that uses its contents is recorded.

Returned textures share a 64 MiB idle-cache budget. Active leases are never evicted; oversized textures are released rather than cached when dropped.

Implementations

impl ScratchTexture

pub fn texture(&self) -> &Texture

Returns the underlying texture.

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

Returns the actual size, which may exceed the requested size.

Methods from Deref<Target = TextureView>

pub fn texture(&self) -> &Texture

Returns the [Texture] that this TextureView refers to.

All wgpu resources are refcounted, so you can own the returned [Texture] by cloning it.

pub unsafe fn as_hal<A>( &self, ) -> Option<impl Deref<Target = <A as Api>::TextureView>>

where A: Api,

Get the [wgpu_hal] texture view from this TextureView.

Find the Api struct corresponding to the active backend in [wgpu_hal::api], and pass that struct to the to the A type parameter.

Returns a guard that dereferences to the type of the hal backend which implements A::TextureView.

Types

The returned type depends on the backend:

• [hal::api::Vulkan] uses [hal::vulkan::TextureView]
• hal::api::Metal uses hal::metal::TextureView
• hal::api::Dx12 uses hal::dx12::TextureView
• [hal::api::Gles] uses [hal::gles::TextureView]

Deadlocks

• The returned guard holds a read-lock on a device-local “destruction” lock, which will cause all calls to destroy to block until the guard is released.

Errors

This method will return None if:

• The texture view is not from the backend specified by A.
• The texture view is from [Backend::BrowserWebGpu]. (Use TextureView::as_webgpu() instead.)
• The texture view is from a custom backend.

Safety

• The returned resource must not be destroyed unless the guard is the last reference to it and it is not in use by the GPU. The guard and handle may be dropped at any time however.
• All the safety requirements of wgpu-hal must be upheld.

Trait Implementations

impl Deref for ScratchTexture

type Target = TextureView

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for ScratchTexture

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.