wgpu_types/
features.rs

1use crate::VertexFormat;
2#[cfg(feature = "serde")]
3use alloc::fmt;
4use alloc::vec::Vec;
5#[cfg(feature = "serde")]
6use bitflags::parser::{ParseError, ParseHex, WriteHex};
7#[cfg(feature = "serde")]
8use bitflags::Bits;
9use bitflags::Flags;
10#[cfg(feature = "serde")]
11use core::mem::size_of;
12#[cfg(feature = "serde")]
13use serde::{Deserialize, Serialize};
14
15pub use webgpu_impl::*;
16mod webgpu_impl {
17    //! Constant values for [`super::FeaturesWebGPU`], separated so they can be picked up by
18    //! `cbindgen` in `mozilla-central` (where Firefox is developed).
19    #![allow(missing_docs)]
20
21    #[doc(hidden)]
22    pub const WEBGPU_FEATURE_DEPTH_CLIP_CONTROL: u64 = 1 << 0;
23
24    #[doc(hidden)]
25    pub const WEBGPU_FEATURE_DEPTH32FLOAT_STENCIL8: u64 = 1 << 1;
26
27    #[doc(hidden)]
28    pub const WEBGPU_FEATURE_TEXTURE_COMPRESSION_BC: u64 = 1 << 2;
29
30    #[doc(hidden)]
31    pub const WEBGPU_FEATURE_TEXTURE_COMPRESSION_BC_SLICED_3D: u64 = 1 << 3;
32
33    #[doc(hidden)]
34    pub const WEBGPU_FEATURE_TEXTURE_COMPRESSION_ETC2: u64 = 1 << 4;
35
36    #[doc(hidden)]
37    pub const WEBGPU_FEATURE_TEXTURE_COMPRESSION_ASTC: u64 = 1 << 5;
38
39    #[doc(hidden)]
40    pub const WEBGPU_FEATURE_TEXTURE_COMPRESSION_ASTC_SLICED_3D: u64 = 1 << 6;
41
42    #[doc(hidden)]
43    pub const WEBGPU_FEATURE_TIMESTAMP_QUERY: u64 = 1 << 7;
44
45    #[doc(hidden)]
46    pub const WEBGPU_FEATURE_INDIRECT_FIRST_INSTANCE: u64 = 1 << 8;
47
48    #[doc(hidden)]
49    pub const WEBGPU_FEATURE_SHADER_F16: u64 = 1 << 9;
50
51    #[doc(hidden)]
52    pub const WEBGPU_FEATURE_RG11B10UFLOAT_RENDERABLE: u64 = 1 << 10;
53
54    #[doc(hidden)]
55    pub const WEBGPU_FEATURE_BGRA8UNORM_STORAGE: u64 = 1 << 11;
56
57    #[doc(hidden)]
58    pub const WEBGPU_FEATURE_FLOAT32_FILTERABLE: u64 = 1 << 12;
59
60    #[doc(hidden)]
61    pub const WEBGPU_FEATURE_DUAL_SOURCE_BLENDING: u64 = 1 << 13;
62
63    #[doc(hidden)]
64    pub const WEBGPU_FEATURE_CLIP_DISTANCES: u64 = 1 << 14;
65}
66
67macro_rules! bitflags_array_impl {
68    ($impl_name:ident $inner_name:ident $name:ident $op:tt $($struct_names:ident)*) => (
69        impl core::ops::$impl_name for $name {
70            type Output = Self;
71
72            #[inline]
73            fn $inner_name(self, other: Self) -> Self {
74                Self {
75                    $($struct_names: self.$struct_names $op other.$struct_names,)*
76                }
77            }
78        }
79    )
80}
81
82macro_rules! bitflags_array_impl_assign {
83    ($impl_name:ident $inner_name:ident $name:ident $op:tt $($struct_names:ident)*) => (
84        impl core::ops::$impl_name for $name {
85            #[inline]
86            fn $inner_name(&mut self, other: Self) {
87                $(self.$struct_names $op other.$struct_names;)*
88            }
89        }
90    )
91}
92
93macro_rules! bit_array_impl {
94    ($impl_name:ident $inner_name:ident $name:ident $op:tt) => (
95        impl core::ops::$impl_name for $name {
96            type Output = Self;
97
98            #[inline]
99            fn $inner_name(mut self, other: Self) -> Self {
100                for (inner, other) in self.0.iter_mut().zip(other.0.iter()) {
101                    *inner $op *other;
102                }
103                self
104            }
105        }
106    )
107}
108
109macro_rules! bitflags_independent_two_arg {
110    ($(#[$meta:meta])* $func_name:ident $($struct_names:ident)*) => (
111        $(#[$meta])*
112        pub const fn $func_name(self, other:Self) -> Self {
113            Self { $($struct_names: self.$struct_names.$func_name(other.$struct_names),)* }
114        }
115    )
116}
117
118// For the most part this macro should not be modified, most configuration should be possible
119// without changing this macro.
120/// Macro for creating sets of bitflags, we need this because there are almost more flags than bits
121/// in a u64, we can't use a u128 because of FFI, and the number of flags is increasing.
122macro_rules! bitflags_array {
123    (
124        $(#[$outer:meta])*
125        pub struct $name:ident: [$T:ty; $Len:expr];
126
127        $(
128            $(#[$bit_outer:meta])*
129            $vis:vis struct $inner_name:ident $lower_inner_name:ident {
130                $(
131                    $(#[$inner:ident $($args:tt)*])*
132                    const $Flag:tt = $value:expr;
133                )*
134            }
135        )*
136    ) => {
137        $(
138            bitflags::bitflags! {
139                $(#[$bit_outer])*
140                $vis struct $inner_name: $T {
141                    $(
142                        $(#[$inner $($args)*])*
143                        const $Flag = $value;
144                    )*
145                }
146            }
147        )*
148
149        $(#[$outer])*
150        pub struct $name {
151            $(
152                #[allow(missing_docs)]
153                $vis $lower_inner_name: $inner_name,
154            )*
155        }
156
157        /// Bits from `Features` in array form
158        #[derive(Default, Copy, Clone, Debug, PartialEq, Eq)]
159        #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
160        pub struct FeatureBits(pub [$T; $Len]);
161
162        bitflags_array_impl! { BitOr bitor $name | $($lower_inner_name)* }
163        bitflags_array_impl! { BitAnd bitand $name & $($lower_inner_name)* }
164        bitflags_array_impl! { BitXor bitxor $name ^ $($lower_inner_name)* }
165        impl core::ops::Not for $name {
166            type Output = Self;
167
168            #[inline]
169            fn not(self) -> Self {
170                Self {
171                   $($lower_inner_name: !self.$lower_inner_name,)*
172                }
173            }
174        }
175        bitflags_array_impl! { Sub sub $name - $($lower_inner_name)* }
176
177        #[cfg(feature = "serde")]
178        impl Serialize for $name {
179            fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
180            where
181                S: serde::Serializer,
182            {
183                bitflags::serde::serialize(self, serializer)
184            }
185        }
186
187        #[cfg(feature = "serde")]
188        impl<'de> Deserialize<'de> for $name {
189            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
190            where
191                D: serde::Deserializer<'de>,
192            {
193                bitflags::serde::deserialize(deserializer)
194            }
195        }
196
197        impl core::fmt::Display for $name {
198            fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
199                let mut iter = self.iter_names();
200                // simple look ahead
201                let mut next = iter.next();
202                while let Some((name, _)) = next {
203                    f.write_str(name)?;
204                    next = iter.next();
205                    if next.is_some() {
206                        f.write_str(" | ")?;
207                    }
208                }
209                Ok(())
210            }
211        }
212
213        bitflags_array_impl_assign! { BitOrAssign bitor_assign $name |= $($lower_inner_name)* }
214        bitflags_array_impl_assign! { BitAndAssign bitand_assign $name &= $($lower_inner_name)* }
215        bitflags_array_impl_assign! { BitXorAssign bitxor_assign $name ^= $($lower_inner_name)* }
216
217        bit_array_impl! { BitOr bitor FeatureBits |= }
218        bit_array_impl! { BitAnd bitand FeatureBits &= }
219        bit_array_impl! { BitXor bitxor FeatureBits ^= }
220
221        impl core::ops::Not for FeatureBits {
222            type Output = Self;
223
224            #[inline]
225            fn not(self) -> Self {
226                let [$($lower_inner_name,)*] = self.0;
227                Self([$(!$lower_inner_name,)*])
228            }
229        }
230
231        #[cfg(feature = "serde")]
232        impl WriteHex for FeatureBits {
233            fn write_hex<W: fmt::Write>(&self, mut writer: W) -> fmt::Result {
234                let [$($lower_inner_name,)*] = self.0;
235                let mut wrote = false;
236                let mut stager = alloc::string::String::with_capacity(size_of::<$T>() * 2);
237                // we don't want to write it if it's just zero as there may be multiple zeros
238                // resulting in something like "00" being written out. We do want to write it if
239                // there has already been something written though.
240                $(if ($lower_inner_name != 0) || wrote {
241                    // First we write to a staging string, then we add any zeros (e.g if #1
242                    // is f and a u8 and #2 is a then the two combined would be f0a which requires
243                    // a 0 inserted)
244                    $lower_inner_name.write_hex(&mut stager)?;
245                    if (stager.len() != size_of::<$T>() * 2) && wrote {
246                        let zeros_to_write = (size_of::<$T>() * 2) - stager.len();
247                        for _ in 0..zeros_to_write {
248                            writer.write_char('0')?
249                        }
250                    }
251                    writer.write_str(&stager)?;
252                    stager.clear();
253                    wrote = true;
254                })*
255                if !wrote {
256                    writer.write_str("0")?;
257                }
258                Ok(())
259            }
260        }
261
262        #[cfg(feature = "serde")]
263        impl ParseHex for FeatureBits {
264            fn parse_hex(input: &str) -> Result<Self, ParseError> {
265
266                let mut unset = Self::EMPTY;
267                let mut end = input.len();
268                if end == 0 {
269                    return Err(ParseError::empty_flag())
270                }
271                // we iterate starting at the least significant places and going up
272                for (idx, _) in [$(stringify!($lower_inner_name),)*].iter().enumerate().rev() {
273                    // A byte is two hex places - u8 (1 byte) = 0x00 (2 hex places).
274                    let checked_start = end.checked_sub(size_of::<$T>() * 2);
275                    let start = checked_start.unwrap_or(0);
276
277                    let cur_input = &input[start..end];
278                    unset.0[idx] = <$T>::from_str_radix(cur_input, 16)
279                        .map_err(|_|ParseError::invalid_hex_flag(cur_input))?;
280
281                    end = start;
282
283                    if let None = checked_start {
284                        break;
285                    }
286                }
287                Ok(unset)
288            }
289        }
290
291        impl bitflags::Bits for FeatureBits {
292            const EMPTY: Self = $name::empty().bits();
293
294            const ALL: Self = $name::all().bits();
295        }
296
297        impl Flags for $name {
298            const FLAGS: &'static [bitflags::Flag<Self>] = $name::FLAGS;
299
300            type Bits = FeatureBits;
301
302            fn bits(&self) -> FeatureBits {
303                FeatureBits([
304                    $(self.$lower_inner_name.bits(),)*
305                ])
306            }
307
308            fn from_bits_retain(bits: FeatureBits) -> Self {
309                let [$($lower_inner_name,)*] = bits.0;
310                Self {
311                    $($lower_inner_name: $inner_name::from_bits_retain($lower_inner_name),)*
312                }
313            }
314
315            fn empty() -> Self {
316                Self::empty()
317            }
318
319            fn all() -> Self {
320                Self::all()
321            }
322        }
323
324        impl $name {
325            pub(crate) const FLAGS: &'static [bitflags::Flag<Self>] = &[
326                $(
327                    $(
328                        bitflags::Flag::new(stringify!($Flag), $name::$Flag),
329                    )*
330                )*
331            ];
332
333            /// Gets the set flags as a container holding an array of bits.
334            pub const fn bits(&self) -> FeatureBits {
335                FeatureBits([
336                    $(self.$lower_inner_name.bits(),)*
337                ])
338            }
339
340            /// Returns self with no flags set.
341            pub const fn empty() -> Self {
342                Self {
343                    $($lower_inner_name: $inner_name::empty(),)*
344                }
345            }
346
347            /// Returns self with all flags set.
348            pub const fn all() -> Self {
349                Self {
350                    $($lower_inner_name: $inner_name::all(),)*
351                }
352            }
353
354            /// Whether all the bits set in `other` are all set in `self`
355            pub const fn contains(self, other:Self) -> bool {
356                // we need an annoying true to catch the last && >:(
357                $(self.$lower_inner_name.contains(other.$lower_inner_name) &&)* true
358            }
359
360            /// Returns whether any bit set in `self` matched any bit set in `other`.
361            pub const fn intersects(self, other:Self) -> bool {
362                $(self.$lower_inner_name.intersects(other.$lower_inner_name) ||)* false
363            }
364
365            /// Returns whether there is no flag set.
366            pub const fn is_empty(self) -> bool {
367                $(self.$lower_inner_name.is_empty() &&)* true
368            }
369
370            /// Returns whether the struct has all flags set.
371            pub const fn is_all(self) -> bool {
372                $(self.$lower_inner_name.is_all() &&)* true
373            }
374
375            bitflags_independent_two_arg! {
376                /// Bitwise or - `self | other`
377                union $($lower_inner_name)*
378            }
379
380            bitflags_independent_two_arg! {
381                /// Bitwise and - `self & other`
382                intersection $($lower_inner_name)*
383            }
384
385            bitflags_independent_two_arg! {
386                /// Bitwise and of the complement of other - `self & !other`
387                difference $($lower_inner_name)*
388            }
389
390            bitflags_independent_two_arg! {
391                /// Bitwise xor - `self ^ other`
392                symmetric_difference $($lower_inner_name)*
393            }
394
395            /// Bitwise not - `!self`
396            pub const fn complement(self) -> Self {
397                Self {
398                    $($lower_inner_name: self.$lower_inner_name.complement(),)*
399                }
400            }
401
402            /// Calls [`Self::insert`] if `set` is true and otherwise calls [`Self::remove`].
403            pub fn set(&mut self, other:Self, set: bool) {
404                $(self.$lower_inner_name.set(other.$lower_inner_name, set);)*
405            }
406
407            /// Inserts specified flag(s) into self
408            pub fn insert(&mut self, other:Self) {
409                $(self.$lower_inner_name.insert(other.$lower_inner_name);)*
410            }
411
412            /// Removes specified flag(s) from self
413            pub fn remove(&mut self, other:Self) {
414                $(self.$lower_inner_name.remove(other.$lower_inner_name);)*
415            }
416
417            /// Toggles specified flag(s) in self
418            pub fn toggle(&mut self, other:Self) {
419                $(self.$lower_inner_name.toggle(other.$lower_inner_name);)*
420            }
421
422            /// Takes in [`FeatureBits`] and returns None if there are invalid bits or otherwise Self with
423            /// those bits set
424            pub const fn from_bits(bits:FeatureBits) -> Option<Self> {
425                let [$($lower_inner_name,)*] = bits.0;
426                // The ? operator does not work in a const context.
427                Some(Self {
428                    $(
429                        $lower_inner_name: match $inner_name::from_bits($lower_inner_name) {
430                            Some(some) => some,
431                            None => return None,
432                        },
433                    )*
434                })
435            }
436
437            /// Takes in [`FeatureBits`] and returns Self with only valid bits (all other bits removed)
438            pub const fn from_bits_truncate(bits:FeatureBits) -> Self {
439                let [$($lower_inner_name,)*] = bits.0;
440                Self { $($lower_inner_name: $inner_name::from_bits_truncate($lower_inner_name),)* }
441            }
442
443            /// Takes in [`FeatureBits`] and returns Self with all bits that were set without removing
444            /// invalid bits
445            pub const fn from_bits_retain(bits:FeatureBits) -> Self {
446                let [$($lower_inner_name,)*] = bits.0;
447                Self { $($lower_inner_name: $inner_name::from_bits_retain($lower_inner_name),)* }
448            }
449
450            /// Takes in a name and returns Self if it matches or none if the name does not match
451            /// the name of any of the flags. Name is capitalisation dependent.
452            pub fn from_name(name: &str) -> Option<Self> {
453                match name {
454                    $(
455                        $(
456                            stringify!($Flag) => Some(Self::$Flag),
457                        )*
458                    )*
459                    _ => None,
460                }
461            }
462
463            /// Combines the features from the internal flags into the entire features struct
464            pub fn from_internal_flags($($lower_inner_name: $inner_name,)*) -> Self {
465                Self {
466                    $($lower_inner_name,)*
467                }
468            }
469
470            /// Returns an iterator over the set flags.
471            pub const fn iter(&self) -> bitflags::iter::Iter<$name> {
472                bitflags::iter::Iter::__private_const_new($name::FLAGS, *self, *self)
473            }
474
475            /// Returns an iterator over the set flags and their names.
476            pub const fn iter_names(&self) -> bitflags::iter::IterNames<$name> {
477                bitflags::iter::IterNames::__private_const_new($name::FLAGS, *self, *self)
478            }
479
480            $(
481                $(
482                    $(#[$inner $($args)*])*
483                    // We need this for structs with only a member.
484                    #[allow(clippy::needless_update)]
485                    pub const $Flag: Self = Self {
486                        $lower_inner_name: $inner_name::from_bits_truncate($value),
487                        ..Self::empty()
488                    };
489                )*
490            )*
491        }
492
493        $(
494            impl From<$inner_name> for Features {
495                // We need this for structs with only a member.
496                #[allow(clippy::needless_update)]
497                fn from($lower_inner_name: $inner_name) -> Self {
498                    Self {
499                        $lower_inner_name,
500                        ..Self::empty()
501                    }
502                }
503            }
504        )*
505    };
506}
507
508impl From<FeatureBits> for Features {
509    fn from(value: FeatureBits) -> Self {
510        Self::from_bits_retain(value)
511    }
512}
513
514impl From<Features> for FeatureBits {
515    fn from(value: Features) -> Self {
516        value.bits()
517    }
518}
519
520bitflags_array! {
521    /// Features that are not guaranteed to be supported.
522    ///
523    /// These are either part of the webgpu standard, or are extension features supported by
524    /// wgpu when targeting native.
525    ///
526    /// If you want to use a feature, you need to first verify that the adapter supports
527    /// the feature. If the adapter does not support the feature, requesting a device with it enabled
528    /// will panic.
529    ///
530    /// Corresponds to [WebGPU `GPUFeatureName`](
531    /// https://gpuweb.github.io/gpuweb/#enumdef-gpufeaturename).
532    #[repr(C)]
533    #[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Hash)]
534    pub struct Features: [u64; 2];
535
536    /// Features that are not guaranteed to be supported.
537    ///
538    /// These are extension features supported by wgpu when targeting native. For all features see [`Features`]
539    ///
540    /// If you want to use a feature, you need to first verify that the adapter supports
541    /// the feature. If the adapter does not support the feature, requesting a device with it enabled
542    /// will panic.
543    ///
544    /// Corresponds to [WebGPU `GPUFeatureName`](
545    /// https://gpuweb.github.io/gpuweb/#enumdef-gpufeaturename).
546    #[repr(transparent)]
547    #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
548    #[cfg_attr(feature = "serde", serde(transparent))]
549    #[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Hash)]
550    pub struct FeaturesWGPU features_wgpu {
551        /// Allows shaders to use f32 atomic load, store, add, sub, and exchange.
552        ///
553        /// Supported platforms:
554        /// - Metal (with MSL 3.0+ and Apple7+/Mac2)
555        /// - Vulkan (with [VK_EXT_shader_atomic_float])
556        ///
557        /// This is a native only feature.
558        ///
559        /// [VK_EXT_shader_atomic_float]: https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_EXT_shader_atomic_float.html
560        const SHADER_FLOAT32_ATOMIC = 1 << 0;
561
562        // The features starting with a ? are features that might become part of the spec or
563        // at the very least we can implement as native features; since they should cover all
564        // possible formats and capabilities across backends.
565        //
566        // ? const FORMATS_TIER_1 = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3837)
567        // ? const RW_STORAGE_TEXTURE_TIER_1 = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3838)
568        // ? const NORM16_FILTERABLE = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3839)
569        // ? const NORM16_RESOLVE = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3839)
570        // ? const FLOAT32_BLENDABLE = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3556)
571        // ? const 32BIT_FORMAT_MULTISAMPLE = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3844)
572        // ? const 32BIT_FORMAT_RESOLVE = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3844)
573        // ? const TEXTURE_COMPRESSION_ASTC_HDR = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3856)
574        // TEXTURE_FORMAT_16BIT_NORM & TEXTURE_COMPRESSION_ASTC_HDR will most likely become web features as well
575        // TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES might not be necessary if we have all the texture features implemented
576
577        // Texture Formats:
578
579        /// Enables normalized `16-bit` texture formats.
580        ///
581        /// Supported platforms:
582        /// - Vulkan
583        /// - DX12
584        /// - Metal
585        ///
586        /// This is a native only feature.
587        const TEXTURE_FORMAT_16BIT_NORM = 1 << 1;
588        /// Enables ASTC HDR family of compressed textures.
589        ///
590        /// Compressed textures sacrifice some quality in exchange for significantly reduced
591        /// bandwidth usage.
592        ///
593        /// Support for this feature guarantees availability of [`TextureUsages::COPY_SRC | TextureUsages::COPY_DST | TextureUsages::TEXTURE_BINDING`] for ASTC formats with the HDR channel type.
594        /// [`Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES`] may enable additional usages.
595        ///
596        /// Supported Platforms:
597        /// - Metal
598        /// - Vulkan
599        /// - OpenGL
600        ///
601        /// This is a native only feature.
602        const TEXTURE_COMPRESSION_ASTC_HDR = 1 << 2;
603        /// Enables device specific texture format features.
604        ///
605        /// See `TextureFormatFeatures` for a listing of the features in question.
606        ///
607        /// By default only texture format properties as defined by the WebGPU specification are allowed.
608        /// Enabling this feature flag extends the features of each format to the ones supported by the current device.
609        /// Note that without this flag, read/write storage access is not allowed at all.
610        ///
611        /// This extension does not enable additional formats.
612        ///
613        /// This is a native only feature.
614        const TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES = 1 << 3;
615
616        // API:
617
618        /// Enables use of Pipeline Statistics Queries. These queries tell the count of various operations
619        /// performed between the start and stop call. Call [`RenderPass::begin_pipeline_statistics_query`] to start
620        /// a query, then call [`RenderPass::end_pipeline_statistics_query`] to stop one.
621        ///
622        /// They must be resolved using [`CommandEncoder::resolve_query_set`] into a buffer.
623        /// The rules on how these resolve into buffers are detailed in the documentation for [`PipelineStatisticsTypes`].
624        ///
625        /// Supported Platforms:
626        /// - Vulkan
627        /// - DX12
628        ///
629        /// This is a native only feature with a [proposal](https://github.com/gpuweb/gpuweb/blob/0008bd30da2366af88180b511a5d0d0c1dffbc36/proposals/pipeline-statistics-query.md) for the web.
630        ///
631        /// [`RenderPass::begin_pipeline_statistics_query`]: https://docs.rs/wgpu/latest/wgpu/struct.RenderPass.html#method.begin_pipeline_statistics_query
632        /// [`RenderPass::end_pipeline_statistics_query`]: https://docs.rs/wgpu/latest/wgpu/struct.RenderPass.html#method.end_pipeline_statistics_query
633        /// [`CommandEncoder::resolve_query_set`]: https://docs.rs/wgpu/latest/wgpu/struct.CommandEncoder.html#method.resolve_query_set
634        /// [`PipelineStatisticsTypes`]: super::PipelineStatisticsTypes
635        const PIPELINE_STATISTICS_QUERY = 1 << 4;
636        /// Allows for timestamp queries directly on command encoders.
637        ///
638        /// Implies [`Features::TIMESTAMP_QUERY`] is supported.
639        ///
640        /// Additionally allows for timestamp writes on command encoders
641        /// using  [`CommandEncoder::write_timestamp`].
642        ///
643        /// Supported platforms:
644        /// - Vulkan
645        /// - DX12
646        /// - Metal
647        ///
648        /// This is a native only feature.
649        ///
650        /// [`CommandEncoder::write_timestamp`]: https://docs.rs/wgpu/latest/wgpu/struct.CommandEncoder.html#method.write_timestamp
651        const TIMESTAMP_QUERY_INSIDE_ENCODERS = 1 << 5;
652        /// Allows for timestamp queries directly on command encoders.
653        ///
654        /// Implies [`Features::TIMESTAMP_QUERY`] & [`Features::TIMESTAMP_QUERY_INSIDE_ENCODERS`] is supported.
655        ///
656        /// Additionally allows for timestamp queries to be used inside render & compute passes using:
657        /// - [`RenderPass::write_timestamp`]
658        /// - [`ComputePass::write_timestamp`]
659        ///
660        /// Supported platforms:
661        /// - Vulkan
662        /// - DX12
663        /// - Metal (AMD & Intel, not Apple GPUs)
664        ///
665        /// This is generally not available on tile-based rasterization GPUs.
666        ///
667        /// 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.
668        ///
669        /// [`RenderPass::write_timestamp`]: https://docs.rs/wgpu/latest/wgpu/struct.RenderPass.html#method.write_timestamp
670        /// [`ComputePass::write_timestamp`]: https://docs.rs/wgpu/latest/wgpu/struct.ComputePass.html#method.write_timestamp
671        const TIMESTAMP_QUERY_INSIDE_PASSES = 1 << 6;
672        /// Webgpu only allows the MAP_READ and MAP_WRITE buffer usage to be matched with
673        /// COPY_DST and COPY_SRC respectively. This removes this requirement.
674        ///
675        /// This is only beneficial on systems that share memory between CPU and GPU. If enabled
676        /// on a system that doesn't, this can severely hinder performance. Only use if you understand
677        /// the consequences.
678        ///
679        /// Supported platforms:
680        /// - Vulkan
681        /// - DX12
682        /// - Metal
683        ///
684        /// This is a native only feature.
685        const MAPPABLE_PRIMARY_BUFFERS = 1 << 7;
686        /// Allows the user to create uniform arrays of textures in shaders:
687        ///
688        /// ex.
689        /// - `var textures: binding_array<texture_2d<f32>, 10>` (WGSL)
690        /// - `uniform texture2D textures[10]` (GLSL)
691        ///
692        /// If [`Features::STORAGE_RESOURCE_BINDING_ARRAY`] is supported as well as this, the user
693        /// may also create uniform arrays of storage textures.
694        ///
695        /// ex.
696        /// - `var textures: array<texture_storage_2d<r32float, write>, 10>` (WGSL)
697        /// - `uniform image2D textures[10]` (GLSL)
698        ///
699        /// This capability allows them to exist and to be indexed by dynamically uniform
700        /// values.
701        ///
702        /// Supported platforms:
703        /// - DX12
704        /// - Metal (with MSL 2.0+ on macOS 10.13+)
705        /// - Vulkan
706        ///
707        /// This is a native only feature.
708        const TEXTURE_BINDING_ARRAY = 1 << 8;
709        /// Allows the user to create arrays of buffers in shaders:
710        ///
711        /// ex.
712        /// - `var<uniform> buffer_array: array<MyBuffer, 10>` (WGSL)
713        /// - `uniform myBuffer { ... } buffer_array[10]` (GLSL)
714        ///
715        /// This capability allows them to exist and to be indexed by dynamically uniform
716        /// values.
717        ///
718        /// If [`Features::STORAGE_RESOURCE_BINDING_ARRAY`] is supported as well as this, the user
719        /// may also create arrays of storage buffers.
720        ///
721        /// ex.
722        /// - `var<storage> buffer_array: array<MyBuffer, 10>` (WGSL)
723        /// - `buffer myBuffer { ... } buffer_array[10]` (GLSL)
724        ///
725        /// Supported platforms:
726        /// - Vulkan
727        ///
728        /// This is a native only feature.
729        const BUFFER_BINDING_ARRAY = 1 << 9;
730        /// Allows the user to create uniform arrays of storage buffers or textures in shaders,
731        /// if resp. [`Features::BUFFER_BINDING_ARRAY`] or [`Features::TEXTURE_BINDING_ARRAY`]
732        /// is supported.
733        ///
734        /// This capability allows them to exist and to be indexed by dynamically uniform
735        /// values.
736        ///
737        /// Supported platforms:
738        /// - Metal (with MSL 2.2+ on macOS 10.13+)
739        /// - Vulkan
740        ///
741        /// This is a native only feature.
742        const STORAGE_RESOURCE_BINDING_ARRAY = 1 << 10;
743        /// Allows shaders to index sampled texture and storage buffer resource arrays with dynamically non-uniform values:
744        ///
745        /// ex. `texture_array[vertex_data]`
746        ///
747        /// In order to use this capability, the corresponding GLSL extension must be enabled like so:
748        ///
749        /// `#extension GL_EXT_nonuniform_qualifier : require`
750        ///
751        /// and then used either as `nonuniformEXT` qualifier in variable declaration:
752        ///
753        /// ex. `layout(location = 0) nonuniformEXT flat in int vertex_data;`
754        ///
755        /// or as `nonuniformEXT` constructor:
756        ///
757        /// ex. `texture_array[nonuniformEXT(vertex_data)]`
758        ///
759        /// WGSL and HLSL do not need any extension.
760        ///
761        /// Supported platforms:
762        /// - DX12
763        /// - Metal (with MSL 2.0+ on macOS 10.13+)
764        /// - Vulkan 1.2+ (or VK_EXT_descriptor_indexing)'s shaderSampledImageArrayNonUniformIndexing & shaderStorageBufferArrayNonUniformIndexing feature)
765        ///
766        /// This is a native only feature.
767        const SAMPLED_TEXTURE_AND_STORAGE_BUFFER_ARRAY_NON_UNIFORM_INDEXING = 1 << 11;
768        /// Allows shaders to index storage texture resource arrays with dynamically non-uniform values:
769        ///
770        /// ex. `texture_array[vertex_data]`
771        ///
772        /// Supported platforms:
773        /// - DX12
774        /// - Metal (with MSL 2.0+ on macOS 10.13+)
775        /// - Vulkan 1.2+ (or VK_EXT_descriptor_indexing)'s shaderStorageTextureArrayNonUniformIndexing feature)
776        ///
777        /// This is a native only feature.
778        const STORAGE_TEXTURE_ARRAY_NON_UNIFORM_INDEXING = 1 << 12;
779        /// Allows the user to create bind groups containing arrays with less bindings than the BindGroupLayout.
780        ///
781        /// Supported platforms:
782        /// - Vulkan
783        /// - DX12
784        ///
785        /// This is a native only feature.
786        const PARTIALLY_BOUND_BINDING_ARRAY = 1 << 13;
787        /// Allows the user to call [`RenderPass::multi_draw_indirect`] and [`RenderPass::multi_draw_indexed_indirect`].
788        ///
789        /// Allows multiple indirect calls to be dispatched from a single buffer.
790        ///
791        /// Natively Supported Platforms:
792        /// - DX12
793        /// - Vulkan
794        ///
795        /// Emulated Platforms:
796        /// - Metal
797        /// - OpenGL
798        /// - WebGPU
799        ///
800        /// Emulation is preformed by looping over the individual indirect draw calls in the backend. This is still significantly
801        /// faster than enulating it yourself, as wgpu only does draw call validation once.
802        ///
803        /// [`RenderPass::multi_draw_indirect`]: ../wgpu/struct.RenderPass.html#method.multi_draw_indirect
804        /// [`RenderPass::multi_draw_indexed_indirect`]: ../wgpu/struct.RenderPass.html#method.multi_draw_indexed_indirect
805        const MULTI_DRAW_INDIRECT = 1 << 14;
806        /// Allows the user to call [`RenderPass::multi_draw_indirect_count`] and [`RenderPass::multi_draw_indexed_indirect_count`].
807        ///
808        /// This allows the use of a buffer containing the actual number of draw calls.
809        ///
810        /// Supported platforms:
811        /// - DX12
812        /// - Vulkan 1.2+ (or VK_KHR_draw_indirect_count)
813        ///
814        /// This is a native only feature.
815        ///
816        /// [`RenderPass::multi_draw_indirect_count`]: ../wgpu/struct.RenderPass.html#method.multi_draw_indirect_count
817        /// [`RenderPass::multi_draw_indexed_indirect_count`]: ../wgpu/struct.RenderPass.html#method.multi_draw_indexed_indirect_count
818        const MULTI_DRAW_INDIRECT_COUNT = 1 << 15;
819        /// Allows the use of push constants: small, fast bits of memory that can be updated
820        /// inside a [`RenderPass`].
821        ///
822        /// Allows the user to call [`RenderPass::set_push_constants`], provide a non-empty array
823        /// to [`PipelineLayoutDescriptor`], and provide a non-zero limit to [`Limits::max_push_constant_size`].
824        ///
825        /// A block of push constants can be declared in WGSL with `var<push_constant>`:
826        ///
827        /// ```rust,ignore
828        /// struct PushConstants { example: f32, }
829        /// var<push_constant> c: PushConstants;
830        /// ```
831        ///
832        /// In GLSL, this corresponds to `layout(push_constant) uniform Name {..}`.
833        ///
834        /// Supported platforms:
835        /// - DX12
836        /// - Vulkan
837        /// - Metal
838        /// - OpenGL (emulated with uniforms)
839        ///
840        /// This is a native only feature.
841        ///
842        /// [`RenderPass`]: ../wgpu/struct.RenderPass.html
843        /// [`PipelineLayoutDescriptor`]: ../wgpu/struct.PipelineLayoutDescriptor.html
844        /// [`RenderPass::set_push_constants`]: ../wgpu/struct.RenderPass.html#method.set_push_constants
845        /// [`Limits::max_push_constant_size`]: super::Limits
846        const PUSH_CONSTANTS = 1 << 16;
847        /// Allows the use of [`AddressMode::ClampToBorder`] with a border color
848        /// of [`SamplerBorderColor::Zero`].
849        ///
850        /// Supported platforms:
851        /// - DX12
852        /// - Vulkan
853        /// - Metal
854        /// - OpenGL
855        ///
856        /// This is a native only feature.
857        ///
858        /// [`AddressMode::ClampToBorder`]: super::AddressMode::ClampToBorder
859        /// [`SamplerBorderColor::Zero`]: super::SamplerBorderColor::Zero
860        const ADDRESS_MODE_CLAMP_TO_ZERO = 1 << 17;
861        /// Allows the use of [`AddressMode::ClampToBorder`] with a border color
862        /// other than [`SamplerBorderColor::Zero`].
863        ///
864        /// Supported platforms:
865        /// - DX12
866        /// - Vulkan
867        /// - Metal (macOS 10.12+ only)
868        /// - OpenGL
869        ///
870        /// This is a native only feature.
871        ///
872        /// [`AddressMode::ClampToBorder`]: super::AddressMode::ClampToBorder
873        /// [`SamplerBorderColor::Zero`]: super::SamplerBorderColor::Zero
874        const ADDRESS_MODE_CLAMP_TO_BORDER = 1 << 18;
875        /// Allows the user to set [`PolygonMode::Line`] in [`PrimitiveState::polygon_mode`]
876        ///
877        /// This allows drawing polygons/triangles as lines (wireframe) instead of filled
878        ///
879        /// Supported platforms:
880        /// - DX12
881        /// - Vulkan
882        /// - Metal
883        ///
884        /// This is a native only feature.
885        ///
886        /// [`PrimitiveState::polygon_mode`]: super::PrimitiveState
887        /// [`PolygonMode::Line`]: super::PolygonMode::Line
888        const POLYGON_MODE_LINE = 1 << 19;
889        /// Allows the user to set [`PolygonMode::Point`] in [`PrimitiveState::polygon_mode`]
890        ///
891        /// This allows only drawing the vertices of polygons/triangles instead of filled
892        ///
893        /// Supported platforms:
894        /// - Vulkan
895        ///
896        /// This is a native only feature.
897        ///
898        /// [`PrimitiveState::polygon_mode`]: super::PrimitiveState
899        /// [`PolygonMode::Point`]: super::PolygonMode::Point
900        const POLYGON_MODE_POINT = 1 << 20;
901        /// Allows the user to set a overestimation-conservative-rasterization in [`PrimitiveState::conservative`]
902        ///
903        /// Processing of degenerate triangles/lines is hardware specific.
904        /// Only triangles are supported.
905        ///
906        /// Supported platforms:
907        /// - Vulkan
908        ///
909        /// This is a native only feature.
910        ///
911        /// [`PrimitiveState::conservative`]: super::PrimitiveState::conservative
912        const CONSERVATIVE_RASTERIZATION = 1 << 21;
913        /// Enables bindings of writable storage buffers and textures visible to vertex shaders.
914        ///
915        /// Note: some (tiled-based) platforms do not support vertex shaders with any side-effects.
916        ///
917        /// Supported Platforms:
918        /// - All
919        ///
920        /// This is a native only feature.
921        const VERTEX_WRITABLE_STORAGE = 1 << 22;
922        /// Enables clear to zero for textures.
923        ///
924        /// Supported platforms:
925        /// - All
926        ///
927        /// This is a native only feature.
928        const CLEAR_TEXTURE = 1 << 23;
929        /// Enables creating shader modules from Metal MSL computer shaders (unsafe).
930        ///
931        /// Metal data is not parsed or interpreted in any way
932        ///
933        /// Supported platforms:
934        /// - Metal
935        ///
936        /// This is a native only feature.
937        const MSL_SHADER_PASSTHROUGH = 1 << 24;
938        /// Enables creating shader modules from SPIR-V binary data (unsafe).
939        ///
940        /// SPIR-V data is not parsed or interpreted in any way; you can use
941        /// [`wgpu::make_spirv_raw!`] to check for alignment and magic number when converting from
942        /// raw bytes.
943        ///
944        /// Supported platforms:
945        /// - Vulkan, in case shader's requested capabilities and extensions agree with
946        /// Vulkan implementation.
947        ///
948        /// This is a native only feature.
949        ///
950        /// [`wgpu::make_spirv_raw!`]: https://docs.rs/wgpu/latest/wgpu/macro.include_spirv_raw.html
951        const SPIRV_SHADER_PASSTHROUGH = 1 << 25;
952        /// Enables multiview render passes and `builtin(view_index)` in vertex shaders.
953        ///
954        /// Supported platforms:
955        /// - Vulkan
956        /// - OpenGL (web only)
957        ///
958        /// This is a native only feature.
959        const MULTIVIEW = 1 << 26;
960        /// Enables using 64-bit types for vertex attributes.
961        ///
962        /// Requires SHADER_FLOAT64.
963        ///
964        /// Supported Platforms: N/A
965        ///
966        /// This is a native only feature.
967        const VERTEX_ATTRIBUTE_64BIT = 1 << 27;
968        /// Enables image atomic fetch add, and, xor, or, min, and max for R32Uint and R32Sint textures.
969        ///
970        /// Supported platforms:
971        /// - Vulkan
972        /// - DX12
973        /// - Metal (with MSL 3.1+)
974        ///
975        /// This is a native only feature.
976        const TEXTURE_ATOMIC = 1 << 28;
977        /// Allows for creation of textures of format [`TextureFormat::NV12`]
978        ///
979        /// Supported platforms:
980        /// - DX12
981        /// - Vulkan
982        ///
983        /// This is a native only feature.
984        ///
985        /// [`TextureFormat::NV12`]: super::TextureFormat::NV12
986        const TEXTURE_FORMAT_NV12 = 1 << 29;
987
988        /// Allows for the creation and usage of `ExternalTexture`s, and bind
989        /// group layouts containing external texture `BindingType`s.
990        ///
991        /// Conceptually this should really be a [`crate::DownlevelFlags`] as
992        /// it corresponds to WebGPU's [`GPUExternalTexture`](
993        /// https://www.w3.org/TR/webgpu/#gpuexternaltexture).
994        /// However, the implementation is currently in-progress, and until it
995        /// is complete we do not want applications to ignore adapters due to
996        /// a missing downlevel flag, when they may not require this feature at
997        /// all.
998        ///
999        /// Supported platforms:
1000        /// - None
1001        const EXTERNAL_TEXTURE = 1 << 30;
1002
1003        // Shader:
1004
1005        /// ***THIS IS EXPERIMENTAL:*** Features enabled by this may have
1006        /// major bugs in it and are expected to be subject to breaking changes, suggestions
1007        /// for the API exposed by this should be posted on [the ray-tracing issue](https://github.com/gfx-rs/wgpu/issues/1040)
1008        ///
1009        /// Allows for the creation of ray-tracing queries within shaders.
1010        ///
1011        /// Supported platforms:
1012        /// - Vulkan
1013        ///
1014        /// This is a native-only feature.
1015        const EXPERIMENTAL_RAY_QUERY = 1 << 31;
1016        /// Enables 64-bit floating point types in SPIR-V shaders.
1017        ///
1018        /// Note: even when supported by GPU hardware, 64-bit floating point operations are
1019        /// frequently between 16 and 64 _times_ slower than equivalent operations on 32-bit floats.
1020        ///
1021        /// Supported Platforms:
1022        /// - Vulkan
1023        ///
1024        /// This is a native only feature.
1025        const SHADER_F64 = 1 << 32;
1026        /// Allows shaders to use i16. Not currently supported in `naga`, only available through `spirv-passthrough`.
1027        ///
1028        /// Supported platforms:
1029        /// - Vulkan
1030        ///
1031        /// This is a native only feature.
1032        const SHADER_I16 = 1 << 33;
1033        /// Enables `builtin(primitive_index)` in fragment shaders.
1034        ///
1035        /// Note: enables geometry processing for pipelines using the builtin.
1036        /// This may come with a significant performance impact on some hardware.
1037        /// Other pipelines are not affected.
1038        ///
1039        /// Supported platforms:
1040        /// - Vulkan
1041        /// - DX12
1042        /// - Metal (some)
1043        /// - OpenGL (some)
1044        ///
1045        /// This is a native only feature.
1046        const SHADER_PRIMITIVE_INDEX = 1 << 34;
1047        /// Allows shaders to use the `early_depth_test` attribute.
1048        ///
1049        /// The attribute is applied to the fragment shader entry point. It can be used in two
1050        /// ways:
1051        ///
1052        ///   1. Force early depth/stencil tests:
1053        ///
1054        ///      - `@early_depth_test(force)` (WGSL)
1055        ///
1056        ///      - `layout(early_fragment_tests) in;` (GLSL)
1057        ///
1058        ///   2. Provide a conservative depth specifier that allows an additional early
1059        ///      depth test under certain conditions:
1060        ///
1061        ///      - `@early_depth_test(greater_equal/less_equal/unchanged)` (WGSL)
1062        ///
1063        ///      - `layout(depth_<greater/less/unchanged>) out float gl_FragDepth;` (GLSL)
1064        ///
1065        /// See [`EarlyDepthTest`] for more details.
1066        ///
1067        /// Supported platforms:
1068        /// - Vulkan
1069        /// - GLES 3.1+
1070        ///
1071        /// This is a native only feature.
1072        ///
1073        /// [`EarlyDepthTest`]: https://docs.rs/naga/latest/naga/ir/enum.EarlyDepthTest.html
1074        const SHADER_EARLY_DEPTH_TEST = 1 << 35;
1075        /// Allows shaders to use i64 and u64.
1076        ///
1077        /// Supported platforms:
1078        /// - Vulkan
1079        /// - DX12 (DXC only)
1080        /// - Metal (with MSL 2.3+)
1081        ///
1082        /// This is a native only feature.
1083        const SHADER_INT64 = 1 << 36;
1084        /// Allows compute and fragment shaders to use the subgroup operation built-ins
1085        ///
1086        /// Supported Platforms:
1087        /// - Vulkan
1088        /// - DX12
1089        /// - Metal
1090        ///
1091        /// This is a native only feature.
1092        const SUBGROUP = 1 << 37;
1093        /// Allows vertex shaders to use the subgroup operation built-ins
1094        ///
1095        /// Supported Platforms:
1096        /// - Vulkan
1097        ///
1098        /// This is a native only feature.
1099        const SUBGROUP_VERTEX = 1 << 38;
1100        /// Allows shaders to use the subgroup barrier
1101        ///
1102        /// Supported Platforms:
1103        /// - Vulkan
1104        /// - Metal
1105        ///
1106        /// This is a native only feature.
1107        const SUBGROUP_BARRIER = 1 << 39;
1108        /// Allows the use of pipeline cache objects
1109        ///
1110        /// Supported platforms:
1111        /// - Vulkan
1112        ///
1113        /// Unimplemented Platforms:
1114        /// - DX12
1115        /// - Metal
1116        const PIPELINE_CACHE = 1 << 40;
1117        /// Allows shaders to use i64 and u64 atomic min and max.
1118        ///
1119        /// Supported platforms:
1120        /// - Vulkan (with VK_KHR_shader_atomic_int64)
1121        /// - DX12 (with SM 6.6+)
1122        /// - Metal (with MSL 2.4+)
1123        ///
1124        /// This is a native only feature.
1125        const SHADER_INT64_ATOMIC_MIN_MAX = 1 << 41;
1126        /// Allows shaders to use all i64 and u64 atomic operations.
1127        ///
1128        /// Supported platforms:
1129        /// - Vulkan (with VK_KHR_shader_atomic_int64)
1130        /// - DX12 (with SM 6.6+)
1131        ///
1132        /// This is a native only feature.
1133        const SHADER_INT64_ATOMIC_ALL_OPS = 1 << 42;
1134        /// Allows using the [VK_GOOGLE_display_timing] Vulkan extension.
1135        ///
1136        /// This is used for frame pacing to reduce latency, and is generally only available on Android.
1137        ///
1138        /// This feature does not have a `wgpu`-level API, and so users of wgpu wishing
1139        /// to use this functionality must access it using various `as_hal` functions,
1140        /// primarily [`Surface::as_hal()`], to then use.
1141        ///
1142        /// Supported platforms:
1143        /// - Vulkan (with [VK_GOOGLE_display_timing])
1144        ///
1145        /// This is a native only feature.
1146        ///
1147        /// [VK_GOOGLE_display_timing]: https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_GOOGLE_display_timing.html
1148        /// [`Surface::as_hal()`]: https://docs.rs/wgpu/latest/wgpu/struct.Surface.html#method.as_hal
1149        const VULKAN_GOOGLE_DISPLAY_TIMING = 1 << 43;
1150
1151        /// Allows using the [VK_KHR_external_memory_win32] Vulkan extension.
1152        ///
1153        /// Supported platforms:
1154        /// - Vulkan (with [VK_KHR_external_memory_win32])
1155        ///
1156        /// This is a native only feature.
1157        ///
1158        /// [VK_KHR_external_memory_win32]: https://registry.khronos.org/vulkan/specs/latest/man/html/VK_KHR_external_memory_win32.html
1159        const VULKAN_EXTERNAL_MEMORY_WIN32 = 1 << 44;
1160
1161        /// Enables R64Uint image atomic min and max.
1162        ///
1163        /// Supported platforms:
1164        /// - Vulkan (with VK_EXT_shader_image_atomic_int64)
1165        /// - DX12 (with SM 6.6+)
1166        /// - Metal (with MSL 3.1+)
1167        ///
1168        /// This is a native only feature.
1169        const TEXTURE_INT64_ATOMIC = 1 << 45;
1170
1171        /// Allows uniform buffers to be bound as binding arrays.
1172        ///
1173        /// This allows:
1174        /// - Shaders to contain `var<uniform> buffer: binding_array<UniformBuffer>;`
1175        /// - The `count` field of `BindGroupLayoutEntry`s with `Uniform` buffers, to be set to `Some`.
1176        ///
1177        /// Supported platforms:
1178        /// - None (<https://github.com/gfx-rs/wgpu/issues/7149>)
1179        ///
1180        /// Potential Platforms:
1181        /// - DX12
1182        /// - Metal
1183        /// - Vulkan 1.2+ (or VK_EXT_descriptor_indexing)'s `shaderUniformBufferArrayNonUniformIndexing` feature)
1184        ///
1185        /// This is a native only feature.
1186        const UNIFORM_BUFFER_BINDING_ARRAYS = 1 << 46;
1187
1188        /// Enables mesh shaders and task shaders in mesh shader pipelines.
1189        ///
1190        /// Supported platforms:
1191        /// - Vulkan (with [VK_EXT_mesh_shader](https://registry.khronos.org/vulkan/specs/latest/man/html/VK_EXT_mesh_shader.html))
1192        ///
1193        /// Potential Platforms:
1194        /// - DX12
1195        /// - Metal
1196        ///
1197        /// This is a native only feature.
1198        const EXPERIMENTAL_MESH_SHADER = 1 << 47;
1199
1200        /// ***THIS IS EXPERIMENTAL:*** Features enabled by this may have
1201        /// major bugs in them and are expected to be subject to breaking changes, suggestions
1202        /// for the API exposed by this should be posted on [the ray-tracing issue](https://github.com/gfx-rs/wgpu/issues/6762)
1203        ///
1204        /// Allows for returning of the hit triangle's vertex position when tracing with an
1205        /// acceleration structure marked with [`AccelerationStructureFlags::ALLOW_RAY_HIT_VERTEX_RETURN`].
1206        ///
1207        /// Supported platforms:
1208        /// - Vulkan
1209        ///
1210        /// This is a native only feature
1211        ///
1212        /// [`AccelerationStructureFlags::ALLOW_RAY_HIT_VERTEX_RETURN`]: super::AccelerationStructureFlags::ALLOW_RAY_HIT_VERTEX_RETURN
1213        const EXPERIMENTAL_RAY_HIT_VERTEX_RETURN = 1 << 48;
1214
1215        /// Enables multiview in mesh shader pipelines
1216        ///
1217        /// Supported platforms:
1218        /// - Vulkan (with [VK_EXT_mesh_shader](https://registry.khronos.org/vulkan/specs/latest/man/html/VK_EXT_mesh_shader.html))
1219        ///
1220        /// Potential Platforms:
1221        /// - DX12
1222        /// - Metal
1223        ///
1224        /// This is a native only feature.
1225        const EXPERIMENTAL_MESH_SHADER_MULTIVIEW = 1 << 49;
1226
1227        /// Allows usage of additional vertex formats in [BlasTriangleGeometrySizeDescriptor::vertex_format]
1228        ///
1229        /// Supported platforms
1230        /// - Vulkan
1231        /// - DX12
1232        ///
1233        /// [BlasTriangleGeometrySizeDescriptor::vertex_format]: super::BlasTriangleGeometrySizeDescriptor
1234        const EXTENDED_ACCELERATION_STRUCTURE_VERTEX_FORMATS = 1 << 50;
1235
1236        /// Enables creating shader modules from DirectX HLSL or DXIL shaders (unsafe)
1237        ///
1238        /// HLSL/DXIL data is not parsed or interpreted in any way
1239        ///
1240        /// Supported platforms:
1241        /// - DX12
1242        ///
1243        /// This is a native only feature.
1244        const HLSL_DXIL_SHADER_PASSTHROUGH = 1 << 51;
1245    }
1246
1247    /// Features that are not guaranteed to be supported.
1248    ///
1249    /// These are part of the webgpu standard. For all features see [`Features`]
1250    ///
1251    /// If you want to use a feature, you need to first verify that the adapter supports
1252    /// the feature. If the adapter does not support the feature, requesting a device with it enabled
1253    /// will panic.
1254    ///
1255    /// Corresponds to [WebGPU `GPUFeatureName`](
1256    /// https://gpuweb.github.io/gpuweb/#enumdef-gpufeaturename).
1257    #[repr(transparent)]
1258    #[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
1259    #[cfg_attr(feature = "serde", serde(transparent))]
1260    #[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Hash)]
1261    pub struct FeaturesWebGPU features_webgpu {
1262        // API:
1263
1264        /// By default, polygon depth is clipped to 0-1 range before/during rasterization.
1265        /// Anything outside of that range is rejected, and respective fragments are not touched.
1266        ///
1267        /// With this extension, we can disabling clipping. That allows
1268        /// shadow map occluders to be rendered into a tighter depth range.
1269        ///
1270        /// Supported platforms:
1271        /// - desktops
1272        /// - some mobile chips
1273        ///
1274        /// This is a web and native feature.
1275        const DEPTH_CLIP_CONTROL = WEBGPU_FEATURE_DEPTH_CLIP_CONTROL;
1276
1277        /// Allows for explicit creation of textures of format [`TextureFormat::Depth32FloatStencil8`]
1278        ///
1279        /// Supported platforms:
1280        /// - Vulkan (mostly)
1281        /// - DX12
1282        /// - Metal
1283        /// - OpenGL
1284        ///
1285        /// This is a web and native feature.
1286        ///
1287        /// [`TextureFormat::Depth32FloatStencil8`]: super::TextureFormat::Depth32FloatStencil8
1288        const DEPTH32FLOAT_STENCIL8 = WEBGPU_FEATURE_DEPTH32FLOAT_STENCIL8;
1289
1290        /// Enables BCn family of compressed textures. All BCn textures use 4x4 pixel blocks
1291        /// with 8 or 16 bytes per block.
1292        ///
1293        /// Compressed textures sacrifice some quality in exchange for significantly reduced
1294        /// bandwidth usage.
1295        ///
1296        /// Support for this feature guarantees availability of [`TextureUsages::COPY_SRC | TextureUsages::COPY_DST | TextureUsages::TEXTURE_BINDING`] for BCn formats.
1297        /// [`Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES`] may enable additional usages.
1298        ///
1299        /// This feature guarantees availability of sliced-3d textures for BC formats when combined with TEXTURE_COMPRESSION_BC_SLICED_3D.
1300        ///
1301        /// Supported Platforms:
1302        /// - desktops
1303        /// - Mobile (All Apple9 and some Apple7 and Apple8 devices)
1304        ///
1305        /// This is a web and native feature.
1306        const TEXTURE_COMPRESSION_BC = WEBGPU_FEATURE_TEXTURE_COMPRESSION_BC;
1307
1308
1309        /// Allows the 3d dimension for textures with BC compressed formats.
1310        ///
1311        /// This feature must be used in combination with TEXTURE_COMPRESSION_BC to enable 3D textures with BC compression.
1312        /// It does not enable the BC formats by itself.
1313        ///
1314        /// Supported Platforms:
1315        /// - desktops
1316        /// - Mobile (All Apple9 and some Apple7 and Apple8 devices)
1317        ///
1318        /// This is a web and native feature.
1319        const TEXTURE_COMPRESSION_BC_SLICED_3D = WEBGPU_FEATURE_TEXTURE_COMPRESSION_BC_SLICED_3D;
1320
1321        /// Enables ETC family of compressed textures. All ETC textures use 4x4 pixel blocks.
1322        /// ETC2 RGB and RGBA1 are 8 bytes per block. RTC2 RGBA8 and EAC are 16 bytes per block.
1323        ///
1324        /// Compressed textures sacrifice some quality in exchange for significantly reduced
1325        /// bandwidth usage.
1326        ///
1327        /// Support for this feature guarantees availability of [`TextureUsages::COPY_SRC | TextureUsages::COPY_DST | TextureUsages::TEXTURE_BINDING`] for ETC2 formats.
1328        /// [`Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES`] may enable additional usages.
1329        ///
1330        /// Supported Platforms:
1331        /// - Vulkan on Intel
1332        /// - Mobile (some)
1333        ///
1334        /// This is a web and native feature.
1335        const TEXTURE_COMPRESSION_ETC2 = WEBGPU_FEATURE_TEXTURE_COMPRESSION_ETC2;
1336
1337        /// Enables ASTC family of compressed textures. ASTC textures use pixel blocks varying from 4x4 to 12x12.
1338        /// Blocks are always 16 bytes.
1339        ///
1340        /// Compressed textures sacrifice some quality in exchange for significantly reduced
1341        /// bandwidth usage.
1342        ///
1343        /// Support for this feature guarantees availability of [`TextureUsages::COPY_SRC | TextureUsages::COPY_DST | TextureUsages::TEXTURE_BINDING`] for ASTC formats with Unorm/UnormSrgb channel type.
1344        /// [`Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES`] may enable additional usages.
1345        ///
1346        /// This feature does not guarantee availability of sliced 3d textures for ASTC formats.
1347        /// If available, 3d support can be enabled by TEXTURE_COMPRESSION_ASTC_SLICED_3D feature.
1348        ///
1349        /// Supported Platforms:
1350        /// - Vulkan on Intel
1351        /// - Mobile (some)
1352        ///
1353        /// This is a web and native feature.
1354        const TEXTURE_COMPRESSION_ASTC = WEBGPU_FEATURE_TEXTURE_COMPRESSION_ASTC;
1355
1356
1357        /// Allows the 3d dimension for textures with ASTC compressed formats.
1358        ///
1359        /// This feature must be used in combination with TEXTURE_COMPRESSION_ASTC to enable 3D textures with ASTC compression.
1360        /// It does not enable the ASTC formats by itself.
1361        ///
1362        /// Supported Platforms:
1363        /// - Vulkan (some)
1364        /// - Metal on Apple3+
1365        /// - OpenGL/WebGL (some)
1366        ///
1367        /// Not Supported:
1368        /// - DX12
1369        ///
1370        /// This is a web and native feature.
1371        const TEXTURE_COMPRESSION_ASTC_SLICED_3D = WEBGPU_FEATURE_TEXTURE_COMPRESSION_ASTC_SLICED_3D;
1372
1373        /// Enables use of Timestamp Queries. These queries tell the current gpu timestamp when
1374        /// all work before the query is finished.
1375        ///
1376        /// This feature allows the use of
1377        /// - [`RenderPassDescriptor::timestamp_writes`]
1378        /// - [`ComputePassDescriptor::timestamp_writes`]
1379        /// to write out timestamps.
1380        ///
1381        /// For arbitrary timestamp write commands on encoders refer to [`Features::TIMESTAMP_QUERY_INSIDE_ENCODERS`].
1382        /// For arbitrary timestamp write commands on passes refer to [`Features::TIMESTAMP_QUERY_INSIDE_PASSES`].
1383        ///
1384        /// They must be resolved using [`CommandEncoder::resolve_query_set`] into a buffer,
1385        /// then the result must be multiplied by the timestamp period [`Queue::get_timestamp_period`]
1386        /// to get the timestamp in nanoseconds. Multiple timestamps can then be diffed to get the
1387        /// time for operations between them to finish.
1388        ///
1389        /// Supported Platforms:
1390        /// - Vulkan
1391        /// - DX12
1392        /// - Metal
1393        ///
1394        /// This is a web and native feature.
1395        ///
1396        /// [`RenderPassDescriptor::timestamp_writes`]: https://docs.rs/wgpu/latest/wgpu/struct.RenderPassDescriptor.html#structfield.timestamp_writes
1397        /// [`ComputePassDescriptor::timestamp_writes`]: https://docs.rs/wgpu/latest/wgpu/struct.ComputePassDescriptor.html#structfield.timestamp_writes
1398        /// [`CommandEncoder::resolve_query_set`]: https://docs.rs/wgpu/latest/wgpu/struct.CommandEncoder.html#method.resolve_query_set
1399        /// [`Queue::get_timestamp_period`]: https://docs.rs/wgpu/latest/wgpu/struct.Queue.html#method.get_timestamp_period
1400        const TIMESTAMP_QUERY = WEBGPU_FEATURE_TIMESTAMP_QUERY;
1401
1402        /// Allows non-zero value for the `first_instance` member in indirect draw calls.
1403        ///
1404        /// If this feature is not enabled, and the `first_instance` member is non-zero, the behavior may be:
1405        /// - The draw call is ignored.
1406        /// - The draw call is executed as if the `first_instance` is zero.
1407        /// - The draw call is executed with the correct `first_instance` value.
1408        ///
1409        /// Supported Platforms:
1410        /// - Vulkan (mostly)
1411        /// - DX12
1412        /// - Metal on Apple3+ or Mac1+
1413        /// - OpenGL (Desktop 4.2+ with ARB_shader_draw_parameters only)
1414        ///
1415        /// Not Supported:
1416        /// - OpenGL ES / WebGL
1417        ///
1418        /// This is a web and native feature.
1419        const INDIRECT_FIRST_INSTANCE = WEBGPU_FEATURE_INDIRECT_FIRST_INSTANCE;
1420
1421        /// Allows shaders to use 16-bit floating point types. You may use them uniform buffers,
1422        /// storage buffers, and local variables. You may not use them in push constants.
1423        ///
1424        /// In order to use this in WGSL shaders, you must add `enable f16;` to the top of your shader,
1425        /// before any global items.
1426        ///
1427        /// Supported Platforms:
1428        /// - Vulkan
1429        /// - Metal
1430        /// - DX12
1431        ///
1432        /// This is a web and native feature.
1433        const SHADER_F16 = WEBGPU_FEATURE_SHADER_F16;
1434
1435        /// Allows for usage of textures of format [`TextureFormat::Rg11b10Ufloat`] as a render target
1436        ///
1437        /// Supported platforms:
1438        /// - Vulkan
1439        /// - DX12
1440        /// - Metal
1441        ///
1442        /// This is a web and native feature.
1443        ///
1444        /// [`TextureFormat::Rg11b10Ufloat`]: super::TextureFormat::Rg11b10Ufloat
1445        const RG11B10UFLOAT_RENDERABLE = WEBGPU_FEATURE_RG11B10UFLOAT_RENDERABLE;
1446
1447        /// Allows the [`TextureUsages::STORAGE_BINDING`] usage on textures with format [`TextureFormat::Bgra8Unorm`]
1448        ///
1449        /// Supported Platforms:
1450        /// - Vulkan
1451        /// - DX12
1452        /// - Metal
1453        ///
1454        /// This is a web and native feature.
1455        ///
1456        /// [`TextureFormat::Bgra8Unorm`]: super::TextureFormat::Bgra8Unorm
1457        /// [`TextureUsages::STORAGE_BINDING`]: super::TextureUsages::STORAGE_BINDING
1458        const BGRA8UNORM_STORAGE = WEBGPU_FEATURE_BGRA8UNORM_STORAGE;
1459
1460
1461        /// Allows textures with formats "r32float", "rg32float", and "rgba32float" to be filterable.
1462        ///
1463        /// Supported Platforms:
1464        /// - Vulkan (mainly on Desktop GPUs)
1465        /// - DX12
1466        /// - Metal on macOS or Apple9+ GPUs, optional on iOS/iPadOS with Apple7/8 GPUs
1467        /// - GL with one of `GL_ARB_color_buffer_float`/`GL_EXT_color_buffer_float`/`OES_texture_float_linear`
1468        ///
1469        /// This is a web and native feature.
1470        const FLOAT32_FILTERABLE = WEBGPU_FEATURE_FLOAT32_FILTERABLE;
1471
1472        /// Allows two outputs from a shader to be used for blending.
1473        /// Note that dual-source blending doesn't support multiple render targets.
1474        ///
1475        /// For more info see the OpenGL ES extension GL_EXT_blend_func_extended.
1476        ///
1477        /// Supported platforms:
1478        /// - OpenGL ES (with GL_EXT_blend_func_extended)
1479        /// - Metal (with MSL 1.2+)
1480        /// - Vulkan (with dualSrcBlend)
1481        /// - DX12
1482        ///
1483        /// This is a web and native feature.
1484        const DUAL_SOURCE_BLENDING = WEBGPU_FEATURE_DUAL_SOURCE_BLENDING;
1485
1486        /// Allows the use of `@builtin(clip_distances)` in WGSL.
1487        ///
1488        /// Supported platforms:
1489        /// - Vulkan (mainly on Desktop GPUs)
1490        /// - GL (Desktop or `GL_EXT_clip_cull_distance`)
1491        ///
1492        /// This is a web and native feature.
1493        const CLIP_DISTANCES = WEBGPU_FEATURE_CLIP_DISTANCES;
1494    }
1495}
1496
1497impl Features {
1498    /// Mask of all features which are part of the upstream WebGPU standard.
1499    #[must_use]
1500    pub const fn all_webgpu_mask() -> Self {
1501        Self::from_bits_truncate(FeatureBits([
1502            FeaturesWGPU::empty().bits(),
1503            FeaturesWebGPU::all().bits(),
1504        ]))
1505    }
1506
1507    /// Mask of all features that are only available when targeting native (not web).
1508    #[must_use]
1509    pub const fn all_native_mask() -> Self {
1510        Self::from_bits_truncate(FeatureBits([
1511            FeaturesWGPU::all().bits(),
1512            FeaturesWebGPU::empty().bits(),
1513        ]))
1514    }
1515
1516    /// Vertex formats allowed for creating and building BLASes
1517    #[must_use]
1518    pub fn allowed_vertex_formats_for_blas(&self) -> Vec<VertexFormat> {
1519        let mut formats = Vec::new();
1520        if self.intersects(Self::EXPERIMENTAL_RAY_QUERY) {
1521            formats.push(VertexFormat::Float32x3);
1522        }
1523        if self.contains(Self::EXTENDED_ACCELERATION_STRUCTURE_VERTEX_FORMATS) {
1524            formats.push(VertexFormat::Float32x2);
1525            formats.push(VertexFormat::Float16x2);
1526            formats.push(VertexFormat::Float16x4);
1527            formats.push(VertexFormat::Snorm16x2);
1528            formats.push(VertexFormat::Snorm16x4);
1529        }
1530        formats
1531    }
1532}
1533
1534#[cfg(test)]
1535mod tests {
1536    use crate::{Features, FeaturesWGPU, FeaturesWebGPU};
1537
1538    #[cfg(feature = "serde")]
1539    #[test]
1540    fn check_hex() {
1541        use crate::FeatureBits;
1542
1543        use bitflags::{
1544            parser::{ParseHex as _, WriteHex as _},
1545            Bits as _,
1546        };
1547
1548        let mut hex = alloc::string::String::new();
1549        FeatureBits::ALL.write_hex(&mut hex).unwrap();
1550        assert_eq!(
1551            FeatureBits::parse_hex(hex.as_str()).unwrap(),
1552            FeatureBits::ALL
1553        );
1554
1555        hex.clear();
1556        FeatureBits::EMPTY.write_hex(&mut hex).unwrap();
1557        assert_eq!(
1558            FeatureBits::parse_hex(hex.as_str()).unwrap(),
1559            FeatureBits::EMPTY
1560        );
1561
1562        for feature in Features::FLAGS {
1563            hex.clear();
1564            feature.value().bits().write_hex(&mut hex).unwrap();
1565            assert_eq!(
1566                FeatureBits::parse_hex(hex.as_str()).unwrap(),
1567                feature.value().bits(),
1568                "{hex}"
1569            );
1570        }
1571    }
1572
1573    #[test]
1574    fn check_features_display() {
1575        use alloc::format;
1576
1577        let feature = Features::CLEAR_TEXTURE;
1578        assert_eq!(format!("{feature}"), "CLEAR_TEXTURE");
1579
1580        let feature = Features::CLEAR_TEXTURE | Features::BGRA8UNORM_STORAGE;
1581        assert_eq!(format!("{feature}"), "CLEAR_TEXTURE | BGRA8UNORM_STORAGE");
1582    }
1583
1584    #[test]
1585    fn check_features_bits() {
1586        let bits = Features::all().bits();
1587        assert_eq!(Features::from_bits_retain(bits), Features::all());
1588
1589        let bits = Features::empty().bits();
1590        assert_eq!(Features::from_bits_retain(bits), Features::empty());
1591
1592        for feature in Features::FLAGS {
1593            let bits = feature.value().bits();
1594            assert_eq!(Features::from_bits_retain(bits), *feature.value());
1595        }
1596
1597        let bits = Features::all().bits();
1598        assert_eq!(Features::from_bits_truncate(bits), Features::all());
1599
1600        let bits = Features::empty().bits();
1601        assert_eq!(Features::from_bits_truncate(bits), Features::empty());
1602
1603        for feature in Features::FLAGS {
1604            let bits = feature.value().bits();
1605            assert_eq!(Features::from_bits_truncate(bits), *feature.value());
1606        }
1607
1608        let bits = Features::all().bits();
1609        assert_eq!(Features::from_bits(bits).unwrap(), Features::all());
1610
1611        let bits = Features::empty().bits();
1612        assert_eq!(Features::from_bits(bits).unwrap(), Features::empty());
1613
1614        for feature in Features::FLAGS {
1615            let bits = feature.value().bits();
1616            assert_eq!(Features::from_bits(bits).unwrap(), *feature.value());
1617        }
1618    }
1619
1620    #[test]
1621    fn create_features_from_parts() {
1622        let features: Features = FeaturesWGPU::TEXTURE_ATOMIC.into();
1623        assert_eq!(features, Features::TEXTURE_ATOMIC);
1624
1625        let features: Features = FeaturesWebGPU::TIMESTAMP_QUERY.into();
1626        assert_eq!(features, Features::TIMESTAMP_QUERY);
1627
1628        let features: Features = Features::from(FeaturesWGPU::TEXTURE_ATOMIC)
1629            | Features::from(FeaturesWebGPU::TIMESTAMP_QUERY);
1630        assert_eq!(
1631            features,
1632            Features::TEXTURE_ATOMIC | Features::TIMESTAMP_QUERY
1633        );
1634        assert_eq!(
1635            features,
1636            Features::from_internal_flags(
1637                FeaturesWGPU::TEXTURE_ATOMIC,
1638                FeaturesWebGPU::TIMESTAMP_QUERY
1639            )
1640        );
1641    }
1642}