[][src]Struct gfx_hal::image::Usage

pub struct Usage { /* fields omitted */ }

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

Methods

impl Usage[src]

pub const TRANSFER_SRC: Usage[src]

The image is used as a transfer source.

pub const TRANSFER_DST: Usage[src]

The image is used as a transfer destination.

pub const SAMPLED: Usage[src]

The image is a sampled image

pub const STORAGE: Usage[src]

The image is a storage image

pub const COLOR_ATTACHMENT: Usage[src]

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

pub const DEPTH_STENCIL_ATTACHMENT: Usage[src]

The image is used as a depth attachment.

pub const TRANSIENT_ATTACHMENT: Usage[src]

pub const INPUT_ATTACHMENT: Usage[src]

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

Returns an empty set of flags

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

Returns the set containing all flags.

pub const fn bits(&self) -> u32[src]

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<Usage>[src]

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[src]

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

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

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

pub const fn is_empty(&self) -> bool[src]

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool[src]

Returns true if all flags are currently set.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

impl Usage[src]

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

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

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

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

Trait Implementations

impl Binary for Usage[src]

impl BitAnd<Usage> for Usage[src]

type Output = Usage

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<Usage> for Usage[src]

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

Disables all flags disabled in the set.

impl BitOr<Usage> for Usage[src]

type Output = Usage

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<Usage> for Usage[src]

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

Adds the set of flags.

impl BitXor<Usage> for Usage[src]

type Output = Usage

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<Usage> for Usage[src]

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

Toggles the set of flags.

impl Clone for Usage[src]

impl Copy for Usage[src]

impl Debug for Usage[src]

impl Eq for Usage[src]

impl Extend<Usage> for Usage[src]

impl FromIterator<Usage> for Usage[src]

impl Hash for Usage[src]

impl LowerHex for Usage[src]

impl Not for Usage[src]

type Output = Usage

The resulting type after applying the ! operator.

fn not(self) -> Usage[src]

Returns the complement of this set of flags.

impl Octal for Usage[src]

impl Ord for Usage[src]

impl PartialEq<Usage> for Usage[src]

impl PartialOrd<Usage> for Usage[src]

impl StructuralEq for Usage[src]

impl StructuralPartialEq for Usage[src]

impl Sub<Usage> for Usage[src]

type Output = Usage

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Usage> for Usage[src]

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

Disables all flags enabled in the set.

impl UpperHex for Usage[src]

Auto Trait Implementations

impl RefUnwindSafe for Usage

impl Send for Usage

impl Sync for Usage

impl Unpin for Usage

impl UnwindSafe for Usage

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.