Struct wgpu::Capabilities

#[repr(transparent)]pub struct Capabilities { /* fields omitted */ }

Methods

impl Capabilities

pub const SAMPLED_TEXTURE_BINDING_ARRAY: Capabilities

Allows the user to create uniform arrays of sampled textures in shaders:

eg. uniform texture2D textures[10].

This capability allows them to exist and to be indexed by compile time constant values.

Supported platforms:

• DX12
• Metal (with MSL 2.0+ on macOS 10.13+)
• Vulkan

pub const SAMPLED_TEXTURE_ARRAY_DYNAMIC_INDEXING: Capabilities

Allows shaders to index sampled texture arrays with dynamically uniform values:

eg. texture_array[uniform_value]

This capability means the hardware will also support SAMPLED_TEXTURE_BINDING_ARRAY.

Supported platforms:

• DX12
• Metal (with MSL 2.0+ on macOS 10.13+)
• Vulkan's shaderSampledImageArrayDynamicIndexing feature

pub const SAMPLED_TEXTURE_ARRAY_NON_UNIFORM_INDEXING: Capabilities

Allows shaders to index sampled texture arrays with dynamically non-uniform values:

eg. texture_array[vertex_data]

In order to use this capability, the corresponding GLSL extension must be enabled like so:

#extension GL_EXT_nonuniform_qualifier : require

HLSL does not need any extension.

This capability means the hardware will also support SAMPLED_TEXTURE_ARRAY_DYNAMIC_INDEXING and SAMPLED_TEXTURE_BINDING_ARRAY.

Supported platforms:

• DX12
• Metal (with MSL 2.0+ on macOS 10.13+)
• Vulkan 1.2+ (or VK_EXT_descriptor_indexing)'s shaderSampledImageArrayNonUniformIndexing feature)

Provided by the BINDING_INDEXING extension. This extension must be enabled for this capability to be anything but false.

pub const UNSIZED_BINDING_ARRAY: Capabilities

Allows the user to create unsized uniform arrays of bindings:

eg. uniform texture2D textures[].

If this capability is supported, SAMPLED_TEXTURE_ARRAY_NON_UNIFORM_INDEXING is very likely to also be supported

Supported platforms:

• DX12
• Vulkan 1.2+ (or VK_EXT_descriptor_indexing)'s runtimeDescriptorArray feature

Provided by the BINDING_INDEXING extension. This extension must be enabled for this capability to be anything but false.

pub const ALL_BUILT_IN: Capabilities

All capabilities that are not provided by an extension

pub const ALL_BINDING_INDEXING: Capabilities

All capabilities that are provided by the BINDING_INDEXING extension

pub const fn empty() -> Capabilities

Returns an empty set of flags

pub const fn all() -> Capabilities

Returns the set containing all flags.

pub const fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u64) -> Option<Capabilities>

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

pub const fn from_bits_truncate(bits: u64) -> Capabilities

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

pub const unsafe fn from_bits_unchecked(bits: u64) -> Capabilities

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for Capabilities

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

Formats the value using the given formatter.

impl BitAnd<Capabilities> for Capabilities

type Output = Capabilities

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<Capabilities> for Capabilities

fn bitand_assign(&mut self, other: Capabilities)

Disables all flags disabled in the set.

impl BitOr<Capabilities> for Capabilities

type Output = Capabilities

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<Capabilities> for Capabilities

fn bitor_assign(&mut self, other: Capabilities)

Adds the set of flags.

impl BitXor<Capabilities> for Capabilities

type Output = Capabilities

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<Capabilities> for Capabilities

fn bitxor_assign(&mut self, other: Capabilities)

Toggles the set of flags.

impl Clone for Capabilities

fn clone(&self) -> Capabilities

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl Default for Capabilities

fn default() -> Capabilities

Returns the "default value" for a type.

impl Eq for Capabilities

impl Extend<Capabilities> for Capabilities

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

Extends a collection with the contents of an iterator.

impl FromIterator<Capabilities> for Capabilities

fn from_iter<T>(iterator: T) -> Capabilities where
    T: IntoIterator<Item = Capabilities>, 

Creates a value from an iterator.

impl Hash for Capabilities

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

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 Capabilities

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

Formats the value using the given formatter.

impl Not for Capabilities

type Output = Capabilities

The resulting type after applying the ! operator.

fn not(self) -> Capabilities

Returns the complement of this set of flags.

impl Octal for Capabilities

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

Formats the value using the given formatter.

impl Ord for Capabilities

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

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

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

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

This method tests for !=.

impl PartialOrd<Capabilities> for Capabilities

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

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

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

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

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

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

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

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

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

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

impl Serialize for Capabilities

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Capabilities

impl StructuralPartialEq for Capabilities

impl Sub<Capabilities> for Capabilities

type Output = Capabilities

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Capabilities> for Capabilities

fn sub_assign(&mut self, other: Capabilities)

Disables all flags enabled in the set.

impl UpperHex for Capabilities

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

Formats the value using the given formatter.