Struct rustacuda::context::ContextFlags
source · pub struct ContextFlags { /* private fields */ }
Expand description
Bit flags for initializing the CUDA context.
If you’re not sure which flags to use, MAP_HOST | SCHED_AUTO
is a good default.
Implementations§
source§impl ContextFlags
impl ContextFlags
sourcepub const SCHED_SPIN: Self = _
pub const SCHED_SPIN: Self = _
Instructs CUDA to actively spin when waiting for results from the GPU. This can decrease latency when waiting for the GPU, but may lower the performance of other CPU threads if they are performing work in parallel with the CUDA thread.
sourcepub const SCHED_YIELD: Self = _
pub const SCHED_YIELD: Self = _
Instructs CUDA to yield its thread when waiting for results from the GPU. This can increase latency when waiting for the GPU, but can increase the performance of CPU threads performing work in parallel with the GPU.
sourcepub const SCHED_BLOCKING_SYNC: Self = _
pub const SCHED_BLOCKING_SYNC: Self = _
Instructs CUDA to block the CPU thread on a synchronization primitive when waiting for the GPU to finish work.
sourcepub const SCHED_AUTO: Self = _
pub const SCHED_AUTO: Self = _
Instructs CUDA to automatically choose whether to yield to other OS threads while waiting for the GPU, or to spin the OS thread. This is the default.
sourcepub const MAP_HOST: Self = _
pub const MAP_HOST: Self = _
Instructs CUDA to support mapped pinned allocations. This flag must be set in order to use page-locked memory (see LockedBuffer).
sourcepub const LMEM_RESIZE_TO_MAX: Self = _
pub const LMEM_RESIZE_TO_MAX: Self = _
Instruct CUDA not to reduce local memory after resizing local memory for a kernel. This can prevent thrashing by local memory allocations when launching many kernels with high local memory usage at the cost of potentially increased memory usage.
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§
source§impl Binary for ContextFlags
impl Binary for ContextFlags
source§impl BitAnd<ContextFlags> for ContextFlags
impl BitAnd<ContextFlags> for ContextFlags
source§impl BitAndAssign<ContextFlags> for ContextFlags
impl BitAndAssign<ContextFlags> for ContextFlags
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<ContextFlags> for ContextFlags
impl BitOr<ContextFlags> for ContextFlags
source§fn bitor(self, other: ContextFlags) -> Self
fn bitor(self, other: ContextFlags) -> Self
Returns the union of the two sets of flags.
§type Output = ContextFlags
type Output = ContextFlags
|
operator.source§impl BitOrAssign<ContextFlags> for ContextFlags
impl BitOrAssign<ContextFlags> for ContextFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<ContextFlags> for ContextFlags
impl BitXor<ContextFlags> for ContextFlags
source§impl BitXorAssign<ContextFlags> for ContextFlags
impl BitXorAssign<ContextFlags> for ContextFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for ContextFlags
impl Clone for ContextFlags
source§fn clone(&self) -> ContextFlags
fn clone(&self) -> ContextFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ContextFlags
impl Debug for ContextFlags
source§impl Extend<ContextFlags> for ContextFlags
impl Extend<ContextFlags> for ContextFlags
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<ContextFlags> for ContextFlags
impl FromIterator<ContextFlags> for ContextFlags
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 ContextFlags
impl Hash for ContextFlags
source§impl LowerHex for ContextFlags
impl LowerHex for ContextFlags
source§impl Not for ContextFlags
impl Not for ContextFlags
source§impl Octal for ContextFlags
impl Octal for ContextFlags
source§impl Ord for ContextFlags
impl Ord for ContextFlags
source§fn cmp(&self, other: &ContextFlags) -> Ordering
fn cmp(&self, other: &ContextFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<ContextFlags> for ContextFlags
impl PartialEq<ContextFlags> for ContextFlags
source§fn eq(&self, other: &ContextFlags) -> bool
fn eq(&self, other: &ContextFlags) -> bool
source§impl PartialOrd<ContextFlags> for ContextFlags
impl PartialOrd<ContextFlags> for ContextFlags
source§fn partial_cmp(&self, other: &ContextFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &ContextFlags) -> 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<ContextFlags> for ContextFlags
impl Sub<ContextFlags> for ContextFlags
source§impl SubAssign<ContextFlags> for ContextFlags
impl SubAssign<ContextFlags> for ContextFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.