Class KaylaRenderer

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

Hierarchy (View Summary)

LeaRendererII
- KaylaRenderer
  - KaylaRenderer

Constructors

constructor

new KaylaRenderer(
canvas: HTMLCanvasElement,
config?: { noAutoDraw?: boolean; disableKaylaBehavior?: boolean },
): KaylaInternals.KaylaRenderer
Parameters
- canvas: HTMLCanvasElement
- config: { noAutoDraw?: boolean; disableKaylaBehavior?: boolean } = {}
Returns KaylaInternals.KaylaRenderer
Overrides LeaRendererII.constructor
- Defined in src/kayla-internals.ts:513

Properties

`Optional`game

game?: KaylaInternals.KaylaGame

The attached game instance (set via attachTo).

pointerX

pointerX: number

Current canvas-space pointer X coordinate.

pointerY

pointerY: number

Current canvas-space pointer Y coordinate.

`Protected`pointerEvents

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

Pointer related event-emitter

onPointerDown

onPointerDown: (e: PointerEvent) => void

onPointerUp

onPointerUp: (e: PointerEvent) => void

onPointerCancel

onPointerCancel: (e: PointerEvent) => void

onPointerMove

onPointerMove: (e: PointerEvent) => void

isKaylaDisabled

isKaylaDisabled: boolean

listenerMap

listenerMap: Map<"draw" | "viewport_update", Listener<any[]>[]> = ...

running

running: boolean

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

automatic

automatic: boolean

Accessors

canvas

get canvas(): HTMLCanvasElement
The target canvas element.

Returns HTMLCanvasElement
Inherited from LEA.LeaRendererII.canvas
- Defined in src/lea.ts:181
set canvas(canvas: HTMLCanvasElement): void
Parameters
- canvas: HTMLCanvasElement
Returns void
Inherited from LEA.LeaRendererII.canvas
- Defined in src/lea.ts:192

ctx

get ctx(): CanvasRenderingContext2D
The 2D rendering context.

Returns CanvasRenderingContext2D
Inherited from LEA.LeaRendererII.ctx
- Defined in src/lea.ts:188

viewportWidth

get viewportWidth(): number
The logical viewport width (game coordinate space).

Returns number
Inherited from LEA.LeaRendererII.viewportWidth
- Defined in src/lea.ts:260
set viewportWidth(v: number): void
Parameters
- v: number
Returns void
Inherited from LEA.LeaRendererII.viewportWidth
- Defined in src/lea.ts:263

width

get width(): number
Returns number
Inherited from LEA.LeaRendererII.width
- Defined in src/lea.ts:269

height

get height(): number
Returns number
Inherited from LEA.LeaRendererII.height
- Defined in src/lea.ts:272

centerX

get centerX(): number
Center X of the viewport (viewportWidth / 2).

Returns number
Inherited from LEA.LeaRendererII.centerX
- Defined in src/lea.ts:279

centerY

get centerY(): number
Center Y of the viewport (viewportHeight / 2).

Returns number
Inherited from LEA.LeaRendererII.centerY
- Defined in src/lea.ts:285

left

get left(): number
Returns number
Inherited from LEA.LeaRendererII.left
- Defined in src/lea.ts:288

top

get top(): number
Returns number
Inherited from LEA.LeaRendererII.top
- Defined in src/lea.ts:291

right

get right(): number
Returns number
Inherited from LEA.LeaRendererII.right
- Defined in src/lea.ts:294

bottom

get bottom(): number
Returns number
Inherited from LEA.LeaRendererII.bottom
- Defined in src/lea.ts:297

viewportHeight

get viewportHeight(): number
The logical viewport height (game coordinate space).

Returns number
Inherited from LEA.LeaRendererII.viewportHeight
- Defined in src/lea.ts:304
set viewportHeight(v: number): void
Parameters
- v: number
Returns void
Inherited from LEA.LeaRendererII.viewportHeight
- Defined in src/lea.ts:307

cameraWidth

get cameraWidth(): number
The camera/pixel resolution width (canvas backing resolution).

Returns number
Inherited from LEA.LeaRendererII.cameraWidth
- Defined in src/lea.ts:316
set cameraWidth(v: number): void
Parameters
- v: number
Returns void
Inherited from LEA.LeaRendererII.cameraWidth
- Defined in src/lea.ts:319

cameraHeight

get cameraHeight(): number
The camera/pixel resolution height (canvas backing resolution).

Returns number
Inherited from LEA.LeaRendererII.cameraHeight
- Defined in src/lea.ts:328
set cameraHeight(v: number): void
Parameters
- v: number
Returns void
Inherited from LEA.LeaRendererII.cameraHeight
- Defined in src/lea.ts:331

FPS

get FPS(): number
Current measured FPS (updated every second).

Returns number
Inherited from LEA.LeaRendererII.FPS
- Defined in src/lea.ts:364

Methods

`Protected`pointerPosUpdater

pointerPosUpdater(e: PointerEvent): void
Parameters
- e: PointerEvent
Returns void
- Defined in src/kayla-internals.ts:539

`Protected`onPointerAll

onPointerAll(e: PointerEvent, action: KaylaPointerAction): void
Parameters
- e: PointerEvent
- action: KaylaPointerAction
Returns void
- Defined in src/kayla-internals.ts:544

`Static`getClickType

getClickType(e: PointerEvent): KaylaClickType
Parameters
- e: PointerEvent
Returns KaylaClickType
- Defined in src/kayla-internals.ts:555

listenPointerUpdates

listenPointerUpdates(): void
Returns void
- Defined in src/kayla-internals.ts:568

unlistenPointerUpdates

unlistenPointerUpdates(): void
Returns void
- Defined in src/kayla-internals.ts:576

pointerPosToWorldPos

pointerPosToWorldPos(mx: number, my: number): Vector2
Transforms canvas-space coordinates to world-space coordinates.
Parameters
- mx: number
  Mouse X in canvas pixels
- my: number
  Mouse Y in canvas pixels
Returns Vector2
World-space position
- Defined in src/kayla-internals.ts:590

camToViewportPos

camToViewportPos(camX: number, camY: number): Vector2
Parameters
- camX: number
- camY: number
Returns Vector2
- Defined in src/kayla-internals.ts:610

pointerPosToWorldPosOLD

pointerPosToWorldPosOLD(mx: number, my: number): Vector2
Parameters
- mx: number
- my: number
Returns Vector2
- Defined in src/kayla-internals.ts:616

getMousePos

getMousePos(): Vector2
Returns the current pointer position in world coordinates.

Requires listenPointerUpdates() to have been called.

Returns Vector2
World-space position
- Defined in src/kayla-internals.ts:636

useDraw

useDraw(
callback: (ctx: CanvasRenderingContext2D, event: KaylaEvent) => void,
): () => void
Registers a draw callback that receives a normalized KaylaEvent.
Parameters
- callback: (ctx: CanvasRenderingContext2D, event: KaylaEvent) => void
  Paint handler
Returns () => void
Unsubscribe function
- Defined in src/kayla-internals.ts:646

attachTo

attachTo(game: KaylaInternals.KaylaGame): void
Attaches this renderer to a game.

Sets renderer.game and adds it to game.#renderers.
Parameters
- game: KaylaInternals.KaylaGame
  The game to attach to
Returns void
- Defined in src/kayla-internals.ts:663

detach

detach(): void
Detaches this renderer from its game (if attached).

Returns void
- Defined in src/kayla-internals.ts:671

on

on<K extends "draw" | "viewport_update">(
    event: K,
    listener: (
        ...args: {
            draw: [CanvasRenderingContext2D];
            viewport_update: [{ width: number; height: number }];
        }[K],
    ) => void,
): this
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
Inherited from LeaRendererII.on
- Defined in src/lea.ts:38

once

once<K extends "draw" | "viewport_update">(
    event: K,
    listener: (
        ...args: {
            draw: [CanvasRenderingContext2D];
            viewport_update: [{ width: number; height: number }];
        }[K],
    ) => void,
): this
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
Inherited from LeaRendererII.once
- Defined in src/lea.ts:58

off

off<K extends "draw" | "viewport_update">(
    event: K,
    listener: (
        ...args: {
            draw: [CanvasRenderingContext2D];
            viewport_update: [{ width: number; height: number }];
        }[K],
    ) => void,
): this
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
Inherited from LeaRendererII.off
- Defined in src/lea.ts:78

emit

emit<K extends "draw" | "viewport_update">(
    event: K,
    ...args: {
        draw: [CanvasRenderingContext2D];
        viewport_update: [{ width: number; height: number }];
    }[K],
): boolean
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
Inherited from LeaRendererII.emit
- Defined in src/lea.ts:100

removeAllListeners

removeAllListeners<K extends "draw" | "viewport_update">(
event?: K,
): KaylaInternals.KaylaRenderer
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 KaylaInternals.KaylaRenderer
This emitter for chaining
Inherited from LeaRendererII.removeAllListeners
- Defined in src/lea.ts:122

listenerCount

listenerCount<K extends "draw" | "viewport_update">(event: K): number
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
Inherited from LeaRendererII.listenerCount
- Defined in src/lea.ts:138

retransform

retransform(): void
Returns void
Inherited from LeaRendererII.retransform
- Defined in src/lea.ts:241

updateCanvasResolution

updateCanvasResolution(): void
Update canvas resolution to match camera Units remain the same

Returns void
Inherited from LeaRendererII.updateCanvasResolution
- Defined in src/lea.ts:341

emitViewportUpdate

emitViewportUpdate(): void
Returns void
Inherited from LeaRendererII.emitViewportUpdate
- Defined in src/lea.ts:346

applyTransform

applyTransform(): void
Apply viewport → canvas transform Scale computed dynamically each frame

Returns void
Inherited from LeaRendererII.applyTransform
- Defined in src/lea.ts:357

update

update(): void
Returns void
Inherited from LeaRendererII.update
- Defined in src/lea.ts:376

start

start(): void
Starts the RAF loop and begins emitting "draw" events.

Returns void
Throws
If called in a non-browser environment or RAF is unavailable
Inherited from LeaRendererII.start
- Defined in src/lea.ts:402

stop

stop(): void
Stops the RAF loop and halts drawing.

Returns void
Throws
If called in a non-browser environment or RAF is unavailable
Inherited from LeaRendererII.stop
- Defined in src/lea.ts:416

Class KaylaRenderer

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns KaylaInternals.KaylaRenderer

Properties

Optionalgame

pointerX

pointerY

ProtectedpointerEvents

onPointerDown

onPointerUp

onPointerCancel

onPointerMove

isKaylaDisabled

listenerMap

running

automatic

Accessors

canvas

Returns HTMLCanvasElement

Parameters

Returns void

ctx

Returns CanvasRenderingContext2D

viewportWidth

Returns number

Parameters

Returns void

width

Returns number

height

Returns number

centerX

Returns number

centerY

Returns number

left

Returns number

top

Returns number

right

Returns number

bottom

Returns number

viewportHeight

Returns number

Parameters

Returns void

cameraWidth

Returns number

Parameters

Returns void

cameraHeight

Returns number

Parameters

Returns void

FPS

Returns number

Methods

ProtectedpointerPosUpdater

Parameters

Returns void

ProtectedonPointerAll

Parameters

Returns void

StaticgetClickType

Parameters

Returns KaylaClickType

listenPointerUpdates

Returns void

unlistenPointerUpdates

Returns void

pointerPosToWorldPos

`Optional`game

`Protected`pointerEvents

`Protected`pointerPosUpdater

`Protected`onPointerAll

`Static`getClickType