Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More

troika-3d-text

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

troika-3d-text

SDF text for the Troika 3D scene management framework


Version published
Weekly downloads
379
decreased by-23.28%
Maintainers
1
Weekly downloads
 
Created

troika-3d-text

PLEASE NOTE: The standalone TextMesh for Three.js, which used to be accessible from this package in a custom dist/textmesh-standalone.umd.js file, has been promoted to its own package, troika-three-text. You can now just import Text from that package directly:

import { Text } from 'troika-three-text'

let myText = new Text()

This package provides high quality text rendering in the Troika scene management framework, using signed distance fields (SDF) and antialiasing using standard derivatives. It is based on troika-three-text.

Demo

Here's an online demo.

Installation

Get it from NPM:

npm install troika-3d-text

You will also need to install a compatible version of Three.js; see the notes in the Troika 3D Readme for details.

Usage

Import the Text3DFacade class:

import { Text3DFacade } from 'troika-3d-text'

...then use it within your scene descriptor to configure it:

{
  key: 'my-text',
  facade: Text3DFacade,
  text: 'Hello world!',
  fontSize: 0.2,
  color: 0x9966FF,
  z: -2
  // ...etc.
}

Supported properties

Text3DFacade supports all properties supported by the Text mesh from troika-three-text; see the documentation there for details.

FAQs

Package last updated on 29 Jun 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts