effect-motion
API ReferencerendererNamespacesTextInterfaces

TextMesh

A glyph mesh over the shared resources, with its update and release hooks.

Interface: TextMesh

Defined in: packages/renderer/src/Text.ts:173

A glyph mesh over the shared resources, with its update and release hooks.

Properties

commit

readonly commit: () => Effect<void, EffectMotionError>;

Defined in: packages/renderer/src/Text.ts:180

Flush pending layout/appearance changes into the GPU state.

Returns

Effect<void, EffectMotionError>


dispose

readonly dispose: () => void;

Defined in: packages/renderer/src/Text.ts:182

Release the mesh's geometry and materials (shared resources stay).

Returns

void


mesh

readonly mesh: Object3D;

Defined in: packages/renderer/src/Text.ts:174


setColor

readonly setColor: (r, g, b, a) => void;

Defined in: packages/renderer/src/Text.ts:178

Set the fill color; r, g, b are 0–255, a is 0–1 opacity.

Parameters

ParameterType
rnumber
gnumber
bnumber
anumber

Returns

void


setLayout

readonly setLayout: (layout) => void;

Defined in: packages/renderer/src/Text.ts:176

Point the mesh at a new layout — pair with TextMesh.commit.

Parameters

ParameterType
layoutLayoutResult

Returns

void

On this page