Struct gfx_hal::command::CommandBufferFlags
source · [−]pub struct CommandBufferFlags { /* private fields */ }
Expand description
Option flags for various command buffer settings.
Implementations
sourceimpl CommandBufferFlags
impl CommandBufferFlags
sourcepub const ONE_TIME_SUBMIT: Self
pub const ONE_TIME_SUBMIT: Self
Says that the command buffer will be recorded, submitted only once, and then reset and re-filled for another submission.
sourcepub const RENDER_PASS_CONTINUE: Self
pub const RENDER_PASS_CONTINUE: Self
If set on a secondary command buffer, it says the command buffer takes place entirely inside a render pass. Ignored on primary command buffer.
sourcepub const SIMULTANEOUS_USE: Self
pub const SIMULTANEOUS_USE: Self
Says that a command buffer can be recorded into multiple primary command buffers, and submitted to a queue while it is still pending.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
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) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
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: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
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: Self) -> Self
pub const fn union(self, other: Self) -> Self
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: Self) -> Self
pub const fn difference(self, other: Self) -> Self
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: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
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) -> Self
pub const fn complement(self) -> Self
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 CommandBufferFlags
impl Binary for CommandBufferFlags
sourceimpl BitAnd<CommandBufferFlags> for CommandBufferFlags
impl BitAnd<CommandBufferFlags> for CommandBufferFlags
sourceimpl BitAndAssign<CommandBufferFlags> for CommandBufferFlags
impl BitAndAssign<CommandBufferFlags> for CommandBufferFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<CommandBufferFlags> for CommandBufferFlags
impl BitOr<CommandBufferFlags> for CommandBufferFlags
sourcefn bitor(self, other: CommandBufferFlags) -> Self
fn bitor(self, other: CommandBufferFlags) -> Self
Returns the union of the two sets of flags.
type Output = Self
type Output = Self
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<CommandBufferFlags> for CommandBufferFlags
impl BitOrAssign<CommandBufferFlags> for CommandBufferFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<CommandBufferFlags> for CommandBufferFlags
impl BitXor<CommandBufferFlags> for CommandBufferFlags
sourceimpl BitXorAssign<CommandBufferFlags> for CommandBufferFlags
impl BitXorAssign<CommandBufferFlags> for CommandBufferFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for CommandBufferFlags
impl Clone for CommandBufferFlags
sourcefn clone(&self) -> CommandBufferFlags
fn clone(&self) -> CommandBufferFlags
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 CommandBufferFlags
impl Debug for CommandBufferFlags
sourceimpl Default for CommandBufferFlags
impl Default for CommandBufferFlags
sourcefn default() -> CommandBufferFlags
fn default() -> CommandBufferFlags
Returns the “default value” for a type. Read more
sourceimpl Extend<CommandBufferFlags> for CommandBufferFlags
impl Extend<CommandBufferFlags> for CommandBufferFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 FromIterator<CommandBufferFlags> for CommandBufferFlags
impl FromIterator<CommandBufferFlags> for CommandBufferFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for CommandBufferFlags
impl Hash for CommandBufferFlags
sourceimpl LowerHex for CommandBufferFlags
impl LowerHex for CommandBufferFlags
sourceimpl Not for CommandBufferFlags
impl Not for CommandBufferFlags
sourceimpl Octal for CommandBufferFlags
impl Octal for CommandBufferFlags
sourceimpl Ord for CommandBufferFlags
impl Ord for CommandBufferFlags
sourceimpl PartialEq<CommandBufferFlags> for CommandBufferFlags
impl PartialEq<CommandBufferFlags> for CommandBufferFlags
sourcefn eq(&self, other: &CommandBufferFlags) -> bool
fn eq(&self, other: &CommandBufferFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CommandBufferFlags) -> bool
fn ne(&self, other: &CommandBufferFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<CommandBufferFlags> for CommandBufferFlags
impl PartialOrd<CommandBufferFlags> for CommandBufferFlags
sourcefn partial_cmp(&self, other: &CommandBufferFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &CommandBufferFlags) -> 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<CommandBufferFlags> for CommandBufferFlags
impl Sub<CommandBufferFlags> for CommandBufferFlags
sourceimpl SubAssign<CommandBufferFlags> for CommandBufferFlags
impl SubAssign<CommandBufferFlags> for CommandBufferFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for CommandBufferFlags
impl UpperHex for CommandBufferFlags
impl Copy for CommandBufferFlags
impl Eq for CommandBufferFlags
impl StructuralEq for CommandBufferFlags
impl StructuralPartialEq for CommandBufferFlags
Auto Trait Implementations
impl RefUnwindSafe for CommandBufferFlags
impl Send for CommandBufferFlags
impl Sync for CommandBufferFlags
impl Unpin for CommandBufferFlags
impl UnwindSafe for CommandBufferFlags
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