Enum BindingType

#[non_exhaustive]
pub enum BindingType {
    UniformBuffer {
        dynamic: bool,
        min_binding_size: Option<NonZero<u64>>,
    },
    StorageBuffer {
        dynamic: bool,
        min_binding_size: Option<NonZero<u64>>,
        readonly: bool,
    },
    Sampler {
        comparison: bool,
    },
    SampledTexture {
        dimension: TextureViewDimension,
        component_type: TextureComponentType,
        multisampled: bool,
    },
    StorageTexture {
        dimension: TextureViewDimension,
        format: TextureFormat,
        readonly: bool,
    },
}

Specific type of a binding.

WebGPU spec: https://gpuweb.github.io/gpuweb/#dictdef-gpubindgrouplayoutentry

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UniformBuffer

A buffer for uniform values.

Example GLSL syntax:

layout(std140, binding = 0)
uniform Globals {
    vec2 aUniform;
    vec2 anotherUniform;
};

Fields

dynamic: bool

Indicates that the binding has a dynamic offset. One offset must be passed to [RenderPass::set_bind_group] for each dynamic binding in increasing order of binding number.

min_binding_size: Option<NonZero<u64>>

Minimum size of the corresponding BufferBinding required to match this entry. When pipeline is created, the size has to cover at least the corresponding structure in the shader plus one element of the unbound array, which can only be last in the structure. If None, the check is performed at draw call time instead of pipeline and bind group creation.

StorageBuffer

A storage buffer.

Example GLSL syntax:

layout (set=0, binding=0) buffer myStorageBuffer {
    vec4 myElement[];
};

Fields

dynamic: bool

Indicates that the binding has a dynamic offset. One offset must be passed to [RenderPass::set_bind_group] for each dynamic binding in increasing order of binding number.

min_binding_size: Option<NonZero<u64>>

Minimum size of the corresponding BufferBinding required to match this entry. When pipeline is created, the size has to cover at least the corresponding structure in the shader plus one element of the unbound array, which can only be last in the structure. If None, the check is performed at draw call time instead of pipeline and bind group creation.

readonly: bool

The buffer can only be read in the shader and it must be annotated with readonly.

Example GLSL syntax:

layout (set=0, binding=0) readonly buffer myStorageBuffer {
    vec4 myElement[];
};

Sampler

A sampler that can be used to sample a texture.

Example GLSL syntax:

layout(binding = 0)
uniform sampler s;

Fields

comparison: bool

Use as a comparison sampler instead of a normal sampler. For more info take a look at the analogous functionality in OpenGL: https://www.khronos.org/opengl/wiki/Sampler_Object#Comparison_mode.

SampledTexture

A texture.

Example GLSL syntax:

layout(binding = 0)
uniform texture2D t;

Fields

dimension: TextureViewDimension

Dimension of the texture view that is going to be sampled.

component_type: TextureComponentType

Component type of the texture. This must be compatible with the format of the texture.

multisampled: bool

True if the texture has a sample count greater than 1. If this is true, the texture must be read from shaders with texture1DMS, texture2DMS, or texture3DMS, depending on dimension.

StorageTexture

A storage texture.

Example GLSL syntax:

layout(set=0, binding=0, r32f) uniform image2D myStorageImage;

Note that the texture format must be specified in the shader as well. A list of valid formats can be found in the specification here: https://www.khronos.org/registry/OpenGL/specs/gl/GLSLangSpec.4.60.html#layout-qualifiers

Fields

dimension: TextureViewDimension

Dimension of the texture view that is going to be sampled.

format: TextureFormat

Format of the texture.

readonly: bool

The texture can only be read in the shader and it must be annotated with readonly.

Example GLSL syntax:

layout(set=0, binding=0, r32f) readonly uniform image2D myStorageImage;

Trait Implementations

impl Clone for BindingType

fn clone(&self) -> BindingType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BindingType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BindingType

fn deserialize<__D>( __deserializer: __D, ) -> Result<BindingType, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BindingType

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BindingType

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BindingType

impl StructuralPartialEq for BindingType