Struct wgpu_types::DownlevelFlags
source · pub struct DownlevelFlags(/* private fields */);
Expand description
Binary flags listing features that may or may not be present on downlevel adapters.
A downlevel adapter is a GPU adapter that WGPU supports, but with potentially limited features, due to the lack of hardware feature support.
Flags that are not present for a downlevel adapter or device usually indicates non-compliance with the WebGPU specification, but not always.
You can check whether a set of flags is compliant through the
DownlevelCapabilities::is_webgpu_compliant()
function.
Implementations§
source§impl DownlevelFlags
impl DownlevelFlags
sourcepub const COMPUTE_SHADERS: Self = _
pub const COMPUTE_SHADERS: Self = _
The device supports compiling and using compute shaders.
WebGL2, and GLES3.0 devices do not support compute.
sourcepub const FRAGMENT_WRITABLE_STORAGE: Self = _
pub const FRAGMENT_WRITABLE_STORAGE: Self = _
Supports binding storage buffers and textures to fragment shaders.
sourcepub const INDIRECT_EXECUTION: Self = _
pub const INDIRECT_EXECUTION: Self = _
Supports indirect drawing and dispatching.
WebGL2, GLES 3.0, and Metal on Apple1/Apple2 GPUs do not support indirect.
sourcepub const BASE_VERTEX: Self = _
pub const BASE_VERTEX: Self = _
Supports non-zero base_vertex
parameter to direct indexed draw calls.
Indirect calls, if supported, always support non-zero base_vertex
.
Supported by:
- Vulkan
- DX12
- Metal on Apple3+ or Mac1+
- OpenGL 3.2+
- OpenGL ES 3.2
sourcepub const READ_ONLY_DEPTH_STENCIL: Self = _
pub const READ_ONLY_DEPTH_STENCIL: Self = _
Supports reading from a depth/stencil texture while using it as a read-only depth/stencil attachment.
The WebGL2 and GLES backends do not support RODS.
sourcepub const NON_POWER_OF_TWO_MIPMAPPED_TEXTURES: Self = _
pub const NON_POWER_OF_TWO_MIPMAPPED_TEXTURES: Self = _
Supports textures with mipmaps which have a non power of two size.
sourcepub const CUBE_ARRAY_TEXTURES: Self = _
pub const CUBE_ARRAY_TEXTURES: Self = _
Supports textures that are cube arrays.
sourcepub const COMPARISON_SAMPLERS: Self = _
pub const COMPARISON_SAMPLERS: Self = _
Supports comparison samplers.
sourcepub const INDEPENDENT_BLEND: Self = _
pub const INDEPENDENT_BLEND: Self = _
Supports different blend operations per color attachment.
sourcepub const VERTEX_STORAGE: Self = _
pub const VERTEX_STORAGE: Self = _
Supports storage buffers in vertex shaders.
sourcepub const ANISOTROPIC_FILTERING: Self = _
pub const ANISOTROPIC_FILTERING: Self = _
Supports samplers with anisotropic filtering. Note this isn’t actually required by WebGPU, the implementation is allowed to completely ignore aniso clamp. This flag is here for native backends so they can communicate to the user of aniso is enabled.
All backends and all devices support anisotropic filtering.
sourcepub const FRAGMENT_STORAGE: Self = _
pub const FRAGMENT_STORAGE: Self = _
Supports storage buffers in fragment shaders.
sourcepub const MULTISAMPLED_SHADING: Self = _
pub const MULTISAMPLED_SHADING: Self = _
Supports sample-rate shading.
sourcepub const DEPTH_TEXTURE_AND_BUFFER_COPIES: Self = _
pub const DEPTH_TEXTURE_AND_BUFFER_COPIES: Self = _
Supports copies between depth textures and buffers.
GLES/WebGL don’t support this.
sourcepub const WEBGPU_TEXTURE_FORMAT_SUPPORT: Self = _
pub const WEBGPU_TEXTURE_FORMAT_SUPPORT: Self = _
Supports all the texture usages described in WebGPU. If this isn’t supported, you
should call get_texture_format_features
to get how you can use textures of a given format
sourcepub const BUFFER_BINDINGS_NOT_16_BYTE_ALIGNED: Self = _
pub const BUFFER_BINDINGS_NOT_16_BYTE_ALIGNED: Self = _
Supports buffer bindings with sizes that aren’t a multiple of 16.
WebGL doesn’t support this.
sourcepub const UNRESTRICTED_INDEX_BUFFER: Self = _
pub const UNRESTRICTED_INDEX_BUFFER: Self = _
Supports buffers to combine BufferUsages::INDEX
with usages other than BufferUsages::COPY_DST
and BufferUsages::COPY_SRC
.
Furthermore, in absence of this feature it is not allowed to copy index buffers from/to buffers with a set of usage flags containing
BufferUsages::VERTEX
/BufferUsages::UNIFORM
/BufferUsages::STORAGE
or BufferUsages::INDIRECT
.
WebGL doesn’t support this.
sourcepub const FULL_DRAW_INDEX_UINT32: Self = _
pub const FULL_DRAW_INDEX_UINT32: Self = _
Supports full 32-bit range indices (2^32-1 as opposed to 2^24-1 without this flag)
Corresponds to Vulkan’s VkPhysicalDeviceFeatures.fullDrawIndexUint32
sourcepub const DEPTH_BIAS_CLAMP: Self = _
pub const DEPTH_BIAS_CLAMP: Self = _
Supports depth bias clamping
Corresponds to Vulkan’s VkPhysicalDeviceFeatures.depthBiasClamp
sourcepub const VIEW_FORMATS: Self = _
pub const VIEW_FORMATS: Self = _
Supports specifying which view format values are allowed when create_view() is called on a texture.
The WebGL and GLES backends doesn’t support this.
sourcepub const UNRESTRICTED_EXTERNAL_TEXTURE_COPIES: Self = _
pub const UNRESTRICTED_EXTERNAL_TEXTURE_COPIES: Self = _
With this feature not present, there are the following restrictions on Queue::copy_external_image_to_texture
:
- The source must not be [
web_sys::OffscreenCanvas
] - [
ImageCopyExternalImage::origin
] must be zero. ImageCopyTextureTagged::color_space
must be srgb.- If the source is an [
web_sys::ImageBitmap
]:- [
ImageCopyExternalImage::flip_y
] must be false. ImageCopyTextureTagged::premultiplied_alpha
must be false.
- [
WebGL doesn’t support this. WebGPU does.
sourcepub const SURFACE_VIEW_FORMATS: Self = _
pub const SURFACE_VIEW_FORMATS: Self = _
Supports specifying which view formats are allowed when calling create_view on the texture returned by get_current_texture.
The GLES/WebGL and Vulkan on Android doesn’t support this.
sourcepub const NONBLOCKING_QUERY_RESOLVE: Self = _
pub const NONBLOCKING_QUERY_RESOLVE: Self = _
If this is true, calls to CommandEncoder::resolve_query_set
will be performed on the queue timeline.
If this is false, calls to CommandEncoder::resolve_query_set
will be performed on the device (i.e. cpu) timeline
and will block that timeline until the query has data. You may work around this limitation by waiting until the submit
whose queries you are resolving is fully finished (through use of queue.on_submitted_work_done
) and only
then submitting the resolve_query_set command. The queries will be guaranteed finished, so will not block.
Supported by:
- Vulkan,
- DX12
- Metal
- OpenGL 4.4+
Not Supported by:
- GL ES / WebGL
sourcepub const VERTEX_AND_INSTANCE_INDEX_RESPECTS_RESPECTIVE_FIRST_VALUE_IN_INDIRECT_DRAW: Self = _
pub const VERTEX_AND_INSTANCE_INDEX_RESPECTS_RESPECTIVE_FIRST_VALUE_IN_INDIRECT_DRAW: Self = _
If this is true, use of @builtin(vertex_index)
and @builtin(instance_index)
will properly take into consideration
the first_vertex
and first_instance
parameters of indirect draw calls.
If this is false, @builtin(vertex_index)
and @builtin(instance_index)
will start by counting from 0, ignoring the
first_vertex
and first_instance
parameters.
For example, if you had a draw call like this:
first_vertex: 4,
vertex_count: 12,
When this flag is present, @builtin(vertex_index)
will start at 4 and go up to 15 (12 invocations).
When this flag is not present, @builtin(vertex_index)
will start at 0 and go up to 11 (12 invocations).
This only affects the builtins in the shaders, vertex buffers and instance rate vertex buffers will behave like expected with this flag disabled.
See also [Features::
]
Supported By:
- Vulkan
- Metal
- OpenGL
Will be implemented in the future by:
- DX12 (#2471)
source§impl DownlevelFlags
impl DownlevelFlags
sourcepub const fn bits(&self) -> u32
pub const fn bits(&self) -> u32
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u32) -> Self
pub const fn from_bits_retain(bits: u32) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
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.
sourcepub const fn intersects(&self, other: Self) -> bool
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.
sourcepub const fn contains(&self, other: Self) -> bool
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.
sourcepub fn remove(&mut self, other: Self)
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.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
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.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl DownlevelFlags
impl DownlevelFlags
sourcepub const fn iter(&self) -> Iter<DownlevelFlags>
pub const fn iter(&self) -> Iter<DownlevelFlags>
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<DownlevelFlags>
pub const fn iter_names(&self) -> IterNames<DownlevelFlags>
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 DownlevelFlags
impl DownlevelFlags
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.
Trait Implementations§
source§impl Binary for DownlevelFlags
impl Binary for DownlevelFlags
source§impl BitAnd for DownlevelFlags
impl BitAnd for DownlevelFlags
source§impl BitAndAssign for DownlevelFlags
impl BitAndAssign for DownlevelFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for DownlevelFlags
impl BitOr for DownlevelFlags
source§fn bitor(self, other: DownlevelFlags) -> Self
fn bitor(self, other: DownlevelFlags) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = DownlevelFlags
type Output = DownlevelFlags
|
operator.source§impl BitOrAssign for DownlevelFlags
impl BitOrAssign for DownlevelFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for DownlevelFlags
impl BitXor for DownlevelFlags
source§impl BitXorAssign for DownlevelFlags
impl BitXorAssign for DownlevelFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for DownlevelFlags
impl Clone for DownlevelFlags
source§fn clone(&self) -> DownlevelFlags
fn clone(&self) -> DownlevelFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DownlevelFlags
impl Debug for DownlevelFlags
source§impl Extend<DownlevelFlags> for DownlevelFlags
impl Extend<DownlevelFlags> for DownlevelFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
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 DownlevelFlags
impl Flags for DownlevelFlags
source§const FLAGS: &'static [Flag<DownlevelFlags>] = _
const FLAGS: &'static [Flag<DownlevelFlags>] = _
source§fn from_bits_retain(bits: u32) -> DownlevelFlags
fn from_bits_retain(bits: u32) -> DownlevelFlags
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<DownlevelFlags> for DownlevelFlags
impl FromIterator<DownlevelFlags> for DownlevelFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for DownlevelFlags
impl Hash for DownlevelFlags
source§impl IntoIterator for DownlevelFlags
impl IntoIterator for DownlevelFlags
source§impl LowerHex for DownlevelFlags
impl LowerHex for DownlevelFlags
source§impl Not for DownlevelFlags
impl Not for DownlevelFlags
source§impl Octal for DownlevelFlags
impl Octal for DownlevelFlags
source§impl Ord for DownlevelFlags
impl Ord for DownlevelFlags
source§fn cmp(&self, other: &DownlevelFlags) -> Ordering
fn cmp(&self, other: &DownlevelFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for DownlevelFlags
impl PartialEq for DownlevelFlags
source§fn eq(&self, other: &DownlevelFlags) -> bool
fn eq(&self, other: &DownlevelFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for DownlevelFlags
impl PartialOrd for DownlevelFlags
source§fn partial_cmp(&self, other: &DownlevelFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &DownlevelFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl PublicFlags for DownlevelFlags
impl PublicFlags for DownlevelFlags
source§impl Sub for DownlevelFlags
impl Sub for DownlevelFlags
source§fn sub(self, other: Self) -> Self
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 = DownlevelFlags
type Output = DownlevelFlags
-
operator.source§impl SubAssign for DownlevelFlags
impl SubAssign for DownlevelFlags
source§fn sub_assign(&mut self, other: Self)
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.