Struct nannou::wgpu::Features [−]
#[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
pub const DEPTH_CLAMPING: Features
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
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
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
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
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
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
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
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
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
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
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
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
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
Allows the user to set a non-fill polygon mode in [RasterizationStateDescriptor::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
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
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
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
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 equivelent operations on 32-bit floats.
Supported Platforms:
- Vulkan
This is a native-only feature.
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.
pub const ALL_WEBGPU: Features
Features which are part of the upstream WebGPU standard.
pub const ALL_NATIVE: Features
Features that are only available when targeting native (not web).
pub const fn empty() -> Features
Returns an empty set of flags
pub const fn all() -> Features
Returns the set containing all flags.
pub const fn bits(&self) -> u64
Returns the raw value of the flags currently stored.
pub fn from_bits(bits: u64) -> Option<Features>
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
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: u64) -> Features
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
pub const fn is_empty(&self) -> bool
Returns true
if no flags are currently stored.
pub const fn is_all(&self) -> bool
Returns true
if all flags are currently set.
pub const fn intersects(&self, other: Features) -> bool
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: Features) -> bool
Returns true
all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: Features)
Inserts the specified flags in-place.
pub fn remove(&mut self, other: Features)
Removes the specified flags in-place.
pub fn toggle(&mut self, other: Features)
Toggles the specified flags in-place.
pub fn set(&mut self, other: Features, value: bool)
Inserts or removes the specified flags depending on the passed value.
Trait Implementations
impl Binary for Features
impl BitAnd<Features> for Features
type Output = Features
The resulting type after applying the &
operator.
pub fn bitand(self, other: Features) -> Features
Returns the intersection between the two sets of flags.
impl BitAndAssign<Features> for Features
pub fn bitand_assign(&mut self, other: Features)
Disables all flags disabled in the set.
impl BitOr<Features> for Features
type Output = Features
The resulting type after applying the |
operator.
pub fn bitor(self, other: Features) -> Features
Returns the union of the two sets of flags.
impl BitOrAssign<Features> for Features
pub fn bitor_assign(&mut self, other: Features)
Adds the set of flags.
impl BitXor<Features> for Features
type Output = Features
The resulting type after applying the ^
operator.
pub fn bitxor(self, other: Features) -> Features
Returns the left flags, but with all the right flags toggled.
impl BitXorAssign<Features> for Features
pub fn bitxor_assign(&mut self, other: Features)
Toggles the set of flags.
impl Clone for Features
pub fn clone(&self) -> Features
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Copy for Features
impl Debug for Features
impl Default for Features
impl Eq for Features
impl Extend<Features> for Features
pub fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = Features>,
T: IntoIterator<Item = Features>,
pub fn extend_one(&mut self, item: A)
[src]
pub fn extend_reserve(&mut self, additional: usize)
[src]
impl FromIterator<Features> for Features
pub fn from_iter<T>(iterator: T) -> Features where
T: IntoIterator<Item = Features>,
T: IntoIterator<Item = Features>,
impl Hash for Features
pub fn hash<__H>(&self, state: &mut __H) where
__H: Hasher,
__H: Hasher,
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl LowerHex for Features
impl Not for Features
type Output = Features
The resulting type after applying the !
operator.
pub fn not(self) -> Features
Returns the complement of this set of flags.
impl Octal for Features
impl Ord for Features
pub fn cmp(&self, other: &Features) -> Ordering
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl PartialEq<Features> for Features
impl PartialOrd<Features> for Features
pub fn partial_cmp(&self, other: &Features) -> Option<Ordering>
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl StructuralEq for Features
impl StructuralPartialEq for Features
impl Sub<Features> for Features
type Output = Features
The resulting type after applying the -
operator.
pub fn sub(self, other: Features) -> Features
Returns the set difference of the two sets of flags.
impl SubAssign<Features> for Features
pub fn sub_assign(&mut self, other: Features)
Disables all flags enabled in the set.
impl UpperHex for Features
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<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
T: Component + Float,
D: AdaptFrom<S, Swp, Dwp, T>,
Swp: WhitePoint,
Dwp: WhitePoint,
[src]
T: Component + Float,
D: AdaptFrom<S, Swp, Dwp, T>,
Swp: WhitePoint,
Dwp: WhitePoint,
pub fn adapt_into_using<M>(self, method: M) -> D where
M: TransformMatrix<Swp, Dwp, T>,
[src]
M: TransformMatrix<Swp, Dwp, T>,
pub fn adapt_into(self) -> D
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> CallHasher for T where
T: Hash,
T: Hash,
impl<T, U> ConvertInto<U> for T where
U: ConvertFrom<T>,
[src]
U: ConvertFrom<T>,
pub fn convert_into(self) -> U
[src]
pub fn convert_unclamped_into(self) -> U
[src]
pub fn try_convert_into(self) -> Result<U, OutOfBounds<U>>
[src]
impl<T> Downcast<T> for T
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
pub fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> NodeId for T where
T: 'static + Copy + Clone + PartialEq<T> + Eq + Hash + Send,
[src]
T: 'static + Copy + Clone + PartialEq<T> + Eq + Hash + Send,
impl<N> NodeTrait for N where
N: Copy + Ord + Hash,
[src]
N: Copy + Ord + Hash,
impl<T> Pointable for T
pub const ALIGN: usize
type Init = T
The type for initializers.
pub unsafe fn init(init: <T as Pointable>::Init) -> usize
pub unsafe fn deref<'a>(ptr: usize) -> &'a T
pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
pub unsafe fn drop(ptr: usize)
impl<T> SetParameter for T
pub fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
T: Parameter<Self>,
T: Parameter<Self>,
impl<T> Style for T where
T: Any + Debug + PartialEq<T>,
[src]
T: Any + Debug + PartialEq<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Upcast<T> for T
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,