RendererBackend
Defined in: packages/threeplay/src/plugins/render/types.ts:12
Wraps a three.js renderer. The engine never talks to three’s renderers directly, so a new backend only has to implement this.
Methods
Section titled “Methods”dispose()
Section titled “dispose()”dispose():
void
Defined in: packages/threeplay/src/plugins/render/types.ts:23
Returns
Section titled “Returns”void
init()
Section titled “init()”init():
Promise<void>
Defined in: packages/threeplay/src/plugins/render/types.ts:19
Async setup (WebGPU needs it). Called once by the render plugin.
Returns
Section titled “Returns”Promise<void>
render()
Section titled “render()”render(
scene,camera):void
Defined in: packages/threeplay/src/plugins/render/types.ts:22
Parameters
Section titled “Parameters”Scene
camera
Section titled “camera”Camera
Returns
Section titled “Returns”void
setSize()
Section titled “setSize()”setSize(
width,height,pixelRatio):void
Defined in: packages/threeplay/src/plugins/render/types.ts:21
Drawing buffer size in CSS pixels plus the pixel ratio.
Parameters
Section titled “Parameters”number
height
Section titled “height”number
pixelRatio
Section titled “pixelRatio”number
Returns
Section titled “Returns”void
Properties
Section titled “Properties”canvas
Section titled “canvas”
readonlycanvas:HTMLCanvasElement|null
Defined in: packages/threeplay/src/plugins/render/types.ts:15
The canvas, or null for the headless backend.
readonlykind:RendererKind
Defined in: packages/threeplay/src/plugins/render/types.ts:13
readonlythree:unknown
Defined in: packages/threeplay/src/plugins/render/types.ts:17
The underlying three.js renderer (escape hatch), or null.