Struct web_glitz::buffer::BufferView

pub struct BufferView<'a, T> where
    T: ?Sized,  { /* fields omitted */ }

A view on a segment or the whole of a Buffer.

Implementations

impl<'a, T> BufferView<'a, T> where
    T: ?Sized, 

pub fn usage_hint(&self) -> UsageHint

Returns the UsageHint that was specified for the Buffer view by this BufferView when it was created.

See UsageHint for details.

impl<'a, T> BufferView<'a, T>

pub fn size_in_bytes(&self) -> usize

The size in bytes of the viewed buffer region.

impl<'a, T> BufferView<'a, T> where
    T: Copy, 

pub fn upload_command<D>(&self, data: D) -> UploadCommand<T, D> where
    D: Borrow<T> + Send + Sync + 'static, 

Returns a command which, when executed will replace the data viewed by this BufferView with the given data.

This will modify the viewed Buffer, the buffer (and any other views on the same data) will be affected by this change.

pub fn download_command(&self) -> DownloadCommand<T>

Returns a command which, when executed will copy the data viewed by in this BufferView into a Box.

When the task is finished, the Box containing the copied data will be output.

impl<'a, T> BufferView<'a, MaybeUninit<T>>

pub unsafe fn assume_init(self) -> BufferView<'a, T>

Converts to BufferView<T>.

Safety

Its up to the user to guarantee that any tasks that read buffer region viewed by this view, is only executed after the viewed region is initialized. Note that certain tasks may wait on GPU fences and allow a runtime to progress other tasks while its waiting on the fence. As such, submitting your initialization tasks as part of a task that includes fencing (these are typically tasks that include "download" commands), may not guarantee that the buffer was initialized before any tasks that are submitted later will begin executing.

impl<'a, T> BufferView<'a, [T]>

pub fn len(&self) -> usize

Returns the number of elements contained in this Buffer.

pub fn get<I>(&self, index: I) -> Option<BufferView<'_, I::Output>> where
    I: BufferViewSliceIndex<T>, 

Returns a BufferView on an element or a sub-slice of the elements this Buffer, depending on the type of index.

• If given a position, returns a view on the element at that position or None if out of bounds.
• If given a range, returns a view on the sub-slice of elements corresponding to that range, or None if out of bounds.

Examples

use web_glitz::buffer::{Buffer, BufferView, UsageHint};

let buffer: Buffer<[f32]> = context.create_buffer([1.0, 2.0, 3.0, 4.0], UsageHint::StreamDraw);
let view = BufferView::from(&buffer);

view.get(1); // Some BufferView<f32> containing `2.0`
view.get(1..3); // Some BufferView<[f32]> containing `[2.0, 3.0]`
view.get(..2); // Some BufferView<[f32]> containing `[1.0 2.0]`
view.get(4); // None (index out of bounds)

pub unsafe fn get_unchecked<I>(&self, index: I) -> BufferView<'_, I::Output> where
    I: BufferViewSliceIndex<T>, 

Returns a BufferView on an element or a sub-slice of the elements this BufferView, depending on the type of index, without doing bounds checking.

• If given a position, returns a view on the element at that position, without doing bounds checking.
• If given a range, returns a view on the slice of elements corresponding to that range, without doing bounds checking.

Examples

use web_glitz::buffer::{Buffer, BufferView, UsageHint};

let buffer: Buffer<[f32]> = context.create_buffer([1.0, 2.0, 3.0, 4.0], UsageHint::StreamDraw);
let view = BufferView::from(&buffer);

unsafe { view.get_unchecked(1) }; // BufferView<f32> containing `2.0`

Unsafe

Only safe if index is in bounds. See [get] for a safe alternative.

impl<'a, T> BufferView<'a, [T]> where
    T: Copy, 

pub fn upload_command<D>(&self, data: D) -> UploadCommand<[T], D> where
    D: Borrow<[T]> + Send + Sync + 'static, 

Returns a command which, when executed will replace the elements viewed by this BufferView with the elements in given data.

If the data contains fewer elements than the slice viewed by this BufferView, then only the first N elements will be replaced, where N is the number of elements in the given data.

If the data contains more elements than the slice viewed by this Buffer, then only the first M elements in the data will be used to update this Buffer, where M is the number of elements in the slice viewed by the BufferView.

This will modify the viewed Buffer, the buffer (and any other views on the same data) will be affected by this change.

pub fn download_command(&self) -> DownloadCommand<[T]>

Returns a command which, when executed will copy the elements viewed by in this BufferView into a Box.

When the task is finished, the Box containing the copied elements will be output.

impl<'a, T> BufferView<'a, [MaybeUninit<T>]>

pub unsafe fn assume_init(self) -> BufferView<'a, [T]>

Converts to BufferView<[T]>.

Safety

Its up to the user to guarantee that any tasks that read buffer region viewed by this view, is only executed after the viewed region is initialized. Note that certain tasks may wait on GPU fences and allow a runtime to progress other tasks while its waiting on the fence. As such, submitting your initialization tasks as part of a task that includes fencing (these are typically tasks that include "download" commands), may not guarantee that the buffer was initialized before any tasks that are submitted later will begin executing.

Trait Implementations

impl<'a, T> Clone for BufferView<'a, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> Clone for BufferView<'a, [T]>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> Copy for BufferView<'a, T>

impl<'a, T> Copy for BufferView<'a, [T]>

impl<'a, T, const LEN: usize> From<&'a Buffer<[T; LEN]>> for BufferView<'a, [T]>

fn from(buffer: &'a Buffer<[T; LEN]>) -> BufferView<'a, [T]>

Performs the conversion.

impl<'a, T> From<&'a Buffer<T>> for BufferView<'a, T> where
    T: ?Sized, 

fn from(buffer: &'a Buffer<T>) -> BufferView<'a, T>

Performs the conversion.

impl<'a, T, const LEN: usize> From<&'a mut Buffer<[T; LEN]>> for BufferView<'a, [T]>

fn from(buffer: &'a mut Buffer<[T; LEN]>) -> BufferView<'a, [T]>

Performs the conversion.

impl<'a, T> From<&'a mut Buffer<T>> for BufferView<'a, T> where
    T: ?Sized, 

fn from(buffer: &'a mut Buffer<T>) -> BufferView<'a, T>

Performs the conversion.

impl<'a, T> Hash for BufferView<'a, T> where
    T: Hash + ?Sized, 

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<'a, T> PartialEq<BufferView<'a, T>> for BufferView<'a, T> where
    T: PartialEq + ?Sized, 

fn eq(&self, other: &BufferView<'a, T>) -> bool

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

fn ne(&self, other: &BufferView<'a, T>) -> bool

This method tests for !=.

impl<'a, T> Resource for BufferView<'a, T> where
    T: InterfaceBlock, 

type Encoding = Self

const TYPE: ResourceSlotType

fn encode<E>(
    self,
    slot_index: u32,
    encoder: BindGroupEncoder<'_, E>
) -> BindGroupEncoder<'_, (Self::Encoding, E)>

Encodes a binding for this resource at the specified slot_index.

impl<'a, T> StructuralPartialEq for BufferView<'a, T> where
    T: ?Sized, 

impl<'a, T> TypedVertexBuffer for BufferView<'a, [T]> where
    T: Vertex, 

type Vertex = T

impl<'a, 'b, T> TypedVertexBuffer for &'a BufferView<'b, [T]> where
    T: Vertex, 

type Vertex = T

impl<'a, 'b, T> TypedVertexBuffer for &'a mut BufferView<'b, [T]> where
    T: Vertex, 

type Vertex = T

impl<'a, T> VertexBuffer for BufferView<'a, [T]>

fn encode(self, encoding: &mut VertexBuffersEncoding<'_>)

impl<'a, 'b, T> VertexBuffer for &'a BufferView<'b, [T]>

fn encode(self, encoding: &mut VertexBuffersEncoding<'_>)

impl<'a, 'b, T> VertexBuffer for &'a mut BufferView<'b, [T]>

fn encode(self, encoding: &mut VertexBuffersEncoding<'_>)