Struct ocl_core::CommandQueueProperties
source · pub struct CommandQueueProperties { /* private fields */ }
Expand description
cl_command_queue_properties - bitfield
Implementations§
source§impl CommandQueueProperties
impl CommandQueueProperties
pub const OUT_OF_ORDER_EXEC_MODE_ENABLE: Self = _
pub const PROFILING_ENABLE: Self = _
pub const ON_DEVICE: Self = _
pub const ON_DEVICE_DEFAULT: Self = _
sourcepub const fn from_bits(bits: u64) -> Option<Self>
pub const fn from_bits(bits: u64) -> 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: u64) -> Self
pub const fn from_bits_truncate(bits: u64) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u64) -> Self
pub const unsafe fn from_bits_unchecked(bits: u64) -> 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
.
source§impl CommandQueueProperties
impl CommandQueueProperties
pub fn new() -> CommandQueueProperties
pub fn out_of_order(self) -> CommandQueueProperties
pub fn profiling(self) -> CommandQueueProperties
Trait Implementations§
source§impl Binary for CommandQueueProperties
impl Binary for CommandQueueProperties
source§impl BitAnd for CommandQueueProperties
impl BitAnd for CommandQueueProperties
source§impl BitAndAssign for CommandQueueProperties
impl BitAndAssign for CommandQueueProperties
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr for CommandQueueProperties
impl BitOr for CommandQueueProperties
source§fn bitor(self, other: CommandQueueProperties) -> Self
fn bitor(self, other: CommandQueueProperties) -> Self
Returns the union of the two sets of flags.
§type Output = CommandQueueProperties
type Output = CommandQueueProperties
|
operator.source§impl BitOrAssign for CommandQueueProperties
impl BitOrAssign for CommandQueueProperties
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for CommandQueueProperties
impl BitXor for CommandQueueProperties
source§impl BitXorAssign for CommandQueueProperties
impl BitXorAssign for CommandQueueProperties
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for CommandQueueProperties
impl Clone for CommandQueueProperties
source§fn clone(&self) -> CommandQueueProperties
fn clone(&self) -> CommandQueueProperties
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CommandQueueProperties
impl Debug for CommandQueueProperties
source§impl Default for CommandQueueProperties
impl Default for CommandQueueProperties
source§fn default() -> CommandQueueProperties
fn default() -> CommandQueueProperties
source§impl Extend<CommandQueueProperties> for CommandQueueProperties
impl Extend<CommandQueueProperties> for CommandQueueProperties
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<CommandQueueProperties> for CommandQueueProperties
impl FromIterator<CommandQueueProperties> for CommandQueueProperties
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for CommandQueueProperties
impl Hash for CommandQueueProperties
source§impl LowerHex for CommandQueueProperties
impl LowerHex for CommandQueueProperties
source§impl Not for CommandQueueProperties
impl Not for CommandQueueProperties
source§impl Octal for CommandQueueProperties
impl Octal for CommandQueueProperties
source§impl Ord for CommandQueueProperties
impl Ord for CommandQueueProperties
source§fn cmp(&self, other: &CommandQueueProperties) -> Ordering
fn cmp(&self, other: &CommandQueueProperties) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
source§impl PartialEq for CommandQueueProperties
impl PartialEq for CommandQueueProperties
source§fn eq(&self, other: &CommandQueueProperties) -> bool
fn eq(&self, other: &CommandQueueProperties) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for CommandQueueProperties
impl PartialOrd for CommandQueueProperties
source§fn partial_cmp(&self, other: &CommandQueueProperties) -> Option<Ordering>
fn partial_cmp(&self, other: &CommandQueueProperties) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub for CommandQueueProperties
impl Sub for CommandQueueProperties
source§impl SubAssign for CommandQueueProperties
impl SubAssign for CommandQueueProperties
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.