Struct wgpu::Features [−][src]
#[repr(transparent)]pub struct Features { /* fields omitted */ }
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.
Implementations
impl Features
[src]
impl Features
[src]pub const DEPTH_CLAMPING: Features
[src]
pub const DEPTH_CLAMPING: Features
[src]By default, polygon depth is clipped to 0-1 range. Anything outside of that range is rejected, and respective fragments are not touched.
With this extension, we can force clamping of the polygon depth to 0-1. 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 TEXTURE_COMPRESSION_BC: Features
[src]
pub const TEXTURE_COMPRESSION_BC: Features
[src]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 [TextureUsage::COPY_SRC | TextureUsage::COPY_DST | TextureUsage::SAMPLED
] for BCn formats.
Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES
may enable additional usages.
Supported Platforms:
- desktops
This is a web and native feature.
pub const TIMESTAMP_QUERY: Features
[src]
pub const TIMESTAMP_QUERY: Features
[src]Enables use of Timestamp Queries. These queries tell the current gpu timestamp when
all work before the query is finished. Call [CommandEncoder::write_timestamp
],
[RenderPassEncoder::write_timestamp
], or [ComputePassEncoder::write_timestamp
] to
write out a timestamp.
They must be resolved using [CommandEncoder::resolve_query_sets
] into a buffer,
then the result must be multiplied by the timestamp period [Device::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.
Due to gfx-hal limitations, this is only supported on vulkan for now.
Supported Platforms:
- Vulkan (works)
- DX12 (future)
This is a web and native feature.
pub const PIPELINE_STATISTICS_QUERY: Features
[src]
pub const PIPELINE_STATISTICS_QUERY: Features
[src]Enables use of Pipeline Statistics Queries. These queries tell the count of various operations
performed between the start and stop call. Call [RenderPassEncoder::begin_pipeline_statistics_query
] to start
a query, then call [RenderPassEncoder::end_pipeline_statistics_query
] to stop one.
They must be resolved using [CommandEncoder::resolve_query_sets
] into a buffer.
The rules on how these resolve into buffers are detailed in the documentation for PipelineStatisticsTypes
.
Due to gfx-hal limitations, this is only supported on vulkan for now.
Supported Platforms:
- Vulkan (works)
- DX12 (future)
This is a web and native feature.
pub const MAPPABLE_PRIMARY_BUFFERS: Features
[src]
pub const MAPPABLE_PRIMARY_BUFFERS: Features
[src]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:
- All
This is a native only feature.
pub const SAMPLED_TEXTURE_BINDING_ARRAY: Features
[src]
pub const SAMPLED_TEXTURE_BINDING_ARRAY: Features
[src]Allows the user to create uniform arrays of sampled textures in shaders:
eg. uniform texture2D textures[10]
.
This capability allows them to exist and to be indexed by compile time constant values.
Supported platforms:
- DX12
- Metal (with MSL 2.0+ on macOS 10.13+)
- Vulkan
This is a native only feature.
pub const SAMPLED_TEXTURE_ARRAY_DYNAMIC_INDEXING: Features
[src]
pub const SAMPLED_TEXTURE_ARRAY_DYNAMIC_INDEXING: Features
[src]Allows shaders to index sampled texture arrays with dynamically uniform values:
eg. texture_array[uniform_value]
This capability means the hardware will also support SAMPLED_TEXTURE_BINDING_ARRAY.
Supported platforms:
- DX12
- Metal (with MSL 2.0+ on macOS 10.13+)
- Vulkan’s shaderSampledImageArrayDynamicIndexing feature
This is a native only feature.
pub const SAMPLED_TEXTURE_ARRAY_NON_UNIFORM_INDEXING: Features
[src]
pub const SAMPLED_TEXTURE_ARRAY_NON_UNIFORM_INDEXING: Features
[src]Allows shaders to index sampled texture arrays with dynamically non-uniform values:
eg. 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:
eg. layout(location = 0) nonuniformEXT flat in int vertex_data;
or as nonuniformEXT
constructor:
eg. texture_array[nonuniformEXT(vertex_data)]
HLSL does not need any extension.
This capability means the hardware will also support SAMPLED_TEXTURE_ARRAY_DYNAMIC_INDEXING and SAMPLED_TEXTURE_BINDING_ARRAY.
Supported platforms:
- DX12
- Metal (with MSL 2.0+ on macOS 10.13+)
- Vulkan 1.2+ (or VK_EXT_descriptor_indexing)’s shaderSampledImageArrayNonUniformIndexing feature)
This is a native only feature.
pub const UNSIZED_BINDING_ARRAY: Features
[src]
pub const UNSIZED_BINDING_ARRAY: Features
[src]Allows the user to create unsized uniform arrays of bindings:
eg. uniform texture2D textures[]
.
If this capability is supported, SAMPLED_TEXTURE_ARRAY_NON_UNIFORM_INDEXING is very likely to also be supported
Supported platforms:
- DX12
- Vulkan 1.2+ (or VK_EXT_descriptor_indexing)’s runtimeDescriptorArray feature
This is a native only feature.
pub const MULTI_DRAW_INDIRECT: Features
[src]
pub const MULTI_DRAW_INDIRECT: Features
[src]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
- Metal
- Vulkan
This is a native only feature.
pub const MULTI_DRAW_INDIRECT_COUNT: Features
[src]
pub const MULTI_DRAW_INDIRECT_COUNT: Features
[src]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.
pub const PUSH_CONSTANTS: Features
[src]
pub const PUSH_CONSTANTS: Features
[src]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 with layout(push_constant) uniform Name {..}
in shaders.
Supported platforms:
- DX12
- Vulkan
- Metal
- DX11 (emulated with uniforms)
- OpenGL (emulated with uniforms)
This is a native only feature.
pub const ADDRESS_MODE_CLAMP_TO_BORDER: Features
[src]
pub const ADDRESS_MODE_CLAMP_TO_BORDER: Features
[src]Allows the use of AddressMode::ClampToBorder
.
Supported platforms:
- DX12
- Vulkan
- Metal (macOS 10.12+ only)
- DX11
- OpenGL
This is a web and native feature.
pub const NON_FILL_POLYGON_MODE: Features
[src]
pub const NON_FILL_POLYGON_MODE: Features
[src]Allows the user to set a non-fill polygon mode in PrimitiveState::polygon_mode
This allows drawing polygons/triangles as lines (wireframe) or points instead of filled
Supported platforms:
- DX12
- Vulkan
This is a native only feature.
pub const TEXTURE_COMPRESSION_ETC2: Features
[src]
pub const TEXTURE_COMPRESSION_ETC2: Features
[src]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 [TextureUsage::COPY_SRC | TextureUsage::COPY_DST | TextureUsage::SAMPLED
] for ETC2 formats.
Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES
may enable additional usages.
Supported Platforms:
- Intel/Vulkan
- Mobile (some)
This is a native-only feature.
pub const TEXTURE_COMPRESSION_ASTC_LDR: Features
[src]
pub const TEXTURE_COMPRESSION_ASTC_LDR: Features
[src]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 [TextureUsage::COPY_SRC | TextureUsage::COPY_DST | TextureUsage::SAMPLED
] for ASTC formats.
Features::TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES
may enable additional usages.
Supported Platforms:
- Intel/Vulkan
- Mobile (some)
This is a native-only feature.
pub const TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES: Features
[src]
pub const TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES: Features
[src]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.
pub const SHADER_FLOAT64: Features
[src]
pub const SHADER_FLOAT64: Features
[src]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.
pub const VERTEX_ATTRIBUTE_64BIT: Features
[src]
pub const VERTEX_ATTRIBUTE_64BIT: Features
[src]Enables using 64-bit types for vertex attributes.
Requires SHADER_FLOAT64.
Supported Platforms: N/A
This is a native-only feature.
pub const CONSERVATIVE_RASTERIZATION: Features
[src]
pub const CONSERVATIVE_RASTERIZATION: Features
[src]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:
- DX12
- Vulkan
This is a native only feature.
pub const BUFFER_BINDING_ARRAY: Features
[src]
pub const BUFFER_BINDING_ARRAY: Features
[src]Allows the user to create arrays of buffers in shaders:
eg. uniform myBuffer { .... } buffer_array[10]
.
This capability allows them to exist and to be indexed by compile time constant values.
Supported platforms:
- DX12
- Vulkan
This is a native only feature.
pub const UNIFORM_BUFFER_ARRAY_DYNAMIC_INDEXING: Features
[src]
pub const UNIFORM_BUFFER_ARRAY_DYNAMIC_INDEXING: Features
[src]Allows shaders to index uniform buffer arrays with dynamically uniform values:
eg. buffer_array[uniform_value]
This capability means the hardware will also support BUFFER_BINDING_ARRAY.
Supported platforms:
- DX12
- Vulkan’s shaderUniformBufferArrayDynamicIndexing feature
This is a native only feature.
pub const UNIFORM_BUFFER_ARRAY_NON_UNIFORM_INDEXING: Features
[src]
pub const UNIFORM_BUFFER_ARRAY_NON_UNIFORM_INDEXING: Features
[src]Allows shaders to index uniform buffer arrays with dynamically non-uniform values:
eg. buffer_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:
eg. layout(location = 0) nonuniformEXT flat in int vertex_data;
or as nonuniformEXT
constructor:
eg. buffer_array[nonuniformEXT(vertex_data)]
HLSL does not need any extension.
This capability means the hardware will also support UNIFORM_BUFFER_ARRAY_DYNAMIC_INDEXING and BUFFER_BINDING_ARRAY.
Supported platforms:
- DX12
- Vulkan 1.2+ (or VK_EXT_descriptor_indexing)’s shaderUniformBufferArrayNonUniformIndexing feature)
This is a native only feature.
pub const STORAGE_BUFFER_ARRAY_DYNAMIC_INDEXING: Features
[src]
pub const STORAGE_BUFFER_ARRAY_DYNAMIC_INDEXING: Features
[src]Allows shaders to index storage buffer arrays with dynamically uniform values:
eg. buffer_array[uniform_value]
This capability means the hardware will also support BUFFER_BINDING_ARRAY.
Supported platforms:
- DX12
- Vulkan’s shaderStorageBufferArrayDynamicIndexing feature
This is a native only feature.
pub const STORAGE_BUFFER_ARRAY_NON_UNIFORM_INDEXING: Features
[src]
pub const STORAGE_BUFFER_ARRAY_NON_UNIFORM_INDEXING: Features
[src]Allows shaders to index storage buffer arrays with dynamically non-uniform values:
eg. buffer_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:
eg. layout(location = 0) nonuniformEXT flat in int vertex_data;
or as nonuniformEXT
constructor:
eg. buffer_array[nonuniformEXT(vertex_data)]
HLSL does not need any extension.
This capability means the hardware will also support STORAGE_BUFFER_ARRAY_DYNAMIC_INDEXING and BUFFER_BINDING_ARRAY.
Supported platforms:
- DX12
- Vulkan 1.2+ (or VK_EXT_descriptor_indexing)’s shaderStorageBufferArrayNonUniformIndexing feature)
This is a native only feature.
pub const ALL_WEBGPU: Features
[src]
pub const ALL_WEBGPU: Features
[src]Features which are part of the upstream WebGPU standard.
pub const ALL_NATIVE: Features
[src]
pub const ALL_NATIVE: Features
[src]Features that are only available when targeting native (not web).
pub fn from_bits(bits: u64) -> Option<Features>
[src]
pub fn from_bits(bits: u64) -> Option<Features>
[src]Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub const fn from_bits_truncate(bits: u64) -> Features
[src]
pub const fn from_bits_truncate(bits: u64) -> Features
[src]Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: u64) -> Features
[src]
pub const unsafe fn from_bits_unchecked(bits: u64) -> Features
[src]Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
pub const fn intersects(&self, other: Features) -> bool
[src]
pub const fn intersects(&self, other: Features) -> bool
[src]Returns true
if there are flags common to both self
and other
.
Trait Implementations
impl BitAndAssign<Features> for Features
[src]
impl BitAndAssign<Features> for Features
[src]pub fn bitand_assign(&mut self, other: Features)
[src]
pub fn bitand_assign(&mut self, other: Features)
[src]Disables all flags disabled in the set.
impl BitOrAssign<Features> for Features
[src]
impl BitOrAssign<Features> for Features
[src]pub fn bitor_assign(&mut self, other: Features)
[src]
pub fn bitor_assign(&mut self, other: Features)
[src]Adds the set of flags.
impl BitXorAssign<Features> for Features
[src]
impl BitXorAssign<Features> for Features
[src]pub fn bitxor_assign(&mut self, other: Features)
[src]
pub fn bitxor_assign(&mut self, other: Features)
[src]Toggles the set of flags.
impl<'de> Deserialize<'de> for Features
[src]
impl<'de> Deserialize<'de> for Features
[src]pub fn deserialize<__D>(
__deserializer: __D
) -> Result<Features, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
[src]
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<Features, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl Extend<Features> for Features
[src]
impl Extend<Features> for Features
[src]pub fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = Features>,
[src]
pub fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = Features>,
[src]Extends a collection with the contents of an iterator. Read more
fn extend_one(&mut self, item: A)
[src]
fn extend_one(&mut self, item: A)
[src]extend_one
)Extends a collection with exactly one element.
fn extend_reserve(&mut self, additional: usize)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
impl FromIterator<Features> for Features
[src]
impl FromIterator<Features> for Features
[src]impl Ord for Features
[src]
impl Ord for Features
[src]impl PartialOrd<Features> for Features
[src]
impl PartialOrd<Features> for Features
[src]pub fn partial_cmp(&self, other: &Features) -> Option<Ordering>
[src]
pub fn partial_cmp(&self, other: &Features) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Serialize for Features
[src]
impl Serialize for Features
[src]pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
[src]
pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
[src]Serialize this value into the given Serde serializer. Read more
impl SubAssign<Features> for Features
[src]
impl SubAssign<Features> for Features
[src]pub fn sub_assign(&mut self, other: Features)
[src]
pub fn sub_assign(&mut self, other: Features)
[src]Disables all flags enabled in the set.
impl Copy for Features
[src]
impl Eq for Features
[src]
impl StructuralEq for Features
[src]
impl StructuralPartialEq for Features
[src]
Auto Trait Implementations
impl RefUnwindSafe for Features
impl Send for Features
impl Sync for Features
impl Unpin for Features
impl UnwindSafe for Features
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> CallHasher for T where
T: Hash,
impl<T> CallHasher for T where
T: Hash,
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]pub fn equivalent(&self, key: &K) -> bool
[src]
pub fn equivalent(&self, key: &K) -> bool
[src]Compare self to key
and return true
if they are equal.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<N> NodeTrait for N where
N: Copy + Ord + Hash,
[src]
N: Copy + Ord + Hash,