Class Letterbox

Letterbox/pillarbox bars for maintaining aspect ratio. Creates black bars on the edges when the game doesn't fill the viewport.

Index

Constructors

Methods

apply cinematicIn cinematicOut remove

Constructors

constructor

new Letterbox(scene: Scene): Letterbox
Parameters
- scene: Scene
Returns Letterbox
- Defined in packages/clik-engine/src/scaling/Letterbox.ts:11

Methods

apply

apply(color?: number): void
Add letterbox/pillarbox bars. Call after scene create. The bars render on top of everything at high depth.
Parameters
- color: number = 0x000000
Returns void
- Defined in packages/clik-engine/src/scaling/Letterbox.ts:19

cinematicIn

cinematicIn(
    barHeight?: number,
    duration?: number,
    color?: number,
): Promise<void>
Cinematic letterbox — animate bars sliding in from top/bottom
Parameters
- barHeight: number = 60
- duration: number = 500
- color: number = 0x000000
Returns Promise<void>
- Defined in packages/clik-engine/src/scaling/Letterbox.ts:58

cinematicOut

cinematicOut(duration?: number): Promise<void>
Animate bars sliding out
Parameters
- duration: number = 400
Returns Promise<void>
- Defined in packages/clik-engine/src/scaling/Letterbox.ts:87

remove

remove(): void
Remove all bars

Returns void
- Defined in packages/clik-engine/src/scaling/Letterbox.ts:52