Struct bevy_render::settings::WgpuFeatures
source · pub struct WgpuFeatures(/* private fields */);
Expand description
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
.
Implementations§
source§impl Features
impl Features
sourcepub const DEPTH_CLIP_CONTROL: Features = _
pub const DEPTH_CLIP_CONTROL: Features = _
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.
sourcepub const DEPTH32FLOAT_STENCIL8: Features = _
pub const DEPTH32FLOAT_STENCIL8: Features = _
Allows for explicit creation of textures of format TextureFormat::Depth32FloatStencil8
Supported platforms:
- Vulkan (mostly)
- DX12
- Metal
- OpenGL
This is a web and native feature.
sourcepub const TEXTURE_COMPRESSION_BC: Features = _
pub const TEXTURE_COMPRESSION_BC: Features = _
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.
Supported Platforms:
- desktops
This is a web and native feature.
sourcepub const TEXTURE_COMPRESSION_ETC2: Features = _
pub const TEXTURE_COMPRESSION_ETC2: Features = _
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.
sourcepub const TEXTURE_COMPRESSION_ASTC: Features = _
pub const TEXTURE_COMPRESSION_ASTC: Features = _
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.
sourcepub const TIMESTAMP_QUERY: Features = _
pub const TIMESTAMP_QUERY: Features = _
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.
sourcepub const INDIRECT_FIRST_INSTANCE: Features = _
pub const INDIRECT_FIRST_INSTANCE: Features = _
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.
sourcepub const SHADER_F16: Features = _
pub const SHADER_F16: Features = _
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.
sourcepub const RG11B10UFLOAT_RENDERABLE: Features = _
pub const RG11B10UFLOAT_RENDERABLE: Features = _
Allows for usage of textures of format TextureFormat::Rg11b10Float
as a render target
Supported platforms:
- Vulkan
- DX12
- Metal
This is a web and native feature.
sourcepub const BGRA8UNORM_STORAGE: Features = _
pub const BGRA8UNORM_STORAGE: Features = _
Allows the [wgpu::TextureUsages::STORAGE_BINDING
] usage on textures with format [TextureFormat::Bgra8unorm
]
Supported Platforms:
- Vulkan
- DX12
- Metal
This is a web and native feature.
sourcepub const FLOAT32_FILTERABLE: Features = _
pub const FLOAT32_FILTERABLE: Features = _
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.
sourcepub const TEXTURE_FORMAT_16BIT_NORM: Features = _
pub const TEXTURE_FORMAT_16BIT_NORM: Features = _
Enables normalized 16-bit
texture formats.
Supported platforms:
- Vulkan
- DX12
- Metal
This is a native only feature.
sourcepub const TEXTURE_COMPRESSION_ASTC_HDR: Features = _
pub const TEXTURE_COMPRESSION_ASTC_HDR: Features = _
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.
sourcepub const TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES: Features = _
pub const TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES: Features = _
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.
sourcepub const PIPELINE_STATISTICS_QUERY: Features = _
pub const PIPELINE_STATISTICS_QUERY: Features = _
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 for the web.
sourcepub const TIMESTAMP_QUERY_INSIDE_ENCODERS: Features = _
pub const TIMESTAMP_QUERY_INSIDE_ENCODERS: Features = _
Allows for timestamp queries directly on command encoders.
Implies Features::TIMESTAMP_QUERY
is supported.
Additionally allows for timestamp writes on command encoders
using [CommandEncoder::write_timestamp
].
Supported platforms:
- Vulkan
- DX12
- Metal
This is a native only feature.
sourcepub const TIMESTAMP_QUERY_INSIDE_PASSES: Features = _
pub const TIMESTAMP_QUERY_INSIDE_PASSES: Features = _
Allows for timestamp queries directly on command encoders.
Implies Features::TIMESTAMP_QUERY
& Features::TIMESTAMP_QUERY_INSIDE_ENCODERS
is supported.
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)
This is generally not available on tile-based rasterization GPUs.
This is a native only feature with a proposal for the web.
sourcepub const MAPPABLE_PRIMARY_BUFFERS: Features = _
pub const MAPPABLE_PRIMARY_BUFFERS: Features = _
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.
sourcepub const TEXTURE_BINDING_ARRAY: Features = _
pub const TEXTURE_BINDING_ARRAY: Features = _
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<f32, 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.
sourcepub const BUFFER_BINDING_ARRAY: Features = _
pub const BUFFER_BINDING_ARRAY: Features = _
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:
- DX12
- Vulkan
This is a native only feature.
sourcepub const STORAGE_RESOURCE_BINDING_ARRAY: Features = _
pub const STORAGE_RESOURCE_BINDING_ARRAY: Features = _
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.
sourcepub const SAMPLED_TEXTURE_AND_STORAGE_BUFFER_ARRAY_NON_UNIFORM_INDEXING: Features = _
pub const SAMPLED_TEXTURE_AND_STORAGE_BUFFER_ARRAY_NON_UNIFORM_INDEXING: Features = _
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.
sourcepub const UNIFORM_BUFFER_AND_STORAGE_TEXTURE_ARRAY_NON_UNIFORM_INDEXING: Features = _
pub const UNIFORM_BUFFER_AND_STORAGE_TEXTURE_ARRAY_NON_UNIFORM_INDEXING: Features = _
Allows shaders to index uniform buffer and storage texture 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 shaderUniformBufferArrayNonUniformIndexing & shaderStorageTextureArrayNonUniformIndexing feature)
This is a native only feature.
sourcepub const PARTIALLY_BOUND_BINDING_ARRAY: Features = _
pub const PARTIALLY_BOUND_BINDING_ARRAY: Features = _
Allows the user to create bind groups containing arrays with less bindings than the BindGroupLayout.
This is a native only feature.
sourcepub const MULTI_DRAW_INDIRECT: Features = _
pub const MULTI_DRAW_INDIRECT: Features = _
Allows the user to call RenderPass::multi_draw_indirect
and RenderPass::multi_draw_indexed_indirect
.
Allows multiple indirect calls to be dispatched from a single buffer.
Supported platforms:
- DX12
- Vulkan
- Metal on Apple3+ or Mac1+ (Emulated on top of
draw_indirect
anddraw_indexed_indirect
)
This is a native only feature.
sourcepub const MULTI_DRAW_INDIRECT_COUNT: Features = _
pub const MULTI_DRAW_INDIRECT_COUNT: Features = _
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.
Supported platforms:
- DX12
- Vulkan 1.2+ (or VK_KHR_draw_indirect_count)
This is a native only feature.
sourcepub const PUSH_CONSTANTS: Features = _
pub const PUSH_CONSTANTS: Features = _
Allows the use of push constants: small, fast bits of memory that can be updated
inside a RenderPass
.
Allows the user to call RenderPass::set_push_constants
, provide a non-empty array
to PipelineLayoutDescriptor
, and provide a non-zero limit to Limits::max_push_constant_size
.
A block of push constants can be declared in WGSL with var<push_constant>
:
struct PushConstants { example: f32, }
var<push_constant> c: PushConstants;
In GLSL, this corresponds to layout(push_constant) uniform Name {..}
.
Supported platforms:
- DX12
- Vulkan
- Metal
- OpenGL (emulated with uniforms)
This is a native only feature.
sourcepub const ADDRESS_MODE_CLAMP_TO_ZERO: Features = _
pub const ADDRESS_MODE_CLAMP_TO_ZERO: Features = _
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.
sourcepub const ADDRESS_MODE_CLAMP_TO_BORDER: Features = _
pub const ADDRESS_MODE_CLAMP_TO_BORDER: Features = _
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.
sourcepub const POLYGON_MODE_LINE: Features = _
pub const POLYGON_MODE_LINE: Features = _
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.
sourcepub const POLYGON_MODE_POINT: Features = _
pub const POLYGON_MODE_POINT: Features = _
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.
sourcepub const CONSERVATIVE_RASTERIZATION: Features = _
pub const CONSERVATIVE_RASTERIZATION: Features = _
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.
sourcepub const VERTEX_WRITABLE_STORAGE: Features = _
pub const VERTEX_WRITABLE_STORAGE: Features = _
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.
sourcepub const CLEAR_TEXTURE: Features = _
pub const CLEAR_TEXTURE: Features = _
Enables clear to zero for textures.
Supported platforms:
- All
This is a native only feature.
sourcepub const SPIRV_SHADER_PASSTHROUGH: Features = _
pub const SPIRV_SHADER_PASSTHROUGH: Features = _
Enables creating shader modules from SPIR-V binary data (unsafe).
SPIR-V data is not parsed or interpreted in any way; you can use
[wgpu::make_spirv_raw!
] to check for alignment and magic number when converting from
raw bytes.
Supported platforms:
- Vulkan, in case shader’s requested capabilities and extensions agree with Vulkan implementation.
This is a native only feature.
sourcepub const MULTIVIEW: Features = _
pub const MULTIVIEW: Features = _
Enables multiview render passes and builtin(view_index)
in vertex shaders.
Supported platforms:
- Vulkan
- OpenGL (web only)
This is a native only feature.
sourcepub const VERTEX_ATTRIBUTE_64BIT: Features = _
pub const VERTEX_ATTRIBUTE_64BIT: Features = _
Enables using 64-bit types for vertex attributes.
Requires SHADER_FLOAT64.
Supported Platforms: N/A
This is a native only feature.
sourcepub const SHADER_UNUSED_VERTEX_OUTPUT: Features = _
pub const SHADER_UNUSED_VERTEX_OUTPUT: Features = _
Allows vertex shaders to have outputs which are not consumed by the fragment shader.
Supported platforms:
- Vulkan
- Metal
- OpenGL
sourcepub const TEXTURE_FORMAT_NV12: Features = _
pub const TEXTURE_FORMAT_NV12: Features = _
Allows for creation of textures of format TextureFormat::NV12
Supported platforms:
- DX12
- Vulkan
This is a native only feature.
sourcepub const RAY_TRACING_ACCELERATION_STRUCTURE: Features = _
pub const RAY_TRACING_ACCELERATION_STRUCTURE: Features = _
Allows for the creation of ray-tracing acceleration structures.
Supported platforms:
- Vulkan
This is a native-only feature.
sourcepub const RAY_QUERY: Features = _
pub const RAY_QUERY: Features = _
Allows for the creation of ray-tracing queries within shaders.
Supported platforms:
- Vulkan
This is a native-only feature.
sourcepub const SHADER_F64: Features = _
pub const SHADER_F64: Features = _
Enables 64-bit floating point types in SPIR-V shaders.
Note: even when supported by GPU hardware, 64-bit floating point operations are frequently between 16 and 64 times slower than equivalent operations on 32-bit floats.
Supported Platforms:
- Vulkan
This is a native only feature.
sourcepub const SHADER_I16: Features = _
pub const SHADER_I16: Features = _
Allows shaders to use i16. Not currently supported in naga
, only available through spirv-passthrough
.
Supported platforms:
- Vulkan
This is a native only feature.
sourcepub const SHADER_PRIMITIVE_INDEX: Features = _
pub const SHADER_PRIMITIVE_INDEX: Features = _
Enables builtin(primitive_index)
in fragment shaders.
Note: enables geometry processing for pipelines using the builtin. This may come with a significant performance impact on some hardware. Other pipelines are not affected.
Supported platforms:
- Vulkan
- DX12
- Metal (some)
- OpenGL (some)
This is a native only feature.
sourcepub const SHADER_EARLY_DEPTH_TEST: Features = _
pub const SHADER_EARLY_DEPTH_TEST: Features = _
Allows shaders to use the early_depth_test
attribute.
Supported platforms:
- GLES 3.1+
This is a native only feature.
sourcepub const DUAL_SOURCE_BLENDING: Features = _
pub const DUAL_SOURCE_BLENDING: Features = _
Allows two outputs from a shader to be used for blending. Note that dual-source blending doesn’t support multiple render targets.
For more info see the OpenGL ES extension GL_EXT_blend_func_extended.
Supported platforms:
- OpenGL ES (with GL_EXT_blend_func_extended)
- Metal (with MSL 1.2+)
- Vulkan (with dualSrcBlend)
- DX12
sourcepub const SHADER_INT64: Features = _
pub const SHADER_INT64: Features = _
Allows shaders to use i64 and u64.
Supported platforms:
- Vulkan
- DX12 (DXC only)
- Metal (with MSL 2.3+)
This is a native only feature.
sourcepub const SUBGROUP: Features = _
pub const SUBGROUP: Features = _
Allows compute and fragment shaders to use the subgroup operation built-ins
Supported Platforms:
- Vulkan
- DX12
- Metal
This is a native only feature.
sourcepub const SUBGROUP_VERTEX: Features = _
pub const SUBGROUP_VERTEX: Features = _
Allows vertex shaders to use the subgroup operation built-ins
Supported Platforms:
- Vulkan
This is a native only feature.
sourcepub const SUBGROUP_BARRIER: Features = _
pub const SUBGROUP_BARRIER: Features = _
Allows shaders to use the subgroup barrier
Supported Platforms:
- Vulkan
- Metal
This is a native only feature.
source§impl Features
impl Features
sourcepub const fn bits(&self) -> u64
pub const fn bits(&self) -> u64
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u64) -> Option<Features>
pub const fn from_bits(bits: u64) -> Option<Features>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u64) -> Features
pub const fn from_bits_truncate(bits: u64) -> Features
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u64) -> Features
pub const fn from_bits_retain(bits: u64) -> Features
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Features>
pub fn from_name(name: &str) -> Option<Features>
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.
sourcepub const fn intersects(&self, other: Features) -> bool
pub const fn intersects(&self, other: Features) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Features) -> bool
pub const fn contains(&self, other: Features) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Features)
pub fn remove(&mut self, other: Features)
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.
sourcepub fn toggle(&mut self, other: Features)
pub fn toggle(&mut self, other: Features)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Features, value: bool)
pub fn set(&mut self, other: Features, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Features) -> Features
pub const fn intersection(self, other: Features) -> Features
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Features) -> Features
pub const fn union(self, other: Features) -> Features
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Features) -> Features
pub const fn difference(self, other: Features) -> Features
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.
sourcepub const fn symmetric_difference(self, other: Features) -> Features
pub const fn symmetric_difference(self, other: Features) -> Features
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Features
pub const fn complement(self) -> Features
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl Features
impl Features
sourcepub const fn iter(&self) -> Iter<Features>
pub const fn iter(&self) -> Iter<Features>
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.
sourcepub const fn iter_names(&self) -> IterNames<Features>
pub const fn iter_names(&self) -> IterNames<Features>
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.
source§impl Features
impl Features
sourcepub fn contains_invalid_bits(&self) -> bool
pub fn contains_invalid_bits(&self) -> bool
Returns true if the bitflags contains bits that are not part of the bitflags definition.
source§impl Features
impl Features
sourcepub const fn all_webgpu_mask() -> Features
pub const fn all_webgpu_mask() -> Features
Mask of all features which are part of the upstream WebGPU standard.
sourcepub const fn all_native_mask() -> Features
pub const fn all_native_mask() -> Features
Mask of all features that are only available when targeting native (not web).
Trait Implementations§
source§impl BitAndAssign for Features
impl BitAndAssign for Features
source§fn bitand_assign(&mut self, other: Features)
fn bitand_assign(&mut self, other: Features)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOrAssign for Features
impl BitOrAssign for Features
source§fn bitor_assign(&mut self, other: Features)
fn bitor_assign(&mut self, other: Features)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXorAssign for Features
impl BitXorAssign for Features
source§fn bitxor_assign(&mut self, other: Features)
fn bitxor_assign(&mut self, other: Features)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Extend<Features> for Features
impl Extend<Features> for Features
source§fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = Features>,
fn extend<T>(&mut self, iterator: T)where
T: IntoIterator<Item = Features>,
The bitwise or (|
) of the bits in each flags value.
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for Features
impl Flags for Features
source§fn from_bits_retain(bits: u64) -> Features
fn from_bits_retain(bits: u64) -> Features
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<Features> for Features
impl FromIterator<Features> for Features
source§impl IntoIterator for Features
impl IntoIterator for Features
source§impl PartialEq for Features
impl PartialEq for Features
source§impl Sub for Features
impl Sub for Features
source§impl SubAssign for Features
impl SubAssign for Features
source§fn sub_assign(&mut self, other: Features)
fn sub_assign(&mut self, other: Features)
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 Copy for Features
impl Eq for Features
impl StructuralPartialEq for Features
Auto Trait Implementations§
impl Freeze for Features
impl RefUnwindSafe for Features
impl Send for Features
impl Sync for Features
impl Unpin for Features
impl UnwindSafe for Features
Blanket Implementations§
source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World
.