Struct sierra::AccelerationStructureBuildFlags

pub struct AccelerationStructureBuildFlags { /* fields omitted */ }

Bits which can be set in AccelerationStructureInfo specifying additional parameters for acceleration structure builds.

Implementations

impl AccelerationStructureBuildFlags

pub const ALLOW_UPDATE: AccelerationStructureBuildFlags

Allow acceleration structure update operation. Acceleration structure update allows changing internal structure without recreating whole AccelerationStructure instance.

pub const ALLOW_COMPACTION: AccelerationStructureBuildFlags

Allow acceleration structure compaction operation. Compaction allows to reduce memory consumption.

pub const PREFER_FAST_TRACE: AccelerationStructureBuildFlags

Hint implementation to make AccelerationStructure faster to trace.

pub const PREFER_FAST_BUILD: AccelerationStructureBuildFlags

Hint implementation to make AccelerationStructure faster to build.

pub const LOW_MEMORY: AccelerationStructureBuildFlags

Hint implementation to use minimal amount of memory.

pub const fn empty() -> AccelerationStructureBuildFlags

Returns an empty set of flags

pub const fn all() -> AccelerationStructureBuildFlags

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<AccelerationStructureBuildFlags>

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) -> AccelerationStructureBuildFlags

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for AccelerationStructureBuildFlags

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

Formats the value using the given formatter.

impl BitAnd<AccelerationStructureBuildFlags> for AccelerationStructureBuildFlags

type Output = AccelerationStructureBuildFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<AccelerationStructureBuildFlags> for AccelerationStructureBuildFlags

fn bitand_assign(&mut self, other: AccelerationStructureBuildFlags)

Disables all flags disabled in the set.

impl BitOr<AccelerationStructureBuildFlags> for AccelerationStructureBuildFlags

type Output = AccelerationStructureBuildFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<AccelerationStructureBuildFlags> for AccelerationStructureBuildFlags

fn bitor_assign(&mut self, other: AccelerationStructureBuildFlags)

Adds the set of flags.

impl BitXor<AccelerationStructureBuildFlags> for AccelerationStructureBuildFlags

type Output = AccelerationStructureBuildFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<AccelerationStructureBuildFlags> for AccelerationStructureBuildFlags

fn bitxor_assign(&mut self, other: AccelerationStructureBuildFlags)

Toggles the set of flags.

impl Clone for AccelerationStructureBuildFlags

fn clone(&self) -> AccelerationStructureBuildFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for AccelerationStructureBuildFlags

impl Debug for AccelerationStructureBuildFlags

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

Formats the value using the given formatter.

impl Eq for AccelerationStructureBuildFlags

impl Extend<AccelerationStructureBuildFlags> for AccelerationStructureBuildFlags

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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<AccelerationStructureBuildFlags> for AccelerationStructureBuildFlags

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

Creates a value from an iterator.

impl Hash for AccelerationStructureBuildFlags

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

Feeds this value into the given Hasher.

pub 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 AccelerationStructureBuildFlags

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

Formats the value using the given formatter.

impl Not for AccelerationStructureBuildFlags

type Output = AccelerationStructureBuildFlags

The resulting type after applying the ! operator.

fn not(self) -> AccelerationStructureBuildFlags

Returns the complement of this set of flags.

impl Octal for AccelerationStructureBuildFlags

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

Formats the value using the given formatter.

impl Ord for AccelerationStructureBuildFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<AccelerationStructureBuildFlags> for AccelerationStructureBuildFlags

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

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

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

This method tests for !=.

impl PartialOrd<AccelerationStructureBuildFlags> for AccelerationStructureBuildFlags

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for AccelerationStructureBuildFlags

impl StructuralPartialEq for AccelerationStructureBuildFlags

impl Sub<AccelerationStructureBuildFlags> for AccelerationStructureBuildFlags

type Output = AccelerationStructureBuildFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<AccelerationStructureBuildFlags> for AccelerationStructureBuildFlags

fn sub_assign(&mut self, other: AccelerationStructureBuildFlags)

Disables all flags enabled in the set.

impl UpperHex for AccelerationStructureBuildFlags

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

Formats the value using the given formatter.