wgpu_types/features.rs
1//! # Features
2//!
3//! Types identifying optional features of WebGPU and wgpu. Availability varies
4//! by hardware and can be checked when requesting an adapter and device.
5//!
6//! The `wgpu` Rust API always uses the `Features` bit flag type to represent a
7//! set of features. However, the WebGPU-defined JavaScript API uses
8//! `kebab-case` feature name strings, so some utilities are provided for
9//! working with those names. See [`Features::as_str`] and [`<Features as
10//! FromStr>::from_str`].
11//!
12//! The [`bitflags`] crate names flags by stringifying the
13//! `SCREAMING_SNAKE_CASE` identifier. These names are returned by
14//! [`Features::iter_names`] and parsed by [`Features::from_name`].
15//! [`bitflags`] does not currently support customized flag naming.
16//! See <https://github.com/bitflags/bitflags/issues/470>.
17
18use crate::{link_to_wgpu_docs, link_to_wgpu_item, VertexFormat};
19#[cfg(feature = "serde")]
20use alloc::fmt;
21use alloc::vec::Vec;
22#[cfg(feature = "serde")]
23use bitflags::parser::{ParseError, ParseHex, WriteHex};
24#[cfg(feature = "serde")]
25use bitflags::Bits;
26use bitflags::Flags;
27#[cfg(feature = "serde")]
28use core::mem::size_of;
29use core::str::FromStr;
30#[cfg(feature = "serde")]
31use serde::{Deserialize, Serialize};
32
33pub use webgpu_impl::*;
34mod webgpu_impl {
35 //! Constant values for [`super::FeaturesWebGPU`], separated so they can be picked up by
36 //! `cbindgen` in `mozilla-central` (where Firefox is developed).
37 #![allow(missing_docs)]
38
39 #[doc(hidden)]
40 pub const WEBGPU_FEATURE_DEPTH_CLIP_CONTROL: u64 = 1 << 0;
41
42 #[doc(hidden)]
43 pub const WEBGPU_FEATURE_DEPTH32FLOAT_STENCIL8: u64 = 1 << 1;
44
45 #[doc(hidden)]
46 pub const WEBGPU_FEATURE_TEXTURE_COMPRESSION_BC: u64 = 1 << 2;
47
48 #[doc(hidden)]
49 pub const WEBGPU_FEATURE_TEXTURE_COMPRESSION_BC_SLICED_3D: u64 = 1 << 3;
50
51 #[doc(hidden)]
52 pub const WEBGPU_FEATURE_TEXTURE_COMPRESSION_ETC2: u64 = 1 << 4;
53
54 #[doc(hidden)]
55 pub const WEBGPU_FEATURE_TEXTURE_COMPRESSION_ASTC: u64 = 1 << 5;
56
57 #[doc(hidden)]
58 pub const WEBGPU_FEATURE_TEXTURE_COMPRESSION_ASTC_SLICED_3D: u64 = 1 << 6;
59
60 #[doc(hidden)]
61 pub const WEBGPU_FEATURE_TIMESTAMP_QUERY: u64 = 1 << 7;
62
63 #[doc(hidden)]
64 pub const WEBGPU_FEATURE_INDIRECT_FIRST_INSTANCE: u64 = 1 << 8;
65
66 #[doc(hidden)]
67 pub const WEBGPU_FEATURE_SHADER_F16: u64 = 1 << 9;
68
69 #[doc(hidden)]
70 pub const WEBGPU_FEATURE_RG11B10UFLOAT_RENDERABLE: u64 = 1 << 10;
71
72 #[doc(hidden)]
73 pub const WEBGPU_FEATURE_BGRA8UNORM_STORAGE: u64 = 1 << 11;
74
75 #[doc(hidden)]
76 pub const WEBGPU_FEATURE_FLOAT32_FILTERABLE: u64 = 1 << 12;
77
78 #[doc(hidden)]
79 pub const WEBGPU_FEATURE_FLOAT32_BLENDABLE: u64 = 1 << 13;
80
81 #[doc(hidden)]
82 pub const WEBGPU_FEATURE_DUAL_SOURCE_BLENDING: u64 = 1 << 14;
83
84 #[doc(hidden)]
85 pub const WEBGPU_FEATURE_CLIP_DISTANCES: u64 = 1 << 15;
86
87 #[doc(hidden)]
88 pub const WEBGPU_FEATURE_IMMEDIATES: u64 = 1 << 16;
89
90 #[doc(hidden)]
91 pub const WEBGPU_FEATURE_PRIMITIVE_INDEX: u64 = 1 << 17;
92}
93
94macro_rules! bitflags_array_impl {
95 ($impl_name:ident $inner_name:ident $name:ident $op:tt $($struct_names:ident)*) => (
96 impl core::ops::$impl_name for $name {
97 type Output = Self;
98
99 #[inline]
100 fn $inner_name(self, other: Self) -> Self {
101 Self {
102 $($struct_names: self.$struct_names $op other.$struct_names,)*
103 }
104 }
105 }
106 )
107}
108
109macro_rules! bitflags_array_impl_assign {
110 ($impl_name:ident $inner_name:ident $name:ident $op:tt $($struct_names:ident)*) => (
111 impl core::ops::$impl_name for $name {
112 #[inline]
113 fn $inner_name(&mut self, other: Self) {
114 $(self.$struct_names $op other.$struct_names;)*
115 }
116 }
117 )
118}
119
120macro_rules! bit_array_impl {
121 ($impl_name:ident $inner_name:ident $name:ident $op:tt) => (
122 impl core::ops::$impl_name for $name {
123 type Output = Self;
124
125 #[inline]
126 fn $inner_name(mut self, other: Self) -> Self {
127 for (inner, other) in self.0.iter_mut().zip(other.0.iter()) {
128 *inner $op *other;
129 }
130 self
131 }
132 }
133 )
134}
135
136macro_rules! bitflags_independent_two_arg {
137 ($(#[$meta:meta])* $func_name:ident $($struct_names:ident)*) => (
138 $(#[$meta])*
139 pub const fn $func_name(self, other:Self) -> Self {
140 Self { $($struct_names: self.$struct_names.$func_name(other.$struct_names),)* }
141 }
142 )
143}
144
145// For the most part this macro should not be modified, most configuration should be possible
146// without changing this macro.
147/// Macro for creating sets of bitflags, we need this because there are almost more flags than bits
148/// in a u64, we can't use a u128 because of FFI, and the number of flags is increasing.
149macro_rules! bitflags_array {
150 (
151 $(#[$outer:meta])*
152 pub struct $name:ident: [$T:ty; $Len:expr];
153
154 $(
155 $(#[$bit_outer:meta])*
156 $vis:vis struct $inner_name:ident $lower_inner_name:ident {
157 $(
158 $(#[doc $($args:tt)*])*
159 #[name($str_name:literal $(, $alias:literal)*)]
160 const $Flag:tt = $value:expr;
161 )*
162 }
163 )*
164 ) => {
165 $(
166 bitflags::bitflags! {
167 $(#[$bit_outer])*
168 $vis struct $inner_name: $T {
169 $(
170 $(#[doc $($args)*])*
171 const $Flag = $value;
172 )*
173 }
174 }
175 )*
176
177 $(#[$outer])*
178 pub struct $name {
179 $(
180 #[allow(missing_docs)]
181 $vis $lower_inner_name: $inner_name,
182 )*
183 }
184
185 /// Bits from `Features` in array form
186 #[derive(Default, Copy, Clone, Debug, PartialEq, Eq)]
187 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
188 pub struct FeatureBits(pub [$T; $Len]);
189
190 bitflags_array_impl! { BitOr bitor $name | $($lower_inner_name)* }
191 bitflags_array_impl! { BitAnd bitand $name & $($lower_inner_name)* }
192 bitflags_array_impl! { BitXor bitxor $name ^ $($lower_inner_name)* }
193 impl core::ops::Not for $name {
194 type Output = Self;
195
196 #[inline]
197 fn not(self) -> Self {
198 Self {
199 $($lower_inner_name: !self.$lower_inner_name,)*
200 }
201 }
202 }
203 bitflags_array_impl! { Sub sub $name - $($lower_inner_name)* }
204
205 #[cfg(feature = "serde")]
206 impl Serialize for $name {
207 fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
208 where
209 S: serde::Serializer,
210 {
211 bitflags::serde::serialize(self, serializer)
212 }
213 }
214
215 #[cfg(feature = "serde")]
216 impl<'de> Deserialize<'de> for $name {
217 fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
218 where
219 D: serde::Deserializer<'de>,
220 {
221 bitflags::serde::deserialize(deserializer)
222 }
223 }
224
225 impl core::fmt::Display for $name {
226 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
227 let mut iter = self.iter_names();
228 // simple look ahead
229 let mut next = iter.next();
230 while let Some((name, _)) = next {
231 f.write_str(name)?;
232 next = iter.next();
233 if next.is_some() {
234 f.write_str(" | ")?;
235 }
236 }
237 Ok(())
238 }
239 }
240
241 bitflags_array_impl_assign! { BitOrAssign bitor_assign $name |= $($lower_inner_name)* }
242 bitflags_array_impl_assign! { BitAndAssign bitand_assign $name &= $($lower_inner_name)* }
243 bitflags_array_impl_assign! { BitXorAssign bitxor_assign $name ^= $($lower_inner_name)* }
244
245 bit_array_impl! { BitOr bitor FeatureBits |= }
246 bit_array_impl! { BitAnd bitand FeatureBits &= }
247 bit_array_impl! { BitXor bitxor FeatureBits ^= }
248
249 impl core::ops::Not for FeatureBits {
250 type Output = Self;
251
252 #[inline]
253 fn not(self) -> Self {
254 let [$($lower_inner_name,)*] = self.0;
255 Self([$(!$lower_inner_name,)*])
256 }
257 }
258
259 #[cfg(feature = "serde")]
260 impl WriteHex for FeatureBits {
261 fn write_hex<W: fmt::Write>(&self, mut writer: W) -> fmt::Result {
262 let [$($lower_inner_name,)*] = self.0;
263 let mut wrote = false;
264 let mut stager = alloc::string::String::with_capacity(size_of::<$T>() * 2);
265 // we don't want to write it if it's just zero as there may be multiple zeros
266 // resulting in something like "00" being written out. We do want to write it if
267 // there has already been something written though.
268 $(if ($lower_inner_name != 0) || wrote {
269 // First we write to a staging string, then we add any zeros (e.g if #1
270 // is f and a u8 and #2 is a then the two combined would be f0a which requires
271 // a 0 inserted)
272 $lower_inner_name.write_hex(&mut stager)?;
273 if (stager.len() != size_of::<$T>() * 2) && wrote {
274 let zeros_to_write = (size_of::<$T>() * 2) - stager.len();
275 for _ in 0..zeros_to_write {
276 writer.write_char('0')?
277 }
278 }
279 writer.write_str(&stager)?;
280 stager.clear();
281 wrote = true;
282 })*
283 if !wrote {
284 writer.write_str("0")?;
285 }
286 Ok(())
287 }
288 }
289
290 #[cfg(feature = "serde")]
291 impl ParseHex for FeatureBits {
292 fn parse_hex(input: &str) -> Result<Self, ParseError> {
293
294 let mut unset = Self::EMPTY;
295 let mut end = input.len();
296 if end == 0 {
297 return Err(ParseError::empty_flag())
298 }
299 // we iterate starting at the least significant places and going up
300 for (idx, _) in [$(stringify!($lower_inner_name),)*].iter().enumerate().rev() {
301 // A byte is two hex places - u8 (1 byte) = 0x00 (2 hex places).
302 let checked_start = end.checked_sub(size_of::<$T>() * 2);
303 let start = checked_start.unwrap_or(0);
304
305 let cur_input = &input[start..end];
306 unset.0[idx] = <$T>::from_str_radix(cur_input, 16)
307 .map_err(|_|ParseError::invalid_hex_flag(cur_input))?;
308
309 end = start;
310
311 if let None = checked_start {
312 break;
313 }
314 }
315 Ok(unset)
316 }
317 }
318
319 impl bitflags::Bits for FeatureBits {
320 const EMPTY: Self = $name::empty().bits();
321
322 const ALL: Self = $name::all().bits();
323 }
324
325 impl Flags for $name {
326 const FLAGS: &'static [bitflags::Flag<Self>] = $name::FLAGS;
327
328 type Bits = FeatureBits;
329
330 fn bits(&self) -> FeatureBits {
331 FeatureBits([
332 $(self.$lower_inner_name.bits(),)*
333 ])
334 }
335
336 fn from_bits_retain(bits: FeatureBits) -> Self {
337 let [$($lower_inner_name,)*] = bits.0;
338 Self {
339 $($lower_inner_name: $inner_name::from_bits_retain($lower_inner_name),)*
340 }
341 }
342
343 fn empty() -> Self {
344 Self::empty()
345 }
346
347 fn all() -> Self {
348 Self::all()
349 }
350 }
351
352 impl $name {
353 pub(crate) const FLAGS: &'static [bitflags::Flag<Self>] = &[
354 $(
355 $(
356 bitflags::Flag::new(stringify!($Flag), $name::$Flag),
357 )*
358 )*
359 ];
360
361 /// Gets the set flags as a container holding an array of bits.
362 pub const fn bits(&self) -> FeatureBits {
363 FeatureBits([
364 $(self.$lower_inner_name.bits(),)*
365 ])
366 }
367
368 /// Returns self with no flags set.
369 pub const fn empty() -> Self {
370 Self {
371 $($lower_inner_name: $inner_name::empty(),)*
372 }
373 }
374
375 /// Returns self with all flags set.
376 pub const fn all() -> Self {
377 Self {
378 $($lower_inner_name: $inner_name::all(),)*
379 }
380 }
381
382 /// Whether all the bits set in `other` are all set in `self`
383 pub const fn contains(self, other:Self) -> bool {
384 // we need an annoying true to catch the last && >:(
385 $(self.$lower_inner_name.contains(other.$lower_inner_name) &&)* true
386 }
387
388 /// Returns whether any bit set in `self` matched any bit set in `other`.
389 pub const fn intersects(self, other:Self) -> bool {
390 $(self.$lower_inner_name.intersects(other.$lower_inner_name) ||)* false
391 }
392
393 /// Returns whether there is no flag set.
394 pub const fn is_empty(self) -> bool {
395 $(self.$lower_inner_name.is_empty() &&)* true
396 }
397
398 /// Returns whether the struct has all flags set.
399 pub const fn is_all(self) -> bool {
400 $(self.$lower_inner_name.is_all() &&)* true
401 }
402
403 bitflags_independent_two_arg! {
404 /// Bitwise or - `self | other`
405 union $($lower_inner_name)*
406 }
407
408 bitflags_independent_two_arg! {
409 /// Bitwise and - `self & other`
410 intersection $($lower_inner_name)*
411 }
412
413 bitflags_independent_two_arg! {
414 /// Bitwise and of the complement of other - `self & !other`
415 difference $($lower_inner_name)*
416 }
417
418 bitflags_independent_two_arg! {
419 /// Bitwise xor - `self ^ other`
420 symmetric_difference $($lower_inner_name)*
421 }
422
423 /// Bitwise not - `!self`
424 pub const fn complement(self) -> Self {
425 Self {
426 $($lower_inner_name: self.$lower_inner_name.complement(),)*
427 }
428 }
429
430 /// Calls [`Self::insert`] if `set` is true and otherwise calls [`Self::remove`].
431 pub fn set(&mut self, other:Self, set: bool) {
432 $(self.$lower_inner_name.set(other.$lower_inner_name, set);)*
433 }
434
435 /// Inserts specified flag(s) into self
436 pub fn insert(&mut self, other:Self) {
437 $(self.$lower_inner_name.insert(other.$lower_inner_name);)*
438 }
439
440 /// Removes specified flag(s) from self
441 pub fn remove(&mut self, other:Self) {
442 $(self.$lower_inner_name.remove(other.$lower_inner_name);)*
443 }
444
445 /// Toggles specified flag(s) in self
446 pub fn toggle(&mut self, other:Self) {
447 $(self.$lower_inner_name.toggle(other.$lower_inner_name);)*
448 }
449
450 /// Takes in [`FeatureBits`] and returns None if there are invalid bits or otherwise Self with
451 /// those bits set
452 pub const fn from_bits(bits:FeatureBits) -> Option<Self> {
453 let [$($lower_inner_name,)*] = bits.0;
454 // The ? operator does not work in a const context.
455 Some(Self {
456 $(
457 $lower_inner_name: match $inner_name::from_bits($lower_inner_name) {
458 Some(some) => some,
459 None => return None,
460 },
461 )*
462 })
463 }
464
465 /// Takes in [`FeatureBits`] and returns Self with only valid bits (all other bits removed)
466 pub const fn from_bits_truncate(bits:FeatureBits) -> Self {
467 let [$($lower_inner_name,)*] = bits.0;
468 Self { $($lower_inner_name: $inner_name::from_bits_truncate($lower_inner_name),)* }
469 }
470
471 /// Takes in [`FeatureBits`] and returns Self with all bits that were set without removing
472 /// invalid bits
473 pub const fn from_bits_retain(bits:FeatureBits) -> Self {
474 let [$($lower_inner_name,)*] = bits.0;
475 Self { $($lower_inner_name: $inner_name::from_bits_retain($lower_inner_name),)* }
476 }
477
478 /// Takes in a bitflags flag name (in `SCREAMING_SNAKE_CASE`) and returns Self
479 /// if it matches or none if the name does not match the name of any of the
480 /// flags. Name is capitalisation dependent.
481 ///
482 /// [`impl FromStr`] can be used to recognize kebab-case names, like are used in
483 /// the WebGPU spec.
484 pub fn from_name(name: &str) -> Option<Self> {
485 match name {
486 $(
487 $(
488 stringify!($Flag) => Some(Self::$Flag),
489 )*
490 )*
491 _ => None,
492 }
493 }
494
495 /// Combines the features from the internal flags into the entire features struct
496 pub fn from_internal_flags($($lower_inner_name: $inner_name,)*) -> Self {
497 Self {
498 $($lower_inner_name,)*
499 }
500 }
501
502 /// Returns an iterator over the set flags.
503 pub const fn iter(&self) -> bitflags::iter::Iter<$name> {
504 bitflags::iter::Iter::__private_const_new($name::FLAGS, *self, *self)
505 }
506
507 /// Returns an iterator over the set flags and their names.
508 ///
509 /// These are bitflags names in `SCREAMING_SNAKE_CASE`.
510 pub const fn iter_names(&self) -> bitflags::iter::IterNames<$name> {
511 bitflags::iter::IterNames::__private_const_new($name::FLAGS, *self, *self)
512 }
513
514 /// If the argument is a single [`Features`] flag, returns the corresponding
515 /// `kebab-case` feature name, otherwise `None`.
516 #[must_use]
517 pub fn as_str(&self) -> Option<&'static str> {
518 Some(match *self {
519 $($(Self::$Flag => $str_name,)*)*
520 _ => return None,
521 })
522 }
523
524 $(
525 $(
526 $(#[doc $($args)*])*
527 // We need this for structs with only a member.
528 #[allow(clippy::needless_update)]
529 pub const $Flag: Self = Self {
530 $lower_inner_name: $inner_name::from_bits_truncate($value),
531 ..Self::empty()
532 };
533 )*
534 )*
535 }
536
537 // Parses kebab-case feature names (i.e. the names given in the spec, for features
538 // in FeaturesWebGPU, and otherwise the `wgpu-` prefixed names).
539 impl FromStr for $name {
540 type Err = ();
541
542 fn from_str(s: &str) -> Result<Self, Self::Err> {
543 Ok(match s {
544 $($($str_name $(| $alias)* => Self::$Flag,)*)*
545 _ => return Err(()),
546 })
547 }
548 }
549
550 $(
551 impl From<$inner_name> for Features {
552 // We need this for structs with only a member.
553 #[allow(clippy::needless_update)]
554 fn from($lower_inner_name: $inner_name) -> Self {
555 Self {
556 $lower_inner_name,
557 ..Self::empty()
558 }
559 }
560 }
561 )*
562 };
563}
564
565impl From<FeatureBits> for Features {
566 fn from(value: FeatureBits) -> Self {
567 Self::from_bits_retain(value)
568 }
569}
570
571impl From<Features> for FeatureBits {
572 fn from(value: Features) -> Self {
573 value.bits()
574 }
575}
576
577bitflags_array! {
578 /// Features that are not guaranteed to be supported.
579 ///
580 /// These are either part of the webgpu standard, or are extension features supported by
581 /// wgpu when targeting native.
582 ///
583 /// If you want to use a feature, you need to first verify that the adapter supports
584 /// the feature. If the adapter does not support the feature, requesting a device with it enabled
585 /// will panic.
586 ///
587 /// Corresponds to [WebGPU `GPUFeatureName`](
588 /// https://gpuweb.github.io/gpuweb/#enumdef-gpufeaturename).
589 #[repr(C)]
590 #[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Hash)]
591 pub struct Features: [u64; 2];
592
593 /// Features that are not guaranteed to be supported.
594 ///
595 /// Most of these are native-only extension features supported by wgpu only when targeting
596 /// native. A few are intended to align with a proposed WebGPU extension, and one
597 /// (`EXTERNAL_TEXTURE`) controls WebGPU-specified behavior that is not optional in the
598 /// standard, but that we don't want to make a [`crate::DownlevelFlags`] until the
599 /// implementation is more complete. For all features see [`Features`].
600 ///
601 /// If you want to use a feature, you need to first verify that the adapter supports
602 /// the feature. If the adapter does not support the feature, requesting a device with it enabled
603 /// will panic.
604 ///
605 /// Corresponds to [WebGPU `GPUFeatureName`](
606 /// https://gpuweb.github.io/gpuweb/#enumdef-gpufeaturename).
607 #[repr(transparent)]
608 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
609 #[cfg_attr(feature = "serde", serde(transparent))]
610 #[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Hash)]
611 pub struct FeaturesWGPU features_wgpu {
612 /// Allows shaders to use f32 atomic load, store, add, sub, and exchange.
613 ///
614 /// Supported platforms:
615 /// - Metal (with MSL 3.0+ and Apple7+/Mac2)
616 /// - Vulkan (with [VK_EXT_shader_atomic_float])
617 ///
618 /// This is a native only feature.
619 ///
620 /// [VK_EXT_shader_atomic_float]: https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_EXT_shader_atomic_float.html
621 #[name("wgpu-shader-float32-atomic")]
622 const SHADER_FLOAT32_ATOMIC = 1 << 0;
623
624 // The features starting with a ? are features that might become part of the spec or
625 // at the very least we can implement as native features; since they should cover all
626 // possible formats and capabilities across backends.
627 //
628 // ? const FORMATS_TIER_1 = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3837)
629 // ? const RW_STORAGE_TEXTURE_TIER_1 = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3838)
630 // ? const NORM16_FILTERABLE = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3839)
631 // ? const NORM16_RESOLVE = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3839)
632 // ? const 32BIT_FORMAT_MULTISAMPLE = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3844)
633 // ? const 32BIT_FORMAT_RESOLVE = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3844)
634 // ? const TEXTURE_COMPRESSION_ASTC_HDR = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3856)
635 // TEXTURE_FORMAT_16BIT_NORM & TEXTURE_COMPRESSION_ASTC_HDR will most likely become web features as well
636 // TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES might not be necessary if we have all the texture features implemented
637
638 // Texture Formats:
639
640 /// Enables normalized `16-bit` texture formats.
641 ///
642 /// Supported platforms:
643 /// - Vulkan
644 /// - DX12
645 /// - Metal
646 ///
647 /// This is a native only feature.
648 #[name("wgpu-texture-format-16-bit-norm", "texture-format-16-bit-norm")]
649 const TEXTURE_FORMAT_16BIT_NORM = 1 << 1;
650 /// Enables ASTC HDR family of compressed textures.
651 ///
652 /// Compressed textures sacrifice some quality in exchange for significantly reduced
653 /// bandwidth usage.
654 ///
655 /// Support for this feature guarantees availability of [`TextureUsages::COPY_SRC | TextureUsages::COPY_DST | TextureUsages::TEXTURE_BINDING`] for ASTC formats with the HDR channel type.
656 /// [`Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES`] may enable additional usages.
657 ///
658 /// Supported Platforms:
659 /// - Metal
660 /// - Vulkan
661 /// - OpenGL
662 ///
663 /// This is a native only feature.
664 #[name("wgpu-texture-compression-astc-hdr", "texture-compression-astc-hdr")]
665 const TEXTURE_COMPRESSION_ASTC_HDR = 1 << 2;
666 /// Enables device specific texture format features.
667 ///
668 /// See `TextureFormatFeatures` for a listing of the features in question.
669 ///
670 /// By default only texture format properties as defined by the WebGPU specification are allowed.
671 /// Enabling this feature flag extends the features of each format to the ones supported by the current device.
672 /// Note that without this flag, read/write storage access is not allowed at all.
673 ///
674 /// This extension does not enable additional formats.
675 ///
676 /// This is a native only feature.
677 #[name("wgpu-texture-adapter-specific-format-features", "texture-adapter-specific-format-features")]
678 const TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES = 1 << 3;
679
680 // API:
681
682 /// Enables use of Pipeline Statistics Queries. These queries tell the count of various operations
683 /// performed between the start and stop call. Call [`RenderPass::begin_pipeline_statistics_query`] to start
684 /// a query, then call [`RenderPass::end_pipeline_statistics_query`] to stop one.
685 ///
686 /// They must be resolved using [`CommandEncoder::resolve_query_set`] into a buffer.
687 /// The rules on how these resolve into buffers are detailed in the documentation for [`PipelineStatisticsTypes`].
688 ///
689 /// Supported Platforms:
690 /// - Vulkan
691 /// - DX12
692 ///
693 /// This is a native only feature with a [proposal](https://github.com/gpuweb/gpuweb/blob/0008bd30da2366af88180b511a5d0d0c1dffbc36/proposals/pipeline-statistics-query.md) for the web.
694 ///
695 #[doc = link_to_wgpu_docs!(["`RenderPass::begin_pipeline_statistics_query`"]: "struct.RenderPass.html#method.begin_pipeline_statistics_query")]
696 #[doc = link_to_wgpu_docs!(["`RenderPass::end_pipeline_statistics_query`"]: "struct.RenderPass.html#method.end_pipeline_statistics_query")]
697 #[doc = link_to_wgpu_docs!(["`CommandEncoder::resolve_query_set`"]: "struct.CommandEncoder.html#method.resolve_query_set")]
698 /// [`PipelineStatisticsTypes`]: super::PipelineStatisticsTypes
699 #[name("wgpu-pipeline-statistics-query", "pipeline-statistics-query")]
700 const PIPELINE_STATISTICS_QUERY = 1 << 4;
701 /// Allows for timestamp queries directly on command encoders.
702 ///
703 /// Implies [`Features::TIMESTAMP_QUERY`] is supported.
704 ///
705 /// Additionally allows for timestamp writes on command encoders
706 /// using [`CommandEncoder::write_timestamp`].
707 ///
708 /// Supported platforms:
709 /// - Vulkan
710 /// - DX12
711 /// - Metal
712 /// - OpenGL (with GL_ARB_timer_query)
713 ///
714 /// This is a native only feature.
715 ///
716 #[doc = link_to_wgpu_docs!(["`CommandEncoder::write_timestamp`"]: "struct.CommandEncoder.html#method.write_timestamp")]
717 #[name("wgpu-timestamp-query-inside-encoders")]
718 const TIMESTAMP_QUERY_INSIDE_ENCODERS = 1 << 5;
719 /// Allows for timestamp queries directly on command encoders.
720 ///
721 /// Implies [`Features::TIMESTAMP_QUERY`] & [`Features::TIMESTAMP_QUERY_INSIDE_ENCODERS`] is supported.
722 ///
723 /// Additionally allows for timestamp queries to be used inside render & compute passes using:
724 /// - [`RenderPass::write_timestamp`]
725 /// - [`ComputePass::write_timestamp`]
726 ///
727 /// Supported platforms:
728 /// - Vulkan
729 /// - DX12
730 /// - Metal (AMD & Intel, not Apple GPUs)
731 /// - OpenGL (with GL_ARB_timer_query)
732 ///
733 /// This is generally not available on tile-based rasterization GPUs.
734 ///
735 /// This is a native only feature with a [proposal](https://github.com/gpuweb/gpuweb/blob/0008bd30da2366af88180b511a5d0d0c1dffbc36/proposals/timestamp-query-inside-passes.md) for the web.
736 ///
737 #[doc = link_to_wgpu_docs!(["`RenderPass::write_timestamp`"]: "struct.RenderPass.html#method.write_timestamp")]
738 #[doc = link_to_wgpu_docs!(["`ComputePass::write_timestamp`"]: "struct.ComputePass.html#method.write_timestamp")]
739 #[name("wgpu-timestamp-query-inside-passes", "timestamp-query-inside-passes")]
740 const TIMESTAMP_QUERY_INSIDE_PASSES = 1 << 6;
741 /// Webgpu only allows the MAP_READ and MAP_WRITE buffer usage to be matched with
742 /// COPY_DST and COPY_SRC respectively. This removes this requirement.
743 ///
744 /// This is only beneficial on systems that share memory between CPU and GPU. If enabled
745 /// on a system that doesn't, this can severely hinder performance. Only use if you understand
746 /// the consequences.
747 ///
748 /// Supported platforms:
749 /// - Vulkan
750 /// - DX12
751 /// - Metal
752 ///
753 /// This is a native only feature.
754 #[name("wgpu-mappable-primary-buffers", "mappable-primary-buffers")]
755 const MAPPABLE_PRIMARY_BUFFERS = 1 << 7;
756 /// Allows the user to create uniform arrays of textures in shaders:
757 ///
758 /// ex.
759 /// - `var textures: binding_array<texture_2d<f32>, 10>` (WGSL)
760 /// - `uniform texture2D textures[10]` (GLSL)
761 ///
762 /// If [`Features::STORAGE_RESOURCE_BINDING_ARRAY`] is supported as well as this, the user
763 /// may also create uniform arrays of storage textures.
764 ///
765 /// ex.
766 /// - `var textures: array<texture_storage_2d<r32float, write>, 10>` (WGSL)
767 /// - `uniform image2D textures[10]` (GLSL)
768 ///
769 /// This capability allows them to exist and to be indexed by dynamically uniform
770 /// values.
771 ///
772 /// Supported platforms:
773 /// - DX12
774 /// - Metal (with MSL 2.0+ on macOS 10.13+)
775 /// - Vulkan
776 ///
777 /// This is a native only feature.
778 #[name("wgpu-texture-binding-array", "texture-binding-array")]
779 const TEXTURE_BINDING_ARRAY = 1 << 8;
780 /// Allows the user to create arrays of buffers in shaders:
781 ///
782 /// ex.
783 /// - `var<uniform> buffer_array: array<MyBuffer, 10>` (WGSL)
784 /// - `uniform myBuffer { ... } buffer_array[10]` (GLSL)
785 ///
786 /// This capability allows them to exist and to be indexed by dynamically uniform
787 /// values.
788 ///
789 /// If [`Features::STORAGE_RESOURCE_BINDING_ARRAY`] is supported as well as this, the user
790 /// may also create arrays of storage buffers.
791 ///
792 /// ex.
793 /// - `var<storage> buffer_array: array<MyBuffer, 10>` (WGSL)
794 /// - `buffer myBuffer { ... } buffer_array[10]` (GLSL)
795 ///
796 /// Supported platforms:
797 /// - Vulkan
798 ///
799 /// This is a native only feature.
800 #[name("wgpu-buffer-binding-array", "buffer-binding-array")]
801 const BUFFER_BINDING_ARRAY = 1 << 9;
802 /// Allows the user to create uniform arrays of storage buffers or textures in shaders,
803 /// if resp. [`Features::BUFFER_BINDING_ARRAY`] or [`Features::TEXTURE_BINDING_ARRAY`]
804 /// is supported.
805 ///
806 /// This capability allows them to exist and to be indexed by dynamically uniform
807 /// values.
808 ///
809 /// Supported platforms:
810 /// - Metal (with MSL 2.2+ on macOS 10.13+)
811 /// - Vulkan
812 ///
813 /// This is a native only feature.
814 #[name("wgpu-storage-resource-binding-array", "storage-resource-binding-array")]
815 const STORAGE_RESOURCE_BINDING_ARRAY = 1 << 10;
816 /// Allows shaders to index sampled texture and storage buffer resource arrays with dynamically non-uniform values:
817 ///
818 /// ex. `texture_array[vertex_data]`
819 ///
820 /// In order to use this capability, the corresponding GLSL extension must be enabled like so:
821 ///
822 /// `#extension GL_EXT_nonuniform_qualifier : require`
823 ///
824 /// and then used either as `nonuniformEXT` qualifier in variable declaration:
825 ///
826 /// ex. `layout(location = 0) nonuniformEXT flat in int vertex_data;`
827 ///
828 /// or as `nonuniformEXT` constructor:
829 ///
830 /// ex. `texture_array[nonuniformEXT(vertex_data)]`
831 ///
832 /// WGSL and HLSL do not need any extension.
833 ///
834 /// Supported platforms:
835 /// - DX12
836 /// - Metal (with MSL 2.0+ on macOS 10.13+)
837 /// - Vulkan 1.2+ (or VK_EXT_descriptor_indexing)'s shaderSampledImageArrayNonUniformIndexing & shaderStorageBufferArrayNonUniformIndexing feature)
838 ///
839 /// This is a native only feature.
840 #[name("wgpu-sampled-texture-and-storage-buffer-array-non-uniform-indexing", "sampled-texture-and-storage-buffer-array-non-uniform-indexing")]
841 const SAMPLED_TEXTURE_AND_STORAGE_BUFFER_ARRAY_NON_UNIFORM_INDEXING = 1 << 11;
842 /// Allows shaders to index storage texture resource arrays with dynamically non-uniform values:
843 ///
844 /// ex. `texture_array[vertex_data]`
845 ///
846 /// Supported platforms:
847 /// - DX12
848 /// - Metal (with MSL 2.0+ on macOS 10.13+)
849 /// - Vulkan 1.2+ (or VK_EXT_descriptor_indexing)'s shaderStorageTextureArrayNonUniformIndexing feature)
850 ///
851 /// This is a native only feature.
852 #[name("wgpu-storage-texture-array-non-uniform-indexing", "storage-texture-array-non-uniform-indexing")]
853 const STORAGE_TEXTURE_ARRAY_NON_UNIFORM_INDEXING = 1 << 12;
854 /// Allows the user to create bind groups containing arrays with less bindings than the BindGroupLayout.
855 ///
856 /// Supported platforms:
857 /// - Vulkan
858 /// - DX12
859 ///
860 /// This is a native only feature.
861 #[name("wgpu-partially-bound-binding-array", "partially-bound-binding-array")]
862 const PARTIALLY_BOUND_BINDING_ARRAY = 1 << 13;
863 /// Allows the user to call [`RenderPass::multi_draw_indirect_count`] and [`RenderPass::multi_draw_indexed_indirect_count`].
864 ///
865 /// This allows the use of a buffer containing the actual number of draw calls. This feature being present also implies
866 /// that all calls to [`RenderPass::multi_draw_indirect`] and [`RenderPass::multi_draw_indexed_indirect`] are not being emulated
867 /// with a series of `draw_indirect` calls.
868 ///
869 /// Supported platforms:
870 /// - DX12
871 /// - Vulkan 1.2+ (or VK_KHR_draw_indirect_count)
872 ///
873 /// This is a native only feature.
874 ///
875 #[doc = link_to_wgpu_docs!(["`RenderPass::multi_draw_indirect`"]: "struct.RenderPass.html#method.multi_draw_indirect")]
876 #[doc = link_to_wgpu_docs!(["`RenderPass::multi_draw_indexed_indirect`"]: "struct.RenderPass.html#method.multi_draw_indexed_indirect")]
877 #[doc = link_to_wgpu_docs!(["`RenderPass::multi_draw_indirect_count`"]: "struct.RenderPass.html#method.multi_draw_indirect_count")]
878 #[doc = link_to_wgpu_docs!(["`RenderPass::multi_draw_indexed_indirect_count`"]: "struct.RenderPass.html#method.multi_draw_indexed_indirect_count")]
879 #[name("wgpu-multi-draw-indirect-count", "multi-draw-indirect-count")]
880 const MULTI_DRAW_INDIRECT_COUNT = 1 << 15;
881 /// Allows the use of [`AddressMode::ClampToBorder`] with a border color
882 /// of [`SamplerBorderColor::Zero`].
883 ///
884 /// Supported platforms:
885 /// - DX12
886 /// - Vulkan
887 /// - Metal
888 /// - OpenGL
889 ///
890 /// This is a native only feature.
891 ///
892 /// [`AddressMode::ClampToBorder`]: super::AddressMode::ClampToBorder
893 /// [`SamplerBorderColor::Zero`]: super::SamplerBorderColor::Zero
894 #[name("wgpu-address-mode-clamp-to-zero", "address-mode-clamp-to-zero")]
895 const ADDRESS_MODE_CLAMP_TO_ZERO = 1 << 17;
896 /// Allows the use of [`AddressMode::ClampToBorder`] with a border color
897 /// other than [`SamplerBorderColor::Zero`].
898 ///
899 /// Supported platforms:
900 /// - DX12
901 /// - Vulkan
902 /// - Metal (macOS 10.12+ only)
903 /// - OpenGL
904 ///
905 /// This is a native only feature.
906 ///
907 /// [`AddressMode::ClampToBorder`]: super::AddressMode::ClampToBorder
908 /// [`SamplerBorderColor::Zero`]: super::SamplerBorderColor::Zero
909 #[name("wgpu-address-mode-clamp-to-border", "address-mode-clamp-to-border")]
910 const ADDRESS_MODE_CLAMP_TO_BORDER = 1 << 18;
911 /// Allows the user to set [`PolygonMode::Line`] in [`PrimitiveState::polygon_mode`]
912 ///
913 /// This allows drawing polygons/triangles as lines (wireframe) instead of filled
914 ///
915 /// Supported platforms:
916 /// - DX12
917 /// - Vulkan
918 /// - Metal
919 ///
920 /// This is a native only feature.
921 ///
922 /// [`PrimitiveState::polygon_mode`]: super::PrimitiveState
923 /// [`PolygonMode::Line`]: super::PolygonMode::Line
924 #[name("wgpu-polygon-mode-line", "polygon-mode-line")]
925 const POLYGON_MODE_LINE = 1 << 19;
926 /// Allows the user to set [`PolygonMode::Point`] in [`PrimitiveState::polygon_mode`]
927 ///
928 /// This allows only drawing the vertices of polygons/triangles instead of filled
929 ///
930 /// Supported platforms:
931 /// - Vulkan
932 ///
933 /// This is a native only feature.
934 ///
935 /// [`PrimitiveState::polygon_mode`]: super::PrimitiveState
936 /// [`PolygonMode::Point`]: super::PolygonMode::Point
937 #[name("wgpu-polygon-mode-point", "polygon-mode-point")]
938 const POLYGON_MODE_POINT = 1 << 20;
939 /// Allows the user to set a overestimation-conservative-rasterization in [`PrimitiveState::conservative`]
940 ///
941 /// Processing of degenerate triangles/lines is hardware specific.
942 /// Only triangles are supported.
943 ///
944 /// Supported platforms:
945 /// - Vulkan
946 ///
947 /// This is a native only feature.
948 ///
949 /// [`PrimitiveState::conservative`]: super::PrimitiveState::conservative
950 #[name("wgpu-conservative-rasterization", "conservative-rasterization")]
951 const CONSERVATIVE_RASTERIZATION = 1 << 21;
952 /// Enables bindings of writable storage buffers and textures visible to vertex shaders.
953 ///
954 /// Note: some (tiled-based) platforms do not support vertex shaders with any side-effects.
955 ///
956 /// Supported Platforms:
957 /// - All
958 ///
959 /// This is a native only feature.
960 #[name("wgpu-vertex-writable-storage", "vertex-writable-storage")]
961 const VERTEX_WRITABLE_STORAGE = 1 << 22;
962 /// Enables clear to zero for textures.
963 ///
964 /// Supported platforms:
965 /// - All
966 ///
967 /// This is a native only feature.
968 #[name("wgpu-clear-texture", "clear-texture")]
969 const CLEAR_TEXTURE = 1 << 23;
970 /// Enables multiview render passes and `builtin(view_index)` in vertex/mesh shaders.
971 ///
972 /// Supported platforms:
973 /// - Vulkan
974 /// - Metal
975 /// - DX12
976 /// - OpenGL (web only)
977 ///
978 /// This is a native only feature.
979 #[name("wgpu-multiview", "multiview")]
980 const MULTIVIEW = 1 << 26;
981 /// Enables using 64-bit types for vertex attributes.
982 ///
983 /// Requires SHADER_FLOAT64.
984 ///
985 /// Supported Platforms: N/A
986 ///
987 /// This is a native only feature.
988 #[name("wgpu-vertex-attribute-64-bit", "vertex-attribute-64-bit")]
989 const VERTEX_ATTRIBUTE_64BIT = 1 << 27;
990 /// Enables image atomic fetch add, and, xor, or, min, and max for R32Uint and R32Sint textures.
991 ///
992 /// Supported platforms:
993 /// - Vulkan
994 /// - DX12
995 /// - Metal (with MSL 3.1+)
996 ///
997 /// This is a native only feature.
998 #[name("wgpu-texture-atomic")]
999 const TEXTURE_ATOMIC = 1 << 28;
1000 /// Allows for creation of textures of format [`TextureFormat::NV12`]
1001 ///
1002 /// Supported platforms:
1003 /// - DX12
1004 /// - Vulkan
1005 ///
1006 /// This is a native only feature.
1007 ///
1008 /// [`TextureFormat::NV12`]: super::TextureFormat::NV12
1009 #[name("wgpu-texture-format-nv12")]
1010 const TEXTURE_FORMAT_NV12 = 1 << 29;
1011 /// Allows for creation of textures of format [`TextureFormat::P010`]
1012 ///
1013 /// Supported platforms:
1014 /// - DX12
1015 /// - Vulkan
1016 ///
1017 /// This is a native only feature.
1018 ///
1019 /// [`TextureFormat::P010`]: super::TextureFormat::P010
1020 #[name("wgpu-texture-format-p010")]
1021 const TEXTURE_FORMAT_P010 = 1 << 30;
1022
1023 /// Allows for the creation and usage of `ExternalTexture`s, and bind
1024 /// group layouts containing external texture `BindingType`s.
1025 ///
1026 /// Conceptually this should really be a [`crate::DownlevelFlags`] as
1027 /// it corresponds to WebGPU's [`GPUExternalTexture`](
1028 /// https://www.w3.org/TR/webgpu/#gpuexternaltexture).
1029 /// However, the implementation is currently in-progress, and until it
1030 /// is complete we do not want applications to ignore adapters due to
1031 /// a missing downlevel flag, when they may not require this feature at
1032 /// all.
1033 ///
1034 /// Supported platforms:
1035 /// - DX12
1036 /// - Metal
1037 #[name("wgpu-external-texture", "external-texture")]
1038 const EXTERNAL_TEXTURE = 1 << 31;
1039
1040 // Shader:
1041
1042 /// ***THIS IS EXPERIMENTAL:*** Features enabled by this may have
1043 /// major bugs in it and are expected to be subject to breaking changes, suggestions
1044 /// for the API exposed by this should be posted on [the ray-tracing issue](https://github.com/gfx-rs/wgpu/issues/1040)
1045 ///
1046 /// Allows for the creation of ray-tracing queries within shaders.
1047 ///
1048 /// Supported platforms:
1049 /// - Vulkan
1050 ///
1051 /// This is a native-only feature.
1052 #[name("wgpu-ray-query")]
1053 const EXPERIMENTAL_RAY_QUERY = 1 << 32;
1054 /// Enables 64-bit floating point types in SPIR-V shaders.
1055 ///
1056 /// Note: even when supported by GPU hardware, 64-bit floating point operations are
1057 /// frequently between 16 and 64 _times_ slower than equivalent operations on 32-bit floats.
1058 ///
1059 /// Supported Platforms:
1060 /// - Vulkan
1061 ///
1062 /// This is a native only feature.
1063 #[name("wgpu-shader-f64", "shader-f64")]
1064 const SHADER_F64 = 1 << 33;
1065 /// Allows shaders to use i16. Not currently supported in `naga`, only available through `spirv-passthrough`.
1066 ///
1067 /// Supported platforms:
1068 /// - Vulkan
1069 ///
1070 /// This is a native only feature.
1071 #[name("wgpu-shader-i16", "shader-i16")]
1072 const SHADER_I16 = 1 << 34;
1073
1074 // Bit 35 (formerly SHADER_PRIMITIVE_INDEX) is available.
1075
1076 /// Allows shaders to use the `early_depth_test` attribute.
1077 ///
1078 /// The attribute is applied to the fragment shader entry point. It can be used in two
1079 /// ways:
1080 ///
1081 /// 1. Force early depth/stencil tests:
1082 ///
1083 /// - `@early_depth_test(force)` (WGSL)
1084 ///
1085 /// - `layout(early_fragment_tests) in;` (GLSL)
1086 ///
1087 /// 2. Provide a conservative depth specifier that allows an additional early
1088 /// depth test under certain conditions:
1089 ///
1090 /// - `@early_depth_test(greater_equal/less_equal/unchanged)` (WGSL)
1091 ///
1092 /// - `layout(depth_<greater/less/unchanged>) out float gl_FragDepth;` (GLSL)
1093 ///
1094 /// See [`EarlyDepthTest`] for more details.
1095 ///
1096 /// Supported platforms:
1097 /// - Vulkan
1098 /// - GLES 3.1+
1099 ///
1100 /// This is a native only feature.
1101 ///
1102 /// [`EarlyDepthTest`]: https://docs.rs/naga/latest/naga/ir/enum.EarlyDepthTest.html
1103 #[name("wgpu-shader-early-depth-test", "shader-early-depth-test")]
1104 const SHADER_EARLY_DEPTH_TEST = 1 << 36;
1105 /// Allows shaders to use i64 and u64.
1106 ///
1107 /// Supported platforms:
1108 /// - Vulkan
1109 /// - DX12 (DXC only)
1110 /// - Metal (with MSL 2.3+)
1111 ///
1112 /// This is a native only feature.
1113 #[name("wgpu-shader-int64")]
1114 const SHADER_INT64 = 1 << 37;
1115 /// Allows compute and fragment shaders to use the subgroup operation
1116 /// built-ins and perform subgroup operations (except barriers).
1117 ///
1118 /// Supported Platforms:
1119 /// - Vulkan
1120 /// - DX12
1121 /// - Metal
1122 ///
1123 /// The `subgroups` feature has been added to WebGPU, but there may be
1124 /// differences between the standard and the `wgpu` implementation,
1125 /// so it remains a native-only feature in wgpu for now.
1126 /// See <https://github.com/gfx-rs/wgpu/issues/5555>.
1127 ///
1128 /// Because it is expected to move to the WebGPU feature set in the
1129 /// not-too-distant future, the name omits the `wgpu-` prefix.
1130 #[name("subgroups")]
1131 const SUBGROUP = 1 << 38;
1132 /// Allows vertex shaders to use the subgroup operation built-ins and
1133 /// perform subgroup operations (except barriers).
1134 ///
1135 /// Supported Platforms:
1136 /// - Vulkan
1137 ///
1138 /// This is a native only feature.
1139 #[name("wgpu-subgroup-vertex")]
1140 const SUBGROUP_VERTEX = 1 << 39;
1141 /// Allows compute shaders to use the subgroup barrier.
1142 ///
1143 /// Requires [`Features::SUBGROUP`]. Without it, enables nothing.
1144 ///
1145 /// Supported Platforms:
1146 /// - Vulkan
1147 /// - Metal
1148 ///
1149 /// This is a native only feature.
1150 #[name("wgpu-subgroup-barrier")]
1151 const SUBGROUP_BARRIER = 1 << 40;
1152 /// Allows the use of pipeline cache objects
1153 ///
1154 /// Supported platforms:
1155 /// - Vulkan
1156 ///
1157 /// Unimplemented Platforms:
1158 /// - DX12
1159 /// - Metal
1160 #[name("wgpu-pipeline-cache")]
1161 const PIPELINE_CACHE = 1 << 41;
1162 /// Allows shaders to use i64 and u64 atomic min and max.
1163 ///
1164 /// Supported platforms:
1165 /// - Vulkan (with VK_KHR_shader_atomic_int64)
1166 /// - DX12 (with SM 6.6+)
1167 /// - Metal (with MSL 2.4+)
1168 ///
1169 /// This is a native only feature.
1170 #[name("wgpu-shader-int64-atomic-min-max")]
1171 const SHADER_INT64_ATOMIC_MIN_MAX = 1 << 42;
1172 /// Allows shaders to use all i64 and u64 atomic operations.
1173 ///
1174 /// Supported platforms:
1175 /// - Vulkan (with VK_KHR_shader_atomic_int64)
1176 /// - DX12 (with SM 6.6+)
1177 ///
1178 /// This is a native only feature.
1179 #[name("wgpu-shader-int64-atomic-all-ops")]
1180 const SHADER_INT64_ATOMIC_ALL_OPS = 1 << 43;
1181 /// Allows using the [VK_GOOGLE_display_timing] Vulkan extension.
1182 ///
1183 /// This is used for frame pacing to reduce latency, and is generally only available on Android.
1184 ///
1185 /// This feature does not have a `wgpu`-level API, and so users of wgpu wishing
1186 /// to use this functionality must access it using various `as_hal` functions,
1187 /// primarily [`Surface::as_hal()`], to then use.
1188 ///
1189 /// Supported platforms:
1190 /// - Vulkan (with [VK_GOOGLE_display_timing])
1191 ///
1192 /// This is a native only feature.
1193 ///
1194 /// [VK_GOOGLE_display_timing]: https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_GOOGLE_display_timing.html
1195 #[doc = link_to_wgpu_docs!(["`Surface::as_hal()`"]: "struct.Surface.html#method.as_hal")]
1196 #[name("wgpu-vulkan-google-display-timing")]
1197 const VULKAN_GOOGLE_DISPLAY_TIMING = 1 << 44;
1198
1199 /// Allows using the [VK_KHR_external_memory_win32] Vulkan extension.
1200 ///
1201 /// Supported platforms:
1202 /// - Vulkan (with [VK_KHR_external_memory_win32])
1203 ///
1204 /// This is a native only feature.
1205 ///
1206 /// [VK_KHR_external_memory_win32]: https://registry.khronos.org/vulkan/specs/latest/man/html/VK_KHR_external_memory_win32.html
1207 #[name("wgpu-vulkan-external-memory-win32")]
1208 const VULKAN_EXTERNAL_MEMORY_WIN32 = 1 << 45;
1209
1210 /// Enables R64Uint image atomic min and max.
1211 ///
1212 /// Supported platforms:
1213 /// - Vulkan (with VK_EXT_shader_image_atomic_int64)
1214 /// - DX12 (with SM 6.6+)
1215 /// - Metal (with MSL 3.1+)
1216 ///
1217 /// This is a native only feature.
1218 #[name("wgpu-texture-int64-atomic")]
1219 const TEXTURE_INT64_ATOMIC = 1 << 46;
1220
1221 /// Allows uniform buffers to be bound as binding arrays.
1222 ///
1223 /// This allows:
1224 /// - Shaders to contain `var<uniform> buffer: binding_array<UniformBuffer>;`
1225 /// - The `count` field of `BindGroupLayoutEntry`s with `Uniform` buffers, to be set to `Some`.
1226 ///
1227 /// Supported platforms:
1228 /// - None (<https://github.com/gfx-rs/wgpu/issues/7149>)
1229 ///
1230 /// Potential Platforms:
1231 /// - DX12
1232 /// - Metal
1233 /// - Vulkan 1.2+ (or VK_EXT_descriptor_indexing)'s `shaderUniformBufferArrayNonUniformIndexing` feature)
1234 ///
1235 /// This is a native only feature.
1236 #[name("wgpu-uniform-buffer-binding-arrays", "uniform-buffer-binding-arrays")]
1237 const UNIFORM_BUFFER_BINDING_ARRAYS = 1 << 47;
1238
1239 /// Enables mesh shaders and task shaders in mesh shader pipelines. This extension does NOT imply support for
1240 /// compiling mesh shaders at runtime.
1241 ///
1242 /// Supported platforms:
1243 /// - Vulkan (with [VK_EXT_mesh_shader](https://registry.khronos.org/vulkan/specs/latest/man/html/VK_EXT_mesh_shader.html))
1244 /// - DX12
1245 /// - Metal
1246 ///
1247 /// Naga is only supported on vulkan. On other platforms you will have to use passthrough shaders.
1248 ///
1249 /// It is recommended to use [`Device::create_shader_module_trusted`] with [`ShaderRuntimeChecks::unchecked()`]
1250 /// to avoid workgroup memory zero initialization, which can be expensive due to zero initialization being
1251 /// single-threaded currently.
1252 ///
1253 /// Some Mesa drivers including LLVMPIPE but not RADV fail to run the naga generated code.
1254 /// [This may be our bug and will be investigated.](https://github.com/gfx-rs/wgpu/issues/8727)
1255 /// However, due to the nature of the failure, the fact that it is unique, and the random changes
1256 /// that make it go away, this is believed to be a Mesa bug. See
1257 /// [this Mesa issue.](https://gitlab.freedesktop.org/mesa/mesa/-/issues/14376)
1258 ///
1259 /// This is a native only feature.
1260 ///
1261 /// [`Device::create_shader_module_trusted`]: https://docs.rs/wgpu/latest/wgpu/struct.Device.html#method.create_shader_module_trusted
1262 /// [`ShaderRuntimeChecks::unchecked()`]: crate::ShaderRuntimeChecks::unchecked
1263 #[name("wgpu-mesh-shader")]
1264 const EXPERIMENTAL_MESH_SHADER = 1 << 48;
1265
1266 /// ***THIS IS EXPERIMENTAL:*** Features enabled by this may have
1267 /// major bugs in them and are expected to be subject to breaking changes, suggestions
1268 /// for the API exposed by this should be posted on [the ray-tracing issue](https://github.com/gfx-rs/wgpu/issues/6762)
1269 ///
1270 /// Allows for returning of the hit triangle's vertex position when tracing with an
1271 /// acceleration structure marked with [`AccelerationStructureFlags::ALLOW_RAY_HIT_VERTEX_RETURN`].
1272 ///
1273 /// Supported platforms:
1274 /// - Vulkan
1275 ///
1276 /// This is a native only feature
1277 ///
1278 /// [`AccelerationStructureFlags::ALLOW_RAY_HIT_VERTEX_RETURN`]: super::AccelerationStructureFlags::ALLOW_RAY_HIT_VERTEX_RETURN
1279 #[name("wgpu-ray-hit-vertex-return")]
1280 const EXPERIMENTAL_RAY_HIT_VERTEX_RETURN = 1 << 49;
1281
1282 /// Enables multiview in mesh shader pipelines
1283 ///
1284 /// Supported platforms:
1285 /// - Vulkan (with [VK_EXT_mesh_shader](https://registry.khronos.org/vulkan/specs/latest/man/html/VK_EXT_mesh_shader.html))
1286 ///
1287 /// Potential Platforms:
1288 /// - DX12
1289 /// - Metal
1290 ///
1291 /// This is a native only feature.
1292 #[name("wgpu-mesh-shader-multiview")]
1293 const EXPERIMENTAL_MESH_SHADER_MULTIVIEW = 1 << 50;
1294
1295 /// Allows usage of additional vertex formats in [BlasTriangleGeometrySizeDescriptor::vertex_format]
1296 ///
1297 /// Supported platforms
1298 /// - Vulkan
1299 /// - DX12
1300 ///
1301 /// [BlasTriangleGeometrySizeDescriptor::vertex_format]: super::BlasTriangleGeometrySizeDescriptor
1302 #[name("wgpu-extended-acceleration-structure-vertex-formats")]
1303 const EXTENDED_ACCELERATION_STRUCTURE_VERTEX_FORMATS = 1 << 51;
1304
1305 /// Enables creating shaders from passthrough with reflection info (unsafe)
1306 ///
1307 /// Allows using [`Device::create_shader_module_passthrough`].
1308 /// Shader code isn't parsed or interpreted in any way. It is the user's
1309 /// responsibility to ensure the code and reflection (if passed) are correct.
1310 ///
1311 /// Supported platforms
1312 /// - Vulkan
1313 /// - DX12
1314 /// - Metal
1315 /// - WebGPU
1316 ///
1317 /// Ideally, in the future, all platforms will be supported. For more info, see
1318 /// [this comment](https://github.com/gfx-rs/wgpu/issues/3103#issuecomment-2833058367).
1319 ///
1320 #[doc = link_to_wgpu_docs!(["`Device::create_shader_module_passthrough`"]: "struct.Device.html#method.create_shader_module_passthrough")]
1321 #[name("wgpu-passthrough-shaders", "passthrough-shaders")]
1322 const PASSTHROUGH_SHADERS = 1 << 52;
1323
1324 /// Enables shader barycentric coordinates.
1325 ///
1326 /// Supported platforms:
1327 /// - Vulkan (with VK_KHR_fragment_shader_barycentric)
1328 /// - DX12 (with SM 6.1+)
1329 /// - Metal (with MSL 2.2+)
1330 ///
1331 /// This is a native only feature.
1332 #[name("wgpu-shader-barycentrics")]
1333 const SHADER_BARYCENTRICS = 1 << 53;
1334
1335 /// Enables using multiview where not all texture array layers are rendered to in a single render pass/render pipeline. Making
1336 /// use of this feature also requires enabling `Features::MULTIVIEW`.
1337 ///
1338 /// Supported platforms
1339 /// - Vulkan
1340 /// - DX12
1341 ///
1342 ///
1343 /// While metal supports this in theory, the behavior of `view_index` differs from vulkan and dx12 so the feature isn't exposed.
1344 #[name("wgpu-selective-multiview")]
1345 const SELECTIVE_MULTIVIEW = 1 << 54;
1346
1347 /// Enables the use of point-primitive outputs from mesh shaders. Making use of this feature also requires enabling
1348 /// `Features::EXPERIMENTAL_MESH_SHADER`.
1349 ///
1350 /// Supported platforms
1351 /// - Vulkan
1352 /// - Metal
1353 ///
1354 /// This is a native only feature.
1355 #[name("wgpu-mesh-shader-points")]
1356 const EXPERIMENTAL_MESH_SHADER_POINTS = 1 << 55;
1357
1358 /// Enables creating texture arrays that are also multisampled.
1359 ///
1360 /// Without this feature, you cannot create a texture that has both a `sample_count` higher
1361 /// than 1, and a `depth_or_array_layers` higher than 1.
1362 ///
1363 /// Supported platforms:
1364 /// - Vulkan (except VK_KHR_portability_subset if multisampleArrayImage is not available)
1365 #[name("wgpu-multisample-array")]
1366 const MULTISAMPLE_ARRAY = 1 << 56;
1367
1368 /// Enables cooperative matrix operations (also known as tensor cores on NVIDIA GPUs
1369 /// or simdgroup matrix operations on Apple GPUs).
1370 ///
1371 /// Cooperative matrices allow a workgroup to collectively load, store, and perform
1372 /// matrix multiply-accumulate operations on small tiles of data, enabling
1373 /// hardware-accelerated matrix math.
1374 ///
1375 /// **Current limitations:** The implementation currently only supports 8x8 f32 matrices.
1376 /// On Vulkan, support is determined by querying `vkGetPhysicalDeviceCooperativeMatrixPropertiesKHR`
1377 /// for configurations matching 8x8x8 f32. Most Vulkan implementations (NVIDIA, AMD) primarily
1378 /// support f16 inputs at larger sizes (e.g., 16x16), so Vulkan support may be limited.
1379 ///
1380 /// Supported platforms:
1381 /// - Metal (with MSL 2.3+ and Apple7+/Mac2+, using simdgroup matrix operations)
1382 /// - Vulkan (with [VK_KHR_cooperative_matrix](https://registry.khronos.org/vulkan/specs/latest/man/html/VK_KHR_cooperative_matrix.html), if 8x8 f32 is supported)
1383 ///
1384 /// This is a native only feature.
1385 #[name("wgpu-cooperative-matrix")]
1386 const EXPERIMENTAL_COOPERATIVE_MATRIX = 1 << 57;
1387
1388 /// Enables shader per-vertex attributes.
1389 ///
1390 /// Supported platforms:
1391 /// - Vulkan (with VK_KHR_fragment_shader_barycentric)
1392 ///
1393 /// This is a native only feature.
1394 #[name("wgpu-shader-per-vertex")]
1395 const SHADER_PER_VERTEX = 1 << 58;
1396
1397 /// Enables shader `draw_index` builtin.
1398 ///
1399 /// Supported platforms:
1400 /// - GLES
1401 /// - Vulkan
1402 ///
1403 /// Potential platforms:
1404 /// - DX12
1405 /// - Metal
1406 ///
1407 /// This is a native only feature.
1408 #[name("wgpu-shader-draw-index")]
1409 const SHADER_DRAW_INDEX = 1 << 59;
1410 /// Allows the user to create arrays of acceleration structures in shaders:
1411 ///
1412 /// ex.
1413 /// - `var tlas: binding_array<acceleration_structure, 10>` (WGSL)
1414 ///
1415 /// This capability allows them to exist and to be indexed by dynamically uniform values.
1416 ///
1417 /// Supported platforms:
1418 /// - DX12
1419 /// - Vulkan
1420 ///
1421 /// This is a native only feature.
1422 #[name("wgpu-acceleration-structure-binding-array")]
1423 const ACCELERATION_STRUCTURE_BINDING_ARRAY = 1 << 60;
1424
1425 /// Enables the `@coherent` memory decoration on storage buffer variables.
1426 ///
1427 /// Backend mapping:
1428 /// - Vulkan
1429 /// - DX12
1430 /// - Metal (3.2+)
1431 /// - GLES (ES 3.1+ / GL 4.3+)
1432 ///
1433 /// This is a native only feature.
1434 #[name("wgpu-memory-decoration-coherent")]
1435 const MEMORY_DECORATION_COHERENT = 1 << 61;
1436
1437 /// Enables the `@volatile` memory decoration on storage buffer variables.
1438 ///
1439 /// Backend mapping:
1440 /// - Vulkan
1441 /// - GLES (ES 3.1+ / GL 4.3+)
1442 ///
1443 /// This is a native only feature.
1444 #[name("wgpu-memory-decoration-volatile")]
1445 const MEMORY_DECORATION_VOLATILE = 1 << 62;
1446
1447 // Adding a new feature? Bit 35 (formerly SHADER_PRIMITIVE_INDEX) is available.
1448 }
1449
1450 /// Features that are not guaranteed to be supported.
1451 ///
1452 /// These are part of the WebGPU standard. For all features, see [`Features`].
1453 ///
1454 /// If you want to use a feature, you need to first verify that the adapter supports
1455 /// the feature. If the adapter does not support the feature, requesting a device with it enabled
1456 /// will panic.
1457 ///
1458 /// Corresponds to [WebGPU `GPUFeatureName`](
1459 /// https://gpuweb.github.io/gpuweb/#enumdef-gpufeaturename).
1460 #[repr(transparent)]
1461 #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
1462 #[cfg_attr(feature = "serde", serde(transparent))]
1463 #[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Hash)]
1464 pub struct FeaturesWebGPU features_webgpu {
1465 // API:
1466
1467 /// By default, polygon depth is clipped to 0-1 range before/during rasterization.
1468 /// Anything outside of that range is rejected, and respective fragments are not touched.
1469 ///
1470 /// With this extension, we can disabling clipping. That allows
1471 /// shadow map occluders to be rendered into a tighter depth range.
1472 ///
1473 /// Supported platforms:
1474 /// - desktops
1475 /// - some mobile chips
1476 /// - WebGPU
1477 ///
1478 /// This is a web and native feature.
1479 #[name("depth-clip-control")]
1480 const DEPTH_CLIP_CONTROL = WEBGPU_FEATURE_DEPTH_CLIP_CONTROL;
1481
1482 /// Allows for explicit creation of textures of format [`TextureFormat::Depth32FloatStencil8`]
1483 ///
1484 /// Supported platforms:
1485 /// - Vulkan (mostly)
1486 /// - DX12
1487 /// - Metal
1488 /// - OpenGL
1489 /// - WebGPU
1490 ///
1491 /// This is a web and native feature.
1492 ///
1493 /// [`TextureFormat::Depth32FloatStencil8`]: super::TextureFormat::Depth32FloatStencil8
1494 #[name("depth32float-stencil8")]
1495 const DEPTH32FLOAT_STENCIL8 = WEBGPU_FEATURE_DEPTH32FLOAT_STENCIL8;
1496
1497 /// Enables BCn family of compressed textures. All BCn textures use 4x4 pixel blocks
1498 /// with 8 or 16 bytes per block.
1499 ///
1500 /// Compressed textures sacrifice some quality in exchange for significantly reduced
1501 /// bandwidth usage.
1502 ///
1503 /// Support for this feature guarantees availability of [`TextureUsages::COPY_SRC | TextureUsages::COPY_DST | TextureUsages::TEXTURE_BINDING`] for BCn formats.
1504 /// [`Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES`] may enable additional usages.
1505 ///
1506 /// This feature guarantees availability of sliced-3d textures for BC formats when combined with TEXTURE_COMPRESSION_BC_SLICED_3D.
1507 ///
1508 /// Supported Platforms:
1509 /// - desktops
1510 /// - Mobile (All Apple9 and some Apple7 and Apple8 devices)
1511 /// - WebGPU
1512 ///
1513 /// This is a web and native feature.
1514 #[name("texture-compression-bc")]
1515 const TEXTURE_COMPRESSION_BC = WEBGPU_FEATURE_TEXTURE_COMPRESSION_BC;
1516
1517
1518 /// Allows the 3d dimension for textures with BC compressed formats.
1519 ///
1520 /// This feature must be used in combination with TEXTURE_COMPRESSION_BC to enable 3D textures with BC compression.
1521 /// It does not enable the BC formats by itself.
1522 ///
1523 /// Supported Platforms:
1524 /// - desktops
1525 /// - Mobile (All Apple9 and some Apple7 and Apple8 devices)
1526 /// - WebGPU
1527 ///
1528 /// This is a web and native feature.
1529 #[name("texture-compression-bc-sliced-3d")]
1530 const TEXTURE_COMPRESSION_BC_SLICED_3D = WEBGPU_FEATURE_TEXTURE_COMPRESSION_BC_SLICED_3D;
1531
1532 /// Enables ETC family of compressed textures. All ETC textures use 4x4 pixel blocks.
1533 /// ETC2 RGB and RGBA1 are 8 bytes per block. RTC2 RGBA8 and EAC are 16 bytes per block.
1534 ///
1535 /// Compressed textures sacrifice some quality in exchange for significantly reduced
1536 /// bandwidth usage.
1537 ///
1538 /// Support for this feature guarantees availability of [`TextureUsages::COPY_SRC | TextureUsages::COPY_DST | TextureUsages::TEXTURE_BINDING`] for ETC2 formats.
1539 /// [`Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES`] may enable additional usages.
1540 ///
1541 /// Supported Platforms:
1542 /// - Vulkan on Intel
1543 /// - Mobile (some)
1544 /// - WebGPU
1545 ///
1546 /// This is a web and native feature.
1547 #[name("texture-compression-etc2")]
1548 const TEXTURE_COMPRESSION_ETC2 = WEBGPU_FEATURE_TEXTURE_COMPRESSION_ETC2;
1549
1550 /// Enables ASTC family of compressed textures. ASTC textures use pixel blocks varying from 4x4 to 12x12.
1551 /// Blocks are always 16 bytes.
1552 ///
1553 /// Compressed textures sacrifice some quality in exchange for significantly reduced
1554 /// bandwidth usage.
1555 ///
1556 /// Support for this feature guarantees availability of [`TextureUsages::COPY_SRC | TextureUsages::COPY_DST | TextureUsages::TEXTURE_BINDING`] for ASTC formats with Unorm/UnormSrgb channel type.
1557 /// [`Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES`] may enable additional usages.
1558 ///
1559 /// This feature does not guarantee availability of sliced 3d textures for ASTC formats.
1560 /// If available, 3d support can be enabled by TEXTURE_COMPRESSION_ASTC_SLICED_3D feature.
1561 ///
1562 /// Supported Platforms:
1563 /// - Vulkan on Intel
1564 /// - Mobile (some)
1565 /// - WebGPU
1566 ///
1567 /// This is a web and native feature.
1568 #[name("texture-compression-astc")]
1569 const TEXTURE_COMPRESSION_ASTC = WEBGPU_FEATURE_TEXTURE_COMPRESSION_ASTC;
1570
1571
1572 /// Allows the 3d dimension for textures with ASTC compressed formats.
1573 ///
1574 /// This feature must be used in combination with TEXTURE_COMPRESSION_ASTC to enable 3D textures with ASTC compression.
1575 /// It does not enable the ASTC formats by itself.
1576 ///
1577 /// Supported Platforms:
1578 /// - Vulkan (some)
1579 /// - Metal on Apple3+
1580 /// - OpenGL/WebGL (some)
1581 /// - WebGPU
1582 ///
1583 /// Not Supported:
1584 /// - DX12
1585 ///
1586 /// This is a web and native feature.
1587 #[name("texture-compression-astc-sliced-3d")]
1588 const TEXTURE_COMPRESSION_ASTC_SLICED_3D = WEBGPU_FEATURE_TEXTURE_COMPRESSION_ASTC_SLICED_3D;
1589
1590 /// Enables use of Timestamp Queries. These queries tell the current gpu timestamp when
1591 /// all work before the query is finished.
1592 ///
1593 /// This feature allows the use of
1594 /// - [`RenderPassDescriptor::timestamp_writes`]
1595 /// - [`ComputePassDescriptor::timestamp_writes`]
1596 /// to write out timestamps.
1597 ///
1598 /// For arbitrary timestamp write commands on encoders refer to [`Features::TIMESTAMP_QUERY_INSIDE_ENCODERS`].
1599 /// For arbitrary timestamp write commands on passes refer to [`Features::TIMESTAMP_QUERY_INSIDE_PASSES`].
1600 ///
1601 /// They must be resolved using [`CommandEncoder::resolve_query_set`] into a buffer,
1602 /// then the result must be multiplied by the timestamp period [`Queue::get_timestamp_period`]
1603 /// to get the timestamp in nanoseconds. Multiple timestamps can then be diffed to get the
1604 /// time for operations between them to finish.
1605 ///
1606 /// Supported Platforms:
1607 /// - Vulkan
1608 /// - DX12
1609 /// - Metal
1610 /// - OpenGL (with GL_ARB_timer_query)
1611 /// - WebGPU
1612 ///
1613 /// This is a web and native feature.
1614 ///
1615 #[doc = link_to_wgpu_docs!(["`RenderPassDescriptor::timestamp_writes`"]: "struct.RenderPassDescriptor.html#structfield.timestamp_writes")]
1616 #[doc = link_to_wgpu_docs!(["`ComputePassDescriptor::timestamp_writes`"]: "struct.ComputePassDescriptor.html#structfield.timestamp_writes")]
1617 #[doc = link_to_wgpu_docs!(["`CommandEncoder::resolve_query_set`"]: "struct.CommandEncoder.html#method.resolve_query_set")]
1618 #[doc = link_to_wgpu_docs!(["`Queue::get_timestamp_period`"]: "struct.Queue.html#method.get_timestamp_period")]
1619 #[name("timestamp-query")]
1620 const TIMESTAMP_QUERY = WEBGPU_FEATURE_TIMESTAMP_QUERY;
1621
1622 /// Allows non-zero value for the `first_instance` member in indirect draw calls.
1623 ///
1624 /// If this feature is not enabled, and the `first_instance` member is non-zero, the behavior may be:
1625 /// - The draw call is ignored.
1626 /// - The draw call is executed as if the `first_instance` is zero.
1627 /// - The draw call is executed with the correct `first_instance` value.
1628 ///
1629 /// Supported Platforms:
1630 /// - Vulkan (mostly)
1631 /// - DX12
1632 /// - Metal on Apple3+ or Mac1+
1633 /// - OpenGL (Desktop 4.2+ with ARB_shader_draw_parameters only)
1634 /// - WebGPU
1635 ///
1636 /// Not Supported:
1637 /// - OpenGL ES / WebGL
1638 ///
1639 /// This is a web and native feature.
1640 #[name("indirect-first-instance")]
1641 const INDIRECT_FIRST_INSTANCE = WEBGPU_FEATURE_INDIRECT_FIRST_INSTANCE;
1642
1643 /// Allows shaders to use 16-bit floating point types. You may use them uniform buffers,
1644 /// storage buffers, and local variables. You may not use them in immediates.
1645 ///
1646 /// In order to use this in WGSL shaders, you must add `enable f16;` to the top of your shader,
1647 /// before any global items.
1648 ///
1649 /// Supported Platforms:
1650 /// - Vulkan
1651 /// - Metal
1652 /// - DX12
1653 /// - WebGPU
1654 ///
1655 /// This is a web and native feature.
1656 #[name("shader-f16")]
1657 const SHADER_F16 = WEBGPU_FEATURE_SHADER_F16;
1658
1659 /// Allows for usage of textures of format [`TextureFormat::Rg11b10Ufloat`] as a render target
1660 ///
1661 /// Supported platforms:
1662 /// - Vulkan
1663 /// - DX12
1664 /// - Metal
1665 /// - WebGPU
1666 ///
1667 /// This is a web and native feature.
1668 ///
1669 /// [`TextureFormat::Rg11b10Ufloat`]: super::TextureFormat::Rg11b10Ufloat
1670 #[name("rg11b10ufloat-renderable")]
1671 const RG11B10UFLOAT_RENDERABLE = WEBGPU_FEATURE_RG11B10UFLOAT_RENDERABLE;
1672
1673 /// Allows the [`TextureUsages::STORAGE_BINDING`] usage on textures with format [`TextureFormat::Bgra8Unorm`]
1674 ///
1675 /// Supported Platforms:
1676 /// - Vulkan
1677 /// - DX12
1678 /// - Metal
1679 /// - WebGPU
1680 ///
1681 /// This is a web and native feature.
1682 ///
1683 /// [`TextureFormat::Bgra8Unorm`]: super::TextureFormat::Bgra8Unorm
1684 /// [`TextureUsages::STORAGE_BINDING`]: super::TextureUsages::STORAGE_BINDING
1685 #[name("bgra8unorm-storage")]
1686 const BGRA8UNORM_STORAGE = WEBGPU_FEATURE_BGRA8UNORM_STORAGE;
1687
1688
1689 /// Allows textures with formats "r32float", "rg32float", and "rgba32float" to be filterable.
1690 ///
1691 /// Supported Platforms:
1692 /// - Vulkan (mainly on Desktop GPUs)
1693 /// - DX12
1694 /// - Metal on macOS or Apple9+ GPUs, optional on iOS/iPadOS with Apple7/8 GPUs
1695 /// - GL with one of `GL_ARB_color_buffer_float`/`GL_EXT_color_buffer_float`/`OES_texture_float_linear`
1696 /// - WebGPU
1697 ///
1698 /// This is a web and native feature.
1699 #[name("float32-filterable")]
1700 const FLOAT32_FILTERABLE = WEBGPU_FEATURE_FLOAT32_FILTERABLE;
1701
1702 /// Allows textures with formats "r32float", "rg32float", and "rgba32float" to be blendable.
1703 ///
1704 /// Supported Platforms:
1705 /// - Vulkan
1706 /// - WebGPU
1707 #[name("float32-blendable")]
1708 const FLOAT32_BLENDABLE = WEBGPU_FEATURE_FLOAT32_BLENDABLE;
1709
1710 /// Allows two outputs from a shader to be used for blending.
1711 /// Note that dual-source blending doesn't support multiple render targets.
1712 ///
1713 /// For more info see the OpenGL ES extension GL_EXT_blend_func_extended.
1714 ///
1715 /// Supported platforms:
1716 /// - OpenGL ES (with GL_EXT_blend_func_extended)
1717 /// - Metal (with MSL 1.2+)
1718 /// - Vulkan (with dualSrcBlend)
1719 /// - DX12
1720 /// - WebGPU
1721 ///
1722 /// This is a web and native feature.
1723 #[name("dual-source-blending")]
1724 const DUAL_SOURCE_BLENDING = WEBGPU_FEATURE_DUAL_SOURCE_BLENDING;
1725
1726 /// Allows the use of `@builtin(clip_distances)` in WGSL.
1727 ///
1728 /// Supported platforms:
1729 /// - Vulkan (mainly on Desktop GPUs)
1730 /// - Metal
1731 /// - GL (Desktop or `GL_EXT_clip_cull_distance`)
1732 /// - WebGPU
1733 ///
1734 /// This is a web and native feature.
1735 #[name("clip-distances")]
1736 const CLIP_DISTANCES = WEBGPU_FEATURE_CLIP_DISTANCES;
1737
1738 /// Allows the use of immediate data: small, fast bits of memory that can be updated
1739 /// inside a [`RenderPass`].
1740 ///
1741 /// Allows the user to call [`RenderPass::set_immediates`], provide a non-zero immediate data size
1742 /// to [`PipelineLayoutDescriptor`], and provide a non-zero limit to [`Limits::max_immediate_size`].
1743 ///
1744 /// A block of immediate data can be declared in WGSL with `var<immediate>`:
1745 ///
1746 /// ```rust,ignore
1747 /// struct Immediates { example: f32, }
1748 /// var<immediate> c: Immediates;
1749 /// ```
1750 ///
1751 /// In GLSL, this corresponds to `layout(immediates) uniform Name {..}`.
1752 ///
1753 /// Supported platforms:
1754 /// - DX12
1755 /// - Vulkan
1756 /// - Metal
1757 /// - OpenGL (emulated with uniforms)
1758 /// - WebGPU
1759 ///
1760 /// WebGPU support is currently a proposal and will be available in browsers in the future.
1761 ///
1762 /// This is a web and native feature.
1763 ///
1764 #[doc = link_to_wgpu_item!(struct RenderPass)]
1765 #[doc = link_to_wgpu_item!(struct PipelineLayoutDescriptor)]
1766 #[doc = link_to_wgpu_docs!(["`RenderPass::set_immediates`"]: "struct.RenderPass.html#method.set_immediates")]
1767 /// [`Limits::max_immediate_size`]: super::Limits
1768 #[name("immediates")]
1769 const IMMEDIATES = WEBGPU_FEATURE_IMMEDIATES;
1770
1771 /// Enables `builtin(primitive_index)` in fragment shaders.
1772 ///
1773 /// Note: enables geometry processing for pipelines using the builtin.
1774 /// This may come with a significant performance impact on some hardware.
1775 /// Other pipelines are not affected.
1776 ///
1777 /// Supported platforms:
1778 /// - Vulkan (with geometryShader)
1779 /// - DX12
1780 /// - Metal (some)
1781 /// - OpenGL (some)
1782 ///
1783 /// This is a web and native feature. `primitive-index` is its
1784 /// WebGPU-defined name, and `shader-primitive-index` is accepted to
1785 /// remain compatible with previous wgpu behavior.
1786 #[name("primitive-index", "shader-primitive-index")]
1787 const PRIMITIVE_INDEX = WEBGPU_FEATURE_PRIMITIVE_INDEX;
1788 }
1789}
1790
1791impl Features {
1792 /// Mask of all features which are part of the upstream WebGPU standard.
1793 #[must_use]
1794 pub const fn all_webgpu_mask() -> Self {
1795 Self::from_bits_truncate(FeatureBits([
1796 FeaturesWGPU::empty().bits(),
1797 FeaturesWebGPU::all().bits(),
1798 ]))
1799 }
1800
1801 /// Mask of all features that are only available when targeting native (not web).
1802 #[must_use]
1803 pub const fn all_native_mask() -> Self {
1804 Self::from_bits_truncate(FeatureBits([
1805 FeaturesWGPU::all().bits(),
1806 FeaturesWebGPU::empty().bits(),
1807 ]))
1808 }
1809
1810 /// Mask of all features which are experimental.
1811 #[must_use]
1812 pub const fn all_experimental_mask() -> Self {
1813 Self::from_bits_truncate(FeatureBits([
1814 FeaturesWGPU::EXPERIMENTAL_MESH_SHADER.bits()
1815 | FeaturesWGPU::EXPERIMENTAL_MESH_SHADER_MULTIVIEW.bits()
1816 | FeaturesWGPU::EXPERIMENTAL_MESH_SHADER_POINTS.bits()
1817 | FeaturesWGPU::EXPERIMENTAL_RAY_QUERY.bits()
1818 | FeaturesWGPU::EXPERIMENTAL_RAY_HIT_VERTEX_RETURN.bits()
1819 | FeaturesWGPU::EXPERIMENTAL_COOPERATIVE_MATRIX.bits(),
1820 FeaturesWebGPU::empty().bits(),
1821 ]))
1822 }
1823
1824 /// Vertex formats allowed for creating and building BLASes
1825 #[must_use]
1826 pub fn allowed_vertex_formats_for_blas(&self) -> Vec<VertexFormat> {
1827 let mut formats = Vec::new();
1828 if self.intersects(Self::EXPERIMENTAL_RAY_QUERY) {
1829 formats.push(VertexFormat::Float32x3);
1830 }
1831 if self.contains(Self::EXTENDED_ACCELERATION_STRUCTURE_VERTEX_FORMATS) {
1832 formats.push(VertexFormat::Float32x2);
1833 formats.push(VertexFormat::Float16x2);
1834 formats.push(VertexFormat::Float16x4);
1835 formats.push(VertexFormat::Snorm16x2);
1836 formats.push(VertexFormat::Snorm16x4);
1837 }
1838 formats
1839 }
1840}
1841
1842#[cfg(test)]
1843mod tests {
1844 use crate::{Features, FeaturesWGPU, FeaturesWebGPU};
1845 use bitflags::{Flag, Flags};
1846
1847 #[cfg(feature = "serde")]
1848 #[test]
1849 fn check_hex() {
1850 use crate::FeatureBits;
1851
1852 use bitflags::{
1853 parser::{ParseHex as _, WriteHex as _},
1854 Bits as _,
1855 };
1856
1857 let mut hex = alloc::string::String::new();
1858 FeatureBits::ALL.write_hex(&mut hex).unwrap();
1859 assert_eq!(
1860 FeatureBits::parse_hex(hex.as_str()).unwrap(),
1861 FeatureBits::ALL
1862 );
1863
1864 hex.clear();
1865 FeatureBits::EMPTY.write_hex(&mut hex).unwrap();
1866 assert_eq!(
1867 FeatureBits::parse_hex(hex.as_str()).unwrap(),
1868 FeatureBits::EMPTY
1869 );
1870
1871 for feature in Features::FLAGS {
1872 hex.clear();
1873 feature.value().bits().write_hex(&mut hex).unwrap();
1874 assert_eq!(
1875 FeatureBits::parse_hex(hex.as_str()).unwrap(),
1876 feature.value().bits(),
1877 "{hex}"
1878 );
1879 }
1880 }
1881
1882 #[test]
1883 fn check_features_display() {
1884 use alloc::format;
1885
1886 let feature = Features::CLEAR_TEXTURE;
1887 assert_eq!(format!("{feature}"), "CLEAR_TEXTURE");
1888
1889 let feature = Features::CLEAR_TEXTURE | Features::BGRA8UNORM_STORAGE;
1890 assert_eq!(format!("{feature}"), "CLEAR_TEXTURE | BGRA8UNORM_STORAGE");
1891 }
1892
1893 #[test]
1894 fn check_features_bits() {
1895 let bits = Features::all().bits();
1896 assert_eq!(Features::from_bits_retain(bits), Features::all());
1897
1898 let bits = Features::empty().bits();
1899 assert_eq!(Features::from_bits_retain(bits), Features::empty());
1900
1901 for feature in Features::FLAGS {
1902 let bits = feature.value().bits();
1903 assert_eq!(Features::from_bits_retain(bits), *feature.value());
1904 }
1905
1906 let bits = FeaturesWebGPU::all().bits();
1907 assert_eq!(
1908 FeaturesWebGPU::from_bits_truncate(bits),
1909 FeaturesWebGPU::all()
1910 );
1911
1912 let bits = FeaturesWebGPU::empty().bits();
1913 assert_eq!(
1914 FeaturesWebGPU::from_bits_truncate(bits),
1915 FeaturesWebGPU::empty()
1916 );
1917
1918 for feature in FeaturesWebGPU::FLAGS {
1919 let bits = feature.value().bits();
1920 assert_eq!(FeaturesWebGPU::from_bits_truncate(bits), *feature.value());
1921 }
1922
1923 let bits = FeaturesWGPU::all().bits();
1924 assert_eq!(FeaturesWGPU::from_bits(bits).unwrap(), FeaturesWGPU::all());
1925
1926 let bits = FeaturesWGPU::empty().bits();
1927 assert_eq!(
1928 FeaturesWGPU::from_bits(bits).unwrap(),
1929 FeaturesWGPU::empty()
1930 );
1931
1932 for feature in FeaturesWGPU::FLAGS {
1933 let bits = feature.value().bits();
1934 assert_eq!(FeaturesWGPU::from_bits(bits).unwrap(), *feature.value());
1935 }
1936 }
1937
1938 #[test]
1939 fn features_names() {
1940 for feature in Features::FLAGS.iter().map(Flag::value).copied() {
1941 let Some(name) = feature.as_str() else {
1942 panic!("`.as_str()` for {feature:?} returned `None`");
1943 };
1944 assert_eq!(name.parse(), Ok(feature));
1945
1946 // Native-only features that are accepted without `wgpu-` prefix for backwards compatibility
1947 let prefix_backcompat_features = [
1948 Features::TEXTURE_FORMAT_16BIT_NORM,
1949 Features::TEXTURE_COMPRESSION_ASTC_HDR,
1950 Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES,
1951 Features::PIPELINE_STATISTICS_QUERY,
1952 Features::TIMESTAMP_QUERY_INSIDE_PASSES,
1953 Features::MAPPABLE_PRIMARY_BUFFERS,
1954 Features::TEXTURE_BINDING_ARRAY,
1955 Features::BUFFER_BINDING_ARRAY,
1956 Features::STORAGE_RESOURCE_BINDING_ARRAY,
1957 Features::SAMPLED_TEXTURE_AND_STORAGE_BUFFER_ARRAY_NON_UNIFORM_INDEXING,
1958 Features::STORAGE_TEXTURE_ARRAY_NON_UNIFORM_INDEXING,
1959 Features::UNIFORM_BUFFER_BINDING_ARRAYS,
1960 Features::PARTIALLY_BOUND_BINDING_ARRAY,
1961 Features::MULTI_DRAW_INDIRECT_COUNT,
1962 Features::ADDRESS_MODE_CLAMP_TO_ZERO,
1963 Features::ADDRESS_MODE_CLAMP_TO_BORDER,
1964 Features::POLYGON_MODE_LINE,
1965 Features::POLYGON_MODE_POINT,
1966 Features::CONSERVATIVE_RASTERIZATION,
1967 Features::VERTEX_WRITABLE_STORAGE,
1968 Features::CLEAR_TEXTURE,
1969 Features::MULTIVIEW,
1970 Features::VERTEX_ATTRIBUTE_64BIT,
1971 Features::EXTERNAL_TEXTURE,
1972 Features::SHADER_F64,
1973 Features::SHADER_I16,
1974 Features::SHADER_EARLY_DEPTH_TEST,
1975 Features::PASSTHROUGH_SHADERS,
1976 ];
1977
1978 if feature == Features::SUBGROUP {
1979 // Standard-track feature that does not have `wgpu-` prefix
1980 assert_eq!(name.parse(), Ok(feature));
1981 } else if feature & Features::all_native_mask() != Features::empty() {
1982 let stripped_name = name.strip_prefix("wgpu-").unwrap_or_else(|| {
1983 panic!("Native feature `{name}` should have `wgpu-` prefix")
1984 });
1985 let expected = if prefix_backcompat_features.contains(&feature) {
1986 Ok(feature)
1987 } else {
1988 Err(())
1989 };
1990 assert_eq!(stripped_name.parse(), expected);
1991 }
1992
1993 // Special backcompat case
1994 if feature == Features::PRIMITIVE_INDEX {
1995 assert_eq!("shader-primitive-index".parse(), Ok(feature));
1996 }
1997 }
1998 }
1999
2000 #[test]
2001 fn create_features_from_parts() {
2002 let features: Features = FeaturesWGPU::TEXTURE_ATOMIC.into();
2003 assert_eq!(features, Features::TEXTURE_ATOMIC);
2004
2005 let features: Features = FeaturesWebGPU::TIMESTAMP_QUERY.into();
2006 assert_eq!(features, Features::TIMESTAMP_QUERY);
2007
2008 let features: Features = Features::from(FeaturesWGPU::TEXTURE_ATOMIC)
2009 | Features::from(FeaturesWebGPU::TIMESTAMP_QUERY);
2010 assert_eq!(
2011 features,
2012 Features::TEXTURE_ATOMIC | Features::TIMESTAMP_QUERY
2013 );
2014 assert_eq!(
2015 features,
2016 Features::from_internal_flags(
2017 FeaturesWGPU::TEXTURE_ATOMIC,
2018 FeaturesWebGPU::TIMESTAMP_QUERY
2019 )
2020 );
2021 }
2022
2023 #[test]
2024 fn experimental_features_part_of_experimental_mask() {
2025 for (name, feature) in Features::all().iter_names() {
2026 let prefixed_with_experimental = name.starts_with("EXPERIMENTAL_");
2027 let in_experimental_mask = Features::all_experimental_mask().contains(feature);
2028 assert_eq!(in_experimental_mask, prefixed_with_experimental);
2029 }
2030 }
2031}