Skip to content
pixi-silk
GitHub repository
Interface

SdfAtlasOptions

import type { SdfAtlasOptions } from 'pixi-silk/text';

Options of an SdfAtlas.

Properties#

PropertyTypeDescriptionDefined in
context?GlyphContextContext to rasterise glyphs with. Default a new canvas from Pixi’s DOM adapter.text/atlas.ts:100
cutoff?numberFraction of the field spent inside glyphs. Default 0.25.text/atlas.ts:92
height?numberStarting height in texels. The texture doubles in height as glyphs arrive. Default 256.text/atlas.ts:96
maxHeight?numberLargest height the texture grows to. When it is full, the atlas starts over. Default 4096.text/atlas.ts:98
radius?numberDistance in raster pixels the field covers. Outlines and glows can reach 0.75 * radius. Default 16.text/atlas.ts:90
size?numberFont size glyphs are baked at, in pixels. Larger is sharper on big text and uses more memory. Default 48.text/atlas.ts:88
width?numberAtlas texture width in texels. Default 1024.text/atlas.ts:94