Skip to content

Sprite - Add Sprite Node Material as valid constructor argument #1716

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Sprite - Add Sprite Node Material as valid constructor argument #1716

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a2d2a9b
init branch
cmhhelgeson Jun 30, 2025
90587e1
run formatting
cmhhelgeson Jul 8, 2025
8b4af87
add missing types
cmhhelgeson Jul 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions types/three/src/objects/Sprite.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { BufferGeometry } from "../core/BufferGeometry.js";
import { Object3D, Object3DEventMap } from "../core/Object3D.js";
import { SpriteMaterial } from "../materials/Materials.js";
import SpriteNodeMaterial from "../materials/nodes/SpriteNodeMaterial.js";
import { Vector2 } from "../math/Vector2.js";

/**
Expand All @@ -21,9 +22,9 @@ import { Vector2 } from "../math/Vector2.js";
export class Sprite<TEventMap extends Object3DEventMap = Object3DEventMap> extends Object3D<TEventMap> {
/**
* Creates a new Sprite.
* @param material An instance of {@link THREE.SpriteMaterial | SpriteMaterial}. Default {@link THREE.SpriteMaterial | `new SpriteMaterial()`}, _with white color_.
* @param material An instance of {@link THREE.SpriteMaterial | SpriteMaterial | SpriteNodeMaterial}. Default {@link THREE.SpriteMaterial | `new SpriteMaterial()`}, _with white color_.
*/
constructor(material?: SpriteMaterial);
constructor(material?: SpriteMaterial | SpriteNodeMaterial);

/**
* Read-only flag to check if a given object is of type {@link Sprite}.
Expand All @@ -50,10 +51,10 @@ export class Sprite<TEventMap extends Object3DEventMap = Object3DEventMap> exten
geometry: BufferGeometry;

/**
* An instance of {@link THREE.SpriteMaterial | SpriteMaterial}, defining the object's appearance.
* An instance of {@link THREE.SpriteMaterial | SpriteMaterial | SpriteNodeMaterial}, defining the object's appearance.
* @defaultValue {@link THREE.SpriteMaterial | `new SpriteMaterial()`}, _with white color_.
*/
material: SpriteMaterial;
material: SpriteMaterial | SpriteNodeMaterial;

/**
* The sprite's anchor point, and the point around which the {@link Sprite} rotates.
Expand Down
Loading