three.textsprite

THREE.TextSprite

class THREE.TextSprite extends THREE.Sprite

An instance of TextSprite automatically computes the optimal font size depending on the distance to the camera and the size of the renderer canvas.

demo

Try it out!

dependencies

• THREE
• THREE.TextTexture

setup

npm

npm install three.textsprite

ES module

import TextSprite from 'three.textsprite';

browser

<script src="https://unpkg.com/three"></script>
<script src="https://unpkg.com/three.texttexture"></script>
<script src="https://unpkg.com/three.textsprite"></script>

The class TextSprite will be available under the namespace THREE.

members

.constructor({textSize, redrawInterval, maxFontSize, texture, material})

argument	description
texture	The parameters to pass to the constructor of TextTexture.
material	The parameters to pass to the constructor of SpriteMaterial.

let sprite = new THREE.TextSprite({
  textSize: 10,
  redrawInterval: 250,
  texture: {
    text: 'Carpe Diem',
    fontFamily: 'Arial, Helvetica, sans-serif',
  },
  material: {
    color: 0xffbbff,
    fog: true,
  },
});
scene.add(sprite);

---

.isTextSprite = true

Used to check whether this is an instance of TextSprite.

You should not change this, as it is used internally for optimisation.

---

.textSize = 1

The size of the text.

---

.redrawInterval = 1

The minimum time that must elapse before the canvas is redrawn. If 0, the canvas is redrawn immediately whenever TextSprite is rendered, otherwise the redrawing is deferred.

---

.maxFontSize = Infinity

The maximum font size.

---

.dispose()

Disposes the texture and the material.