Skip to main content

InstancedBufferAttribute

Struct InstancedBufferAttribute 

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

new InstancedBufferAttribute( new Float32Array( count * 16 ), 16 ).

The renderer keeps one GPU buffer per attribute, keyed on id, and writes into it only when version has moved since the last write, as three.js’ Attributes.update() does (issue #89).

Unlike three.js, a write through this type bumps the version itself: array_mut always does, and setMatrixAt() / setColorAt() do when the value they write differs from the one there. three.js needs attribute.needsUpdate = true because its Float32Array is mutated behind the attribute’s back; here every write goes through the attribute, so a second call would only add a stale-frame footgun, the same reasoning as Texture::set_data (docs/api.md). set_needs_update stays, for forcing a write.

clone() mints a fresh id, as a cloned BufferAttribute does, and shares the array until one side writes to it.

Fields§

§item_size: usize

BufferAttribute.itemSize.

Implementations§

Source§

impl InstancedBufferAttribute

Source

pub fn new(array: Vec<f32>, item_size: usize) -> Self

new InstancedBufferAttribute( array, itemSize ).

Source

pub fn id(&self) -> usize

BufferAttribute.id. Never reused, and never shared with a clone.

Source

pub fn array(&self) -> &[f32]

attribute.array, for reading.

Source

pub fn array_mut(&mut self) -> &mut [f32]

attribute.array, for writing. Bumps the version, so the next render re-writes the GPU buffer: the caller is taken to have changed something.

Source

pub fn version(&self) -> u32

BufferAttribute.version — how many times the array has been changed or marked changed.

Source

pub fn set_needs_update(&mut self)

attribute.needsUpdate = true — version ++, so the next render re-writes the GPU buffer even though nothing was written through array_mut.

Source

pub fn count(&self) -> usize

BufferAttribute.count — array.length / itemSize.

Trait Implementations§

Source§

impl Clone for InstancedBufferAttribute

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 InstancedBufferAttribute

The array is count * item_size floats — sixteen per instance for the instance matrix. Debug prints its length, as the textures do.

Source§

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

Formats the value using the given formatter. Read more

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.