Struct BufferDescriptor

#[repr(C)]
pub struct BufferDescriptor<L> {
    pub label: L,
    pub size: BufferAddress,
    pub usage: BufferUsages,
    pub mapped_at_creation: bool,
}

Describes a Buffer.

Corresponds to WebGPU GPUBufferDescriptor.

Fields

label: L

Debug label of a buffer. This will show up in graphics debuggers for easy identification.

size: BufferAddress

Size of a buffer, in bytes.

usage: BufferUsages

Usages of a buffer. If the buffer is used in any way that isn’t specified here, the operation will panic.

Specifying only usages the application will actually perform may increase performance. Additionally, on the WebGL backend, there are restrictions on BufferUsages::INDEX; see DownlevelFlags::UNRESTRICTED_INDEX_BUFFER for more information.

mapped_at_creation: bool

Allows a buffer to be mapped immediately after they are made. It does not have to be BufferUsages::MAP_READ or BufferUsages::MAP_WRITE, all buffers are allowed to be mapped at creation.

If this is true, size must be a multiple of COPY_BUFFER_ALIGNMENT.

Implementations

impl<L> BufferDescriptor<L>

pub fn map_label<K>(&self, fun: impl FnOnce(&L) -> K) -> BufferDescriptor<K>

Takes a closure and maps the label of the buffer descriptor into another.

Trait Implementations

impl<L: Clone> Clone for BufferDescriptor<L>

fn clone(&self) -> BufferDescriptor<L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L: Debug> Debug for BufferDescriptor<L>

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

Formats the value using the given formatter.

impl<'de, L> Deserialize<'de> for BufferDescriptor<L>

where L: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<L: Hash> Hash for BufferDescriptor<L>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<L: PartialEq> PartialEq for BufferDescriptor<L>

fn eq(&self, other: &BufferDescriptor<L>) -> 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<L> Serialize for BufferDescriptor<L>

where L: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<L: Eq> Eq for BufferDescriptor<L>

impl<L> StructuralPartialEq for BufferDescriptor<L>