Class CinematicLetterbox

Index

Methods

create close open toggle setTarget pulse isOpen isClosed isAnimating getState tick dispose

Methods

`Static`create

create(opts?: CinematicLetterboxOptions): CinematicLetterbox
Parameters
- opts: CinematicLetterboxOptions = {}
Returns CinematicLetterbox
- Defined in runtime/cinematic-letterbox.ts:112

close

close(opts?: LetterboxCloseOptions): void
Parameters
- opts: LetterboxCloseOptions = {}
Returns void
- Defined in runtime/cinematic-letterbox.ts:117

open

open(opts?: LetterboxOpenOptions): void
Parameters
- opts: LetterboxOpenOptions = {}
Returns void
- Defined in runtime/cinematic-letterbox.ts:128

toggle

toggle(opts?: LetterboxCloseOptions): void
Parameters
- opts: LetterboxCloseOptions = {}
Returns void
- Defined in runtime/cinematic-letterbox.ts:136

setTarget

setTarget(value: number, opts?: LetterboxCloseOptions): void
Parameters
- value: number
- opts: LetterboxCloseOptions = {}
Returns void
- Defined in runtime/cinematic-letterbox.ts:142

pulse

pulse(opts?: LetterboxPulseOptions): void
Parameters
- opts: LetterboxPulseOptions = {}
Returns void
- Defined in runtime/cinematic-letterbox.ts:151

isOpen

isOpen(): boolean
Returns boolean
- Defined in runtime/cinematic-letterbox.ts:172

isClosed

isClosed(): boolean
Returns boolean
- Defined in runtime/cinematic-letterbox.ts:176

isAnimating

isAnimating(): boolean
Returns boolean
- Defined in runtime/cinematic-letterbox.ts:180

getState

getState(): LetterboxState
Returns LetterboxState
- Defined in runtime/cinematic-letterbox.ts:184

tick

tick(dtMs: number): void
Parameters
- dtMs: number
Returns void
- Defined in runtime/cinematic-letterbox.ts:194

dispose

dispose(): void
Returns void
- Defined in runtime/cinematic-letterbox.ts:219