quilt-three / Interface: SessionOptions

Defined in: packages/three/src/index.ts:51

Properties

container?

optional container?: (document) => HTMLElement

Defined in: packages/three/src/index.ts:58

Main workspace host, and companion host when called with a companion document.

Parameters

document

Document

Returns

HTMLElement

---

createRenderer?

optional createRenderer?: (canvas) => ThreeRenderer | Promise<ThreeRenderer>

Defined in: packages/three/src/index.ts:56

Parameters

canvas

HTMLCanvasElement

Returns

ThreeRenderer | Promise<ThreeRenderer>

---

frameloop?

optional frameloop?: "always" | "demand"

Defined in: packages/three/src/index.ts:54

---

maxPixelRatio?

optional maxPixelRatio?: number

Defined in: packages/three/src/index.ts:55

---

onError?

optional onError?: (error) => void

Defined in: packages/three/src/index.ts:60

Parameters

error

unknown

Returns

void

---

requestFrame?

optional requestFrame?: (window) => void

Defined in: packages/three/src/index.ts:62

External scheduler, used by the R3F adapter. Must eventually call session.render().

Parameters

window

Window

Returns

void

---

scene

scene: Scene

Defined in: packages/three/src/index.ts:52

---

update?

optional update?: (delta) => void

Defined in: packages/three/src/index.ts:59

Parameters

delta

number

Returns

void

---

window

window: Window

Defined in: packages/three/src/index.ts:53