Class: Engine3D
Orillusion 3D Engine
-- Engine3D.setting.*
-- await Engine3D.init();
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new Engine3D(): Engine3D
Returns
Properties
res
▪ Static res: Res
resource manager in engine3d
Defined in
inputSystem
▪ Static inputSystem: InputSystem
input system in engine3d
Defined in
divB
▪ Static divB: HTMLDivElement
input system in engine3d
Defined in
views
▪ Static views: View3D[]
more view in engine3d
Defined in
setting
▪ Static setting: EngineSetting
engine setting
Defined in
Accessors
frameRate
• get frameRate(): number
set engine render frameRate 24/30/60/114/120/144/240/360 fps or other
Returns
number
Defined in
• set frameRate(value): void
get engine render frameRate
Parameters
| Name | Type |
|---|---|
value | number |
Returns
void
Defined in
size
• get size(): number[]
get render window size width and height
Returns
number[]
Defined in
aspect
• get aspect(): number
get render window aspect
Returns
number
Defined in
width
• get width(): number
get render window size width
Returns
number
Defined in
height
• get height(): number
get render window size height
Returns
number
Defined in
Methods
init
▸ init(descriptor?): Promise<void>
create webgpu 3d engine
Parameters
| Name | Type | Description |
|---|---|---|
descriptor | Object | CanvasConfig |
descriptor.canvasConfig? | CanvasConfig | - |
descriptor.beforeRender? | Function | - |
descriptor.renderLoop? | Function | - |
descriptor.lateRender? | Function | - |
descriptor.engineSetting? | EngineSetting | - |
Returns
Promise<void>
Defined in
startRenderView
▸ startRenderView(view): ForwardRenderJob
set render view and start renderer
Parameters
| Name | Type |
|---|---|
view | View3D |
Returns
Defined in
startRenderViews
▸ startRenderViews(views): void
set render views and start renderer
Parameters
| Name | Type |
|---|---|
views | View3D[] |
Returns
void
Defined in
getRenderJob
▸ getRenderJob(view): RendererJob
get view render job instance
Parameters
| Name | Type |
|---|---|
view | View3D |
Returns
RendererJob
Defined in
pause
▸ pause(): void
Pause the engine render
Returns
void
Defined in
resume
▸ resume(): void
Resume the engine render
Returns
void