Struct rustacuda::memory::array::ArrayObjectFlags

pub struct ArrayObjectFlags { /* fields omitted */ }

Flags which modify the behavior of CUDA array creation.

Implementations

impl ArrayObjectFlags

pub const LAYERED: ArrayObjectFlags

Enables creation of layered CUDA arrays. When this flag is set, depth specifies the number of layers, not the depth of a 3D array.

pub const SURFACE_LDST: ArrayObjectFlags

Enables surface references to be bound to the CUDA array.

pub const CUBEMAP: ArrayObjectFlags

Enables creation of cubemaps. If this flag is set, Width must be equal to Height, and Depth must be six. If the LAYERED flag is also set, then Depth must be a multiple of six.

pub const TEXTURE_GATHER: ArrayObjectFlags

Indicates that the CUDA array will be used for texture gather. Texture gather can only be performed on 2D CUDA arrays.

pub const fn empty() -> ArrayObjectFlags

Returns an empty set of flags

pub const fn all() -> ArrayObjectFlags

Returns the set containing all flags.

pub const fn bits(&self) -> c_uint

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: c_uint) -> Option<ArrayObjectFlags>

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

pub const fn from_bits_truncate(bits: c_uint) -> ArrayObjectFlags

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

pub const unsafe fn from_bits_unchecked(bits: c_uint) -> ArrayObjectFlags

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: ArrayObjectFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

impl ArrayObjectFlags

pub fn new() -> Self

Creates a default flags object with no flags set.

Trait Implementations

impl Binary for ArrayObjectFlags

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

Formats the value using the given formatter.

impl BitAnd<ArrayObjectFlags> for ArrayObjectFlags

type Output = ArrayObjectFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<ArrayObjectFlags> for ArrayObjectFlags

fn bitand_assign(&mut self, other: ArrayObjectFlags)

Disables all flags disabled in the set.

impl BitOr<ArrayObjectFlags> for ArrayObjectFlags

type Output = ArrayObjectFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<ArrayObjectFlags> for ArrayObjectFlags

fn bitor_assign(&mut self, other: ArrayObjectFlags)

Adds the set of flags.

impl BitXor<ArrayObjectFlags> for ArrayObjectFlags

type Output = ArrayObjectFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<ArrayObjectFlags> for ArrayObjectFlags

fn bitxor_assign(&mut self, other: ArrayObjectFlags)

Toggles the set of flags.

impl Clone for ArrayObjectFlags

fn clone(&self) -> ArrayObjectFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ArrayObjectFlags

impl Debug for ArrayObjectFlags

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

Formats the value using the given formatter.

impl Default for ArrayObjectFlags

fn default() -> ArrayObjectFlags

Returns the "default value" for a type.

impl Eq for ArrayObjectFlags

impl Extend<ArrayObjectFlags> for ArrayObjectFlags

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<ArrayObjectFlags> for ArrayObjectFlags

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

Creates a value from an iterator.

impl Hash for ArrayObjectFlags

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 ArrayObjectFlags

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

Formats the value using the given formatter.

impl Not for ArrayObjectFlags

type Output = ArrayObjectFlags

The resulting type after applying the ! operator.

fn not(self) -> ArrayObjectFlags

Returns the complement of this set of flags.

impl Octal for ArrayObjectFlags

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

Formats the value using the given formatter.

impl Ord for ArrayObjectFlags

fn cmp(&self, other: &ArrayObjectFlags) -> 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<ArrayObjectFlags> for ArrayObjectFlags

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

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

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

This method tests for !=.

impl PartialOrd<ArrayObjectFlags> for ArrayObjectFlags

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for ArrayObjectFlags

impl StructuralPartialEq for ArrayObjectFlags

impl Sub<ArrayObjectFlags> for ArrayObjectFlags

type Output = ArrayObjectFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<ArrayObjectFlags> for ArrayObjectFlags

fn sub_assign(&mut self, other: ArrayObjectFlags)

Disables all flags enabled in the set.

impl UpperHex for ArrayObjectFlags

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

Formats the value using the given formatter.