Struct gfx_hal::external_memory::ExternalMemoryTypeFlags
source · [−]pub struct ExternalMemoryTypeFlags { /* private fields */ }
Expand description
External memory type flags.
Implementations
sourceimpl ExternalMemoryTypeFlags
impl ExternalMemoryTypeFlags
sourcepub const OPAQUE_FD: ExternalMemoryTypeFlags
pub const OPAQUE_FD: ExternalMemoryTypeFlags
This is supported on Unix only. Specifies a POSIX file descriptor handle that has only limited valid usage outside of Vulkan and other compatible APIs. It must be compatible with the POSIX system calls dup, dup2, close, and the non-standard system call dup3. Additionally, it must be transportable over a socket using an SCM_RIGHTS control message. It owns a reference to the underlying memory resource represented by its memory object.
sourcepub const DMA_BUF: ExternalMemoryTypeFlags
pub const DMA_BUF: ExternalMemoryTypeFlags
This is supported on Linux or Android only. Is a file descriptor for a Linux dma_buf. It owns a reference to the underlying memory resource represented by its memory object.
sourcepub const HOST_ALLOCATION: ExternalMemoryTypeFlags
pub const HOST_ALLOCATION: ExternalMemoryTypeFlags
Specifies a host pointer returned by a host memory allocation command. It does not own a reference to the underlying memory resource, and will therefore become invalid if the host memory is freed.
sourcepub const HOST_MAPPED_FOREIGN_MEMORY: ExternalMemoryTypeFlags
pub const HOST_MAPPED_FOREIGN_MEMORY: ExternalMemoryTypeFlags
Specifies a host pointer to host mapped foreign memory. It does not own a reference to the underlying memory resource, and will therefore become invalid if the foreign memory is unmapped or otherwise becomes no longer available.
sourcepub const fn empty() -> ExternalMemoryTypeFlags
pub const fn empty() -> ExternalMemoryTypeFlags
Returns an empty set of flags.
sourcepub const fn all() -> ExternalMemoryTypeFlags
pub const fn all() -> ExternalMemoryTypeFlags
Returns the set containing all flags.
sourcepub const fn from_bits(bits: u32) -> Option<ExternalMemoryTypeFlags>
pub const fn from_bits(bits: u32) -> Option<ExternalMemoryTypeFlags>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> ExternalMemoryTypeFlags
pub const fn from_bits_truncate(bits: u32) -> ExternalMemoryTypeFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> ExternalMemoryTypeFlags
pub const unsafe fn from_bits_unchecked(bits: u32) -> ExternalMemoryTypeFlags
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: ExternalMemoryTypeFlags) -> bool
pub const fn intersects(&self, other: ExternalMemoryTypeFlags) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: ExternalMemoryTypeFlags) -> bool
pub const fn contains(&self, other: ExternalMemoryTypeFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: ExternalMemoryTypeFlags)
pub fn insert(&mut self, other: ExternalMemoryTypeFlags)
Inserts the specified flags in-place.
sourcepub fn remove(&mut self, other: ExternalMemoryTypeFlags)
pub fn remove(&mut self, other: ExternalMemoryTypeFlags)
Removes the specified flags in-place.
sourcepub fn toggle(&mut self, other: ExternalMemoryTypeFlags)
pub fn toggle(&mut self, other: ExternalMemoryTypeFlags)
Toggles the specified flags in-place.
sourcepub fn set(&mut self, other: ExternalMemoryTypeFlags, value: bool)
pub fn set(&mut self, other: ExternalMemoryTypeFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(
self,
other: ExternalMemoryTypeFlags
) -> ExternalMemoryTypeFlags
pub const fn intersection(
self,
other: ExternalMemoryTypeFlags
) -> ExternalMemoryTypeFlags
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(
self,
other: ExternalMemoryTypeFlags
) -> ExternalMemoryTypeFlags
pub const fn union(
self,
other: ExternalMemoryTypeFlags
) -> ExternalMemoryTypeFlags
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(
self,
other: ExternalMemoryTypeFlags
) -> ExternalMemoryTypeFlags
pub const fn difference(
self,
other: ExternalMemoryTypeFlags
) -> ExternalMemoryTypeFlags
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(
self,
other: ExternalMemoryTypeFlags
) -> ExternalMemoryTypeFlags
pub const fn symmetric_difference(
self,
other: ExternalMemoryTypeFlags
) -> ExternalMemoryTypeFlags
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> ExternalMemoryTypeFlags
pub const fn complement(self) -> ExternalMemoryTypeFlags
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations
sourceimpl Binary for ExternalMemoryTypeFlags
impl Binary for ExternalMemoryTypeFlags
sourceimpl BitAnd<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
impl BitAnd<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
sourcepub fn bitand(self, other: ExternalMemoryTypeFlags) -> ExternalMemoryTypeFlags
pub fn bitand(self, other: ExternalMemoryTypeFlags) -> ExternalMemoryTypeFlags
Returns the intersection between the two sets of flags.
type Output = ExternalMemoryTypeFlags
type Output = ExternalMemoryTypeFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
impl BitAndAssign<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
sourcepub fn bitand_assign(&mut self, other: ExternalMemoryTypeFlags)
pub fn bitand_assign(&mut self, other: ExternalMemoryTypeFlags)
Disables all flags disabled in the set.
sourceimpl BitOr<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
impl BitOr<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
sourcepub fn bitor(self, other: ExternalMemoryTypeFlags) -> ExternalMemoryTypeFlags
pub fn bitor(self, other: ExternalMemoryTypeFlags) -> ExternalMemoryTypeFlags
Returns the union of the two sets of flags.
type Output = ExternalMemoryTypeFlags
type Output = ExternalMemoryTypeFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
impl BitOrAssign<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
sourcepub fn bitor_assign(&mut self, other: ExternalMemoryTypeFlags)
pub fn bitor_assign(&mut self, other: ExternalMemoryTypeFlags)
Adds the set of flags.
sourceimpl BitXor<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
impl BitXor<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
sourcepub fn bitxor(self, other: ExternalMemoryTypeFlags) -> ExternalMemoryTypeFlags
pub fn bitxor(self, other: ExternalMemoryTypeFlags) -> ExternalMemoryTypeFlags
Returns the left flags, but with all the right flags toggled.
type Output = ExternalMemoryTypeFlags
type Output = ExternalMemoryTypeFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
impl BitXorAssign<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
sourcepub fn bitxor_assign(&mut self, other: ExternalMemoryTypeFlags)
pub fn bitxor_assign(&mut self, other: ExternalMemoryTypeFlags)
Toggles the set of flags.
sourceimpl Clone for ExternalMemoryTypeFlags
impl Clone for ExternalMemoryTypeFlags
sourcepub fn clone(&self) -> ExternalMemoryTypeFlags
pub fn clone(&self) -> ExternalMemoryTypeFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ExternalMemoryTypeFlags
impl Debug for ExternalMemoryTypeFlags
sourceimpl Extend<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
impl Extend<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
sourcepub fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = ExternalMemoryTypeFlags>,
pub fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = ExternalMemoryTypeFlags>,
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl From<ExternalImageMemoryType> for ExternalMemoryTypeFlags
impl From<ExternalImageMemoryType> for ExternalMemoryTypeFlags
sourcepub fn from(
external_memory_type: ExternalImageMemoryType
) -> ExternalMemoryTypeFlags
pub fn from(
external_memory_type: ExternalImageMemoryType
) -> ExternalMemoryTypeFlags
Performs the conversion.
sourceimpl From<ExternalMemoryType> for ExternalMemoryTypeFlags
impl From<ExternalMemoryType> for ExternalMemoryTypeFlags
sourcepub fn from(external_memory_type: ExternalMemoryType) -> ExternalMemoryTypeFlags
pub fn from(external_memory_type: ExternalMemoryType) -> ExternalMemoryTypeFlags
Performs the conversion.
sourceimpl FromIterator<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
impl FromIterator<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
sourcepub fn from_iter<T>(iterator: T) -> ExternalMemoryTypeFlags where
T: IntoIterator<Item = ExternalMemoryTypeFlags>,
pub fn from_iter<T>(iterator: T) -> ExternalMemoryTypeFlags where
T: IntoIterator<Item = ExternalMemoryTypeFlags>,
Creates a value from an iterator. Read more
sourceimpl Hash for ExternalMemoryTypeFlags
impl Hash for ExternalMemoryTypeFlags
sourceimpl LowerHex for ExternalMemoryTypeFlags
impl LowerHex for ExternalMemoryTypeFlags
sourceimpl Not for ExternalMemoryTypeFlags
impl Not for ExternalMemoryTypeFlags
sourcepub fn not(self) -> ExternalMemoryTypeFlags
pub fn not(self) -> ExternalMemoryTypeFlags
Returns the complement of this set of flags.
type Output = ExternalMemoryTypeFlags
type Output = ExternalMemoryTypeFlags
The resulting type after applying the !
operator.
sourceimpl Octal for ExternalMemoryTypeFlags
impl Octal for ExternalMemoryTypeFlags
sourceimpl Ord for ExternalMemoryTypeFlags
impl Ord for ExternalMemoryTypeFlags
sourceimpl PartialEq<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
impl PartialEq<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
sourcepub fn eq(&self, other: &ExternalMemoryTypeFlags) -> bool
pub fn eq(&self, other: &ExternalMemoryTypeFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcepub fn ne(&self, other: &ExternalMemoryTypeFlags) -> bool
pub fn ne(&self, other: &ExternalMemoryTypeFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
impl PartialOrd<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
sourcepub fn partial_cmp(&self, other: &ExternalMemoryTypeFlags) -> Option<Ordering>
pub fn partial_cmp(&self, other: &ExternalMemoryTypeFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
impl Sub<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
sourcepub fn sub(self, other: ExternalMemoryTypeFlags) -> ExternalMemoryTypeFlags
pub fn sub(self, other: ExternalMemoryTypeFlags) -> ExternalMemoryTypeFlags
Returns the set difference of the two sets of flags.
type Output = ExternalMemoryTypeFlags
type Output = ExternalMemoryTypeFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
impl SubAssign<ExternalMemoryTypeFlags> for ExternalMemoryTypeFlags
sourcepub fn sub_assign(&mut self, other: ExternalMemoryTypeFlags)
pub fn sub_assign(&mut self, other: ExternalMemoryTypeFlags)
Disables all flags enabled in the set.
sourceimpl UpperHex for ExternalMemoryTypeFlags
impl UpperHex for ExternalMemoryTypeFlags
impl Copy for ExternalMemoryTypeFlags
impl Eq for ExternalMemoryTypeFlags
impl StructuralEq for ExternalMemoryTypeFlags
impl StructuralPartialEq for ExternalMemoryTypeFlags
Auto Trait Implementations
impl RefUnwindSafe for ExternalMemoryTypeFlags
impl Send for ExternalMemoryTypeFlags
impl Sync for ExternalMemoryTypeFlags
impl Unpin for ExternalMemoryTypeFlags
impl UnwindSafe for ExternalMemoryTypeFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more