API reference

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

I

interfaceBitmapTextOptions

@codexo/exojs / rendering / stable

26
props
0
methods
0
events
Import
import { BitmapTextOptions } from '@codexo/exojs'
Properties26
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. null (the default) takes the fill, gradient included, so a gradient-filled label gets a gradient-filled rule.
decorationOffset?: number
Extra downward offset in pixels applied to both rules, on top of the position the font's metrics put them at. Defaults to 0.
decorationThickness?: number
Rule thickness in pixels. 0 (the default) 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…
font?: FontFace
A pre-constructed FontFace to use as the font for this node. When passed to Text, the face is automatically registered with document.fonts. Load the face via FontFactory before constructing the node so glyphs render immediately. Takes precedence over fontFamily when both are set. ts const face = await loader.load(Asset.type('font', 'roboto.woff2', { family: 'Roboto' })); const label = new Text('Score: 0', { font: face, fontSize: 24 });
fontFamily?: string
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…
CSS font-variant-caps. Defaults to 'normal'.
fontWeight?: FontWeightFont weight values accepted by CSS / Canvas 2D.
CSS font-weight. Defaults to 'normal' so that single-weight custom fonts render without browser-synthesised bold artefacts. Set explicitly to 'bold' for display / title text that intentionally requires bold.
gradient?: TextGradientA multi-stop fill gradient for text. The ramp is a shader-side function of the node's ink box, not a rasterized texture, so it costs no atlas work and follows… | null
Multi-stop fill gradient. When set it overrides fillColor for the glyph interior; null disables it. The ramp spans the ink extent (getLocalBounds()), not the advance box.
layout?: LayoutOptionsControls text flow and overflow - separate from TextStyle which describes visual appearance. Pass to Text or layoutText.
Layout options forwarded to the text layout engine.
leading?: number
Extra pixel gap between lines, added on top of lineHeight.
lineHeight?: number
Multiplier of fontSize for the distance between lines. Default 1.2 - not a pixel value.
msdf?: boolean
Set to true if the atlas was produced by msdf-atlas-gen (MSDF). Selects the text-msdf shader which applies the median SDF formula. Defaults to false (colour/RGBA atlas).
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…
outlineWidth?: number
Outline width in SDF units (0..0.5). 0 disables the outline.
scale?: number
Scale applied uniformly to all glyph metrics. Defaults to 1.
shadowAlpha?: number
Shadow opacity (0..1). 0 disables the shadow.
shadowBlur?: number
Shadow blur softness (0..1). Larger values soften the shadow edge.
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…
Drop-shadow color.
shadowOffsetX?: number
Horizontal shadow offset in pixels.
shadowOffsetY?: number
Vertical shadow offset in pixels.
strikethrough?: boolean
Draw a rule through each line. Defaults to false.
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. Defaults to 'none'. The mapping is Unicode-aware and never touches the node's text: reading it back gives the string that was assigned, so a transformed label stays editable and a caret still lands where the reader clicked. 'capitalize' uppercases the first grapheme cluster of each word and leaves the rest of the word alone, matching CSS. Word boundaries and the case mapping both follow locale when LayoutOptions.locale sets one.
underline?: boolean
Draw a rule under each line. Defaults to false.
Source
src/rendering/text/BitmapText.ts