Struct gfx_hal::image::Usage

[+] Show declaration

pub struct Usage { /* fields omitted */ }

[−] Expand description

TODO: Find out if TRANSIENT_ATTACHMENT + INPUT_ATTACHMENT are applicable on backends other than Vulkan. --AP Image usage flags

Implementations

impl Usage[−]

pub const TRANSFER_SRC: Usage[−][−]

The image is used as a transfer source.

pub const TRANSFER_DST: Usage[−][−]

The image is used as a transfer destination.

pub const SAMPLED: Usage[−][−]

The image is a sampled image

pub const STORAGE: Usage[−][−]

The image is a storage image

pub const COLOR_ATTACHMENT: Usage[−][−]

The image is used as a color attachment -- that is, color input to a rendering pass.

pub const DEPTH_STENCIL_ATTACHMENT: Usage[−][−]

The image is used as a depth attachment.

pub const TRANSIENT_ATTACHMENT: Usage[−][−]

pub const INPUT_ATTACHMENT: Usage[−][−]

pub const fn empty() -> Usage[−]

Returns an empty set of flags

pub const fn all() -> Usage[−]

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<Usage>[−]

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) -> Usage[−]

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> Usage[−]

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: Usage) -> bool[−]

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

pub const fn contains(&self, other: Usage) -> bool[−]

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

pub fn insert(&mut self, other: Usage)[−]

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Usage)[−]

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Usage)[−]

Toggles the specified flags in-place.

pub fn set(&mut self, other: Usage, value: bool)[−]

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

impl Usage[−]

pub fn can_transfer(&self) -> bool[−]

Returns true if this image can be used in transfer operations.

pub fn can_target(&self) -> bool[−]

Returns true if this image can be used as a target.

Trait Implementations

impl Binary for Usage[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl BitAnd<Usage> for Usage[+]

type Output = Usage

The resulting type after applying the & operator.

fn bitand(self, other: Usage) -> Usage[−]

Returns the intersection between the two sets of flags.

impl BitAndAssign<Usage> for Usage[+]

fn bitand_assign(&mut self, other: Usage)[−]

Disables all flags disabled in the set.

impl BitOr<Usage> for Usage[+]

type Output = Usage

The resulting type after applying the | operator.

fn bitor(self, other: Usage) -> Usage[−]

Returns the union of the two sets of flags.

impl BitOrAssign<Usage> for Usage[+]

fn bitor_assign(&mut self, other: Usage)[−]

Adds the set of flags.

impl BitXor<Usage> for Usage[+]

type Output = Usage

The resulting type after applying the ^ operator.

fn bitxor(self, other: Usage) -> Usage[−]

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

impl BitXorAssign<Usage> for Usage[+]

fn bitxor_assign(&mut self, other: Usage)[−]

Toggles the set of flags.

impl Clone for Usage[+]

[+] Show hidden undocumented items

fn clone(&self) -> Usage[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for Usage

impl Debug for Usage[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Eq for Usage

impl Extend<Usage> for Usage[+]

[+] Show hidden undocumented items

fn extend<T: IntoIterator<Item = Usage>>(&mut self, iterator: T)[−]

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)[−]

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

Extends a collection with exactly one element.

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<Usage> for Usage[+]

[+] Show hidden undocumented items

fn from_iter<T: IntoIterator<Item = Usage>>(iterator: T) -> Usage[−]

Creates a value from an iterator.

impl Hash for Usage[+]

[+] Show hidden undocumented items

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, [−]

Feeds a slice of this type into the given Hasher.

impl LowerHex for Usage[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Not for Usage[+]

type Output = Usage

The resulting type after applying the ! operator.

fn not(self) -> Usage[−]

Returns the complement of this set of flags.

impl Octal for Usage[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Ord for Usage[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &Usage) -> Ordering[−]

This method returns an Ordering between self and other.

[+] Expand attributes

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

Compares and returns the maximum of two values.

[+] Expand attributes

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

Compares and returns the minimum of two values.

[+] Expand attributes

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

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

Restrict a value to a certain interval.

impl PartialEq<Usage> for Usage[+]

[+] Show hidden undocumented items

fn eq(&self, other: &Usage) -> bool[−]

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

fn ne(&self, other: &Usage) -> bool[−]

This method tests for !=.

impl PartialOrd<Usage> for Usage[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &Usage) -> Option<Ordering>[−]

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

fn lt(&self, other: &Usage) -> bool[−]

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

fn le(&self, other: &Usage) -> bool[−]

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

fn gt(&self, other: &Usage) -> bool[−]

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

fn ge(&self, other: &Usage) -> bool[−]

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

impl StructuralEq for Usage

impl StructuralPartialEq for Usage

impl Sub<Usage> for Usage[+]

type Output = Usage

The resulting type after applying the - operator.

fn sub(self, other: Usage) -> Usage[−]

Returns the set difference of the two sets of flags.

impl SubAssign<Usage> for Usage[+]

fn sub_assign(&mut self, other: Usage)[−]

Disables all flags enabled in the set.

impl UpperHex for Usage[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.