Struct wgpu::DownlevelFlags

pub struct DownlevelFlags(_);

Binary flags listing features that may or may not be present on downlevel adapters.

A downlevel adapter is a GPU adapter that WGPU supports, but with potentially limited features, due to the lack of hardware feature support.

Flags that are not present for a downlevel adapter or device usually indicates non-compliance with the WebGPU specification, but not always.

You can check whether a set of flags is compliant through the DownlevelCapabilities::is_webgpu_compliant() function.

Implementations

impl DownlevelFlags

pub const COMPUTE_SHADERS: DownlevelFlags = Self::from_bits_retain(1 << 0)

The device supports compiling and using compute shaders.

DX11 on FL10 level hardware, WebGL2, and GLES3.0 devices do not support compute.

pub const FRAGMENT_WRITABLE_STORAGE: DownlevelFlags = Self::from_bits_retain(1 << 1)

Supports binding storage buffers and textures to fragment shaders.

pub const INDIRECT_EXECUTION: DownlevelFlags = Self::from_bits_retain(1 << 2)

Supports indirect drawing and dispatching.

DX11 on FL10 level hardware, WebGL2, and GLES 3.0 devices do not support indirect.

pub const BASE_VERTEX: DownlevelFlags = Self::from_bits_retain(1 << 3)

Supports non-zero base_vertex parameter to indexed draw calls.

pub const READ_ONLY_DEPTH_STENCIL: DownlevelFlags = Self::from_bits_retain(1 << 4)

Supports reading from a depth/stencil buffer while using as a read-only depth/stencil attachment.

The WebGL2 and GLES backends do not support RODS.

pub const NON_POWER_OF_TWO_MIPMAPPED_TEXTURES: DownlevelFlags = Self::from_bits_retain(1 << 5)

Supports textures with mipmaps which have a non power of two size.

pub const CUBE_ARRAY_TEXTURES: DownlevelFlags = Self::from_bits_retain(1 << 6)

Supports textures that are cube arrays.

pub const COMPARISON_SAMPLERS: DownlevelFlags = Self::from_bits_retain(1 << 7)

Supports comparison samplers.

pub const INDEPENDENT_BLEND: DownlevelFlags = Self::from_bits_retain(1 << 8)

Supports different blend operations per color attachment.

pub const VERTEX_STORAGE: DownlevelFlags = Self::from_bits_retain(1 << 9)

Supports storage buffers in vertex shaders.

pub const ANISOTROPIC_FILTERING: DownlevelFlags = Self::from_bits_retain(1 << 10)

Supports samplers with anisotropic filtering. Note this isn’t actually required by WebGPU, the implementation is allowed to completely ignore aniso clamp. This flag is here for native backends so they can communicate to the user of aniso is enabled.

All backends and all devices support anisotropic filtering.

pub const FRAGMENT_STORAGE: DownlevelFlags = Self::from_bits_retain(1 << 11)

Supports storage buffers in fragment shaders.

pub const MULTISAMPLED_SHADING: DownlevelFlags = Self::from_bits_retain(1 << 12)

Supports sample-rate shading.

pub const DEPTH_TEXTURE_AND_BUFFER_COPIES: DownlevelFlags = Self::from_bits_retain(1 << 13)

Supports copies between depth textures and buffers.

GLES/WebGL don’t support this.

pub const WEBGPU_TEXTURE_FORMAT_SUPPORT: DownlevelFlags = Self::from_bits_retain(1 << 14)

Supports all the texture usages described in WebGPU. If this isn’t supported, you should call get_texture_format_features to get how you can use textures of a given format

pub const BUFFER_BINDINGS_NOT_16_BYTE_ALIGNED: DownlevelFlags = Self::from_bits_retain(1 << 15)

Supports buffer bindings with sizes that aren’t a multiple of 16.

WebGL doesn’t support this.

pub const UNRESTRICTED_INDEX_BUFFER: DownlevelFlags = Self::from_bits_retain(1 << 16)

Supports buffers to combine BufferUsages::INDEX with usages other than BufferUsages::COPY_DST and BufferUsages::COPY_SRC. Furthermore, in absence of this feature it is not allowed to copy index buffers from/to buffers with a set of usage flags containing BufferUsages::VERTEX/BufferUsages::UNIFORM/BufferUsages::STORAGE or BufferUsages::INDIRECT.

WebGL doesn’t support this.

pub const FULL_DRAW_INDEX_UINT32: DownlevelFlags = Self::from_bits_retain(1 << 17)

Supports full 32-bit range indices (2^32-1 as opposed to 2^24-1 without this flag)

Corresponds to Vulkan’s VkPhysicalDeviceFeatures.fullDrawIndexUint32

pub const DEPTH_BIAS_CLAMP: DownlevelFlags = Self::from_bits_retain(1 << 18)

Supports depth bias clamping

Corresponds to Vulkan’s VkPhysicalDeviceFeatures.depthBiasClamp

pub const VIEW_FORMATS: DownlevelFlags = Self::from_bits_retain(1 << 19)

Supports specifying which view format values are allowed when create_view() is called on a texture.

The WebGL and GLES backends doesn’t support this.

pub const UNRESTRICTED_EXTERNAL_TEXTURE_COPIES: DownlevelFlags = Self::from_bits_retain(1 << 20)

With this feature not present, there are the following restrictions on Queue::copy_external_image_to_texture:

• The source must not be [web_sys::OffscreenCanvas]
• [ImageCopyExternalImage::origin] must be zero.
• ImageCopyTextureTagged::color_space must be srgb.
• If the source is an [web_sys::ImageBitmap]:
  • [ImageCopyExternalImage::flip_y] must be false.
  • ImageCopyTextureTagged::premultiplied_alpha must be false.

WebGL doesn’t support this. WebGPU does.

pub const SURFACE_VIEW_FORMATS: DownlevelFlags = Self::from_bits_retain(1 << 21)

Supports specifying which view formats are allowed when calling create_view on the texture returned by get_current_texture.

The GLES/WebGL and Vulkan on Android doesn’t support this.

impl DownlevelFlags

pub const fn empty() -> DownlevelFlags

Returns an empty set of flags.

pub const fn all() -> DownlevelFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u32) -> Option<DownlevelFlags>

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

pub const fn from_bits_truncate(bits: u32) -> DownlevelFlags

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

pub const fn from_bits_retain(bits: u32) -> DownlevelFlags

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

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

Get the value for a flag from its stringified name.

Names are case-sensitive, so must correspond exactly to the identifier given to the 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: DownlevelFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

This method is equivalent to union.

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

Removes the specified flags in-place.

This method is equivalent to difference.

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

Toggles the specified flags in-place.

This method is equivalent to symmetric_difference.

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

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

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

Returns the intersection between the flags in self and other.

Calculating self bitwise and (&) other, including any bits that don’t correspond to a defined flag.

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

Returns the union of between the flags in self and other.

Calculates self bitwise or (|) other, including any bits that don’t correspond to a defined flag.

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

Returns the difference between the flags in self and other.

Calculates self bitwise and (&!) the bitwise negation of other, including any bits that don’t correspond to a defined flag.

This method is not equivalent to a & !b when there are bits set that don’t correspond to a defined flag. The ! operator will unset any bits that don’t correspond to a flag, so they’ll always be unset by a &! b, but respected by a.difference(b).

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

Returns the symmetric difference between the flags in self and other.

Calculates self bitwise exclusive or (^) other, including any bits that don’t correspond to a defined flag.

pub const fn complement(self) -> DownlevelFlags

Returns the complement of this set of flags.

Calculates the bitwise negation (!) of self, unsetting any bits that don’t correspond to a defined flag.

impl DownlevelFlags

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

Iterate over enabled flag values.

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

Iterate over enabled flag values with their stringified names.

impl DownlevelFlags

pub fn contains_invalid_bits(&self) -> bool

Returns true if the bitflags contains bits that are not part of the bitflags definition.

impl DownlevelFlags

pub const fn compliant() -> DownlevelFlags

All flags that indicate if the backend is WebGPU compliant

Trait Implementations

impl Binary for DownlevelFlags

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

Formats the value using the given formatter.

impl BitAnd<DownlevelFlags> for DownlevelFlags

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

Returns the intersection between the two sets of flags.

type Output = DownlevelFlags

The resulting type after applying the & operator.

impl BitAndAssign<DownlevelFlags> for DownlevelFlags

fn bitand_assign(&mut self, other: DownlevelFlags)

Disables all flags disabled in the set.

impl BitOr<DownlevelFlags> for DownlevelFlags

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

Returns the union of the two sets of flags.

type Output = DownlevelFlags

The resulting type after applying the | operator.

impl BitOrAssign<DownlevelFlags> for DownlevelFlags

fn bitor_assign(&mut self, other: DownlevelFlags)

Adds the set of flags.

impl BitXor<DownlevelFlags> for DownlevelFlags

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

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

type Output = DownlevelFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<DownlevelFlags> for DownlevelFlags

fn bitxor_assign(&mut self, other: DownlevelFlags)

Toggles the set of flags.

impl Clone for DownlevelFlags

fn clone(&self) -> DownlevelFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DownlevelFlags

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DownlevelFlags

Available on crate feature replay only.

fn deserialize<D>( deserializer: D ) -> Result<DownlevelFlags, <D as Deserializer<'de>>::Error>where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<DownlevelFlags> for DownlevelFlags

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

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

const FLAGS: &'static [Flag<DownlevelFlags>] = &[{ ::bitflags::Flag::new("COMPUTE_SHADERS", DownlevelFlags::COMPUTE_SHADERS) }, { ::bitflags::Flag::new("FRAGMENT_WRITABLE_STORAGE", DownlevelFlags::FRAGMENT_WRITABLE_STORAGE) }, { ::bitflags::Flag::new("INDIRECT_EXECUTION", DownlevelFlags::INDIRECT_EXECUTION) }, { ::bitflags::Flag::new("BASE_VERTEX", DownlevelFlags::BASE_VERTEX) }, { ::bitflags::Flag::new("READ_ONLY_DEPTH_STENCIL", DownlevelFlags::READ_ONLY_DEPTH_STENCIL) }, { ::bitflags::Flag::new("NON_POWER_OF_TWO_MIPMAPPED_TEXTURES", DownlevelFlags::NON_POWER_OF_TWO_MIPMAPPED_TEXTURES) }, { ::bitflags::Flag::new("CUBE_ARRAY_TEXTURES", DownlevelFlags::CUBE_ARRAY_TEXTURES) }, { ::bitflags::Flag::new("COMPARISON_SAMPLERS", DownlevelFlags::COMPARISON_SAMPLERS) }, { ::bitflags::Flag::new("INDEPENDENT_BLEND", DownlevelFlags::INDEPENDENT_BLEND) }, { ::bitflags::Flag::new("VERTEX_STORAGE", DownlevelFlags::VERTEX_STORAGE) }, { ::bitflags::Flag::new("ANISOTROPIC_FILTERING", DownlevelFlags::ANISOTROPIC_FILTERING) }, { ::bitflags::Flag::new("FRAGMENT_STORAGE", DownlevelFlags::FRAGMENT_STORAGE) }, { ::bitflags::Flag::new("MULTISAMPLED_SHADING", DownlevelFlags::MULTISAMPLED_SHADING) }, { ::bitflags::Flag::new("DEPTH_TEXTURE_AND_BUFFER_COPIES", DownlevelFlags::DEPTH_TEXTURE_AND_BUFFER_COPIES) }, { ::bitflags::Flag::new("WEBGPU_TEXTURE_FORMAT_SUPPORT", DownlevelFlags::WEBGPU_TEXTURE_FORMAT_SUPPORT) }, { ::bitflags::Flag::new("BUFFER_BINDINGS_NOT_16_BYTE_ALIGNED", DownlevelFlags::BUFFER_BINDINGS_NOT_16_BYTE_ALIGNED) }, { ::bitflags::Flag::new("UNRESTRICTED_INDEX_BUFFER", DownlevelFlags::UNRESTRICTED_INDEX_BUFFER) }, { ::bitflags::Flag::new("FULL_DRAW_INDEX_UINT32", DownlevelFlags::FULL_DRAW_INDEX_UINT32) }, { ::bitflags::Flag::new("DEPTH_BIAS_CLAMP", DownlevelFlags::DEPTH_BIAS_CLAMP) }, { ::bitflags::Flag::new("VIEW_FORMATS", DownlevelFlags::VIEW_FORMATS) }, { ::bitflags::Flag::new("UNRESTRICTED_EXTERNAL_TEXTURE_COPIES", DownlevelFlags::UNRESTRICTED_EXTERNAL_TEXTURE_COPIES) }, { ::bitflags::Flag::new("SURFACE_VIEW_FORMATS", DownlevelFlags::SURFACE_VIEW_FORMATS) }]

The set of available flags and their names.

type Bits = u32

The underlying storage type.

fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

fn from_bits_retain(bits: u32) -> DownlevelFlags

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

fn empty() -> Self

Returns an empty set of flags.

fn all() -> Self

Returns the set containing all flags.

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

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

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

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

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

Get the flag for a particular name.

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

Iterate over enabled flag values.

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

Iterate over the raw names and bits for enabled flag values.

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

fn insert(&mut self, other: Self)where Self: Sized,

Inserts the specified flags in-place.

fn remove(&mut self, other: Self)where Self: Sized,

Removes the specified flags in-place.

fn toggle(&mut self, other: Self)where Self: Sized,

Toggles the specified flags in-place.

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

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

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

Returns the intersection between the flags in self and other.

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

Returns the union of between the flags in self and other.

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

Returns the difference between the flags in self and other.

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

Returns the symmetric difference between the flags in self and other.

fn complement(self) -> Self

Returns the complement of this set of flags.

impl FromIterator<DownlevelFlags> for DownlevelFlags

fn from_iter<T>(iterator: T) -> DownlevelFlagswhere T: IntoIterator<Item = DownlevelFlags>,

Creates a value from an iterator.

impl Hash for DownlevelFlags

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

Feeds a slice of this type into the given Hasher.

impl IntoIterator for DownlevelFlags

type Item = DownlevelFlags

The type of the elements being iterated over.

type IntoIter = Iter<DownlevelFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <DownlevelFlags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for DownlevelFlags

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

Formats the value using the given formatter.

impl Not for DownlevelFlags

fn not(self) -> DownlevelFlags

Returns the complement of this set of flags.

type Output = DownlevelFlags

The resulting type after applying the ! operator.

impl Octal for DownlevelFlags

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

Formats the value using the given formatter.

impl Ord for DownlevelFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<DownlevelFlags> for DownlevelFlags

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

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

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

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

impl PartialOrd<DownlevelFlags> for DownlevelFlags

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

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

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

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

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

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

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

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

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

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

impl Serialize for DownlevelFlags

Available on crate feature trace only.

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 Sub<DownlevelFlags> for DownlevelFlags

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

Returns the set difference of the two sets of flags.

type Output = DownlevelFlags

The resulting type after applying the - operator.

impl SubAssign<DownlevelFlags> for DownlevelFlags

fn sub_assign(&mut self, other: DownlevelFlags)

Disables all flags enabled in the set.

impl UpperHex for DownlevelFlags

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

Formats the value using the given formatter.

impl Copy for DownlevelFlags

impl Eq for DownlevelFlags

impl StructuralEq for DownlevelFlags

impl StructuralPartialEq for DownlevelFlags