Class SpritesLayer

Hierarchy (view full)

BaseLayer
- SpritesLayer

Constructors

constructor

new SpritesLayer(id, width, height, options?, loadedListener?, updatedListener?): SpritesLayer
Parameters
- id: string
- width: number
- height: number
- Optional options: Options<OptionsObject> | Partial<SpritesLayerOptions>
- Optional loadedListener: ((layer) => void | Promise<void>)
  - - (layer): void | Promise<void>
    - Parameters
      layer: SpritesLayer
      Returns void | Promise<void>
- Optional updatedListener: ((layer) => void | Promise<void>)
  - - (layer): void | Promise<void>
    - Parameters
      layer: SpritesLayer
      Returns void | Promise<void>
Returns SpritesLayer
Overrides BaseLayer.constructor
- Defined in src/layers/sprites-layer.ts:22

Accessors

backgroundColor

get backgroundColor(): string
Returns string
Inherited from BaseLayer.backgroundColor
- Defined in src/layers/base-layer.ts:488

backgroundOpacity

get backgroundOpacity(): number
Returns number
Inherited from BaseLayer.backgroundOpacity
- Defined in src/layers/base-layer.ts:495

borderColor

get borderColor(): string
Returns string
Inherited from BaseLayer.borderColor
- Defined in src/layers/base-layer.ts:502

borderWidth

get borderWidth(): number
Returns number
Inherited from BaseLayer.borderWidth
- Defined in src/layers/base-layer.ts:509

opacity

get opacity(): number
Current layer opacity (0 to 1)

Returns number
Inherited from BaseLayer.opacity
- Defined in src/layers/base-layer.ts:562

id

get id(): string
Returns string
Inherited from BaseLayer.id
- Defined in src/layers/base-layer.ts:633

width

get width(): number
Get layer width

Returns number
Inherited from BaseLayer.width
- Defined in src/layers/base-layer.ts:640

height

get height(): number
Get layer height

Returns number
Inherited from BaseLayer.height
- Defined in src/layers/base-layer.ts:647

canvas

get canvas(): HTMLCanvasElement
Get output canvas

Returns HTMLCanvasElement
Inherited from BaseLayer.canvas
- Defined in src/layers/base-layer.ts:654

options

get options(): Options<OptionsObject>
Returns Options<OptionsObject>
Inherited from BaseLayer.options
- Defined in src/layers/base-layer.ts:658

Methods

addRenderer

addRenderer<T, P>(id, rendererClass, params?, active?): Promise<T>
Add a renderer to this layer. It's constructed with the layer's own width/height, so callers pass only the class and its config - never dimensions.
Type Parameters
- T extends LayerRenderer<never>
- P = unknown
Parameters
- id: string
  unique id for this renderer within the layer
- rendererClass: (new (width, height, params?) => T)
  the renderer class (not an instance)
  - - new (width, height, params?): T
    - Parameters
      width: number
      height: number
      Optional params: P
      Returns T
- Optional params: P
  optional config forwarded to the renderer constructor
- active: boolean = true
  if true (default) the renderer is added to the render queue
Returns Promise<T>
the constructed, initialised renderer instance
Example
```
const shaky = await layer.addRenderer('shaky', ShakyRenderer, { mode: 'decay' })
  shaky.triggerShake()
```
Inherited from BaseLayer.addRenderer
- Defined in src/layers/base-layer.ts:133

removeRenderer

removeRenderer(id): void
Remove a renderer from this layer. If it was in the render queue, it will be removed from there too.
Parameters
- id: string
  Renderer id to remove. If not found, this is a no-op.
Returns void
Inherited from BaseLayer.removeRenderer
- Defined in src/layers/base-layer.ts:181

deactivateRenderer

deactivateRenderer(id): void
Pause a renderer without destroying it. The instance is kept and can be re-enabled with activateRenderer. Order in the queue is preserved.
Parameters
- id: string
  Renderer id to deactivate. No-op if not found or already inactive.
Returns void
Inherited from BaseLayer.deactivateRenderer
- Defined in src/layers/base-layer.ts:194

activateRenderer

activateRenderer(id): void
Re-enable a previously deactivated renderer, restoring it at its original position in the queue. The renderer must have been registered via the constructor renderers dict or addRenderer.
Parameters
- id: string
  Renderer id to activate.
Returns void
Throws
if the renderer is not registered on this layer.
Inherited from BaseLayer.activateRenderer
- Defined in src/layers/base-layer.ts:206

isRendererActive

isRendererActive(id): boolean
Returns true if the renderer is registered and currently active.
Parameters
- id: string
Returns boolean
Inherited from BaseLayer.isRendererActive
- Defined in src/layers/base-layer.ts:226

setBackgroundColor

setBackgroundColor(color): void
Set the background fill color for this layer and trigger a redraw. Pass undefined to clear.
Parameters
- color: string
Returns void
Inherited from BaseLayer.setBackgroundColor
- Defined in src/layers/base-layer.ts:484

setBackgroundOpacity

setBackgroundOpacity(opacity): void
Set the background fill opacity (0–1) and trigger a redraw.
Parameters
- opacity: number
Returns void
Inherited from BaseLayer.setBackgroundOpacity
- Defined in src/layers/base-layer.ts:491

setBorderColor

setBorderColor(color): void
Set the border stroke color and trigger a redraw.
Parameters
- color: string
Returns void
Inherited from BaseLayer.setBorderColor
- Defined in src/layers/base-layer.ts:498

setBorderWidth

setBorderWidth(width): void
Set the border stroke width in pixels and trigger a redraw.
Parameters
- width: number
Returns void
Inherited from BaseLayer.setBorderWidth
- Defined in src/layers/base-layer.ts:505

haveRenderer

haveRenderer(): boolean
Returns boolean
Inherited from BaseLayer.haveRenderer
- Defined in src/layers/base-layer.ts:511

toggleVisibility

toggleVisibility(): boolean
Returns boolean
Inherited from BaseLayer.toggleVisibility
- Defined in src/layers/base-layer.ts:535

setOpacity

setOpacity(opacity): void
Set the layer opacity.
Parameters
- opacity: number
  value between 0 (transparent) and 1 (opaque)
Returns void
Inherited from BaseLayer.setOpacity
- Defined in src/layers/base-layer.ts:545

fadeIn

fadeIn(duration, easing?): Promise<void>
Animate layer opacity from its current value to 1 (fully opaque).
Parameters
- duration: number
  fade duration in ms
- easing: EasingFunction = Easing.easeOutSine
  easing function (defaults to easeOutSine)
Returns Promise<void>
resolves when the fade completes
Inherited from BaseLayer.fadeIn
- Defined in src/layers/base-layer.ts:572

fadeOut

fadeOut(duration, easing?): Promise<void>
Animate layer opacity from its current value to 0 (fully transparent).
Parameters
- duration: number
  fade duration in ms
- easing: EasingFunction = Easing.easeOutSine
  easing function (defaults to easeOutSine)
Returns Promise<void>
resolves when the fade completes
Inherited from BaseLayer.fadeOut
- Defined in src/layers/base-layer.ts:599

isVisible

isVisible(): boolean
Returns boolean
Inherited from BaseLayer.isVisible
- Defined in src/layers/base-layer.ts:621

isLoaded

isLoaded(): boolean
Returns boolean
Inherited from BaseLayer.isLoaded
- Defined in src/layers/base-layer.ts:625

destroy

destroy(): void
Returns void
Inherited from BaseLayer.destroy
- Defined in src/layers/base-layer.ts:629

createSprite

createSprite(id, spriteSheet, hFrameOffset, vFrameOffset, animations, x, y): Promise<Sprite>
Create a sprite and add it to the layer
Parameters
- id: string
- spriteSheet: ImageBitmap
- hFrameOffset: number
  (horizontal distance between frames)
- vFrameOffset: number
  (vertical distance between frames)
- animations: SpriteAnimationItem[]
- x: string | number
  horizontal position on the layer: pixels (12) or a percentage string ('50%')
- y: string | number
  vertical position on the layer: pixels (12) or a percentage string ('50%')
Returns Promise<Sprite>
- Defined in src/layers/sprites-layer.ts:80

addSprite

addSprite(id, sprite, _x, _y, v?): boolean
Add an existing Sprite object to the layer ad x,y position
Parameters
- id: string
- sprite: Sprite
- _x: string | number
  horizontal position: pixels (12) or a percentage string ('50%')
- _y: string | number
  vertical position: pixels (12) or a percentage string ('50%')
- Optional v: boolean
Returns boolean
true if sprite was assed false otherwise
- Defined in src/layers/sprites-layer.ts:142

setSpriteVisibility

setSpriteVisibility(id, v): void
Change sprite visibility
Parameters
- id: string
- v: boolean
Returns void
- Defined in src/layers/sprites-layer.ts:219

run

run(id): void
Run sprite current animation
Parameters
- id: string
Returns void
- Defined in src/layers/sprites-layer.ts:231

stop

stop(id): void
Stop sprite current animation
Parameters
- id: string
Returns void
- Defined in src/layers/sprites-layer.ts:254

setVisibility

setVisibility(isVisible): void
This layer's render loop is driven by run()/stop(), not by having renderers, so BaseLayer.setVisibility(true) alone would leave the loop stopped and the output frozen when the layer is shown while sprites are running (they keep animating while hidden). Resume compositing on show.
Parameters
- isVisible: boolean
Returns void
Overrides BaseLayer.setVisibility
- Defined in src/layers/sprites-layer.ts:278

enqueueSequence

enqueueSequence(id, queue, loop): void
Add sequence of animations to sprite queue
Parameters
- id: string
- queue: SpriteSequenceItem[]
- loop: boolean
Returns void
- Defined in src/layers/sprites-layer.ts:294

Class SpritesLayer

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Parameters

Returns void | Promise<void>

Parameters

Returns void | Promise<void>

Returns SpritesLayer

Accessors

backgroundColor

Returns string

backgroundOpacity

Returns number

borderColor

Returns string

borderWidth

Returns number

opacity

Returns number

id

Returns string

width

Returns number

height

Returns number

canvas

Returns HTMLCanvasElement

options

Returns Options<OptionsObject>

Methods

addRenderer

Type Parameters

Parameters

Parameters

Returns T

Returns Promise<T>

Example

removeRenderer

Parameters

Returns void

deactivateRenderer

Parameters

Returns void

activateRenderer

Parameters

Returns void

Throws

isRendererActive

Parameters

Returns boolean

setBackgroundColor

Parameters

Returns void

setBackgroundOpacity

Parameters

Returns void

setBorderColor

Parameters

Returns void

setBorderWidth

Parameters

Returns void

haveRenderer

Returns boolean

toggleVisibility

Returns boolean

setOpacity

Parameters

Returns void

fadeIn

Parameters

Returns Promise<void>

fadeOut

Parameters