Skip to content
ClassGame Objects & Sprites@public

FlxGradient

Immutable renderer-neutral local gradient descriptor.

ts
export declare class FlxGradient

Properties

PropertyModifiersTypeDescription
centerreadonlyReadonly<PointLike>Radial inner-circle center.
endreadonlyReadonly<PointLike>Linear end point.
innerRadiusreadonlynumberRadial inner radius.
outerCenterreadonlyReadonly<PointLike>Radial outer-circle center.
outerRadiusreadonlynumberRadial outer radius.
startreadonlyReadonly<PointLike>Linear start point.
stopsreadonlyreadonly Readonly<FlxGradientStop>[]Ordered immutable RGBA stops.
typereadonly'linear' | 'radial'Gradient family used by camera adapters.

Methods

static linear()

ts
static linear(stops: readonly FlxGradientStop[], options?: FlxLinearGradientOptions): FlxGradient

Create an immutable local linear gradient.

Parameters:

ParameterTypeDescription
stopsreadonly FlxGradientStop[]-
optionsFlxLinearGradientOptions-

Returns: FlxGradient

static radial()

ts
static radial(stops: readonly FlxGradientStop[], options?: FlxRadialGradientOptions): FlxGradient

Create an immutable local radial gradient.

Parameters:

ParameterTypeDescription
stopsreadonly FlxGradientStop[]-
optionsFlxRadialGradientOptions-

Returns: FlxGradient

Released under the MIT License.