Struct maplibre::render::settings::Features

[−]
#[repr(transparent)]
pub struct Features(pub(crate) <Features as PublicFlags>::Internal);
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.

Tuple Fields

0: <Features as PublicFlags>::Internal

Implementations

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.

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 [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

This is currently unimplemented on Metal.

This is a web and native feature.

Allows non-zero value for the “first instance” in indirect draw calls.

Supported Platforms:

  • Vulkan (mostly)
  • DX12
  • Metal

This is a web and native feature.

Allows shaders to acquire the FP16 ability

Note: this is not supported in naga yet，only through spir-v passthrough right now.

Supported Platforms:

  • Vulkan
  • Metal

This is a web and native feature.

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.

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

Supported platforms:

  • Vulkan (mostly)
  • DX12
  • Metal

This is a web and native feature.

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.

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.

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

Supported Platforms:

  • Vulkan on Intel
  • Mobile (some)

This is a web and native feature.

Enables normalized 16-bit texture formats.

Supported platforms:

  • Vulkan
  • DX12
  • Metal

This is a native only feature.

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

Supported Platforms:

  • Metal
  • Vulkan
  • OpenGL

This is a native only feature.

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.

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].

Supported Platforms:

  • Vulkan
  • DX12

This is a native only feature with a proposal for the web.

Allows for timestamp queries inside render passes.

Implies Features::TIMESTAMP_QUERY is supported.

Supported platforms:

  • Vulkan
  • DX12

This is currently unimplemented on Metal. When implemented, it will be supported on Metal on AMD and Intel GPUs, but not Apple GPUs.

This is a native only feature with a proposal for the web.

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.

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.

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.

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.

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.

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.

Allows the user to create bind groups continaing arrays with less bindings than the BindGroupLayout.

This is a native only feature.

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 (Emulated on top of draw_indirect and draw_indexed_indirect)

This is a native only feature.

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.

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.

Allows the use of [AddressMode::ClampToBorder] with a border color of [SamplerBorderColor::Zero].

Supported platforms:

  • DX12
  • Vulkan
  • Metal
  • DX11
  • OpenGL

This is a native only feature.

Allows the use of [AddressMode::ClampToBorder] with a border color other than [SamplerBorderColor::Zero].

Supported platforms:

  • DX12
  • Vulkan
  • Metal (macOS 10.12+ only)
  • DX11
  • OpenGL

This is a native only feature.

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.

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:

  • DX12
  • Vulkan

This is a native only feature.

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.

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.

Enables clear to zero for textures.

Supported platforms:

  • All

This is a native only feature.

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.

Enables multiview render passes and builtin(view_index) in vertex shaders.

Supported platforms:

  • Vulkan
  • OpenGL (web only)

This is a native only feature.

Enables using 64-bit types for vertex attributes.

Requires SHADER_FLOAT64.

Supported Platforms: N/A

This is a native only feature.

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.

Allows shaders to use i16. Not currently supported in naga, only available through spirv-passthrough.

Supported platforms:

  • Vulkan

This is a native only feature.

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
  • DX11 (feature level 10+)
  • DX12
  • Metal (some)
  • OpenGL (some)

This is a native only feature.

Allows shaders to use the early_depth_test attribute.

Supported platforms:

  • GLES 3.1+

This is a native only feature.

Get a flags value with all bits unset.

Get a flags value with all known bits set.

Get the underlying bits value.

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

Convert from a bits value.

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

Convert from a bits value, unsetting any unknown bits.

Convert from a bits value exactly.

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.

Whether all bits in this flags value are unset.

Whether all known bits in this flags value are set.

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

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

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

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.

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

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

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

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

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.

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

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

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.

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.

Returns true if the bitflags contains bits that are not part of the bitflags definition.

Mask of all features which are part of the upstream WebGPU standard.

Mask of all features that are only available when targeting native (not web).

Trait Implementations

Formats the value using the given formatter.

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

The resulting type after applying the & operator.

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

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

The resulting type after applying the | operator.

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

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

The resulting type after applying the ^ operator.

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

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more

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

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
The set of defined flags.
The underlying bits type.
Get the underlying bits value. Read more
Convert from a bits value exactly.
Get a flags value with all bits unset.
Get a flags value with all known bits set.
Convert from a bits value. Read more
Convert from a bits value, unsetting any unknown bits.
Get a flags value with the bits of a flag with the given name set. Read more
Yield a set of contained flags values. Read more
Yield a set of contained named flags values. Read more
Whether all bits in this flags value are unset.
Whether all known bits in this flags value are set.
Whether any set bits in a source flags value are also set in a target flags value.
Whether all set bits in a source flags value are also set in a target flags value.
The bitwise or (|) of the bits in two flags values.
The intersection of a source flags value with the complement of a target flags value (&!). Read more
The bitwise exclusive-or (^) of the bits in two flags values.
Call [Flags::insert] when value is true or [Flags::remove] when value is false.
The bitwise and (&) of the bits in two flags values.
The bitwise or (|) of the bits in two flags values.
The intersection of a source flags value with the complement of a target flags value (&!). Read more
The bitwise exclusive-or (^) of the bits in two flags values.
The bitwise negation (!) of the bits in a flags value, truncating the result.

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

Feeds this value into the given Hasher. Read more
Feeds a slice of this type into the given Hasher. Read more
The type of the elements being iterated over.
Which kind of iterator are we turning this into?
Creates an iterator from a value. Read more
Formats the value using the given formatter.

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

The resulting type after applying the ! operator.
Formats the value using the given formatter.
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

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.

The resulting type after applying the - operator.

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.

Formats the value using the given formatter.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Convert 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. Read more
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more
Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more
Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more
Compare self to key and return true if they are equal.

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more