API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

C

classTextStyle

@codexo/exojs / rendering / stable

Describes how a Text node renders its string. Every setter marks the style dirty with a StyleChangeHint so that the owning node can batch-rebuild efficiently on the next frame: - `'tint'` - only updates `Mesh.tint`, no atlas work - `'layout'` - rebuilds the glyph mesh, reuses cached atlas glyphs - `'font'` - atlas lookup + full mesh rebuild Call consumeDirty at the start of each frame to get the accumulated hint and clear the flag.

25
props
3
methods
1
events
Import
import { TextStyle } from '@codexo/exojs'

Describes how a Text node renders its string.

Every setter marks the style dirty with a StyleChangeHint so that the owning node can batch-rebuild efficiently on the next frame: - `'tint'` - only updates `Mesh.tint`, no atlas work - `'layout'` - rebuilds the glyph mesh, reuses cached atlas glyphs - `'font'` - atlas lookup + full mesh rebuild

Call consumeDirty at the start of each frame to get the accumulated hint and clear the flag.

Constructors1
new(options: TextStyleOptionsConstruction-time options for a TextStyle. All properties are optional; defaults match the TextStyle constructor.): TextStyleText styling options carried by a TextObject.
Methods3
clone(): TextStyleText styling options carried by a TextObject.
Return a new TextStyle with all properties copied from this one.
consumeDirty(): StyleChangeHintDescribes how costly a style change is to incorporate. Hints accumulate to the heaviest pending change: `tint` < `layout` < `font` | null
Returns the accumulated StyleChangeHint and clears the dirty flag, or null if nothing has changed since the last call. Call this once per frame from the owning node's layout pass.
copy(style: TextStyleText styling options carried by a TextObject.): this
Copy all properties from style into this instance and return this.
Properties25
align: TextAlignmentHorizontal alignment mode for multi-line text layout.
decorationColor: Color32-bit RGBA color value with channel-wise accessors. Red, green, and blue are integers in 0..255; alpha is a float in 0..1. Out-of-range values are saturated o… | null
Rule colour, or null to follow the fill.
decorationOffset: number
Extra downward offset in pixels applied to both rules.
decorationThickness: number
Rule thickness in pixels; 0 derives it from the font size.
fillColor: Color32-bit RGBA color value with channel-wise accessors. Red, green, and blue are integers in 0..255; alpha is a float in 0..1. Out-of-range values are saturated o…
Runtime fill color applied as Mesh.tint. Glyphs are always rasterized white; this color multiplies them at draw time without touching the atlas.
font: string
CSS font shorthand used as CanvasRenderingContext2D.font during glyph rasterization.
fontFamily: string
fontKey: FontVariantKeyEverything that decides which glyphs a text run is drawn from. Named rather than positional because the four values are all strings and three of them default t…
The typeface, slant, weight and caps variant this style selects, as the key a glyph atlas, a metrics cache or a line shaper is resolved by.
fontSize: number
fontStyle: FontStyleCSS font-style values accepted by Canvas 2D. `'oblique'` slants an upright face by a fixed angle. Where a family ships a real italic the browser resolves `'ita…
fontVariant: FontVariantCSS font-variant-caps values the glyph rasterizer honours. `'small-caps'` renders lowercase letters as reduced capitals - from the family's own small-cap glyph…
fontWeight: FontWeightFont weight values accepted by CSS / Canvas 2D.
gradient: ResolvedTextGradientA text gradient with every optional field resolved and its stops normalized. | null
Multi-stop fill gradient, or null when the glyph interior takes fillColor. Read back normalized: stops cloned, offsets clamped to 0..1 and sorted, angle resolved. Assigning re-normalizes, so the object handed in is never aliased and mutating it afterwards changes nothing.
leading: number
Extra pixel gap between lines, added on top of lineHeight.
lineHeight: number
outlineColor: Color32-bit RGBA color value with channel-wise accessors. Red, green, and blue are integers in 0..255; alpha is a float in 0..1. Out-of-range values are saturated o…
Outline color - used by BitmapText/SDF rendering as a shader uniform.
outlineWidth: number
Outline width in SDF units (0..0.5). 0 disables the outline.
shadowAlpha: number
Shadow opacity (0..1). 0 disables the shadow.
shadowBlur: number
shadowColor: Color32-bit RGBA color value with channel-wise accessors. Red, green, and blue are integers in 0..255; alpha is a float in 0..1. Out-of-range values are saturated o…
shadowOffsetX: number
shadowOffsetY: number
strikethrough: boolean
Rule through each line.
textTransform: TextTransformCase mapping applied to the string before it is laid out. Mirrors the CSS `text-transform` values of the same names.
Case mapping applied before layout. Changing it re-flows the text; the node's text is untouched.
underline: boolean
Rule under each line. Rebuilds the geometry: a rule is a quad of its own.
Events1
onChange: SignalLightweight typed event emitter. Each `Signal` represents one named notification channel (e.g. `onResize`, `onFrame`). Listeners are added with Signal.add or S…<[]>
Fires once per dirty cycle when any property changes.
Source
src/rendering/text/TextStyle.ts