Struct FeaturesWebGPU

#[repr(transparent)]
pub struct FeaturesWebGPU(<FeaturesWebGPU as PublicFlags>::Internal);

Features that are not guaranteed to be supported.

These are part of the webgpu standard. 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.

Tuple Fields

0: <FeaturesWebGPU as PublicFlags>::Internal

Implementations

impl FeaturesWebGPU

pub const DEPTH_CLIP_CONTROL: Self = _

By default, polygon depth is clipped to 0-1 range before/during rasterization. Anything outside of that range is rejected, and respective fragments are not touched.

With this extension, we can disabling clipping. That allows shadow map occluders to be rendered into a tighter depth range.

Supported platforms:

• desktops
• some mobile chips

This is a web and native feature.

pub const DEPTH32FLOAT_STENCIL8: Self = _

Allows for explicit creation of textures of format TextureFormat::Depth32FloatStencil8

Supported platforms:

• Vulkan (mostly)
• DX12
• Metal
• OpenGL

This is a web and native feature.

pub const TEXTURE_COMPRESSION_BC: Self = _

Enables BCn family of compressed textures. All BCn textures use 4x4 pixel blocks with 8 or 16 bytes per block.

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 BCn formats. Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES may enable additional usages.

This feature guarantees availability of sliced-3d textures for BC formats when combined with TEXTURE_COMPRESSION_BC_SLICED_3D.

Supported Platforms:

• desktops
• Mobile (All Apple9 and some Apple7 and Apple8 devices)

This is a web and native feature.

pub const TEXTURE_COMPRESSION_BC_SLICED_3D: Self = _

Allows the 3d dimension for textures with BC compressed formats.

This feature must be used in combination with TEXTURE_COMPRESSION_BC to enable 3D textures with BC compression. It does not enable the BC formats by itself.

Supported Platforms:

• desktops
• Mobile (All Apple9 and some Apple7 and Apple8 devices)

This is a web and native feature.

pub const TEXTURE_COMPRESSION_ETC2: Self = _

Enables ETC family of compressed textures. All ETC textures use 4x4 pixel blocks. ETC2 RGB and RGBA1 are 8 bytes per block. RTC2 RGBA8 and EAC are 16 bytes per block.

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 ETC2 formats. Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES may enable additional usages.

Supported Platforms:

• Vulkan on Intel
• Mobile (some)

This is a web and native feature.

pub const TEXTURE_COMPRESSION_ASTC: Self = _

Enables ASTC family of compressed textures. ASTC textures use pixel blocks varying from 4x4 to 12x12. Blocks are always 16 bytes.

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 Unorm/UnormSrgb channel type. Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES may enable additional usages.

Supported Platforms:

• Vulkan on Intel
• Mobile (some)

This is a web and native feature.

pub const TIMESTAMP_QUERY: Self = _

Enables use of Timestamp Queries. These queries tell the current gpu timestamp when all work before the query is finished.

This feature allows the use of

• RenderPassDescriptor::timestamp_writes
• ComputePassDescriptor::timestamp_writes to write out timestamps.

For arbitrary timestamp write commands on encoders refer to Features::TIMESTAMP_QUERY_INSIDE_ENCODERS. For arbitrary timestamp write commands on passes refer to Features::TIMESTAMP_QUERY_INSIDE_PASSES.

They must be resolved using CommandEncoder::resolve_query_set into a buffer, then the result must be multiplied by the timestamp period Queue::get_timestamp_period to get the timestamp in nanoseconds. Multiple timestamps can then be diffed to get the time for operations between them to finish.

Supported Platforms:

• Vulkan
• DX12
• Metal

This is a web and native feature.

pub const INDIRECT_FIRST_INSTANCE: Self = _

Allows non-zero value for the first_instance member in indirect draw calls.

If this feature is not enabled, and the first_instance member is non-zero, the behavior may be:

• The draw call is ignored.
• The draw call is executed as if the first_instance is zero.
• The draw call is executed with the correct first_instance value.

Supported Platforms:

• Vulkan (mostly)
• DX12
• Metal on Apple3+ or Mac1+
• OpenGL (Desktop 4.2+ with ARB_shader_draw_parameters only)

Not Supported:

• OpenGL ES / WebGL

This is a web and native feature.

pub const SHADER_F16: Self = _

Allows shaders to acquire the FP16 ability

Note: this is not supported in naga yet, only through spirv-passthrough right now.

Supported Platforms:

• Vulkan
• Metal

This is a web and native feature.

pub const RG11B10UFLOAT_RENDERABLE: Self = _

Allows for usage of textures of format TextureFormat::Rg11b10Ufloat as a render target

Supported platforms:

• Vulkan
• DX12
• Metal

This is a web and native feature.

pub const BGRA8UNORM_STORAGE: Self = _

Allows the TextureUsages::STORAGE_BINDING usage on textures with format TextureFormat::Bgra8Unorm

Supported Platforms:

• Vulkan
• DX12
• Metal

This is a web and native feature.

pub const FLOAT32_FILTERABLE: Self = _

Allows textures with formats “r32float”, “rg32float”, and “rgba32float” to be filterable.

Supported Platforms:

• Vulkan (mainly on Desktop GPUs)
• DX12
• Metal on macOS or Apple9+ GPUs, optional on iOS/iPadOS with Apple7/8 GPUs
• GL with one of GL_ARB_color_buffer_float/GL_EXT_color_buffer_float/OES_texture_float_linear

This is a web and native feature.

impl FeaturesWebGPU

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u64

Get the underlying bits value.

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

pub const fn from_bits(bits: u64) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u64) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u64) -> Self

Convert from a bits value exactly.

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

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

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

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

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

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

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

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

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

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

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

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

Call insert when value is true or remove when value is false.

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

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

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

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

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

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

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

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

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

pub const fn complement(self) -> Self

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

impl FeaturesWebGPU

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

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

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

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for FeaturesWebGPU

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

Formats the value using the given formatter.

impl BitAnd for FeaturesWebGPU

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

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

type Output = FeaturesWebGPU

The resulting type after applying the & operator.

impl BitAndAssign for FeaturesWebGPU

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for FeaturesWebGPU

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

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

type Output = FeaturesWebGPU

The resulting type after applying the | operator.

impl BitOrAssign for FeaturesWebGPU

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for FeaturesWebGPU

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

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

type Output = FeaturesWebGPU

The resulting type after applying the ^ operator.

impl BitXorAssign for FeaturesWebGPU

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for FeaturesWebGPU

fn clone(&self) -> FeaturesWebGPU

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FeaturesWebGPU

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

Formats the value using the given formatter.

impl Default for FeaturesWebGPU

fn default() -> FeaturesWebGPU

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FeaturesWebGPU

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<FeaturesWebGPU> for FeaturesWebGPU

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

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

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for FeaturesWebGPU

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

The set of defined flags.

type Bits = u64

The underlying bits type.

fn bits(&self) -> u64

Get the underlying bits value.

fn from_bits_retain(bits: u64) -> FeaturesWebGPU

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

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

Convert from a bits value.

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

Convert from a bits value, unsetting any unknown bits.

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

Get a flags value with the bits of a flag with the given name set.

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

Yield a set of contained flags values.

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

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

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

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

where Self: Sized,

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

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

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

fn remove(&mut self, other: Self)

where Self: Sized,

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

fn toggle(&mut self, other: Self)

where Self: Sized,

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

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

where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

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

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

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

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

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

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

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

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

fn complement(self) -> Self

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

impl From<FeaturesWebGPU> for Features

fn from(features_webgpu: FeaturesWebGPU) -> Self

Converts to this type from the input type.

impl FromIterator<FeaturesWebGPU> for FeaturesWebGPU

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

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

impl Hash for FeaturesWebGPU

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for FeaturesWebGPU

type Item = FeaturesWebGPU

The type of the elements being iterated over.

type IntoIter = Iter<FeaturesWebGPU>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for FeaturesWebGPU

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

Formats the value using the given formatter.

impl Not for FeaturesWebGPU

fn not(self) -> Self

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

type Output = FeaturesWebGPU

The resulting type after applying the ! operator.

impl Octal for FeaturesWebGPU

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

Formats the value using the given formatter.

impl PartialEq for FeaturesWebGPU

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PublicFlags for FeaturesWebGPU

type Primitive = u64

The type of the underlying storage.

type Internal = InternalBitFlags

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

impl Serialize for FeaturesWebGPU

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for FeaturesWebGPU

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

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

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = FeaturesWebGPU

The resulting type after applying the - operator.

impl SubAssign for FeaturesWebGPU

fn sub_assign(&mut self, other: Self)

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

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for FeaturesWebGPU

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

Formats the value using the given formatter.

impl Copy for FeaturesWebGPU

impl Eq for FeaturesWebGPU

impl StructuralPartialEq for FeaturesWebGPU