Struct gfx_hal::Features

pub struct Features { /* private fields */ }

Features that the device supports.

These only include features of the core interface and not API extensions.

Can be obtained from a physical device by calling features.

Implementations

impl Features

pub const CORE_MASK: Self

Bit mask of Vulkan Core/Extension features.

pub const PORTABILITY_MASK: Self

Bit mask of Vulkan Portability features.

pub const WEBGPU_MASK: Self

Bit mask for extra WebGPU features.

pub const EXTENSIONS_MASK: Self

Bit mask for all extensions.

pub const ROBUST_BUFFER_ACCESS: Self

Support for robust buffer access. Buffer access by SPIR-V shaders is checked against the buffer/image boundaries.

pub const FULL_DRAW_INDEX_U32: Self

Support the full 32-bit range of indexed for draw calls. If not supported, the maximum index value is determined by Limits::max_draw_index_value.

pub const IMAGE_CUBE_ARRAY: Self

Support cube array image views.

pub const INDEPENDENT_BLENDING: Self

Support different color blending settings per attachments on graphics pipeline creation.

pub const GEOMETRY_SHADER: Self

Support geometry shader.

pub const TESSELLATION_SHADER: Self

Support tessellation shaders.

pub const SAMPLE_RATE_SHADING: Self

Support per-sample shading and multisample interpolation.

pub const DUAL_SRC_BLENDING: Self

Support dual source blending.

pub const LOGIC_OP: Self

Support logic operations.

pub const MULTI_DRAW_INDIRECT: Self

Support multiple draws per indirect call.

pub const DRAW_INDIRECT_FIRST_INSTANCE: Self

Support indirect drawing with first instance value. If not supported the first instance value must be 0.

pub const DEPTH_CLAMP: Self

Support depth clamping.

pub const DEPTH_BIAS_CLAMP: Self

Support depth bias clamping.

pub const NON_FILL_POLYGON_MODE: Self

Support non-fill polygon modes.

pub const DEPTH_BOUNDS: Self

Support depth bounds test.

pub const LINE_WIDTH: Self

Support lines with width other than 1.0.

pub const POINT_SIZE: Self

Support points with size greater than 1.0.

pub const ALPHA_TO_ONE: Self

Support replacing alpha values with 1.0.

pub const MULTI_VIEWPORTS: Self

Support multiple viewports and scissors.

pub const SAMPLER_ANISOTROPY: Self

Support anisotropic filtering.

pub const FORMAT_ETC2: Self

Support ETC2 texture compression formats.

pub const FORMAT_ASTC_LDR: Self

Support ASTC (LDR) texture compression formats.

pub const FORMAT_BC: Self

Support BC texture compression formats.

pub const PRECISE_OCCLUSION_QUERY: Self

Support precise occlusion queries, returning the actual number of samples. If not supported, queries return a non-zero value when at least one sample passes.

pub const PIPELINE_STATISTICS_QUERY: Self

Support query of pipeline statistics.

pub const VERTEX_STORES_AND_ATOMICS: Self

Support unordered access stores and atomic ops in the vertex, geometry and tessellation shader stage. If not supported, the shader resources must be annotated as read-only.

pub const FRAGMENT_STORES_AND_ATOMICS: Self

Support unordered access stores and atomic ops in the fragment shader stage If not supported, the shader resources must be annotated as read-only.

pub const SHADER_TESSELLATION_AND_GEOMETRY_POINT_SIZE: Self

pub const SHADER_IMAGE_GATHER_EXTENDED: Self

pub const SHADER_STORAGE_IMAGE_EXTENDED_FORMATS: Self

pub const SHADER_STORAGE_IMAGE_MULTISAMPLE: Self

pub const SHADER_STORAGE_IMAGE_READ_WITHOUT_FORMAT: Self

pub const SHADER_STORAGE_IMAGE_WRITE_WITHOUT_FORMAT: Self

pub const SHADER_UNIFORM_BUFFER_ARRAY_DYNAMIC_INDEXING: Self

pub const SHADER_SAMPLED_IMAGE_ARRAY_DYNAMIC_INDEXING: Self

pub const SHADER_STORAGE_BUFFER_ARRAY_DYNAMIC_INDEXING: Self

pub const SHADER_STORAGE_IMAGE_ARRAY_DYNAMIC_INDEXING: Self

pub const SHADER_CLIP_DISTANCE: Self

pub const SHADER_CULL_DISTANCE: Self

pub const SHADER_FLOAT64: Self

pub const SHADER_INT64: Self

pub const SHADER_INT16: Self

pub const SHADER_RESOURCE_RESIDENCY: Self

pub const SHADER_RESOURCE_MIN_LOD: Self

pub const SPARSE_BINDING: Self

pub const SPARSE_RESIDENCY_BUFFER: Self

pub const SPARSE_RESIDENCY_IMAGE_2D: Self

pub const SPARSE_RESIDENCY_IMAGE_3D: Self

pub const SPARSE_RESIDENCY_2_SAMPLES: Self

pub const SPARSE_RESIDENCY_4_SAMPLES: Self

pub const SPARSE_RESIDENCY_8_SAMPLES: Self

pub const SPARSE_RESIDENCY_16_SAMPLES: Self

pub const SPARSE_RESIDENCY_ALIASED: Self

pub const VARIABLE_MULTISAMPLE_RATE: Self

pub const INHERITED_QUERIES: Self

pub const TEXTURE_DESCRIPTOR_ARRAY: Self

Support for arrays of texture descriptors

pub const SAMPLER_MIRROR_CLAMP_EDGE: Self

Support for

pub const SAMPLED_TEXTURE_DESCRIPTOR_INDEXING: Self

Allow indexing sampled texture descriptor arrays with dynamically non-uniform data

pub const STORAGE_TEXTURE_DESCRIPTOR_INDEXING: Self

Allow indexing storage texture descriptor arrays with dynamically non-uniform data

pub const UNSIZED_DESCRIPTOR_ARRAY: Self

Allow descriptor arrays to be unsized in shaders

pub const DESCRIPTOR_INDEXING_MASK: Self

Mask for all the features associated with descriptor indexing.

pub const DRAW_INDIRECT_COUNT: Self

Enable draw_indirect_count and draw_indexed_indirect_count

pub const CONSERVATIVE_RASTERIZATION: Self

Support for conservative rasterization. Presence of this flag only indicates basic overestimation rasterization for triangles only. (no guarantee on underestimation, overestimation, handling of degenerate primitives, fragment shader coverage reporting and uncertainty ranges)

pub const BUFFER_DESCRIPTOR_ARRAY: Self

Support for arrays of buffer descriptors

pub const UNIFORM_BUFFER_DESCRIPTOR_INDEXING: Self

Allow indexing uniform buffer descriptor arrays with dynamically non-uniform data

pub const STORAGE_BUFFER_DESCRIPTOR_INDEXING: Self

Allow indexing storage buffer descriptor arrays with dynamically non-uniform data

pub const TRIANGLE_FAN: Self

Support triangle fan primitive topology.

pub const SEPARATE_STENCIL_REF_VALUES: Self

Support separate stencil reference values for front and back sides.

pub const INSTANCE_RATE: Self

Support manually specified vertex attribute rates (divisors).

pub const SAMPLER_MIP_LOD_BIAS: Self

Support non-zero mipmap bias on samplers.

pub const SAMPLER_BORDER_COLOR: Self

Support sampler wrap mode that clamps to border.

pub const MUTABLE_COMPARISON_SAMPLER: Self

Can create comparison samplers in regular descriptor sets.

pub const MUTABLE_UNNORMALIZED_SAMPLER: Self

Can create non-normalized samplers in regular descriptor sets.

pub const NDC_Y_UP: Self

Make the NDC coordinate system pointing Y up, to match D3D and Metal.

pub const TASK_SHADER: Self

Supports task shader stage.

pub const MESH_SHADER: Self

Supports mesh shader stage.

pub const MESH_SHADER_MASK: Self

Mask for all the features associated with mesh shader stages.

pub const SAMPLER_REDUCTION: Self

Support sampler min/max reduction mode.

pub const EXTERNAL_MEMORY: Self

Supports external memory import and export.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u128

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u128) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u128) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u128) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

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: Self) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for Features

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl BitAnd<Features> for Features

fn bitand(self, other: Self) -> Self

Returns the intersection between the two sets of flags.

type Output = Self

The resulting type after applying the & operator.

impl BitAndAssign<Features> for Features

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<Features> for Features

fn bitor(self, other: Features) -> Self

Returns the union of the two sets of flags.

type Output = Self

The resulting type after applying the | operator.

impl BitOrAssign<Features> for Features

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<Features> for Features

fn bitxor(self, other: Self) -> Self

Returns the left flags, but with all the right flags toggled.

type Output = Self

The resulting type after applying the ^ operator.

impl BitXorAssign<Features> for Features

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for Features

fn clone(&self) -> Features

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Features

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Extend<Features> for Features

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Features> for Features

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl Hash for Features

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for Features

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Not for Features

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = Self

The resulting type after applying the ! operator.

impl Octal for Features

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Ord for Features

fn cmp(&self, other: &Features) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Features> for Features

fn eq(&self, other: &Features) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Features) -> bool

This method tests for !=.

impl PartialOrd<Features> for Features

fn partial_cmp(&self, other: &Features) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<Features> for Features

fn sub(self, other: Self) -> Self

Returns the set difference of the two sets of flags.

type Output = Self

The resulting type after applying the - operator.

impl SubAssign<Features> for Features

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for Features

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for Features

impl Eq for Features

impl StructuralEq for Features

impl StructuralPartialEq for Features