Struct rustacuda::context::ContextFlags

pub struct ContextFlags { /* fields omitted */ }

Bit flags for initializing the CUDA context.

If you're not sure which flags to use, MAP_HOST | SCHED_AUTO is a good default.

Methods

impl ContextFlags

pub const SCHED_SPIN: ContextFlags

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.

pub const SCHED_YIELD: ContextFlags

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.

pub const SCHED_BLOCKING_SYNC: ContextFlags

Instructs CUDA to block the CPU thread on a synchronization primitive when waiting for the GPU to finish work.

pub const SCHED_AUTO: ContextFlags

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.

pub const MAP_HOST: ContextFlags

Instructs CUDA to support mapped pinned allocations. This flag must be set in order to use page-locked memory (see LockedBuffer).

pub const LMEM_RESIZE_TO_MAX: ContextFlags

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.

pub const fn empty() -> ContextFlags

Returns an empty set of flags

pub const fn all() -> ContextFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> ContextFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true all of the flags in other are contained within self.

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for ContextFlags

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

Formats the value using the given formatter.

impl BitAnd<ContextFlags> for ContextFlags

type Output = ContextFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<ContextFlags> for ContextFlags

fn bitand_assign(&mut self, other: ContextFlags)

Disables all flags disabled in the set.

impl BitOr<ContextFlags> for ContextFlags

type Output = ContextFlags

The resulting type after applying the | operator.

fn bitor(self, other: ContextFlags) -> ContextFlags

Returns the union of the two sets of flags.

impl BitOrAssign<ContextFlags> for ContextFlags

fn bitor_assign(&mut self, other: ContextFlags)

Adds the set of flags.

impl BitXor<ContextFlags> for ContextFlags

type Output = ContextFlags

The resulting type after applying the ^ operator.

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

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<ContextFlags> for ContextFlags

fn bitxor_assign(&mut self, other: ContextFlags)

Toggles the set of flags.

impl Clone for ContextFlags

fn clone(&self) -> ContextFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ContextFlags

impl Debug for ContextFlags

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

Formats the value using the given formatter.

impl Eq for ContextFlags

impl Extend<ContextFlags> for ContextFlags

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

Extends a collection with the contents of an iterator.

impl FromIterator<ContextFlags> for ContextFlags

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

Creates a value from an iterator.

impl Hash for ContextFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for ContextFlags

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

Formats the value using the given formatter.

impl Not for ContextFlags

type Output = ContextFlags

The resulting type after applying the ! operator.

fn not(self) -> ContextFlags

Returns the complement of this set of flags.

impl Octal for ContextFlags

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

Formats the value using the given formatter.

impl Ord for ContextFlags

fn cmp(&self, other: &ContextFlags) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ContextFlags> for ContextFlags

fn eq(&self, other: &ContextFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ContextFlags) -> bool

This method tests for !=.

impl PartialOrd<ContextFlags> for ContextFlags

fn partial_cmp(&self, other: &ContextFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &ContextFlags) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &ContextFlags) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &ContextFlags) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &ContextFlags) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for ContextFlags

impl StructuralPartialEq for ContextFlags

impl Sub<ContextFlags> for ContextFlags

type Output = ContextFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<ContextFlags> for ContextFlags

fn sub_assign(&mut self, other: ContextFlags)

Disables all flags enabled in the set.

impl UpperHex for ContextFlags

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

Formats the value using the given formatter.