[][src]Struct wgpu::Features

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

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[src]

pub const DEPTH_CLAMPING: Features[src]

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[src]

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[src]

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[src]

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[src]

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[src]

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

and then used either as nonuniformEXT qualifier in variable declaration:

eg. layout(location = 0) nonuniformEXT flat in int vertex_data;

or as nonuniformEXT constructor:

eg. texture_array[nonuniformEXT(vertex_data)]

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[src]

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[src]

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[src]

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[src]

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 ADDRESS_MODE_CLAMP_TO_BORDER: Features[src]

Allows the use of AddressMode::ClampToBorder.

Supported platforms:

  • DX12
  • Vulkan
  • Metal (macOS 10.12+ only)
  • DX11
  • OpenGL

This is a web and native feature.

pub const NON_FILL_POLYGON_MODE: Features[src]

Allows the user to set a non-fill polygon mode in RasterizationStateDescriptor::polygon_mode

This allows drawing polygons/triangles as lines (wireframe) or points instead of filled

Supported platforms:

  • DX12
  • Vulkan

This is a native only feature.

pub const ALL_WEBGPU: Features[src]

Features which are part of the upstream WebGPU standard.

pub const ALL_NATIVE: Features[src]

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

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

Returns an empty set of flags

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

Returns the set containing all flags.

pub const fn bits(&self) -> u64[src]

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u64) -> Option<Features>[src]

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[src]

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

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

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool[src]

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool[src]

Returns true if all flags are currently set.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for Features[src]

impl BitAnd<Features> for Features[src]

type Output = Features

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<Features> for Features[src]

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

Disables all flags disabled in the set.

impl BitOr<Features> for Features[src]

type Output = Features

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<Features> for Features[src]

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

Adds the set of flags.

impl BitXor<Features> for Features[src]

type Output = Features

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<Features> for Features[src]

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

Toggles the set of flags.

impl Clone for Features[src]

impl Copy for Features[src]

impl Debug for Features[src]

impl Default for Features[src]

impl<'de> Deserialize<'de> for Features[src]

impl Eq for Features[src]

impl Extend<Features> for Features[src]

impl FromIterator<Features> for Features[src]

impl Hash for Features[src]

impl LowerHex for Features[src]

impl Not for Features[src]

type Output = Features

The resulting type after applying the ! operator.

fn not(self) -> Features[src]

Returns the complement of this set of flags.

impl Octal for Features[src]

impl Ord for Features[src]

impl PartialEq<Features> for Features[src]

impl PartialOrd<Features> for Features[src]

impl Serialize for Features[src]

impl StructuralEq for Features[src]

impl StructuralPartialEq for Features[src]

impl Sub<Features> for Features[src]

type Output = Features

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Features> for Features[src]

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

Disables all flags enabled in the set.

impl UpperHex for Features[src]

Auto Trait Implementations

impl RefUnwindSafe for Features

impl Send for Features

impl Sync for Features

impl Unpin for Features

impl UnwindSafe for Features

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]

impl<Q, K> Equivalent<K> for Q where
    K: Borrow<Q> + ?Sized,
    Q: Eq + ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<N> NodeTrait for N where
    N: Copy + Ord + Hash
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.