Skip to main content

Type Alias: AnimationLoopProps

AnimationLoopProps = object

Defined in: modules/engine/src/animation-loop/animation-loop.ts:32

AnimationLoop properties

Properties​

animationFrameProvider?​

optional animationFrameProvider?: AnimationFrameProvider

Defined in: modules/engine/src/animation-loop/animation-loop.ts:50

Experimental v10 work-in-progress frame source.

autoResizeViewport?​

optional autoResizeViewport?: boolean

Defined in: modules/engine/src/animation-loop/animation-loop.ts:48

device​

device: Device | Promise<Device>

Defined in: modules/engine/src/animation-loop/animation-loop.ts:33

mobileQuality?​

optional mobileQuality?: Readonly<Record<string, boolean | number>>

Defined in: modules/engine/src/animation-loop/animation-loop.ts:36

Optional application-provided quality settings for adaptive renderers.

onAddHTML?​

optional onAddHTML?: (div) => string

Defined in: modules/engine/src/animation-loop/animation-loop.ts:38

Parameters​

div​

HTMLDivElement

Returns​

string

onError?​

optional onError?: (reason) => void

Defined in: modules/engine/src/animation-loop/animation-loop.ts:43

Parameters​

reason​

Error

Returns​

void

onFinalize?​

optional onFinalize?: (animationProps) => void

Defined in: modules/engine/src/animation-loop/animation-loop.ts:42

Parameters​

animationProps​

AnimationProps

Returns​

void

onInitialize?​

optional onInitialize?: (animationProps) => Promise<unknown>

Defined in: modules/engine/src/animation-loop/animation-loop.ts:39

Parameters​

animationProps​

AnimationProps

Returns​

Promise<unknown>

onRender?​

optional onRender?: (animationProps) => unknown

Defined in: modules/engine/src/animation-loop/animation-loop.ts:41

Encode a frame. Return false when no GPU work was encoded to skip device submission.

Parameters​

animationProps​

AnimationProps

Returns​

unknown

stats?​

optional stats?: Stats

Defined in: modules/engine/src/animation-loop/animation-loop.ts:45