Struct Capabilities 

pub struct Capabilities(/* private fields */);

Allowed IR capabilities.

Implementations

impl Capabilities

pub const IMMEDIATES: Self

Support for AddressSpace::Immediate.

pub const FLOAT64: Self

Float values with width = 8.

pub const PRIMITIVE_INDEX: Self

Support for BuiltIn::PrimitiveIndex.

pub const TEXTURE_AND_SAMPLER_BINDING_ARRAY: Self

Support for binding arrays of sampled textures and samplers.

pub const BUFFER_BINDING_ARRAY: Self

Support for binding arrays of uniform buffers.

pub const STORAGE_TEXTURE_BINDING_ARRAY: Self

Support for binding arrays of storage textures.

pub const STORAGE_BUFFER_BINDING_ARRAY: Self

Support for binding arrays of storage buffers.

pub const CLIP_DISTANCE: Self

Support for BuiltIn::ClipDistance.

pub const CULL_DISTANCE: Self

Support for BuiltIn::CullDistance.

pub const STORAGE_TEXTURE_16BIT_NORM_FORMATS: Self

Support for 16-bit normalized storage texture formats.

pub const MULTIVIEW: Self

Support for BuiltIn::ViewIndex.

pub const EARLY_DEPTH_TEST: Self

Support for early_depth_test.

pub const MULTISAMPLED_SHADING: Self

Support for BuiltIn::SampleIndex and Sampling::Sample.

pub const RAY_QUERY: Self

Support for ray queries and acceleration structures.

pub const DUAL_SOURCE_BLENDING: Self

Support for generating two sources for blending from fragment shaders.

pub const CUBE_ARRAY_TEXTURES: Self

Support for arrayed cube textures.

pub const SHADER_INT64: Self

Support for 64-bit signed and unsigned integers.

pub const SUBGROUP: Self

Support for subgroup operations (except barriers) in fragment and compute shaders.

Subgroup operations in the vertex stage require Capabilities::SUBGROUP_VERTEX_STAGE in addition to Capabilities::SUBGROUP. (But note that create_validator automatically sets Capabilities::SUBGROUP whenever Features::SUBGROUP_VERTEX is available.)

Subgroup barriers require Capabilities::SUBGROUP_BARRIER in addition to Capabilities::SUBGROUP.

pub const SUBGROUP_BARRIER: Self

Support for subgroup barriers in compute shaders.

Requires Capabilities::SUBGROUP. Without it, enables nothing.

pub const SUBGROUP_VERTEX_STAGE: Self

Support for subgroup operations (not including barriers) in the vertex stage.

Without Capabilities::SUBGROUP, enables nothing. (But note that create_validator automatically sets Capabilities::SUBGROUP whenever Features::SUBGROUP_VERTEX is available.)

pub const SHADER_INT64_ATOMIC_MIN_MAX: Self

Support for AtomicFunction::Min and AtomicFunction::Max on 64-bit integers in the Storage address space, when the return value is not used.

This is the only 64-bit atomic functionality available on Metal 3.1.

pub const SHADER_INT64_ATOMIC_ALL_OPS: Self

Support for all atomic operations on 64-bit integers.

pub const SHADER_FLOAT32_ATOMIC: Self

Support for AtomicFunction::Add, AtomicFunction::Sub, and AtomicFunction::Exchange { compare: None } on 32-bit floating-point numbers in the Storage address space.

pub const TEXTURE_ATOMIC: Self

Support for atomic operations on images.

pub const TEXTURE_INT64_ATOMIC: Self

Support for atomic operations on 64-bit images.

pub const RAY_HIT_VERTEX_POSITION: Self

Support for ray queries returning vertex position

pub const SHADER_FLOAT16: Self

Support for 16-bit floating-point types.

pub const TEXTURE_EXTERNAL: Self

Support for [ImageClass::External]

pub const SHADER_FLOAT16_IN_FLOAT32: Self

Support for quantizeToF16, pack2x16float, and unpack2x16float, which store f16-precision values in f32s.

pub const SHADER_BARYCENTRICS: Self

Support for fragment shader barycentric coordinates.

pub const MESH_SHADER: Self

Support for task shaders, mesh shaders, and per-primitive fragment inputs

pub const MESH_SHADER_POINT_TOPOLOGY: Self

Support for mesh shaders which output points.

pub const TEXTURE_AND_SAMPLER_BINDING_ARRAY_NON_UNIFORM_INDEXING: Self

Support for non-uniform indexing of binding arrays of sampled textures and samplers.

pub const BUFFER_BINDING_ARRAY_NON_UNIFORM_INDEXING: Self

Support for non-uniform indexing of binding arrays of uniform buffers.

pub const STORAGE_TEXTURE_BINDING_ARRAY_NON_UNIFORM_INDEXING: Self

Support for non-uniform indexing of binding arrays of storage textures.

pub const STORAGE_BUFFER_BINDING_ARRAY_NON_UNIFORM_INDEXING: Self

Support for non-uniform indexing of binding arrays of storage buffers.

pub const COOPERATIVE_MATRIX: Self

Support for cooperative matrix types and operations

pub const PER_VERTEX: Self

Support for per-vertex fragment input.

pub const RAY_TRACING_PIPELINE: Self

Support for ray generation, any hit, closest hit, and miss shaders.

pub const DRAW_INDEX: Self

Support for draw index builtin

pub const ACCELERATION_STRUCTURE_BINDING_ARRAY: Self

Support for binding arrays of acceleration structures.

pub const MEMORY_DECORATION_COHERENT: Self

Support for the @coherent memory decoration on storage buffers.

pub const MEMORY_DECORATION_VOLATILE: Self

Support for the @volatile memory decoration on storage buffers.

impl Capabilities

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

Get the underlying bits value.

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

pub const fn from_bits(bits: u64) -> 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: u64) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u64) -> 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 self 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 other are also set in self.

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

Whether all set bits in other are also set in self.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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 self and other.

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 self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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 self and other.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl Capabilities

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

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

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 Capabilities

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

Formats the value using the given formatter.

impl BitAnd for Capabilities

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

The bitwise and (&) of the bits in self and other.

type Output = Capabilities

The resulting type after applying the & operator.

impl BitAndAssign for Capabilities

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in self and other.

impl BitOr for Capabilities

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

The bitwise or (|) of the bits in self and other.

type Output = Capabilities

The resulting type after applying the | operator.

impl BitOrAssign for Capabilities

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in self and other.

impl BitXor for Capabilities

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

The bitwise exclusive-or (^) of the bits in self and other.

type Output = Capabilities

The resulting type after applying the ^ operator.

impl BitXorAssign for Capabilities

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for Capabilities

fn clone(&self) -> Capabilities

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Capabilities

impl Debug for Capabilities

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

Formats the value using the given formatter.

impl Default for Capabilities

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Capabilities

impl Extend<Capabilities> for Capabilities

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 Capabilities

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

The set of defined flags.

type Bits = u64

The underlying bits type.

fn bits(&self) -> u64

Get the underlying bits value.

fn from_bits_retain(bits: u64) -> Capabilities

Convert from a bits value exactly.

fn all_named() -> Capabilities

Get a flags value with all bits from named flags set.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

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 iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

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 other are also set in self.

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

where Self: Sized,

Whether all set bits in other are also set in self.

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 self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

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 self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl FromIterator<Capabilities> for Capabilities

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

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

impl IntoIterator for Capabilities

type Item = Capabilities

The type of the elements being iterated over.

type IntoIter = Iter<Capabilities>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for Capabilities

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

Formats the value using the given formatter.

impl Not for Capabilities

fn not(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

type Output = Capabilities

The resulting type after applying the ! operator.

impl Octal for Capabilities

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

Formats the value using the given formatter.

impl PartialEq for Capabilities

fn eq(&self, other: &Capabilities) -> 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 PublicFlags for Capabilities

type Primitive = u64

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl StructuralPartialEq for Capabilities

impl Sub for Capabilities

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

The intersection of self with the complement of other (&!).

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 = Capabilities

The resulting type after applying the - operator.

impl SubAssign for Capabilities

fn sub_assign(&mut self, other: Self)

The intersection of self with the complement of other (&!).

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 Capabilities

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

Formats the value using the given formatter.