emile

Appearance

@emile/engine

@emile/engine / rendering/renderer / RendererOptions

Interface: RendererOptions ​

Defined in: src/rendering/renderer.ts:13

Properties ​

autoInit? ​

optional autoInit: boolean

Defined in: src/rendering/renderer.ts:19

Wether or not to automatically initialize the renderer.

Default ​

ts
true

autoSize? ​

optional autoSize: boolean

Defined in: src/rendering/renderer.ts:53

Wether or not to auto size the renderer to the parent element.

Default ​

ts
true

backgroundColor? ​

optional backgroundColor: ColorSource

Defined in: src/rendering/renderer.ts:60

The background color of the renderer.

Default ​

ts
"black"

enablePixiDevTools? ​

optional enablePixiDevTools: boolean

Defined in: src/rendering/renderer.ts:76

Wether or not to enable the pixi dev tools.

Default ​

ts
false

enablePixiInteraction? ​

optional enablePixiInteraction: boolean

Defined in: src/rendering/renderer.ts:85

Wether or not to enable pixi interactivity on the stage.

Uses app.stage.eventMode = "static" to enable interaction on the stage.

Default ​

ts
true

height? ​

optional height: number

Defined in: src/rendering/renderer.ts:46

The height of the renderer.

If set to -1, the height will be the same as the parent element.

Default ​

ts
-1

parentElement? ​

optional parentElement: null | HTMLElement

Defined in: src/rendering/renderer.ts:28

The parent element to attach the renderer to.

If not set, you must manually add the renderer's canvas to the DOM. Using the attach method.

Default ​

ts
null

scale? ​

optional scale: number

Defined in: src/rendering/renderer.ts:69

The renderer's root scale.

e.g. 50 means 1 unit in the game world is 50 pixels on the screen.

Default ​

ts
50

width? ​

optional width: number

Defined in: src/rendering/renderer.ts:37

The width of the renderer.

If set to -1, the width will be the same as the parent element.

Default ​

ts
-1