Skip to content
pixi-silk
GitHub repository
Class

ColorWheel

import { ColorWheel } from 'pixi-silk/ui/color';

Colour wheel: hue around the disc, saturation from the centre out, and a value strip beside it. Origin at the top-left corner, the disc first, then the strip.

Extends#

Constructors#

Constructor#

new ColorWheel(options?: ColorWheelOptions): ColorWheel;

Parameters#

ParameterType
optionsColorWheelOptions

Returns#

ColorWheel

Overrides#

ColorPicker.constructor

Properties#

PropertyModifierTypeDescriptionInherited fromDefined in
modelreadonlyColorModelThe colour this picker edits. Share it to link pickers.ColorPicker.modelui/color/ColorPicker.ts:36
statereadonlyColorPickerStateSignals to read. See ColorPickerState.ColorPicker.stateui/color/ColorPicker.ts:38

Accessors#

pickerWidth#

Get Signature#

get pickerWidth(): number;

Total width in local units: disc, gap and strip.

Returns

number

Methods#

destroy()#

destroy(options?: DestroyOptions): void;

Stops the animation and unsubscribes from the model. The model stays usable. Destroys children by default.

Parameters#

ParameterType
options?DestroyOptions

Returns#

void

Inherited from#

ColorPicker.destroy


tick()#

tick(dt: number): boolean;

Advances the animation by dt seconds (only needed with ticker: null). Returns true while moving.

Parameters#

ParameterType
dtnumber

Returns#

boolean

Inherited from#

ColorPicker.tick