Docs

Glow ​

Declare a bounded screen-space glow.

Generated from the reviewed SDK 0.1.0 contract snapshot. Unreviewed workspace changes are not included.

Public exports ​

Import from @scape/sdk.

GizmoGlow, gizmoGlowError, gizmoGlowFrame, validGizmoGlow.

Type declarations ​

These declarations preserve source comments and related types. Import only the public exports listed above; module-relative paths below describe how the package is organized.

ts
/** Bounded decorative glow, evaluated by the host without per-frame author callbacks. */
export interface GizmoGlow {
    color: string;
    size: number;
    pulse: {
        speed: number;
        amount: number;
        phaseX: number;
    };
    opacity: {
        base: number;
        amount: number;
        speed: number;
        phaseY: number;
    };
    hue?: {
        speed: number;
        phaseY: number;
        saturation: number;
        lightness: number;
    };
}
/** The first actionable validation error, or null when the recipe is valid. */
export declare function gizmoGlowError(value: unknown): string | null;
export declare function validGizmoGlow(value: unknown): value is GizmoGlow;
export declare function gizmoGlowFrame(glow: GizmoGlow, seconds: number, x: number, y: number, reducedMotion?: boolean): {
    size: number;
    opacity: number;
    hue: number | undefined;
};

Usage and limits ​

See Gizmo guides, working examples, and limits for lifecycle, validation and host behavior.

All SDK exports