Struct wgpu::TextureUsage

#[repr(transparent)]pub struct TextureUsage { /* fields omitted */ }

Different ways that you can use a texture.

The usages determine what kind of memory the texture is allocated from and what actions the texture can partake in.

Implementations

impl TextureUsage

pub const COPY_SRC: TextureUsage

Allows a texture to be the source in a [CommandEncoder::copy_texture_to_buffer] or [CommandEncoder::copy_texture_to_texture] operation.

pub const COPY_DST: TextureUsage

Allows a texture to be the destination in a [CommandEncoder::copy_texture_to_buffer], [CommandEncoder::copy_texture_to_texture], or [Queue::write_texture] operation.

pub const SAMPLED: TextureUsage

Allows a texture to be a BindingType::Texture in a bind group.

pub const STORAGE: TextureUsage

Allows a texture to be a BindingType::StorageTexture in a bind group.

pub const RENDER_ATTACHMENT: TextureUsage

Allows a texture to be an output attachment of a renderpass.

pub const fn empty() -> TextureUsage

Returns an empty set of flags

pub const fn all() -> TextureUsage

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<TextureUsage>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> TextureUsage

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> TextureUsage

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: TextureUsage) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: TextureUsage) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: TextureUsage)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: TextureUsage)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: TextureUsage)

Toggles the specified flags in-place.

pub fn set(&mut self, other: TextureUsage, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for TextureUsage

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

Formats the value using the given formatter.

impl BitAnd<TextureUsage> for TextureUsage

type Output = TextureUsage

The resulting type after applying the & operator.

pub fn bitand(self, other: TextureUsage) -> TextureUsage

Returns the intersection between the two sets of flags.

impl BitAndAssign<TextureUsage> for TextureUsage

pub fn bitand_assign(&mut self, other: TextureUsage)

Disables all flags disabled in the set.

impl BitOr<TextureUsage> for TextureUsage

type Output = TextureUsage

The resulting type after applying the | operator.

pub fn bitor(self, other: TextureUsage) -> TextureUsage

Returns the union of the two sets of flags.

impl BitOrAssign<TextureUsage> for TextureUsage

pub fn bitor_assign(&mut self, other: TextureUsage)

Adds the set of flags.

impl BitXor<TextureUsage> for TextureUsage

type Output = TextureUsage

The resulting type after applying the ^ operator.

pub fn bitxor(self, other: TextureUsage) -> TextureUsage

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<TextureUsage> for TextureUsage

pub fn bitxor_assign(&mut self, other: TextureUsage)

Toggles the set of flags.

impl Clone for TextureUsage

pub fn clone(&self) -> TextureUsage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TextureUsage

impl Debug for TextureUsage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TextureUsage

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<TextureUsage, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for TextureUsage

impl Extend<TextureUsage> for TextureUsage

pub fn extend<T>(&mut self, iterator: T) where
    T: IntoIterator<Item = TextureUsage>, 

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<TextureUsage> for TextureUsage

pub fn from_iter<T>(iterator: T) -> TextureUsage where
    T: IntoIterator<Item = TextureUsage>, 

Creates a value from an iterator.

impl Hash for TextureUsage

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for TextureUsage

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

Formats the value using the given formatter.

impl Not for TextureUsage

type Output = TextureUsage

The resulting type after applying the ! operator.

pub fn not(self) -> TextureUsage

Returns the complement of this set of flags.

impl Octal for TextureUsage

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

Formats the value using the given formatter.

impl Ord for TextureUsage

pub fn cmp(&self, other: &TextureUsage) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<TextureUsage> for TextureUsage

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<TextureUsage> for TextureUsage

pub fn partial_cmp(&self, other: &TextureUsage) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &TextureUsage) -> bool

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for TextureUsage

pub fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for TextureUsage

impl StructuralPartialEq for TextureUsage

impl Sub<TextureUsage> for TextureUsage

type Output = TextureUsage

The resulting type after applying the - operator.

pub fn sub(self, other: TextureUsage) -> TextureUsage

Returns the set difference of the two sets of flags.

impl SubAssign<TextureUsage> for TextureUsage

pub fn sub_assign(&mut self, other: TextureUsage)

Disables all flags enabled in the set.

impl UpperHex for TextureUsage

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

Formats the value using the given formatter.