Skip to content

Class: Engine3D

Orillusion 3D Engine

-- Engine3D.setting.*

-- await Engine3D.init();

Constructors

Properties

Accessors

Methods

Constructors

constructor

new Engine3D(): Engine3D

Returns

Engine3D

Properties

res

Static res: Res

resource manager in engine3d

Defined in

src/Engine3D.ts:42


inputSystem

Static inputSystem: InputSystem

input system in engine3d

Defined in

src/Engine3D.ts:47


views

Static views: View3D[]

more view in engine3d

Defined in

src/Engine3D.ts:52


Engine3D

Static Engine3D: any

Defined in

src/Engine3D.ts:62


divB

Static divB: HTMLDivElement

Defined in

src/Engine3D.ts:63


setting

Static setting: EngineSetting

engine setting

Defined in

src/Engine3D.ts:114

Accessors

frameRate

get frameRate(): number

set engine render frameRate 24/30/60/114/120/144/240/360 fps or other

Returns

number

Defined in

src/Engine3D.ts:68

set frameRate(value): void

get engine render frameRate

Parameters

NameType
valuenumber

Returns

void

Defined in

src/Engine3D.ts:75


size

get size(): number[]

get render window size width and height

Returns

number[]

Defined in

src/Engine3D.ts:86


aspect

get aspect(): number

get render window aspect

Returns

number

Defined in

src/Engine3D.ts:93


width

get width(): number

get render window size width

Returns

number

Defined in

src/Engine3D.ts:100


height

get height(): number

get render window size height

Returns

number

Defined in

src/Engine3D.ts:107

Methods

init

init(descriptor?): Promise<void>

create webgpu 3d engine

Parameters

NameTypeDescription
descriptorObjectCanvasConfig
descriptor.canvasConfig?CanvasConfig-
descriptor.beforeRender?Function-
descriptor.renderLoop?Function-
descriptor.lateRender?Function-
descriptor.engineSetting?EngineSetting-

Returns

Promise<void>

Defined in

src/Engine3D.ts:313


startRenderView

startRenderView(view): ForwardRenderJob

set render view and start renderer

Parameters

NameType
viewView3D

Returns

ForwardRenderJob

Defined in

src/Engine3D.ts:359


startRenderViews

startRenderViews(views): void

set render views and start renderer

Parameters

NameType
viewsView3D[]

Returns

void

Defined in

src/Engine3D.ts:388


getRenderJob

getRenderJob(view): RendererJob

get view render job instance

Parameters

NameType
viewView3D

Returns

RendererJob

Defined in

src/Engine3D.ts:416


pause

pause(): void

Pause the engine render

Returns

void

Defined in

src/Engine3D.ts:423


resume

resume(): void

Resume the engine render

Returns

void

Defined in

src/Engine3D.ts:433