Struct gfx_core::memory::Bind

pub struct Bind { /* fields omitted */ }

[−] Expand description

Flags providing information about the usage of a resource.

A Bind value can be a combination of the following bit patterns:

• RENDER_TARGET
• DEPTH_STENCIL
• SHADER_RESOURCE
• UNORDERED_ACCESS
• TRANSFER_SRC
• TRANSFER_DST

This information is used to create resources (see gfx::Factory).

Implementations

impl Bind[−]

pub const RENDER_TARGET: Bind[−][−]

Can be rendered into.

pub const DEPTH_STENCIL: Bind[−][−]

Can serve as a depth/stencil target.

pub const SHADER_RESOURCE: Bind[−][−]

Can be bound to the shader for reading.

pub const UNORDERED_ACCESS: Bind[−][−]

Can be bound to the shader for writing.

pub const TRANSFER_SRC: Bind[−][−]

Can be transfered from.

pub const TRANSFER_DST: Bind[−][−]

Can be transfered into.

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

Returns an empty set of flags

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

Returns the set containing all flags.

pub const fn bits(&self) -> u8[−]

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<Bind>[−]

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

pub const fn from_bits_truncate(bits: u8) -> Bind[−]

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

pub const unsafe fn from_bits_unchecked(bits: u8) -> Bind[−]

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

impl Bind[−]

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

Is this memory bound to be mutated ?

Trait Implementations

impl Binary for Bind[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl BitAnd<Bind> for Bind[+]

type Output = Bind

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<Bind> for Bind[+]

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

Disables all flags disabled in the set.

impl BitOr<Bind> for Bind[+]

type Output = Bind

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<Bind> for Bind[+]

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

Adds the set of flags.

impl BitXor<Bind> for Bind[+]

type Output = Bind

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<Bind> for Bind[+]

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

Toggles the set of flags.

impl Clone for Bind[+]

[+] Show hidden undocumented items

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Bind

impl Debug for Bind[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Eq for Bind

impl Extend<Bind> for Bind[+]

[+] Show hidden undocumented items

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

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

[+] Show hidden undocumented items

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

Creates a value from an iterator.

impl Hash for Bind[+]

[+] Show hidden undocumented items

fn hash<__H: Hasher>(&self, state: &mut __H)[−]

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 Bind[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Not for Bind[+]

type Output = Bind

The resulting type after applying the ! operator.

fn not(self) -> Bind[−]

Returns the complement of this set of flags.

impl Octal for Bind[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Ord for Bind[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &Bind) -> 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<Bind> for Bind[+]

[+] Show hidden undocumented items

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

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

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

This method tests for !=.

impl PartialOrd<Bind> for Bind[+]

[+] Show hidden undocumented items

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl StructuralEq for Bind

impl StructuralPartialEq for Bind

impl Sub<Bind> for Bind[+]

type Output = Bind

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Bind> for Bind[+]

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

Disables all flags enabled in the set.

impl UpperHex for Bind[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.