Struct MemoryFormatSelection 

pub struct MemoryFormatSelection(/* private fields */);

Selection of memory formats the API user accepts

Implementations

impl MemoryFormatSelection

pub const B8g8r8a8Premultiplied: Self

pub const A8r8g8b8Premultiplied: Self

pub const R8g8b8a8Premultiplied: Self

pub const B8g8r8a8: Self

pub const A8r8g8b8: Self

pub const R8g8b8a8: Self

pub const A8b8g8r8: Self

pub const R8g8b8: Self

pub const B8g8r8: Self

pub const R16g16b16: Self

pub const R16g16b16a16Premultiplied: Self

pub const R16g16b16a16: Self

pub const R16g16b16Float: Self

pub const R16g16b16a16Float: Self

pub const R32g32b32Float: Self

pub const R32g32b32a32FloatPremultiplied: Self

pub const R32g32b32a32Float: Self

pub const G8a8Premultiplied: Self

pub const G8a8: Self

pub const G8: Self

pub const G16a16Premultiplied: Self

pub const G16a16: Self

pub const G16: Self

impl MemoryFormatSelection

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

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

Convert from a bits value.

This method will return None if any unknown bits are set.

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

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl MemoryFormatSelection

pub const fn iter(&self) -> Iter<MemoryFormatSelection>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<MemoryFormatSelection>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl MemoryFormatSelection

pub fn memory_formats(self) -> Vec<MemoryFormat>

List of selected memory formats

pub fn best_format_for(self, src: MemoryFormat) -> Option<MemoryFormat>

Select the best contained format to represent src

The function returns None if no formats are selected.

assert_eq!(
    (MemoryFormatSelection::R8g8b8 | MemoryFormatSelection::R8g8b8a8)
        .best_format_for(MemoryFormat::A8b8g8r8),
    Some(MemoryFormat::R8g8b8a8)
);

assert_eq!(
    (MemoryFormatSelection::R8g8b8 | MemoryFormatSelection::R8g8b8a8)
        .best_format_for(MemoryFormat::B8g8r8),
    Some(MemoryFormat::R8g8b8)
);

assert_eq!(
    (MemoryFormatSelection::R8g8b8 | MemoryFormatSelection::R16g16b16)
        .best_format_for(MemoryFormat::B8g8r8),
    Some(MemoryFormat::R8g8b8)
);

assert_eq!(
    (MemoryFormatSelection::R8g8b8 | MemoryFormatSelection::R16g16b16)
        .best_format_for(MemoryFormat::R16g16b16Float),
    Some(MemoryFormat::R16g16b16)
);

assert_eq!(
    MemoryFormatSelection::empty().best_format_for(MemoryFormat::R16g16b16Float),
    None
);

Trait Implementations

impl Binary for MemoryFormatSelection

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

Formats the value using the given formatter.

impl BitAnd for MemoryFormatSelection

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = MemoryFormatSelection

The resulting type after applying the & operator.

impl BitAndAssign for MemoryFormatSelection

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for MemoryFormatSelection

fn bitor(self, other: MemoryFormatSelection) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = MemoryFormatSelection

The resulting type after applying the | operator.

impl BitOrAssign for MemoryFormatSelection

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for MemoryFormatSelection

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = MemoryFormatSelection

The resulting type after applying the ^ operator.

impl BitXorAssign for MemoryFormatSelection

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for MemoryFormatSelection

fn clone(&self) -> MemoryFormatSelection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryFormatSelection

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

Formats the value using the given formatter.

impl Default for MemoryFormatSelection

fn default() -> Self

Returns the “default value” for a type.

impl Extend<MemoryFormatSelection> for MemoryFormatSelection

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

The bitwise or (|) of the bits in each flags value.

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 Flags for MemoryFormatSelection

const FLAGS: &'static [Flag<MemoryFormatSelection>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> MemoryFormatSelection

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<MemoryFormatSelection> for MemoryFormatSelection

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for MemoryFormatSelection

type Item = MemoryFormatSelection

The type of the elements being iterated over.

type IntoIter = Iter<MemoryFormatSelection>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for MemoryFormatSelection

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

Formats the value using the given formatter.

impl Not for MemoryFormatSelection

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = MemoryFormatSelection

The resulting type after applying the ! operator.

impl Octal for MemoryFormatSelection

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

Formats the value using the given formatter.

impl PublicFlags for MemoryFormatSelection

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for MemoryFormatSelection

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = MemoryFormatSelection

The resulting type after applying the - operator.

impl SubAssign for MemoryFormatSelection

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for MemoryFormatSelection

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

Formats the value using the given formatter.

impl Copy for MemoryFormatSelection