-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Expand file tree
/
Copy pathfeatures.rs
More file actions
2075 lines (1906 loc) · 84.8 KB
/
Copy pathfeatures.rs
File metadata and controls
2075 lines (1906 loc) · 84.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! # Features
//!
//! Types identifying optional features of WebGPU and wgpu. Availability varies
//! by hardware and can be checked when requesting an adapter and device.
//!
//! The `wgpu` Rust API always uses the `Features` bit flag type to represent a
//! set of features. However, the WebGPU-defined JavaScript API uses
//! `kebab-case` feature name strings, so some utilities are provided for
//! working with those names. See [`Features::as_str`] and [`Features::from_str`].
//!
//! The [`bitflags`] crate names flags by stringifying the
//! `SCREAMING_SNAKE_CASE` identifier. These names are returned by
//! [`Features::iter_names`] and parsed by [`Features::from_name`].
//! [`bitflags`] does not currently support customized flag naming.
//! See <https://github.com/bitflags/bitflags/issues/470>.
use crate::{link_to_wgpu_docs, link_to_wgpu_item, VertexFormat};
#[cfg(feature = "serde")]
use alloc::fmt;
use alloc::vec::Vec;
#[cfg(feature = "serde")]
use bitflags::parser::{ParseError, ParseHex, WriteHex};
#[cfg(feature = "serde")]
use bitflags::Bits;
use bitflags::Flags;
#[cfg(feature = "serde")]
use core::mem::size_of;
use core::str::FromStr;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
pub use webgpu_impl::*;
mod webgpu_impl {
//! Constant values for [`super::FeaturesWebGPU`], separated so they can be picked up by
//! `cbindgen` in `mozilla-central` (where Firefox is developed).
#![allow(missing_docs)]
#[doc(hidden)]
pub const WEBGPU_FEATURE_DEPTH_CLIP_CONTROL: u64 = 1 << 0;
#[doc(hidden)]
pub const WEBGPU_FEATURE_DEPTH32FLOAT_STENCIL8: u64 = 1 << 1;
#[doc(hidden)]
pub const WEBGPU_FEATURE_TEXTURE_COMPRESSION_BC: u64 = 1 << 2;
#[doc(hidden)]
pub const WEBGPU_FEATURE_TEXTURE_COMPRESSION_BC_SLICED_3D: u64 = 1 << 3;
#[doc(hidden)]
pub const WEBGPU_FEATURE_TEXTURE_COMPRESSION_ETC2: u64 = 1 << 4;
#[doc(hidden)]
pub const WEBGPU_FEATURE_TEXTURE_COMPRESSION_ASTC: u64 = 1 << 5;
#[doc(hidden)]
pub const WEBGPU_FEATURE_TEXTURE_COMPRESSION_ASTC_SLICED_3D: u64 = 1 << 6;
#[doc(hidden)]
pub const WEBGPU_FEATURE_TIMESTAMP_QUERY: u64 = 1 << 7;
#[doc(hidden)]
pub const WEBGPU_FEATURE_INDIRECT_FIRST_INSTANCE: u64 = 1 << 8;
#[doc(hidden)]
pub const WEBGPU_FEATURE_SHADER_F16: u64 = 1 << 9;
#[doc(hidden)]
pub const WEBGPU_FEATURE_RG11B10UFLOAT_RENDERABLE: u64 = 1 << 10;
#[doc(hidden)]
pub const WEBGPU_FEATURE_BGRA8UNORM_STORAGE: u64 = 1 << 11;
#[doc(hidden)]
pub const WEBGPU_FEATURE_FLOAT32_FILTERABLE: u64 = 1 << 12;
#[doc(hidden)]
pub const WEBGPU_FEATURE_FLOAT32_BLENDABLE: u64 = 1 << 13;
#[doc(hidden)]
pub const WEBGPU_FEATURE_DUAL_SOURCE_BLENDING: u64 = 1 << 14;
#[doc(hidden)]
pub const WEBGPU_FEATURE_CLIP_DISTANCES: u64 = 1 << 15;
#[doc(hidden)]
pub const WEBGPU_FEATURE_IMMEDIATES: u64 = 1 << 16;
#[doc(hidden)]
pub const WEBGPU_FEATURE_PRIMITIVE_INDEX: u64 = 1 << 17;
}
macro_rules! bitflags_array_impl {
($impl_name:ident $inner_name:ident $name:ident $op:tt $($struct_names:ident)*) => (
impl core::ops::$impl_name for $name {
type Output = Self;
#[inline]
fn $inner_name(self, other: Self) -> Self {
Self {
$($struct_names: self.$struct_names $op other.$struct_names,)*
}
}
}
)
}
macro_rules! bitflags_array_impl_assign {
($impl_name:ident $inner_name:ident $name:ident $op:tt $($struct_names:ident)*) => (
impl core::ops::$impl_name for $name {
#[inline]
fn $inner_name(&mut self, other: Self) {
$(self.$struct_names $op other.$struct_names;)*
}
}
)
}
macro_rules! bit_array_impl {
($impl_name:ident $inner_name:ident $name:ident $op:tt) => (
impl core::ops::$impl_name for $name {
type Output = Self;
#[inline]
fn $inner_name(mut self, other: Self) -> Self {
for (inner, other) in self.0.iter_mut().zip(other.0.iter()) {
*inner $op *other;
}
self
}
}
)
}
macro_rules! bitflags_independent_two_arg {
($(#[$meta:meta])* $func_name:ident $($struct_names:ident)*) => (
$(#[$meta])*
pub const fn $func_name(self, other:Self) -> Self {
Self { $($struct_names: self.$struct_names.$func_name(other.$struct_names),)* }
}
)
}
// For the most part this macro should not be modified, most configuration should be possible
// without changing this macro.
/// Macro for creating sets of bitflags, we need this because there are almost more flags than bits
/// in a u64, we can't use a u128 because of FFI, and the number of flags is increasing.
macro_rules! bitflags_array {
(
$(#[$outer:meta])*
pub struct $name:ident: [$T:ty; $Len:expr];
$(
$(#[$bit_outer:meta])*
$vis:vis struct $inner_name:ident $lower_inner_name:ident {
$(
$(#[doc $($args:tt)*])*
#[name($str_name:literal $(, $alias:literal)*)]
const $Flag:tt = $value:expr;
)*
}
)*
) => {
$(
bitflags::bitflags! {
$(#[$bit_outer])*
$vis struct $inner_name: $T {
$(
$(#[doc $($args)*])*
const $Flag = $value;
)*
}
}
)*
$(#[$outer])*
pub struct $name {
$(
#[allow(missing_docs)]
$vis $lower_inner_name: $inner_name,
)*
}
/// Bits from `Features` in array form
#[derive(Default, Copy, Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct FeatureBits(pub [$T; $Len]);
bitflags_array_impl! { BitOr bitor $name | $($lower_inner_name)* }
bitflags_array_impl! { BitAnd bitand $name & $($lower_inner_name)* }
bitflags_array_impl! { BitXor bitxor $name ^ $($lower_inner_name)* }
impl core::ops::Not for $name {
type Output = Self;
#[inline]
fn not(self) -> Self {
Self {
$($lower_inner_name: !self.$lower_inner_name,)*
}
}
}
bitflags_array_impl! { Sub sub $name - $($lower_inner_name)* }
#[cfg(feature = "serde")]
impl Serialize for $name {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
bitflags::serde::serialize(self, serializer)
}
}
#[cfg(feature = "serde")]
impl<'de> Deserialize<'de> for $name {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
bitflags::serde::deserialize(deserializer)
}
}
impl core::fmt::Display for $name {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
let mut iter = self.iter_names();
// simple look ahead
let mut next = iter.next();
while let Some((name, _)) = next {
f.write_str(name)?;
next = iter.next();
if next.is_some() {
f.write_str(" | ")?;
}
}
Ok(())
}
}
bitflags_array_impl_assign! { BitOrAssign bitor_assign $name |= $($lower_inner_name)* }
bitflags_array_impl_assign! { BitAndAssign bitand_assign $name &= $($lower_inner_name)* }
bitflags_array_impl_assign! { BitXorAssign bitxor_assign $name ^= $($lower_inner_name)* }
bit_array_impl! { BitOr bitor FeatureBits |= }
bit_array_impl! { BitAnd bitand FeatureBits &= }
bit_array_impl! { BitXor bitxor FeatureBits ^= }
impl core::ops::Not for FeatureBits {
type Output = Self;
#[inline]
fn not(self) -> Self {
let [$($lower_inner_name,)*] = self.0;
Self([$(!$lower_inner_name,)*])
}
}
#[cfg(feature = "serde")]
impl WriteHex for FeatureBits {
fn write_hex<W: fmt::Write>(&self, mut writer: W) -> fmt::Result {
let [$($lower_inner_name,)*] = self.0;
let mut wrote = false;
let mut stager = alloc::string::String::with_capacity(size_of::<$T>() * 2);
// we don't want to write it if it's just zero as there may be multiple zeros
// resulting in something like "00" being written out. We do want to write it if
// there has already been something written though.
$(if ($lower_inner_name != 0) || wrote {
// First we write to a staging string, then we add any zeros (e.g if #1
// is f and a u8 and #2 is a then the two combined would be f0a which requires
// a 0 inserted)
$lower_inner_name.write_hex(&mut stager)?;
if (stager.len() != size_of::<$T>() * 2) && wrote {
let zeros_to_write = (size_of::<$T>() * 2) - stager.len();
for _ in 0..zeros_to_write {
writer.write_char('0')?
}
}
writer.write_str(&stager)?;
stager.clear();
wrote = true;
})*
if !wrote {
writer.write_str("0")?;
}
Ok(())
}
}
#[cfg(feature = "serde")]
impl ParseHex for FeatureBits {
fn parse_hex(input: &str) -> Result<Self, ParseError> {
let mut unset = Self::EMPTY;
let mut end = input.len();
if end == 0 {
return Err(ParseError::empty_flag())
}
// we iterate starting at the least significant places and going up
for (idx, _) in [$(stringify!($lower_inner_name),)*].iter().enumerate().rev() {
// A byte is two hex places - u8 (1 byte) = 0x00 (2 hex places).
let checked_start = end.checked_sub(size_of::<$T>() * 2);
let start = checked_start.unwrap_or(0);
let cur_input = &input[start..end];
unset.0[idx] = <$T>::from_str_radix(cur_input, 16)
.map_err(|_|ParseError::invalid_hex_flag(cur_input))?;
end = start;
if let None = checked_start {
break;
}
}
Ok(unset)
}
}
impl bitflags::Bits for FeatureBits {
const EMPTY: Self = $name::empty().bits();
const ALL: Self = $name::all().bits();
}
impl Flags for $name {
const FLAGS: &'static [bitflags::Flag<Self>] = $name::FLAGS;
type Bits = FeatureBits;
fn bits(&self) -> FeatureBits {
FeatureBits([
$(self.$lower_inner_name.bits(),)*
])
}
fn from_bits_retain(bits: FeatureBits) -> Self {
let [$($lower_inner_name,)*] = bits.0;
Self {
$($lower_inner_name: $inner_name::from_bits_retain($lower_inner_name),)*
}
}
fn empty() -> Self {
Self::empty()
}
fn all() -> Self {
Self::all()
}
}
impl $name {
pub(crate) const FLAGS: &'static [bitflags::Flag<Self>] = &[
$(
$(
bitflags::Flag::new(stringify!($Flag), $name::$Flag),
)*
)*
];
/// Gets the set flags as a container holding an array of bits.
pub const fn bits(&self) -> FeatureBits {
FeatureBits([
$(self.$lower_inner_name.bits(),)*
])
}
/// Returns self with no flags set.
pub const fn empty() -> Self {
Self {
$($lower_inner_name: $inner_name::empty(),)*
}
}
/// Returns self with all flags set.
pub const fn all() -> Self {
Self {
$($lower_inner_name: $inner_name::all(),)*
}
}
/// Whether all the bits set in `other` are all set in `self`
pub const fn contains(self, other:Self) -> bool {
// we need an annoying true to catch the last && >:(
$(self.$lower_inner_name.contains(other.$lower_inner_name) &&)* true
}
/// Returns whether any bit set in `self` matched any bit set in `other`.
pub const fn intersects(self, other:Self) -> bool {
$(self.$lower_inner_name.intersects(other.$lower_inner_name) ||)* false
}
/// Returns whether there is no flag set.
pub const fn is_empty(self) -> bool {
$(self.$lower_inner_name.is_empty() &&)* true
}
/// Returns whether the struct has all flags set.
pub const fn is_all(self) -> bool {
$(self.$lower_inner_name.is_all() &&)* true
}
bitflags_independent_two_arg! {
/// Bitwise or - `self | other`
union $($lower_inner_name)*
}
bitflags_independent_two_arg! {
/// Bitwise and - `self & other`
intersection $($lower_inner_name)*
}
bitflags_independent_two_arg! {
/// Bitwise and of the complement of other - `self & !other`
difference $($lower_inner_name)*
}
bitflags_independent_two_arg! {
/// Bitwise xor - `self ^ other`
symmetric_difference $($lower_inner_name)*
}
/// Bitwise not - `!self`
pub const fn complement(self) -> Self {
Self {
$($lower_inner_name: self.$lower_inner_name.complement(),)*
}
}
/// Calls [`Self::insert`] if `set` is true and otherwise calls [`Self::remove`].
pub fn set(&mut self, other:Self, set: bool) {
$(self.$lower_inner_name.set(other.$lower_inner_name, set);)*
}
/// Inserts specified flag(s) into self
pub fn insert(&mut self, other:Self) {
$(self.$lower_inner_name.insert(other.$lower_inner_name);)*
}
/// Removes specified flag(s) from self
pub fn remove(&mut self, other:Self) {
$(self.$lower_inner_name.remove(other.$lower_inner_name);)*
}
/// Toggles specified flag(s) in self
pub fn toggle(&mut self, other:Self) {
$(self.$lower_inner_name.toggle(other.$lower_inner_name);)*
}
/// Takes in [`FeatureBits`] and returns None if there are invalid bits or otherwise Self with
/// those bits set
pub const fn from_bits(bits:FeatureBits) -> Option<Self> {
let [$($lower_inner_name,)*] = bits.0;
// The ? operator does not work in a const context.
Some(Self {
$(
$lower_inner_name: match $inner_name::from_bits($lower_inner_name) {
Some(some) => some,
None => return None,
},
)*
})
}
/// Takes in [`FeatureBits`] and returns Self with only valid bits (all other bits removed)
pub const fn from_bits_truncate(bits:FeatureBits) -> Self {
let [$($lower_inner_name,)*] = bits.0;
Self { $($lower_inner_name: $inner_name::from_bits_truncate($lower_inner_name),)* }
}
/// Takes in [`FeatureBits`] and returns Self with all bits that were set without removing
/// invalid bits
pub const fn from_bits_retain(bits:FeatureBits) -> Self {
let [$($lower_inner_name,)*] = bits.0;
Self { $($lower_inner_name: $inner_name::from_bits_retain($lower_inner_name),)* }
}
/// Takes in a bitflags flag name (in `SCREAMING_SNAKE_CASE`) and returns Self
/// if it matches or none if the name does not match the name of any of the
/// flags. Name is capitalisation dependent.
///
/// [`impl FromStr`] can be used to recognize kebab-case names, like are used in
/// the WebGPU spec.
pub fn from_name(name: &str) -> Option<Self> {
match name {
$(
$(
stringify!($Flag) => Some(Self::$Flag),
)*
)*
_ => None,
}
}
/// Combines the features from the internal flags into the entire features struct
pub fn from_internal_flags($($lower_inner_name: $inner_name,)*) -> Self {
Self {
$($lower_inner_name,)*
}
}
/// Returns an iterator over the set flags.
pub const fn iter(&self) -> bitflags::iter::Iter<$name> {
bitflags::iter::Iter::__private_const_new($name::FLAGS, *self, *self)
}
/// Returns an iterator over the set flags and their names.
///
/// These are bitflags names in `SCREAMING_SNAKE_CASE`.
pub const fn iter_names(&self) -> bitflags::iter::IterNames<$name> {
bitflags::iter::IterNames::__private_const_new($name::FLAGS, *self, *self)
}
/// If the argument is a single [`Features`] flag, returns the corresponding
/// `kebab-case` feature name, otherwise `None`.
#[must_use]
pub fn as_str(&self) -> Option<&'static str> {
Some(match *self {
$($(Self::$Flag => $str_name,)*)*
_ => return None,
})
}
$(
$(
$(#[doc $($args)*])*
#[allow(clippy::needless_update, reason = "only useless if there is 1 member")]
pub const $Flag: Self = Self {
$lower_inner_name: $inner_name::from_bits_truncate($value),
..Self::empty()
};
)*
)*
}
// Parses kebab-case feature names (i.e. the names given in the spec, for features
// in FeaturesWebGPU, and otherwise the `wgpu-` prefixed names).
impl FromStr for $name {
type Err = ();
fn from_str(s: &str) -> Result<Self, Self::Err> {
Ok(match s {
$($($str_name $(| $alias)* => Self::$Flag,)*)*
_ => return Err(()),
})
}
}
$(
impl From<$inner_name> for Features {
#[allow(clippy::needless_update, reason = "only useless if there is 1 member")]
fn from($lower_inner_name: $inner_name) -> Self {
Self {
$lower_inner_name,
..Self::empty()
}
}
}
)*
};
}
impl From<FeatureBits> for Features {
fn from(value: FeatureBits) -> Self {
Self::from_bits_retain(value)
}
}
impl From<Features> for FeatureBits {
fn from(value: Features) -> Self {
value.bits()
}
}
bitflags_array! {
/// Features that are not guaranteed to be supported.
///
/// These are either part of the webgpu standard, or are extension features supported by
/// wgpu when targeting native.
///
/// If you want to use a feature, you need to first verify that the adapter supports
/// the feature. If the adapter does not support the feature, requesting a device with it enabled
/// will panic.
///
/// Corresponds to [WebGPU `GPUFeatureName`](
/// https://gpuweb.github.io/gpuweb/#enumdef-gpufeaturename).
#[repr(C)]
#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct Features: [u64; 2];
/// Features that are not guaranteed to be supported.
///
/// Most of these are native-only extension features supported by wgpu only when targeting
/// native. A few are intended to align with a proposed WebGPU extension, and one
/// (`EXTERNAL_TEXTURE`) controls WebGPU-specified behavior that is not optional in the
/// standard, but that we don't want to make a [`crate::DownlevelFlags`] until the
/// implementation is more complete. For all features see [`Features`].
///
/// If you want to use a feature, you need to first verify that the adapter supports
/// the feature. If the adapter does not support the feature, requesting a device with it enabled
/// will panic.
///
/// Corresponds to [WebGPU `GPUFeatureName`](
/// https://gpuweb.github.io/gpuweb/#enumdef-gpufeaturename).
#[repr(transparent)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(transparent))]
#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct FeaturesWGPU features_wgpu {
/// Allows shaders to use f32 atomic load, store, add, sub, and exchange.
///
/// Supported platforms:
/// - Metal (with MSL 3.0+ and Apple7+/Mac2)
/// - Vulkan (with [VK_EXT_shader_atomic_float])
///
/// This is a native only feature.
///
/// [VK_EXT_shader_atomic_float]: https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_EXT_shader_atomic_float.html
#[name("wgpu-shader-float32-atomic")]
const SHADER_FLOAT32_ATOMIC = 1 << 0;
// The features starting with a ? are features that might become part of the spec or
// at the very least we can implement as native features; since they should cover all
// possible formats and capabilities across backends.
//
// ? const FORMATS_TIER_1 = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3837)
// ? const RW_STORAGE_TEXTURE_TIER_1 = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3838)
// ? const NORM16_FILTERABLE = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3839)
// ? const NORM16_RESOLVE = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3839)
// ? const 32BIT_FORMAT_MULTISAMPLE = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3844)
// ? const 32BIT_FORMAT_RESOLVE = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3844)
// ? const TEXTURE_COMPRESSION_ASTC_HDR = 1 << ??; (https://github.com/gpuweb/gpuweb/issues/3856)
// TEXTURE_FORMAT_16BIT_NORM & TEXTURE_COMPRESSION_ASTC_HDR will most likely become web features as well
// TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES might not be necessary if we have all the texture features implemented
// Texture Formats:
/// Enables normalized `16-bit` texture formats.
///
/// Supported platforms:
/// - Vulkan
/// - DX12
/// - Metal
/// - OpenGL (desktop GL 3.3+ for UNORM; GLES / WebGL2 needs
/// `EXT_texture_norm16`. SNORM color-attachment usage
/// additionally requires `EXT_render_snorm` on both paths.)
///
/// This is a native only feature.
#[name("wgpu-texture-format-16-bit-norm", "texture-format-16-bit-norm")]
const TEXTURE_FORMAT_16BIT_NORM = 1 << 1;
/// Enables ASTC HDR family of compressed textures.
///
/// Compressed textures sacrifice some quality in exchange for significantly reduced
/// bandwidth usage.
///
/// Support for this feature guarantees availability of [`TextureUsages::COPY_SRC | TextureUsages::COPY_DST | TextureUsages::TEXTURE_BINDING`] for ASTC formats with the HDR channel type.
/// [`Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES`] may enable additional usages.
///
/// Supported Platforms:
/// - Metal
/// - Vulkan
/// - OpenGL
///
/// This is a native only feature.
#[name("wgpu-texture-compression-astc-hdr", "texture-compression-astc-hdr")]
const TEXTURE_COMPRESSION_ASTC_HDR = 1 << 2;
/// Enables device specific texture format features.
///
/// See `TextureFormatFeatures` for a listing of the features in question.
///
/// By default only texture format properties as defined by the WebGPU specification are allowed.
/// Enabling this feature flag extends the features of each format to the ones supported by the current device.
/// Note that without this flag, read/write storage access is not allowed at all.
///
/// This extension does not enable additional formats.
///
/// This is a native only feature.
#[name("wgpu-texture-adapter-specific-format-features", "texture-adapter-specific-format-features")]
const TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES = 1 << 3;
// API:
/// Enables use of Pipeline Statistics Queries. These queries tell the count of various operations
/// performed between the start and stop call. Call [`RenderPass::begin_pipeline_statistics_query`] to start
/// a query, then call [`RenderPass::end_pipeline_statistics_query`] to stop one.
///
/// They must be resolved using [`CommandEncoder::resolve_query_set`] into a buffer.
/// The rules on how these resolve into buffers are detailed in the documentation for [`PipelineStatisticsTypes`].
///
/// Supported Platforms:
/// - Vulkan
/// - DX12
///
/// This is a native only feature with a [proposal](https://github.com/gpuweb/gpuweb/blob/0008bd30da2366af88180b511a5d0d0c1dffbc36/proposals/pipeline-statistics-query.md) for the web.
///
#[doc = link_to_wgpu_docs!(["`RenderPass::begin_pipeline_statistics_query`"]: "struct.RenderPass.html#method.begin_pipeline_statistics_query")]
#[doc = link_to_wgpu_docs!(["`RenderPass::end_pipeline_statistics_query`"]: "struct.RenderPass.html#method.end_pipeline_statistics_query")]
#[doc = link_to_wgpu_docs!(["`CommandEncoder::resolve_query_set`"]: "struct.CommandEncoder.html#method.resolve_query_set")]
/// [`PipelineStatisticsTypes`]: super::PipelineStatisticsTypes
#[name("wgpu-pipeline-statistics-query", "pipeline-statistics-query")]
const PIPELINE_STATISTICS_QUERY = 1 << 4;
/// Allows for timestamp queries directly on command encoders.
///
/// Adapters that support this feature also support
/// [`Features::TIMESTAMP_QUERY`]. Both features must be requested
/// explicitly to use timestamp queries on command encoders.
///
/// Additionally allows for timestamp writes on command encoders
/// using [`CommandEncoder::write_timestamp`].
///
/// Supported platforms:
/// - Vulkan
/// - DX12
/// - Metal (AMD & Intel, not Apple GPUs)
/// - OpenGL (with GL_ARB_timer_query)
///
/// This is a native only feature.
///
#[doc = link_to_wgpu_docs!(["`CommandEncoder::write_timestamp`"]: "struct.CommandEncoder.html#method.write_timestamp")]
#[name("wgpu-timestamp-query-inside-encoders")]
const TIMESTAMP_QUERY_INSIDE_ENCODERS = 1 << 5;
/// Allows for timestamp queries directly inside render and compute passes.
///
/// Adapters that support this feature also support
/// [`Features::TIMESTAMP_QUERY`] and [`Features::TIMESTAMP_QUERY_INSIDE_ENCODERS`].
/// This feature must be requested with [`Features::TIMESTAMP_QUERY`] to use timestamp
/// queries inside passes. Additionally, [`Features::TIMESTAMP_QUERY_INSIDE_ENCODERS`]
/// must be requested to use timestamp queries on command encoders.
///
/// Additionally allows for timestamp queries to be used inside render & compute passes using:
/// - [`RenderPass::write_timestamp`]
/// - [`ComputePass::write_timestamp`]
///
/// Supported platforms:
/// - Vulkan
/// - DX12
/// - Metal (AMD & Intel, not Apple GPUs)
/// - OpenGL (with GL_ARB_timer_query)
///
/// This is generally not available on tile-based rasterization GPUs.
///
/// 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.
///
#[doc = link_to_wgpu_docs!(["`RenderPass::write_timestamp`"]: "struct.RenderPass.html#method.write_timestamp")]
#[doc = link_to_wgpu_docs!(["`ComputePass::write_timestamp`"]: "struct.ComputePass.html#method.write_timestamp")]
#[name("wgpu-timestamp-query-inside-passes", "timestamp-query-inside-passes")]
const TIMESTAMP_QUERY_INSIDE_PASSES = 1 << 6;
/// Webgpu only allows the MAP_READ and MAP_WRITE buffer usage to be matched with
/// COPY_DST and COPY_SRC respectively. This removes this requirement.
///
/// This is only beneficial on systems that share memory between CPU and GPU. If enabled
/// on a system that doesn't, this can severely hinder performance. Only use if you understand
/// the consequences.
///
/// Supported platforms:
/// - Vulkan
/// - DX12
/// - Metal
///
/// This is a native only feature.
#[name("wgpu-mappable-primary-buffers", "mappable-primary-buffers")]
const MAPPABLE_PRIMARY_BUFFERS = 1 << 7;
/// Allows the user to create uniform arrays of textures in shaders:
///
/// ex.
/// - `var textures: binding_array<texture_2d<f32>, 10>` (WGSL)
/// - `uniform texture2D textures[10]` (GLSL)
///
/// If [`Features::STORAGE_RESOURCE_BINDING_ARRAY`] is supported as well as this, the user
/// may also create uniform arrays of storage textures.
///
/// ex.
/// - `var textures: array<texture_storage_2d<r32float, write>, 10>` (WGSL)
/// - `uniform image2D textures[10]` (GLSL)
///
/// This capability allows them to exist and to be indexed by dynamically uniform
/// values.
///
/// Supported platforms:
/// - DX12
/// - Metal (with MSL 2.0+ on macOS 10.13+)
/// - Vulkan
///
/// This is a native only feature.
#[name("wgpu-texture-binding-array", "texture-binding-array")]
const TEXTURE_BINDING_ARRAY = 1 << 8;
/// Allows the user to create arrays of buffers in shaders:
///
/// ex.
/// - `var<uniform> buffer_array: array<MyBuffer, 10>` (WGSL)
/// - `uniform myBuffer { ... } buffer_array[10]` (GLSL)
///
/// This capability allows them to exist and to be indexed by dynamically uniform
/// values.
///
/// If [`Features::STORAGE_RESOURCE_BINDING_ARRAY`] is supported as well as this, the user
/// may also create arrays of storage buffers.
///
/// ex.
/// - `var<storage> buffer_array: array<MyBuffer, 10>` (WGSL)
/// - `buffer myBuffer { ... } buffer_array[10]` (GLSL)
///
/// Supported platforms:
/// - Vulkan
///
/// This is a native only feature.
#[name("wgpu-buffer-binding-array", "buffer-binding-array")]
const BUFFER_BINDING_ARRAY = 1 << 9;
/// Allows the user to create uniform arrays of storage buffers or textures in shaders,
/// if resp. [`Features::BUFFER_BINDING_ARRAY`] or [`Features::TEXTURE_BINDING_ARRAY`]
/// is supported.
///
/// This capability allows them to exist and to be indexed by dynamically uniform
/// values.
///
/// Supported platforms:
/// - Metal (with MSL 2.2+ on macOS 10.13+)
/// - Vulkan
///
/// This is a native only feature.
#[name("wgpu-storage-resource-binding-array", "storage-resource-binding-array")]
const STORAGE_RESOURCE_BINDING_ARRAY = 1 << 10;
/// Allows shaders to index sampled texture and storage buffer resource arrays with dynamically non-uniform values:
///
/// ex. `texture_array[vertex_data]`
///
/// In order to use this capability, the corresponding GLSL extension must be enabled like so:
///
/// `#extension GL_EXT_nonuniform_qualifier : require`
///
/// and then used either as `nonuniformEXT` qualifier in variable declaration:
///
/// ex. `layout(location = 0) nonuniformEXT flat in int vertex_data;`
///
/// or as `nonuniformEXT` constructor:
///
/// ex. `texture_array[nonuniformEXT(vertex_data)]`
///
/// WGSL and HLSL do not need any extension.
///
/// Supported platforms:
/// - DX12
/// - Metal (with MSL 2.0+ on macOS 10.13+)
/// - Vulkan 1.2+ (or VK_EXT_descriptor_indexing)'s shaderSampledImageArrayNonUniformIndexing & shaderStorageBufferArrayNonUniformIndexing feature)
///
/// This is a native only feature.
#[name("wgpu-sampled-texture-and-storage-buffer-array-non-uniform-indexing", "sampled-texture-and-storage-buffer-array-non-uniform-indexing")]
const SAMPLED_TEXTURE_AND_STORAGE_BUFFER_ARRAY_NON_UNIFORM_INDEXING = 1 << 11;
/// Allows shaders to index storage texture resource arrays with dynamically non-uniform values:
///
/// ex. `texture_array[vertex_data]`
///
/// Supported platforms:
/// - DX12
/// - Metal (with MSL 2.0+ on macOS 10.13+)
/// - Vulkan 1.2+ (or VK_EXT_descriptor_indexing)'s shaderStorageTextureArrayNonUniformIndexing feature)
///
/// This is a native only feature.
#[name("wgpu-storage-texture-array-non-uniform-indexing", "storage-texture-array-non-uniform-indexing")]
const STORAGE_TEXTURE_ARRAY_NON_UNIFORM_INDEXING = 1 << 12;
/// Allows the user to create bind groups containing arrays with less bindings than the BindGroupLayout.
///
/// Supported platforms:
/// - Vulkan
/// - DX12
///
/// This is a native only feature.
#[name("wgpu-partially-bound-binding-array", "partially-bound-binding-array")]
const PARTIALLY_BOUND_BINDING_ARRAY = 1 << 13;
/// Allows the user to call [`RenderPass::multi_draw_indirect_count`] and [`RenderPass::multi_draw_indexed_indirect_count`].
///
/// This allows the use of a buffer containing the actual number of draw calls. This feature being present also implies
/// that all calls to [`RenderPass::multi_draw_indirect`] and [`RenderPass::multi_draw_indexed_indirect`] are not being emulated
/// with a series of `draw_indirect` calls.
///
/// Supported platforms:
/// - DX12
/// - Vulkan 1.2+ (or VK_KHR_draw_indirect_count)
///
/// This is a native only feature.
///
#[doc = link_to_wgpu_docs!(["`RenderPass::multi_draw_indirect`"]: "struct.RenderPass.html#method.multi_draw_indirect")]
#[doc = link_to_wgpu_docs!(["`RenderPass::multi_draw_indexed_indirect`"]: "struct.RenderPass.html#method.multi_draw_indexed_indirect")]
#[doc = link_to_wgpu_docs!(["`RenderPass::multi_draw_indirect_count`"]: "struct.RenderPass.html#method.multi_draw_indirect_count")]
#[doc = link_to_wgpu_docs!(["`RenderPass::multi_draw_indexed_indirect_count`"]: "struct.RenderPass.html#method.multi_draw_indexed_indirect_count")]
#[name("wgpu-multi-draw-indirect-count", "multi-draw-indirect-count")]
const MULTI_DRAW_INDIRECT_COUNT = 1 << 15;
/// Allows the use of [`AddressMode::ClampToBorder`] with a border color
/// of [`SamplerBorderColor::Zero`].
///
/// Supported platforms:
/// - DX12
/// - Vulkan
/// - Metal
/// - OpenGL
///
/// This is a native only feature.
///
/// [`AddressMode::ClampToBorder`]: super::AddressMode::ClampToBorder
/// [`SamplerBorderColor::Zero`]: super::SamplerBorderColor::Zero
#[name("wgpu-address-mode-clamp-to-zero", "address-mode-clamp-to-zero")]
const ADDRESS_MODE_CLAMP_TO_ZERO = 1 << 17;
/// Allows the use of [`AddressMode::ClampToBorder`] with a border color
/// other than [`SamplerBorderColor::Zero`].
///
/// Supported platforms:
/// - DX12
/// - Vulkan
/// - Metal (macOS 10.12+ only)
/// - OpenGL
///
/// This is a native only feature.
///
/// [`AddressMode::ClampToBorder`]: super::AddressMode::ClampToBorder
/// [`SamplerBorderColor::Zero`]: super::SamplerBorderColor::Zero
#[name("wgpu-address-mode-clamp-to-border", "address-mode-clamp-to-border")]
const ADDRESS_MODE_CLAMP_TO_BORDER = 1 << 18;
/// Allows the user to set [`PolygonMode::Line`] in [`PrimitiveState::polygon_mode`]
///
/// This allows drawing polygons/triangles as lines (wireframe) instead of filled
///
/// Supported platforms:
/// - DX12
/// - Vulkan
/// - Metal
///
/// This is a native only feature.
///
/// [`PrimitiveState::polygon_mode`]: super::PrimitiveState
/// [`PolygonMode::Line`]: super::PolygonMode::Line
#[name("wgpu-polygon-mode-line", "polygon-mode-line")]
const POLYGON_MODE_LINE = 1 << 19;
/// Allows the user to set [`PolygonMode::Point`] in [`PrimitiveState::polygon_mode`]
///
/// This allows only drawing the vertices of polygons/triangles instead of filled
///
/// Supported platforms:
/// - Vulkan
///
/// This is a native only feature.
///
/// [`PrimitiveState::polygon_mode`]: super::PrimitiveState
/// [`PolygonMode::Point`]: super::PolygonMode::Point
#[name("wgpu-polygon-mode-point", "polygon-mode-point")]
const POLYGON_MODE_POINT = 1 << 20;
/// Allows the user to set a overestimation-conservative-rasterization in [`PrimitiveState::conservative`]
///
/// Processing of degenerate triangles/lines is hardware specific.
/// Only triangles are supported.
///
/// Supported platforms:
/// - Vulkan
///
/// This is a native only feature.
///
/// [`PrimitiveState::conservative`]: super::PrimitiveState::conservative
#[name("wgpu-conservative-rasterization", "conservative-rasterization")]
const CONSERVATIVE_RASTERIZATION = 1 << 21;
/// Enables bindings of writable storage buffers and textures visible to vertex shaders.
///
/// Note: some (tiled-based) platforms do not support vertex shaders with any side-effects.
///
/// Supported Platforms:
/// - All
///
/// This is a native only feature.
#[name("wgpu-vertex-writable-storage", "vertex-writable-storage")]
const VERTEX_WRITABLE_STORAGE = 1 << 22;
/// Enables clear to zero for textures.
///
/// Supported platforms:
/// - All
///
/// This is a native only feature.
#[name("wgpu-clear-texture", "clear-texture")]
const CLEAR_TEXTURE = 1 << 23;
/// Enables multiview render passes and `builtin(view_index)` in vertex/mesh shaders.
///
/// Supported platforms:
/// - Vulkan
/// - Metal
/// - DX12
/// - OpenGL (web only)
///
/// This is a native only feature.
#[name("wgpu-multiview", "multiview")]
const MULTIVIEW = 1 << 26;
/// Enables using 64-bit types for vertex attributes.
///
/// Requires SHADER_FLOAT64.
///
/// Supported Platforms: N/A
///
/// This is a native only feature.
#[name("wgpu-vertex-attribute-64-bit", "vertex-attribute-64-bit")]
const VERTEX_ATTRIBUTE_64BIT = 1 << 27;
/// Enables image atomic fetch add, and, xor, or, min, and max for R32Uint and R32Sint textures.
///
/// Supported platforms:
/// - Vulkan
/// - DX12