Struct TextureView

pub struct TextureView {
    pub(crate) inner: DispatchTextureView,
    pub(crate) texture: Texture,
}

Handle to a texture view.

A TextureView object refers to a Texture, or a subset of its layers and mip levels, and specifies an interpretation of the texture’s texels, which is needed to use a texture as a binding in a BindGroup or as an attachment in a RenderPass. It can be created using Texture::create_view(), which accepts a TextureViewDescriptor specifying the properties of the view.

Corresponds to WebGPU GPUTextureView.

Fields

inner: DispatchTextureView

texture: Texture

Implementations

impl 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: Api>( &self, ) -> Option<impl Deref<Target = A::TextureView>>

Available on wgpu_core only.

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 the webgpu or custom backend.
• The texture this view points to has had Texture::destroy() called on it.

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.

pub fn as_custom<T: TextureViewInterface>(&self) -> Option<&T>

Available on custom only.

Returns custom implementation of TextureView (if custom backend and is internally T)

Trait Implementations

impl Clone for TextureView

fn clone(&self) -> TextureView

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextureView

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

Formats the value using the given formatter.

impl Hash for TextureView

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 TextureView

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,

Restrict a value to a certain interval.

impl PartialEq for TextureView

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for TextureView

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for TextureView