Struct wgpu_types::DownlevelFlags

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

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: Self = _

The device supports compiling and using compute shaders.

WebGL2, and GLES3.0 devices do not support compute.

pub const FRAGMENT_WRITABLE_STORAGE: Self = _

Supports binding storage buffers and textures to fragment shaders.

pub const INDIRECT_EXECUTION: Self = _

Supports indirect drawing and dispatching.

WebGL2, GLES 3.0, and Metal on Apple1/Apple2 GPUs do not support indirect.

pub const BASE_VERTEX: Self = _

Supports non-zero base_vertex parameter to direct indexed draw calls.

Indirect calls, if supported, always support non-zero base_vertex.

Supported by:

• Vulkan
• DX12
• Metal on Apple3+ or Mac1+
• OpenGL 3.2+
• OpenGL ES 3.2

pub const READ_ONLY_DEPTH_STENCIL: Self = _

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

The WebGL2 and GLES backends do not support RODS.

pub const NON_POWER_OF_TWO_MIPMAPPED_TEXTURES: Self = _

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

pub const CUBE_ARRAY_TEXTURES: Self = _

Supports textures that are cube arrays.

pub const COMPARISON_SAMPLERS: Self = _

Supports comparison samplers.

pub const INDEPENDENT_BLEND: Self = _

Supports different blend operations per color attachment.

pub const VERTEX_STORAGE: Self = _

Supports storage buffers in vertex shaders.

pub const ANISOTROPIC_FILTERING: Self = _

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: Self = _

Supports storage buffers in fragment shaders.

pub const MULTISAMPLED_SHADING: Self = _

Supports sample-rate shading.

pub const DEPTH_TEXTURE_AND_BUFFER_COPIES: Self = _

Supports copies between depth textures and buffers.

GLES/WebGL don’t support this.

pub const WEBGPU_TEXTURE_FORMAT_SUPPORT: Self = _

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: Self = _

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

WebGL doesn’t support this.

pub const UNRESTRICTED_INDEX_BUFFER: Self = _

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: Self = _

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: Self = _

Supports depth bias clamping

Corresponds to Vulkan’s VkPhysicalDeviceFeatures.depthBiasClamp

pub const VIEW_FORMATS: Self = _

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: Self = _

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: Self = _

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.

pub const NONBLOCKING_QUERY_RESOLVE: Self = _

If this is true, calls to CommandEncoder::resolve_query_set will be performed on the queue timeline.

If this is false, calls to CommandEncoder::resolve_query_set will be performed on the device (i.e. cpu) timeline and will block that timeline until the query has data. You may work around this limitation by waiting until the submit whose queries you are resolving is fully finished (through use of queue.on_submitted_work_done) and only then submitting the resolve_query_set command. The queries will be guarenteed finished, so will not block.

Supported by:

• Vulkan,
• DX12
• Metal
• OpenGL 4.4+

Not Supported by:

• GL ES / WebGL

pub const VERTEX_AND_INSTANCE_INDEX_RESPECTS_RESPECTIVE_FIRST_VALUE_IN_INDIRECT_DRAW: Self = _

If this is true, use of @builtin(vertex_index) and @builtin(instance_index) will properly take into consideration the first_vertex and first_instance parameters of indirect draw calls.

If this is false, @builtin(vertex_index) and @builtin(instance_index) will start by counting from 0, ignoring the first_vertex and first_instance parameters.

For example, if you had a draw call like this:

• first_vertex: 4,
• vertex_count: 12,

When this flag is present, @builtin(vertex_index) will start at 4 and go up to 15 (12 invocations).

When this flag is not present, @builtin(vertex_index) will start at 0 and go up to 11 (12 invocations).

This only affects the builtins in the shaders, vertex buffers and instance rate vertex buffers will behave like expected with this flag disabled.

See also [Features::]

Supported By:

• Vulkan
• Metal
• OpenGL

Will be implemented in the future by:

• DX12 (#2471)

impl DownlevelFlags

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

Get the underlying bits value.

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

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

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> 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 this flags value 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 a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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 two flags values.

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 two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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 two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl DownlevelFlags

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

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

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.

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

All flags that indicate if the backend is WebGPU compliant

Trait Implementations

impl Binary for DownlevelFlags

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

Formats the value using the given formatter.

impl BitAnd for DownlevelFlags

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

The bitwise and (&) of the bits in two flags values.

type Output = DownlevelFlags

The resulting type after applying the & operator.

impl BitAndAssign for DownlevelFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for DownlevelFlags

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

The bitwise or (|) of the bits in two flags values.

type Output = DownlevelFlags

The resulting type after applying the | operator.

impl BitOrAssign for DownlevelFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for DownlevelFlags

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = DownlevelFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for DownlevelFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

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

Formats the value using the given formatter.

impl Extend<DownlevelFlags> for DownlevelFlags

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 DownlevelFlags

const FLAGS: &'static [Flag<DownlevelFlags>] = _

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> DownlevelFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits 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 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 a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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 intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<DownlevelFlags> for DownlevelFlags

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

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

impl Hash for DownlevelFlags

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

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) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for DownlevelFlags

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

Formats the value using the given formatter.

impl Not for DownlevelFlags

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = DownlevelFlags

The resulting type after applying the ! operator.

impl Octal for DownlevelFlags

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

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq 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 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 PublicFlags for DownlevelFlags

type Primitive = u32

The type of the underlying storage.

type Internal = InternalBitFlags

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

impl Sub for DownlevelFlags

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The resulting type after applying the - operator.

impl SubAssign for DownlevelFlags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

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 DownlevelFlags

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

Formats the value using the given formatter.

impl Copy for DownlevelFlags

impl Eq for DownlevelFlags

impl StructuralEq for DownlevelFlags

impl StructuralPartialEq for DownlevelFlags