Skip to main content

Sprite

Struct Sprite 

Source
pub struct Sprite {
    pub geometry: Rc<BufferGeometry>,
    pub material: SpriteNodeMaterial,
    pub center: Vector2,
    pub count: usize,
}
Expand description

The state Sprite adds to Object3D. It lives in a node’s Payload, as Mesh’s does — see docs/scene-graph.md.

Fields§

§geometry: Rc<BufferGeometry>

Sprite.geometry — the shared quad, the same Rc for every sprite.

§material: SpriteNodeMaterial

Sprite.material.

§center: Vector2

Sprite.center — the sprite’s anchor point in its own quad, ( 0.5, 0.5 ) being the middle and ( 0, 0 ) the bottom left. Read by the vertex shader through a reference( 'center', 'vec2', object ) uniform, by raycast(), and by Frustum.intersectsSprite().

§count: usize

Sprite.count — the number of instances drawn, 1 by default. A larger count draws the one quad that many times, and the material tells the instances apart with instanceIndex or an instanced attribute (webgpu_instance_sprites).

Implementations§

Source§

impl Sprite

Source

pub fn new(material: impl Into<Option<SpriteNodeMaterial>>) -> ObjectRef

new Sprite( material ), as a scene-graph ObjectRef.

None is three’s default argument, new SpriteMaterial(), which under WebGPURenderer is a SpriteNodeMaterial.

Source

pub fn of(material: Option<SpriteNodeMaterial>) -> Self

The Sprite state alone, for a caller that already has the node.

Source

pub fn raycast( &self, matrix_world: &Matrix4, object: &ObjectRef, raycaster: &Raycaster, intersects: &mut Vec<Intersection>, )

Sprite.raycast( raycaster, intersects ) — the quad as the vertex shader places it, facing raycaster.camera, tested as two triangles with no backface culling.

three.js logs an error when raycaster.camera is null and then throws on reading it; the port logs the same message and hits nothing.

Trait Implementations§

Source§

impl Clone for Sprite

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

Auto Trait Implementations§

§

impl !RefUnwindSafe for Sprite

§

impl !Send for Sprite

§

impl !Sync for Sprite

§

impl !UnwindSafe for Sprite

§

impl Freeze for Sprite

§

impl Unpin for Sprite

§

impl UnsafeUnpin for Sprite

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.