[][src]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.

Implementations

impl ContextFlags[src]

pub const SCHED_SPIN: ContextFlags[src]

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[src]

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[src]

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

pub const SCHED_AUTO: ContextFlags[src]

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[src]

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[src]

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[src]

Returns an empty set of flags

pub const fn all() -> ContextFlags[src]

Returns the set containing all flags.

pub const fn bits(&self) -> u32[src]

Returns the raw value of the flags currently stored.

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

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[src]

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

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

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

pub const fn is_empty(&self) -> bool[src]

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool[src]

Returns true if all flags are currently set.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for ContextFlags[src]

impl BitAnd<ContextFlags> for ContextFlags[src]

type Output = ContextFlags

The resulting type after applying the & operator.

fn bitand(self, other: ContextFlags) -> ContextFlags[src]

Returns the intersection between the two sets of flags.

impl BitAndAssign<ContextFlags> for ContextFlags[src]

fn bitand_assign(&mut self, other: ContextFlags)[src]

Disables all flags disabled in the set.

impl BitOr<ContextFlags> for ContextFlags[src]

type Output = ContextFlags

The resulting type after applying the | operator.

fn bitor(self, other: ContextFlags) -> ContextFlags[src]

Returns the union of the two sets of flags.

impl BitOrAssign<ContextFlags> for ContextFlags[src]

fn bitor_assign(&mut self, other: ContextFlags)[src]

Adds the set of flags.

impl BitXor<ContextFlags> for ContextFlags[src]

type Output = ContextFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: ContextFlags) -> ContextFlags[src]

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

impl BitXorAssign<ContextFlags> for ContextFlags[src]

fn bitxor_assign(&mut self, other: ContextFlags)[src]

Toggles the set of flags.

impl Clone for ContextFlags[src]

impl Copy for ContextFlags[src]

impl Debug for ContextFlags[src]

impl Eq for ContextFlags[src]

impl Extend<ContextFlags> for ContextFlags[src]

impl FromIterator<ContextFlags> for ContextFlags[src]

impl Hash for ContextFlags[src]

impl LowerHex for ContextFlags[src]

impl Not for ContextFlags[src]

type Output = ContextFlags

The resulting type after applying the ! operator.

fn not(self) -> ContextFlags[src]

Returns the complement of this set of flags.

impl Octal for ContextFlags[src]

impl Ord for ContextFlags[src]

impl PartialEq<ContextFlags> for ContextFlags[src]

impl PartialOrd<ContextFlags> for ContextFlags[src]

impl StructuralEq for ContextFlags[src]

impl StructuralPartialEq for ContextFlags[src]

impl Sub<ContextFlags> for ContextFlags[src]

type Output = ContextFlags

The resulting type after applying the - operator.

fn sub(self, other: ContextFlags) -> ContextFlags[src]

Returns the set difference of the two sets of flags.

impl SubAssign<ContextFlags> for ContextFlags[src]

fn sub_assign(&mut self, other: ContextFlags)[src]

Disables all flags enabled in the set.

impl UpperHex for ContextFlags[src]

Auto Trait Implementations

impl RefUnwindSafe for ContextFlags

impl Send for ContextFlags

impl Sync for ContextFlags

impl Unpin for ContextFlags

impl UnwindSafe for ContextFlags

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.