starfield-react/dist/src/hooks/useStarField.d.ts

A React component that draws an animated Starfield on a canvas dom element.

import { MutableRefObject, RefObject } from 'react';
import { ColorFunction, StarFieldState } from '../field/StarState';
export interface Options {
    count: number;
    speed: number;
    starRatio: number;
    starSize: number;
    width: number;
    height: number;
    starStyle: ColorFunction | string;
    clear: boolean;
    starShape: 'butt' | 'round' | 'square';
    bgStyle: string;
    fps: number;
    noBackground: boolean;
}
export declare function useStarField(canvasRef: RefObject<HTMLCanvasElement>, options: Options, stateReference?: MutableRefObject<StarFieldState>): void;