Struct TexelArray 

pub struct TexelArray {
    texture: Texture,
    view: TextureView,
    layout: TexelArrayLayout,
    staging: StagingBuffer,
    scratch: Vec<u8>,
}

A flat array of fixed-size elements stored in a texture.

See the module docs for what it is for and how it is laid out.

Fields

texture: Texture

The texture the elements live in.

view: TextureView

The whole texture as one view, which is what a bind group binds.

layout: TexelArrayLayout

The array’s shape and format.

staging: StagingBuffer

The staging buffer the row-padded image reaches the texture through, reused across frames like every other upload.

scratch: Vec<u8>

The row-padded image the last upload was assembled in, kept so a steady frame reallocates nothing.

Implementations

impl TexelArray

pub fn new( device: &Device, label: Option<&str>, element_size: u64, capacity: u64, max_dimension: u32, ) -> Self

Allocate an array with room for capacity elements of element_size bytes.

max_dimension is the device’s [wgpu::Limits::max_texture_dimension_2d]; the texture never exceeds it on either axis.

Panics

Under the conditions TexelArrayLayout::new panics.

pub fn texture(&self) -> &Texture

The texture the elements live in.

pub fn view(&self) -> &TextureView

The view a bind group binds.

pub fn layout(&self) -> &TexelArrayLayout

The array’s shape and format.

pub fn binding_resource(&self) -> BindingResource<'_>

The bind-group resource that binds this array.

pub fn upload( &mut self, device: &Device, encoder: &mut CommandEncoder, elements: &[u8], )

Upload elements — whole elements, laid out as the storage buffer would have held them — into the texture, recording the copy into encoder.

The bytes go through a reused staging buffer, so a steady frame allocates nothing and the copy is batched with the rest of the frame’s work rather than costing a submission of its own.

Panics

Under the conditions TexelArrayLayout::pack panics.

pub fn write(&mut self, queue: &Queue, elements: &[u8])

Upload elements through the queue, for data written once.

The rows are re-aligned by [wgpu::Queue::write_texture], so unlike Self::upload this needs no copy alignment — but it also costs a submission of its own.

Panics

Under the conditions TexelArrayLayout::pack panics.