Struct wgpu::Features

[+] Show declaration

[+] Expand attributes
#[repr(transparent)]pub struct Features { /* fields omitted */ }

[−] Expand description

Features that are not guaranteed to be supported.

These are either part of the webgpu standard, or are extension features supported by wgpu when targeting native.

If you want to use a feature, you need to first verify that the adapter supports the feature. If the adapter does not support the feature, requesting a device with it enabled will panic.

Implementations

impl Features[−]

pub const DEPTH_CLAMPING: Features[−][−]

By default, polygon depth is clipped to 0-1 range. Anything outside of that range is rejected, and respective fragments are not touched.

With this extension, we can force clamping of the polygon depth to 0-1. That allows shadow map occluders to be rendered into a tighter depth range.

Supported platforms:

• desktops
• some mobile chips

This is a web and native feature.

pub const TEXTURE_COMPRESSION_BC: Features[−][−]

Enables BCn family of compressed textures. All BCn textures use 4x4 pixel blocks with 8 or 16 bytes per block.

Compressed textures sacrifice some quality in exchange for signifigantly reduced bandwidth usage.

Supported Platforms:

• desktops

This is a web and native feature.

pub const MAPPABLE_PRIMARY_BUFFERS: Features[−][−]

Webgpu only allows the MAP_READ and MAP_WRITE buffer usage to be matched with COPY_DST and COPY_SRC respectively. This removes this requirement.

This is only beneficial on systems that share memory between CPU and GPU. If enabled on a system that doesn't, this can severely hinder performance. Only use if you understand the consequences.

Supported platforms:

• All

This is a native only feature.

pub const SAMPLED_TEXTURE_BINDING_ARRAY: Features[−][−]

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

This is a native only feature.

pub const SAMPLED_TEXTURE_ARRAY_DYNAMIC_INDEXING: Features[−][−]

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

This is a native only feature.

pub const SAMPLED_TEXTURE_ARRAY_NON_UNIFORM_INDEXING: Features[−][−]

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)

This is a native only feature.

pub const UNSIZED_BINDING_ARRAY: Features[−][−]

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

This is a native only feature.

pub const MULTI_DRAW_INDIRECT: Features[−][−]

Allows the user to call [RenderPass::multi_draw_indirect] and [RenderPass::multi_draw_indexed_indirect].

Allows multiple indirect calls to be dispatched from a single buffer.

Supported platforms:

• DX12
• Metal
• Vulkan

This is a native only feature.

pub const MULTI_DRAW_INDIRECT_COUNT: Features[−][−]

Allows the user to call [RenderPass::multi_draw_indirect_count] and [RenderPass::multi_draw_indexed_indirect_count].

This allows the use of a buffer containing the actual number of draw calls.

Supported platforms:

• DX12
• Vulkan 1.2+ (or VK_KHR_draw_indirect_count)

This is a native only feature.

pub const PUSH_CONSTANTS: Features[−][−]

Allows the use of push constants: small, fast bits of memory that can be updated inside a [RenderPass].

Allows the user to call [RenderPass::set_push_constants], provide a non-empty array to [PipelineLayoutDescriptor], and provide a non-zero limit to Limits::max_push_constant_size.

A block of push constants can be declared with layout(push_constant) uniform Name {..} in shaders.

Supported platforms:

• DX12
• Vulkan
• Metal
• DX11 (emulated with uniforms)
• OpenGL (emulated with uniforms)

This is a native only feature.

pub const ALL_WEBGPU: Features[−][−]

Features which are part of the upstream WebGPU standard.

pub const ALL_NATIVE: Features[−][−]

Features that are only available when targeting native (not web).

pub const fn empty() -> Features[−]

Returns an empty set of flags

pub const fn all() -> Features[−]

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<Features>[−]

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) -> Features[−]

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

pub const unsafe fn from_bits_unchecked(bits: u64) -> Features[−]

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: Features) -> bool[−]

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

pub const fn contains(&self, other: Features) -> bool[−]

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

pub fn insert(&mut self, other: Features)[−]

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Features)[−]

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Features)[−]

Toggles the specified flags in-place.

pub fn set(&mut self, other: Features, value: bool)[−]

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

Trait Implementations

impl Binary for Features[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl BitAnd<Features> for Features[+]

type Output = Features

The resulting type after applying the & operator.

fn bitand(self, other: Features) -> Features[−]

Returns the intersection between the two sets of flags.

impl BitAndAssign<Features> for Features[+]

fn bitand_assign(&mut self, other: Features)[−]

Disables all flags disabled in the set.

impl BitOr<Features> for Features[+]

type Output = Features

The resulting type after applying the | operator.

fn bitor(self, other: Features) -> Features[−]

Returns the union of the two sets of flags.

impl BitOrAssign<Features> for Features[+]

fn bitor_assign(&mut self, other: Features)[−]

Adds the set of flags.

impl BitXor<Features> for Features[+]

type Output = Features

The resulting type after applying the ^ operator.

fn bitxor(self, other: Features) -> Features[−]

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

impl BitXorAssign<Features> for Features[+]

fn bitxor_assign(&mut self, other: Features)[−]

Toggles the set of flags.

impl Clone for Features[+]

[+] Show hidden undocumented items

fn clone(&self) -> Features[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for Features

impl Debug for Features[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for Features[+]

[+] Show hidden undocumented items

fn default() -> Features[−]

Returns the "default value" for a type.

impl Eq for Features

impl Extend<Features> for Features[+]

[+] Show hidden undocumented items

fn extend<T>(&mut self, iterator: T) where
    T: IntoIterator<Item = Features>, [−]

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<Features> for Features[+]

[+] Show hidden undocumented items

fn from_iter<T>(iterator: T) -> Features where
    T: IntoIterator<Item = Features>, [−]

Creates a value from an iterator.

impl Hash for Features[+]

[+] Show hidden undocumented items

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 Features[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Not for Features[+]

type Output = Features

The resulting type after applying the ! operator.

fn not(self) -> Features[−]

Returns the complement of this set of flags.

impl Octal for Features[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Ord for Features[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &Features) -> Ordering[−]

This method returns an Ordering between self and other.

[+] Expand attributes

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

Compares and returns the maximum of two values.

[+] Expand attributes

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

Compares and returns the minimum of two values.

[+] Expand attributes

#[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<Features> for Features[+]

[+] Show hidden undocumented items

fn eq(&self, other: &Features) -> bool[−]

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

fn ne(&self, other: &Features) -> bool[−]

This method tests for !=.

impl PartialOrd<Features> for Features[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &Features) -> Option<Ordering>[−]

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

fn lt(&self, other: &Features) -> bool[−]

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

fn le(&self, other: &Features) -> bool[−]

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

fn gt(&self, other: &Features) -> bool[−]

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

fn ge(&self, other: &Features) -> bool[−]

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

impl StructuralEq for Features

impl StructuralPartialEq for Features

impl Sub<Features> for Features[+]

type Output = Features

The resulting type after applying the - operator.

fn sub(self, other: Features) -> Features[−]

Returns the set difference of the two sets of flags.

impl SubAssign<Features> for Features[+]

fn sub_assign(&mut self, other: Features)[−]

Disables all flags enabled in the set.

impl UpperHex for Features[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.