Struct Texture 

pub struct Texture { /* private fields */ }

Available on crate feature unstable-wgpu-27 only.

Handle to a texture on the GPU.

It can be created with Device::create_texture.

Corresponds to WebGPU GPUTexture.

Implementations

impl Texture

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

where A: Api,

Available on crate feature wgpu-27 and wgpu_core only.

Get the wgpu_hal texture from this Texture.

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::Texture.

Types

The returned type depends on the backend:

• hal::api::Vulkan uses hal::vulkan::Texture
• hal::api::Metal uses hal::metal::Texture
• hal::api::Dx12 uses hal::dx12::Texture
• hal::api::Gles uses hal::gles::Texture

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 is not from the backend specified by A.
• The texture is from the webgpu or custom backend.
• The texture has had Self::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 create_view( &self, desc: &TextureViewDescriptor<Option<&str>>, ) -> TextureView

Available on crate feature wgpu-27 only.

Creates a view of this texture, specifying an interpretation of its texels and possibly a subset of its layers and mip levels.

Texture views are needed to use a texture as a binding in a BindGroup or as an attachment in a RenderPass.

pub fn destroy(&self)

Available on crate feature wgpu-27 only.

Destroy the associated native resources as soon as possible.

pub fn as_image_copy(&self) -> TexelCopyTextureInfo<&Texture>

Available on crate feature wgpu-27 only.

Make an TexelCopyTextureInfo representing the whole texture.

pub fn size(&self) -> Extent3d

Available on crate feature wgpu-27 only.

Returns the size of this Texture.

This is always equal to the size that was specified when creating the texture.

pub fn width(&self) -> u32

Available on crate feature wgpu-27 only.

Returns the width of this Texture.

This is always equal to the size.width that was specified when creating the texture.

pub fn height(&self) -> u32

Available on crate feature wgpu-27 only.

Returns the height of this Texture.

This is always equal to the size.height that was specified when creating the texture.

pub fn depth_or_array_layers(&self) -> u32

Available on crate feature wgpu-27 only.

Returns the depth or layer count of this Texture.

This is always equal to the size.depth_or_array_layers that was specified when creating the texture.

pub fn mip_level_count(&self) -> u32

Available on crate feature wgpu-27 only.

Returns the mip_level_count of this Texture.

This is always equal to the mip_level_count that was specified when creating the texture.

pub fn sample_count(&self) -> u32

Available on crate feature wgpu-27 only.

Returns the sample_count of this Texture.

This is always equal to the sample_count that was specified when creating the texture.

pub fn dimension(&self) -> TextureDimension

Available on crate feature wgpu-27 only.

Returns the dimension of this Texture.

This is always equal to the dimension that was specified when creating the texture.

pub fn format(&self) -> TextureFormat

Available on crate feature wgpu-27 only.

Returns the format of this Texture.

This is always equal to the format that was specified when creating the texture.

pub fn usage(&self) -> TextureUsages

Available on crate feature wgpu-27 only.

Returns the allowed usages of this Texture.

This is always equal to the usage that was specified when creating the texture.

Trait Implementations

impl Clone for Texture

fn clone(&self) -> Texture

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Texture

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

Formats the value using the given formatter.

impl Hash for Texture

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

where H: Hasher,

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 Texture

fn cmp(&self, other: &Texture) -> 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 Texture

fn eq(&self, other: &Texture) -> 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 Texture

fn partial_cmp(&self, other: &Texture) -> 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 TryFrom<Texture> for Image

type Error = TextureImportError

The type returned in the event of a conversion error.

fn try_from( texture: Texture, ) -> Result<Image, <Image as TryFrom<Texture>>::Error>

Performs the conversion.

impl Eq for Texture