Interface IRenderOptions

A CSS background color string to use when render.options.wireframes is disabled. This may be also set to 'transparent' or equivalent.

Default

'#14151f'
Copy

A flag to enable or disable rendering entirely.

Default

false
Copy

A flag that specifies if render.bounds should be used when rendering.

Default

false
Copy

The target height in pixels of the render.canvas to be created. See also the options.pixelRatio property to change render quality.

Default

600
Copy

The pixel ratio to use when rendering.

Default

1
Copy

A flag to enable or disable the body angle debug overlay.

Default

false
Copy

A flag to enable or disable the body axes debug overlay.

Default

false
Copy

A flag to enable or disable the body bounds debug overlay.

Default

false
Copy

A flag to enable or disable the collision broadphase debug overlay.

Deprecated

no longer implemented

Default

false
Copy

A flag to enable or disable the body collisions debug overlay.

Default

false
Copy

A flag to enable or disable the body convex hulls debug overlay.

Default

false
Copy

A flag to enable or disable all debug information overlays together. This includes and has priority over the values of:

• render.options.showStats
• render.options.showPerformance

Default

false
Copy

A flag to enable or disable the body and part ids debug overlay.

Default

false
Copy

A flag to enable or disable the body internal edges debug overlay.

Default

false
Copy

A flag to enable or disable the mouse position debug overlay.

Default

false
Copy

A flag to enable or disable performance charts. From left to right, the values shown are:

• average render frequency (e.g. 60 fps)
• exact engine delta time used for last update (e.g. 16.66ms)
• average engine execution duration (e.g. 5.00ms)
• average render execution duration (e.g. 0.40ms)
• average effective play speed (e.g. '1.00x' is 'real-time')

Each value is recorded over a fixed sample of past frames (60 frames).

A chart shown below each value indicates the variance from the average over the sample. The more stable or fixed the value is the flatter the chart will appear.

Default

false
Copy

A flag to enable or disable the body positions debug overlay.

Default

false
Copy

A flag to enable or disable the collision resolver separations debug overlay.

Default

false
Copy

A flag to enable or disable sleeping bodies indicators.

Default

true
Copy

A flag to enable or disable the engine stats info overlay. From left to right, the values shown are:

• body parts total
• body total
• constraints total
• composites total
• collision pairs total

Default

false
Copy

A flag to enable or disable the body velocity debug overlay.

Default

false
Copy

A flag to enable or disable the body vertex numbers debug overlay.

Default

false
Copy

The target width in pixels of the render.canvas to be created. See also the options.pixelRatio property to change render quality.

Default

800
Copy

A CSS color string to use for background when render.options.wireframes is enabled. This may be also set to 'transparent' or equivalent.

Default

'#14151f'
Copy

A CSS color string to use for stroke when render.options.wireframes is enabled. This may be also set to 'transparent' or equivalent.

Default

'#bbb'
Copy

A flag to toggle wireframe rendering otherwise solid fill rendering is used.

Default

true
Copy