Enum BindingType

pub enum BindingType {
    Buffer {
        ty: BufferBindingType,
        has_dynamic_offset: bool,
        min_binding_size: Option<NonZero<u64>>,
    },
    Sampler(SamplerBindingType),
    Texture {
        sample_type: TextureSampleType,
        view_dimension: TextureViewDimension,
        multisampled: bool,
    },
    StorageTexture {
        access: StorageTextureAccess,
        format: TextureFormat,
        view_dimension: TextureViewDimension,
    },
    AccelerationStructure {
        vertex_return: bool,
    },
    ExternalTexture,
}

Type of a binding in a bind group layout.

For each binding in a layout, a BindGroup must provide a BindingResource of the corresponding type.

Corresponds to WebGPU’s mutually exclusive fields within GPUBindGroupLayoutEntry.

Variants

Buffer

A buffer binding.

Corresponds to WebGPU GPUBufferBindingLayout.

Fields

ty: BufferBindingType

Sub-type of the buffer binding.

has_dynamic_offset: 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>>

The minimum size for a BufferBinding matching this entry, in bytes.

If this is Some(size):

• When calling create_bind_group, the resource at this bind point must be a BindingResource::Buffer whose effective size is at least size.

• When calling create_render_pipeline or create_compute_pipeline, size must be at least the minimum buffer binding size for the shader module global at this bind point: large enough to hold the global’s value, along with one element of a trailing runtime-sized array, if present.

If this is None:

• Each draw or dispatch command checks that the buffer range at this bind point satisfies the minimum buffer binding size.

Sampler(SamplerBindingType)

A sampler that can be used to sample a texture.

Example WGSL syntax:

@group(0) @binding(0)
var s: sampler;

Example GLSL syntax:

layout(binding = 0)
uniform sampler s;

Corresponds to WebGPU GPUSamplerBindingLayout.

Texture

A texture binding.

Example WGSL syntax:

@group(0) @binding(0)
var t: texture_2d<f32>;

Example GLSL syntax:

layout(binding = 0)
uniform texture2D t;

Corresponds to WebGPU GPUTextureBindingLayout.

Fields

sample_type: TextureSampleType

Sample type of the texture binding.

view_dimension: TextureViewDimension

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

multisampled: bool

True if the texture has a sample count greater than 1. If this is true, the texture must be declared as texture_multisampled_2d or texture_depth_multisampled_2d in the shader, and read using textureLoad.

StorageTexture

A storage texture.

Example WGSL syntax:

@group(0) @binding(0)
var my_storage_image: texture_storage_2d<r32float, write>;

Example GLSL syntax:

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

Note that the texture format must be specified in the shader, along with the access mode. For WGSL, the format must be one of the enumerants in the list of storage texel formats.

Corresponds to WebGPU GPUStorageTextureBindingLayout.

Fields

access: StorageTextureAccess

Allowed access to this texture.

format: TextureFormat

Format of the texture.

view_dimension: TextureViewDimension

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

AccelerationStructure

A ray-tracing acceleration structure binding.

Example WGSL syntax:

@group(0) @binding(0)
var as: acceleration_structure;

or with vertex return enabled

@group(0) @binding(0)
var as: acceleration_structure<vertex_return>;

Example GLSL syntax:

layout(binding = 0)
uniform accelerationStructureEXT as;

Fields

vertex_return: bool

Whether this acceleration structure can be used to create a ray query that has flag vertex return in the shader

If enabled requires Features::EXPERIMENTAL_RAY_HIT_VERTEX_RETURN

ExternalTexture

An external texture binding.

Example WGSL syntax:

@group(0) @binding(0)
var t: texture_external;

Corresponds to WebGPU GPUExternalTextureBindingLayout.

Requires Features::EXTERNAL_TEXTURE

Implementations

impl BindingType

pub fn has_dynamic_offset(&self) -> bool

Returns true for buffer bindings with dynamic offset enabled.

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 Hash for BindingType

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoBindGroupLayoutEntryBuilder for BindingType

fn into_bind_group_layout_entry_builder(self) -> BindGroupLayoutEntryBuilder

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 Copy for BindingType

impl Eq for BindingType

impl StructuralPartialEq for BindingType