AuroraEffect class

A shader-based aurora borealis effect.

Renders layered, flowing color bands reminiscent of the northern lights, with smooth HSL color cycling and optional pointer-based warping.

{@tool snippet}

GKWidget(
  effect: AuroraEffect(
    speed: 1.0,
    colorShift: 0.0,
  ),
  trigger: GKTrigger.auto,
  interactive: true,
)

{@end-tool}

Inheritance

Constructors

AuroraEffect({double speed = 1.0, double colorShift = 0.0})
Creates an AuroraEffect.
const

Properties

colorShift → double
Hue shift for the aurora color palette, ranging from 0.0 to 1.0.
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
speed → double
The animation speed multiplier.
final

Methods

build(BuildContext context, GKController controller, {Widget? child}) → Widget
Builds the widget tree for this effect.
override
dispose() → void
Override to release resources held by this effect.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited