@kayelaa/canvas API - v0.2.15
    Preparing search index...

    Interface KaylaRenderer

    Renderer wrapper that extends LEA renderer with game integration and pointer utilities.

    interface KaylaRenderer {
        game?: KaylaInternals.KaylaGame;
        pointerX: number;
        pointerY: number;
        pointerEvents: LeaEventEmitter<
            { action: [Vector2, KaylaClickType, KaylaPointerAction] },
        >;
        onPointerDown: (e: PointerEvent) => void;
        onPointerUp: (e: PointerEvent) => void;
        onPointerCancel: (e: PointerEvent) => void;
        onPointerMove: (e: PointerEvent) => void;
        isKaylaDisabled: boolean;
        pointerPosUpdater(e: PointerEvent): void;
        onPointerAll(e: PointerEvent, action: KaylaPointerAction): void;
        listenPointerUpdates(): void;
        unlistenPointerUpdates(): void;
        pointerPosToWorldPos(mx: number, my: number): Vector2;
        camToViewportPos(camX: number, camY: number): Vector2;
        pointerPosToWorldPosOLD(mx: number, my: number): Vector2;
        getMousePos(): Vector2;
        useDraw(
            callback: (ctx: CanvasRenderingContext2D, event: KaylaEvent) => void,
        ): () => void;
        attachTo(game: KaylaInternals.KaylaGame): void;
        detach(): void;
        listenerMap: Map<"draw" | "viewport_update", Listener<any[]>[]>;
        on<K extends "draw" | "viewport_update">(
            event: K,
            listener: (
                ...args: {
                    draw: [CanvasRenderingContext2D];
                    viewport_update: [{ width: number; height: number }];
                }[K],
            ) => void,
        ): this;
        once<K extends "draw" | "viewport_update">(
            event: K,
            listener: (
                ...args: {
                    draw: [CanvasRenderingContext2D];
                    viewport_update: [{ width: number; height: number }];
                }[K],
            ) => void,
        ): this;
        off<K extends "draw" | "viewport_update">(
            event: K,
            listener: (
                ...args: {
                    draw: [CanvasRenderingContext2D];
                    viewport_update: [{ width: number; height: number }];
                }[K],
            ) => void,
        ): this;
        emit<K extends "draw" | "viewport_update">(
            event: K,
            ...args: {
                draw: [CanvasRenderingContext2D];
                viewport_update: [{ width: number; height: number }];
            }[K],
        ): boolean;
        removeAllListeners<K extends "draw" | "viewport_update">(
            event?: K,
        ): KaylaRenderer;
        listenerCount<K extends "draw" | "viewport_update">(event: K): number;
        running: boolean;
        get canvas(): HTMLCanvasElement;
        set canvas(canvas: HTMLCanvasElement): void;
        get ctx(): CanvasRenderingContext2D;
        automatic: boolean;
        retransform(): void;
        get viewportWidth(): number;
        set viewportWidth(v: number): void;
        get width(): number;
        get height(): number;
        get centerX(): number;
        get centerY(): number;
        get left(): number;
        get top(): number;
        get right(): number;
        get bottom(): number;
        get viewportHeight(): number;
        set viewportHeight(v: number): void;
        get cameraWidth(): number;
        set cameraWidth(v: number): void;
        get cameraHeight(): number;
        set cameraHeight(v: number): void;
        updateCanvasResolution(): void;
        emitViewportUpdate(): void;
        applyTransform(): void;
        get FPS(): number;
        update(): void;
        start(): void;
        stop(): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    game? pointerX pointerY pointerEvents onPointerDown onPointerUp onPointerCancel onPointerMove isKaylaDisabled listenerMap running automatic

    Accessors

    canvas ctx viewportWidth width height centerX centerY left top right bottom viewportHeight cameraWidth cameraHeight FPS

    Methods

    pointerPosUpdater onPointerAll listenPointerUpdates unlistenPointerUpdates pointerPosToWorldPos camToViewportPos pointerPosToWorldPosOLD getMousePos useDraw attachTo detach on once off emit removeAllListeners listenerCount retransform updateCanvasResolution emitViewportUpdate applyTransform update start stop

    Properties

    game?: KaylaInternals.KaylaGame

    The attached game instance (set via attachTo).

    pointerX: number

    Current canvas-space pointer X coordinate.

    pointerY: number

    Current canvas-space pointer Y coordinate.

    pointerEvents: LeaEventEmitter<
        { action: [Vector2, KaylaClickType, KaylaPointerAction] },
    >

    Pointer related event-emitter

    onPointerDown: (e: PointerEvent) => void
    onPointerUp: (e: PointerEvent) => void
    onPointerCancel: (e: PointerEvent) => void
    onPointerMove: (e: PointerEvent) => void
    isKaylaDisabled: boolean
    listenerMap: Map<"draw" | "viewport_update", Listener<any[]>[]> = ...
    running: boolean

    Whether the renderer is currently running (RAF loop active).

    automatic: boolean

    Accessors

    • get canvas(): HTMLCanvasElement

      The target canvas element.

      Returns HTMLCanvasElement

    • set canvas(canvas: HTMLCanvasElement): void

      Parameters

      • canvas: HTMLCanvasElement

      Returns void

    • get ctx(): CanvasRenderingContext2D

      The 2D rendering context.

      Returns CanvasRenderingContext2D

    • get viewportWidth(): number

      The logical viewport width (game coordinate space).

      Returns number

    • set viewportWidth(v: number): void

      Parameters

      • v: number

      Returns void

    • get width(): number

      Returns number

    • get height(): number

      Returns number

    • get centerX(): number

      Center X of the viewport (viewportWidth / 2).

      Returns number

    • get centerY(): number

      Center Y of the viewport (viewportHeight / 2).

      Returns number

    • get left(): number

      Returns number

    • get top(): number

      Returns number

    • get right(): number

      Returns number

    • get bottom(): number

      Returns number

    • get viewportHeight(): number

      The logical viewport height (game coordinate space).

      Returns number

    • set viewportHeight(v: number): void

      Parameters

      • v: number

      Returns void

    • get cameraWidth(): number

      The camera/pixel resolution width (canvas backing resolution).

      Returns number

    • set cameraWidth(v: number): void

      Parameters

      • v: number

      Returns void

    • get cameraHeight(): number

      The camera/pixel resolution height (canvas backing resolution).

      Returns number

    • set cameraHeight(v: number): void

      Parameters

      • v: number

      Returns void

    • get FPS(): number

      Current measured FPS (updated every second).

      Returns number

    Methods

    • Registers a draw callback that receives a normalized KaylaEvent.

      Parameters

      • callback: (ctx: CanvasRenderingContext2D, event: KaylaEvent) => void

        Paint handler

      Returns () => void

      Unsubscribe function

    • Registers a listener for the specified event.

      Type Parameters

      • K extends "draw" | "viewport_update"

        Event name

      Parameters

      • event: K

        The name of the event

      • listener: (
            ...args: {
                draw: [CanvasRenderingContext2D];
                viewport_update: [{ width: number; height: number }];
            }[K],
        ) => void

        The callback to invoke when the event is emitted

      Returns this

      This emitter for chaining

    • Registers a one-time listener for the specified event.

      The listener is automatically removed after the first invocation.

      Type Parameters

      • K extends "draw" | "viewport_update"

        Event name

      Parameters

      • event: K

        The name of the event

      • listener: (
            ...args: {
                draw: [CanvasRenderingContext2D];
                viewport_update: [{ width: number; height: number }];
            }[K],
        ) => void

        The callback to invoke once

      Returns this

      This emitter for chaining

    • Removes a listener for the specified event.

      Type Parameters

      • K extends "draw" | "viewport_update"

        Event name

      Parameters

      • event: K

        The name of the event

      • listener: (
            ...args: {
                draw: [CanvasRenderingContext2D];
                viewport_update: [{ width: number; height: number }];
            }[K],
        ) => void

        The callback to remove

      Returns this

      This emitter for chaining

    • Emits an event, invoking all registered listeners with the provided arguments.

      If the event is "error" and no listeners are registered, the first argument (the error) will be thrown.

      Type Parameters

      • K extends "draw" | "viewport_update"

        Event name

      Parameters

      • event: K

        The name of the event to emit

      • ...args: {
            draw: [CanvasRenderingContext2D];
            viewport_update: [{ width: number; height: number }];
        }[K]

        Arguments to pass to listeners

      Returns boolean

      true if any listeners were invoked, false otherwise

    • Removes all listeners for the specified event, or all listeners if no event is provided.

      Type Parameters

      • K extends "draw" | "viewport_update"

        Event name

      Parameters

      • Optionalevent: K

        Optional event name to clear listeners for

      Returns KaylaRenderer

      This emitter for chaining

    • Returns the number of listeners registered for the specified event.

      Type Parameters

      • K extends "draw" | "viewport_update"

        Event name

      Parameters

      • event: K

        The event to count listeners for

      Returns number

      The number of registered listeners

    • Starts the RAF loop and begins emitting "draw" events.

      Returns void

      If called in a non-browser environment or RAF is unavailable

    • Stops the RAF loop and halts drawing.

      Returns void

      If called in a non-browser environment or RAF is unavailable

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods