Skip to main content

StorageBufferAttribute

Struct StorageBufferAttribute 

Source
pub struct StorageBufferAttribute {
    pub item_size: usize,
    /* private fields */
}
Expand description

three.js’ StorageBufferAttribute / StorageInstancedBufferAttribute (src/renderers/common/): an attribute whose GPU buffer is also a storage buffer, so a compute kernel can write what a draw reads as vertices.

A handle, as IndirectStorageBufferAttribute is: clones are the same attribute, and the renderer keys the one GPU buffer on id, which storage( &attribute, ty, count ) (in nodes::tsl) carries too. Turn it into a geometry attribute with .into(). The array is the buffer’s initial contents only; it is uploaded once, padded to vec4 stride when the item size is 3.

Fields§

§item_size: usize

BufferAttribute.itemSize, unpadded.

Implementations§

Source§

impl StorageBufferAttribute

Source

pub fn new( contents: impl Into<StorageContents>, item_size: usize, kind: ArrayKind, ) -> Self

new StorageBufferAttribute( count | array, itemSize, typeClass ). With a count, the array is count * item_size zeros of kind; with an array, kind is ignored as three ignores typeClass.

Source

pub fn new_instanced( contents: impl Into<StorageContents>, item_size: usize, kind: ArrayKind, ) -> Self

new StorageInstancedBufferAttribute( count | array, itemSize, typeClass ) — read as a vertex attribute, it steps once per instance.

Source

pub fn id(&self) -> BufferId

The identity the renderer’s GPU buffer is keyed on.

Source

pub fn count(&self) -> usize

BufferAttribute.count — array.length / itemSize.

Source

pub fn data(&self) -> Ref<'_, TypedArray>

attribute.array — the initial contents.

Source

pub fn is_instanced(&self) -> bool

isStorageInstancedBufferAttribute.

Trait Implementations§

Source§

impl Clone for StorageBufferAttribute

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StorageBufferAttribute

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<StorageBufferAttribute> for BufferAttribute

Source§

fn from(storage: StorageBufferAttribute) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.