Skip to content
pixi-silk
GitHub repository
Interface

AuroraOptions

import type { AuroraOptions } from 'pixi-silk/glow';

Options of Aurora.

Properties#

PropertyTypeDescriptionDefined in
background?ColorSourceColour above the light. Default near black.glow/aurora.ts:91
colors?[ColorSource, ColorSource, ColorSource]Deep, mid and hot colours, top to bottom. White is added under them. Default violet, pink, white.glow/aurora.ts:89
heightnumberBox height in local units.glow/aurora.ts:87
radius?numberCorner radius of the box in local units. Default 0.glow/aurora.ts:97
rise?numberHow high the light reaches, 0 to 1 of the box height. Default 0.62.glow/aurora.ts:93
speed?numberDrift speed, a multiplier on time. 0 freezes it and stops the ticker. Default 1.glow/aurora.ts:95
ticker?Ticker | nullTicker that drives the drift. Default Ticker.shared. null leaves it to Aurora.tick.glow/aurora.ts:99
widthnumberBox width in local units.glow/aurora.ts:85