Struct MTL4RenderEncoderOptions 

#[repr(transparent)]
pub struct MTL4RenderEncoderOptions(pub NSUInteger);

Available on crate feature MTL4RenderCommandEncoder only.

Custom render pass options you specify at encoder creation time.

Use these options to implement parallel encoding of render passes across multiple CPU threads by providing these values to the options parameter of MTL4CommandBuffer/renderCommandEncoderWithDescriptor:options: and observing these requirements:

1. Commit all command encoders together in an array you provide to MTL4CommandQueue/commit:count: or MTL4CommandQueue/commit:count:options:
2. The first command buffer in the array contains a render pass that you start with option MTL4RenderEncoderOptionSuspending
3. The last command buffer in the array contains the same render pass that you start with option MTL4RenderEncoderOptionResuming
4. All intermediate command buffers between the first and last in the array contain the same render pass that you start with both MTL4RenderEncoderOptionResuming and MTL4RenderEncoderOptionSuspending options.
5. The sequence of render passes, in submission order, doesn’t intermix with compute, blit, acceleration structure or machine learning encoding.
6. A command buffer shouldn’t contain a render pass that you start with option MTL4RenderEncoderOptionSuspending if it already contains a render pass that you start with option MTL4RenderEncoderOptionResuming.

See also Apple’s documentation

Tuple Fields

0: NSUInteger

Implementations

impl MTL4RenderEncoderOptions

pub const None: Self

Declares that this render pass doesn’t suspend nor resume.

pub const Suspending: Self

Configures the render pass as suspending.

Pass this option to MTL4CommandBuffer/renderCommandEncoderWithDescriptor:options: to specify that Metal can stitch the work a render command encoder encodes with a subsequent “resuming” render command encoder.

pub const Resuming: Self

Configures the render pass to as resuming.

Pass this option to MTL4CommandBuffer/renderCommandEncoderWithDescriptor:options: to specify that Metal can stitch the work a render command encoder encodes with a prior “suspending” render command encoder.

impl MTL4RenderEncoderOptions

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> NSUInteger

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: NSUInteger) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: NSUInteger) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: NSUInteger) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

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

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl MTL4RenderEncoderOptions

pub const fn iter(&self) -> Iter<MTL4RenderEncoderOptions>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<MTL4RenderEncoderOptions>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for MTL4RenderEncoderOptions

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

Formats the value using the given formatter.

impl BitAnd for MTL4RenderEncoderOptions

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

The bitwise and (&) of the bits in two flags values.

type Output = MTL4RenderEncoderOptions

The resulting type after applying the & operator.

impl BitAndAssign for MTL4RenderEncoderOptions

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for MTL4RenderEncoderOptions

fn bitor(self, other: MTL4RenderEncoderOptions) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = MTL4RenderEncoderOptions

The resulting type after applying the | operator.

impl BitOrAssign for MTL4RenderEncoderOptions

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for MTL4RenderEncoderOptions

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = MTL4RenderEncoderOptions

The resulting type after applying the ^ operator.

impl BitXorAssign for MTL4RenderEncoderOptions

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for MTL4RenderEncoderOptions

fn clone(&self) -> MTL4RenderEncoderOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MTL4RenderEncoderOptions

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

Formats the value using the given formatter.

impl Encode for MTL4RenderEncoderOptions

const ENCODING: Encoding = NSUInteger::ENCODING

The Objective-C type-encoding for this type.

impl Extend<MTL4RenderEncoderOptions> for MTL4RenderEncoderOptions

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

The bitwise or (|) of the bits in each flags value.

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 Flags for MTL4RenderEncoderOptions

const FLAGS: &'static [Flag<MTL4RenderEncoderOptions>]

The set of defined flags.

type Bits = usize

The underlying bits type.

fn bits(&self) -> NSUInteger

Get the underlying bits value.

fn from_bits_retain(bits: NSUInteger) -> MTL4RenderEncoderOptions

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<MTL4RenderEncoderOptions> for MTL4RenderEncoderOptions

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

The bitwise or (|) of the bits in each flags value.

impl Hash for MTL4RenderEncoderOptions

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for MTL4RenderEncoderOptions

type Item = MTL4RenderEncoderOptions

The type of the elements being iterated over.

type IntoIter = Iter<MTL4RenderEncoderOptions>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for MTL4RenderEncoderOptions

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

Formats the value using the given formatter.

impl Not for MTL4RenderEncoderOptions

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = MTL4RenderEncoderOptions

The resulting type after applying the ! operator.

impl Octal for MTL4RenderEncoderOptions

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

Formats the value using the given formatter.

impl Ord for MTL4RenderEncoderOptions

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MTL4RenderEncoderOptions

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MTL4RenderEncoderOptions

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl RefEncode for MTL4RenderEncoderOptions

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Sub for MTL4RenderEncoderOptions

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = MTL4RenderEncoderOptions

The resulting type after applying the - operator.

impl SubAssign for MTL4RenderEncoderOptions

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for MTL4RenderEncoderOptions

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

Formats the value using the given formatter.

impl Copy for MTL4RenderEncoderOptions

impl Eq for MTL4RenderEncoderOptions

impl StructuralPartialEq for MTL4RenderEncoderOptions