Skip to main content

TextureDescriptor

Struct TextureDescriptor 

Source
pub struct TextureDescriptor {
    pub width: u32,
    pub height: u32,
    pub depth_or_layers: u32,
    pub dimension: &'static str,
    pub format: GpuTextureFormat,
    pub usage: u32,
    pub mip_level_count: u32,
    pub sample_count: u32,
    pub label: Option<String>,
}
Expand description

The general texture constructor, covering 2D, 2D-array, and 3D textures.

Texture2DDescriptor is the narrow preset: a single layer, a format string, and a usage string, with no label. The two fields TextureDescriptor adds on top of it are what keep it general — dimension selects between a 2D texture, a 2D array, and a 3D texture, and label names the resource in the browser’s GPU debug tooling, which is the only way to tell two same-sized textures apart in a capture.

Fields§

§width: u32

The width in texels. Must be greater than zero.

§height: u32

The height in texels. Must be greater than zero.

§depth_or_layers: u32

The number of array layers for a 2d-array texture, or the depth in texels for a 3d texture. 1 for a plain 2D texture.

§dimension: &'static str

The texture’s dimensionality. Defaults to "2d"; a "2d-array" or "3d" texture needs this set explicitly.

§format: GpuTextureFormat

The texel format.

§usage: u32

The legal uses of this texture, as a usage bitmask. Combine several TextureUsage values with |.

§mip_level_count: u32

The number of mip levels. Zero is treated as one.

§sample_count: u32

The samples per texel: 1 for an ordinary texture, 4 for a multisampled render target.

§label: Option<String>

A debug label shown for this texture in the browser’s GPU tooling, or None to leave it unnamed.

Implementations§

Source§

impl TextureDescriptor

Source

pub fn get_width(&self) -> u32

Source

pub fn get_height(&self) -> u32

Source

pub fn get_depth_or_layers(&self) -> u32

Source

pub fn set_depth_or_layers(&mut self, val: u32) -> &mut Self

Source

pub fn get_dimension(&self) -> &'static str

Source

pub fn get_format(&self) -> GpuTextureFormat

Source

pub fn get_usage(&self) -> u32

Source

pub fn get_mip_level_count(&self) -> u32

Source

pub fn get_sample_count(&self) -> u32

Source

pub fn get_label(&self) -> Option<String>

Source

pub fn try_get_label(&self) -> Option<String>

Source§

impl TextureDescriptor

Source

pub fn new( width: u32, height: u32, dimension: &'static str, format: GpuTextureFormat, usage: u32, ) -> Self

Trait Implementations§

Source§

impl Clone for TextureDescriptor

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TextureDescriptor

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more