npm - @kayelaa/canvas - Versions diffs - 0.1.13 → 0.1.14 - Mend

@kayelaa/canvas 0.1.13 → 0.1.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (136) hide show

package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/classes/KaylaRenderer.md DELETED Viewed

@@ -1,934 +0,0 @@
-[**@kayelaa/canvas**](../../../../../../README.md)
-***
-[@kayelaa/canvas](../../../../../../README.md) / [Kayla](../../../README.md) / [KaylaInternals](../README.md) / KaylaRenderer
-# Class: KaylaRenderer
-Defined in: [kayla-internals.ts:292](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L292)
-Renderer wrapper that extends LEA renderer with game integration and pointer utilities.
-## Extends
-- [`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md)
-## Extended by
-- [`KaylaRenderer`](../../../interfaces/KaylaRenderer.md)
-## Constructors
-### Constructor
-> **new KaylaRenderer**(`canvas`): `KaylaRenderer`
-Defined in: [kayla-internals.ts:308](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L308)
-#### Parameters
-##### canvas
-`HTMLCanvasElement`
-#### Returns
-`KaylaRenderer`
-#### Overrides
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`constructor`](../../../../LEA/classes/LeaRendererII.md#constructor)
-## Properties
-### game?
-> `optional` **game**: [`KaylaGame`](KaylaGame.md)
-Defined in: [kayla-internals.ts:296](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L296)
-The attached game instance (set via `attachTo`).
-***
-### pointerX
-> **pointerX**: `number`
-Defined in: [kayla-internals.ts:301](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L301)
-Current canvas-space pointer X coordinate.
-***
-### pointerY
-> **pointerY**: `number`
-Defined in: [kayla-internals.ts:306](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L306)
-Current canvas-space pointer Y coordinate.
-***
-### canvas
-> **canvas**: `HTMLCanvasElement`
-Defined in: [lea.ts:161](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L161)
-The target canvas element.
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`canvas`](../../../../LEA/classes/LeaRendererII.md#canvas)
-***
-### ctx
-> **ctx**: `CanvasRenderingContext2D`
-Defined in: [lea.ts:165](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L165)
-The 2D rendering context.
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`ctx`](../../../../LEA/classes/LeaRendererII.md#ctx)
-***
-### running
-> **running**: `boolean`
-Defined in: [lea.ts:169](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L169)
-Whether the renderer is currently running (RAF loop active).
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`running`](../../../../LEA/classes/LeaRendererII.md#running)
-***
-### automatic
-> **automatic**: `boolean`
-Defined in: [lea.ts:218](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L218)
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`automatic`](../../../../LEA/classes/LeaRendererII.md#automatic)
-## Accessors
-### viewportWidth
-#### Get Signature
-> **get** **viewportWidth**(): `number`
-Defined in: [lea.ts:239](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L239)
-The logical viewport width (game coordinate space).
-##### Returns
-`number`
-#### Set Signature
-> **set** **viewportWidth**(`v`): `void`
-Defined in: [lea.ts:242](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L242)
-##### Parameters
-###### v
-`number`
-##### Returns
-`void`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`viewportWidth`](../../../../LEA/classes/LeaRendererII.md#viewportwidth)
-***
-### width
-#### Get Signature
-> **get** **width**(): `number`
-Defined in: [lea.ts:247](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L247)
-##### Returns
-`number`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`width`](../../../../LEA/classes/LeaRendererII.md#width)
-***
-### height
-#### Get Signature
-> **get** **height**(): `number`
-Defined in: [lea.ts:250](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L250)
-##### Returns
-`number`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`height`](../../../../LEA/classes/LeaRendererII.md#height)
-***
-### centerX
-#### Get Signature
-> **get** **centerX**(): `number`
-Defined in: [lea.ts:257](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L257)
-Center X of the viewport (viewportWidth / 2).
-##### Returns
-`number`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`centerX`](../../../../LEA/classes/LeaRendererII.md#centerx)
-***
-### centerY
-#### Get Signature
-> **get** **centerY**(): `number`
-Defined in: [lea.ts:263](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L263)
-Center Y of the viewport (viewportHeight / 2).
-##### Returns
-`number`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`centerY`](../../../../LEA/classes/LeaRendererII.md#centery)
-***
-### left
-#### Get Signature
-> **get** **left**(): `number`
-Defined in: [lea.ts:266](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L266)
-##### Returns
-`number`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`left`](../../../../LEA/classes/LeaRendererII.md#left)
-***
-### top
-#### Get Signature
-> **get** **top**(): `number`
-Defined in: [lea.ts:269](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L269)
-##### Returns
-`number`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`top`](../../../../LEA/classes/LeaRendererII.md#top)
-***
-### right
-#### Get Signature
-> **get** **right**(): `number`
-Defined in: [lea.ts:272](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L272)
-##### Returns
-`number`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`right`](../../../../LEA/classes/LeaRendererII.md#right)
-***
-### bottom
-#### Get Signature
-> **get** **bottom**(): `number`
-Defined in: [lea.ts:275](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L275)
-##### Returns
-`number`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`bottom`](../../../../LEA/classes/LeaRendererII.md#bottom)
-***
-### viewportHeight
-#### Get Signature
-> **get** **viewportHeight**(): `number`
-Defined in: [lea.ts:282](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L282)
-The logical viewport height (game coordinate space).
-##### Returns
-`number`
-#### Set Signature
-> **set** **viewportHeight**(`v`): `void`
-Defined in: [lea.ts:285](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L285)
-##### Parameters
-###### v
-`number`
-##### Returns
-`void`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`viewportHeight`](../../../../LEA/classes/LeaRendererII.md#viewportheight)
-***
-### cameraWidth
-#### Get Signature
-> **get** **cameraWidth**(): `number`
-Defined in: [lea.ts:293](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L293)
-The camera/pixel resolution width (canvas backing resolution).
-##### Returns
-`number`
-#### Set Signature
-> **set** **cameraWidth**(`v`): `void`
-Defined in: [lea.ts:296](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L296)
-##### Parameters
-###### v
-`number`
-##### Returns
-`void`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`cameraWidth`](../../../../LEA/classes/LeaRendererII.md#camerawidth)
-***
-### cameraHeight
-#### Get Signature
-> **get** **cameraHeight**(): `number`
-Defined in: [lea.ts:305](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L305)
-The camera/pixel resolution height (canvas backing resolution).
-##### Returns
-`number`
-#### Set Signature
-> **set** **cameraHeight**(`v`): `void`
-Defined in: [lea.ts:308](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L308)
-##### Parameters
-###### v
-`number`
-##### Returns
-`void`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`cameraHeight`](../../../../LEA/classes/LeaRendererII.md#cameraheight)
-***
-### FPS
-#### Get Signature
-> **get** **FPS**(): `number`
-Defined in: [lea.ts:334](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L334)
-Current measured FPS (updated every second).
-##### Returns
-`number`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`FPS`](../../../../LEA/classes/LeaRendererII.md#fps)
-## Methods
-### listenPointerUpdates()
-> **listenPointerUpdates**(): `void`
-Defined in: [kayla-internals.ts:327](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L327)
-#### Returns
-`void`
-***
-### unlistenPointerUpdates()
-> **unlistenPointerUpdates**(): `void`
-Defined in: [kayla-internals.ts:331](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L331)
-#### Returns
-`void`
-***
-### pointerPosToWorldPos()
-> **pointerPosToWorldPos**(`mx`, `my`): [`Vector2`](../../../../LEA/classes/Vector2.md)
-Defined in: [kayla-internals.ts:345](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L345)
-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`](../../../../LEA/classes/Vector2.md)
-World-space position
-***
-### getMousePos()
-> **getMousePos**(): [`Vector2`](../../../../LEA/classes/Vector2.md)
-Defined in: [kayla-internals.ts:365](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L365)
-Returns the current pointer position in world coordinates.
-Requires `listenPointerUpdates()` to have been called.
-#### Returns
-[`Vector2`](../../../../LEA/classes/Vector2.md)
-World-space position
-***
-### useDraw()
-> **useDraw**(`callback`): () => `void`
-Defined in: [kayla-internals.ts:375](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L375)
-Registers a draw callback that receives a normalized `KaylaEvent`.
-#### Parameters
-##### callback
-(`ctx`, `event`) => `void`
-Paint handler
-#### Returns
-Unsubscribe function
-> (): `void`
-##### Returns
-`void`
-***
-### attachTo()
-> **attachTo**(`game`): `void`
-Defined in: [kayla-internals.ts:392](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L392)
-Attaches this renderer to a game.
-Sets `renderer.game` and adds it to `game.#renderers`.
-#### Parameters
-##### game
-[`KaylaGame`](KaylaGame.md)
-The game to attach to
-#### Returns
-`void`
-***
-### detach()
-> **detach**(): `void`
-Defined in: [kayla-internals.ts:400](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L400)
-Detaches this renderer from its game (if attached).
-#### Returns
-`void`
-***
-### on()
-> **on**\<`K`\>(`event`, `listener`): `this`
-Defined in: [lea.ts:38](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L38)
-Registers a listener for the specified event.
-#### Type Parameters
-##### K
-`K` *extends* `"draw"`
-Event name
-#### Parameters
-##### event
-`K`
-The name of the event
-##### listener
-(...`args`) => `void`
-The callback to invoke when the event is emitted
-#### Returns
-`this`
-This emitter for chaining
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`on`](../../../../LEA/classes/LeaRendererII.md#on)
-***
-### once()
-> **once**\<`K`\>(`event`, `listener`): `this`
-Defined in: [lea.ts:58](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L58)
-Registers a one-time listener for the specified event.
-The listener is automatically removed after the first invocation.
-#### Type Parameters
-##### K
-`K` *extends* `"draw"`
-Event name
-#### Parameters
-##### event
-`K`
-The name of the event
-##### listener
-(...`args`) => `void`
-The callback to invoke once
-#### Returns
-`this`
-This emitter for chaining
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`once`](../../../../LEA/classes/LeaRendererII.md#once)
-***
-### off()
-> **off**\<`K`\>(`event`, `listener`): `this`
-Defined in: [lea.ts:78](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L78)
-Removes a listener for the specified event.
-#### Type Parameters
-##### K
-`K` *extends* `"draw"`
-Event name
-#### Parameters
-##### event
-`K`
-The name of the event
-##### listener
-(...`args`) => `void`
-The callback to remove
-#### Returns
-`this`
-This emitter for chaining
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`off`](../../../../LEA/classes/LeaRendererII.md#off)
-***
-### emit()
-> **emit**\<`K`\>(`event`, ...`args`): `boolean`
-Defined in: [lea.ts:100](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L100)
-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
-`K` *extends* `"draw"`
-Event name
-#### Parameters
-##### event
-`K`
-The name of the event to emit
-##### args
-...`object`\[`K`\]
-Arguments to pass to listeners
-#### Returns
-`boolean`
-`true` if any listeners were invoked, `false` otherwise
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`emit`](../../../../LEA/classes/LeaRendererII.md#emit)
-***
-### removeAllListeners()
-> **removeAllListeners**\<`K`\>(`event?`): `KaylaRenderer`
-Defined in: [lea.ts:119](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L119)
-Removes all listeners for the specified event, or all listeners if no event is provided.
-#### Type Parameters
-##### K
-`K` *extends* `"draw"`
-Event name
-#### Parameters
-##### event?
-`K`
-Optional event name to clear listeners for
-#### Returns
-`KaylaRenderer`
-This emitter for chaining
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`removeAllListeners`](../../../../LEA/classes/LeaRendererII.md#removealllisteners)
-***
-### listenerCount()
-> **listenerCount**\<`K`\>(`event`): `number`
-Defined in: [lea.ts:135](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L135)
-Returns the number of listeners registered for the specified event.
-#### Type Parameters
-##### K
-`K` *extends* `"draw"`
-Event name
-#### Parameters
-##### event
-`K`
-The event to count listeners for
-#### Returns
-`number`
-The number of registered listeners
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`listenerCount`](../../../../LEA/classes/LeaRendererII.md#listenercount)
-***
-### retransform()
-> **retransform**(): `void`
-Defined in: [lea.ts:220](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L220)
-#### Returns
-`void`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`retransform`](../../../../LEA/classes/LeaRendererII.md#retransform)
-***
-### updateCanvasResolution()
-> **updateCanvasResolution**(): `void`
-Defined in: [lea.ts:318](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L318)
-Update canvas resolution to match camera
-Units remain the same
-#### Returns
-`void`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`updateCanvasResolution`](../../../../LEA/classes/LeaRendererII.md#updatecanvasresolution)
-***
-### applyTransform()
-> **applyTransform**(): `void`
-Defined in: [lea.ts:327](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L327)
-Apply viewport → canvas transform
-Scale computed dynamically each frame
-#### Returns
-`void`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`applyTransform`](../../../../LEA/classes/LeaRendererII.md#applytransform)
-***
-### update()
-> **update**(): `void`
-Defined in: [lea.ts:346](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L346)
-#### Returns
-`void`
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`update`](../../../../LEA/classes/LeaRendererII.md#update)
-***
-### start()
-> **start**(): `void`
-Defined in: [lea.ts:372](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L372)
-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`](../../../../LEA/classes/LeaRendererII.md).[`start`](../../../../LEA/classes/LeaRendererII.md#start)
-***
-### stop()
-> **stop**(): `void`
-Defined in: [lea.ts:386](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L386)
-Stops the RAF loop and halts drawing.
-#### Returns
-`void`
-#### Throws
-If called in a non-browser environment or RAF is unavailable
-#### Inherited from
-[`LeaRendererII`](../../../../LEA/classes/LeaRendererII.md).[`stop`](../../../../LEA/classes/LeaRendererII.md#stop)