Namespace: Debug

LittleJS Debug System

Press Esc to show debug overlay with mouse pick
Number keys toggle debug functions
+/- apply time scale
Debug primitive rendering
Save a 2d canvas as a png image

Source: src/engineDebug.js, line 1

Members

(static, constant) debug :boolean

True if debug is enabled

Type:

boolean

Default Value: true
Source: src/engineDebug.js, line 17

(static) debugKey :string

Key code used to toggle debug mode, Esc by default

Type:

string

Default Value: Escape
Source: src/engineDebug.js, line 41

(static) debugOverlay :boolean

True if the debug overlay is active, always false in release builds

Type:

boolean

Source: src/engineDebug.js, line 47

(static, constant) debugPointSize :number

Size to render debug points by default

Type:

number

Default Value: 0.5
Source: src/engineDebug.js, line 29

(static, constant) enableAsserts :boolean

True if asserts are enabled

Type:

boolean

Default Value: true
Source: src/engineDebug.js, line 23

(static) showWatermark :boolean

True if watermark with FPS should be shown, false in release builds

Type:

boolean

Default Value: true
Source: src/engineDebug.js, line 35

Methods

(static) ASSERT(assert, …outputopt)

Asserts if the expression is false, does not do anything in release builds

Parameters:

Name	Type	Attributes	Description
`assert`	boolean
`output`	Object	<optional> <repeatable>	error message output

Source: src/engineDebug.js, line 59

(static) debugCircle(pos, sizeopt, coloropt, timeopt, fillopt)

Draw a debug circle in world space

Parameters:

Name	Type	Attributes	Default	Description
`pos`	Vector2
`size`	number	<optional>	0	diameter
`color`	string	<optional>	#fff
`time`	number	<optional>	0
`fill`	boolean	<optional>	false

Source: src/engineDebug.js, line 102

(static) debugClear()

Clear all debug primitives in the list

Source: src/engineDebug.js, line 171

(static) debugLine(posA, posB, coloropt, widthopt, timeopt)

Draw a debug line in world space

Parameters:

Name	Type	Attributes	Default
`posA`	Vector2
`posB`	Vector2
`color`	string	<optional>
`width`	number	<optional>	0.1
`time`	number	<optional>

Source: src/engineDebug.js, line 127

(static) debugOverlap(posA, sizeA, posB, sizeB, coloropt)

Draw a debug combined axis aligned bounding box in world space

Parameters:

Name	Type	Attributes
`posA`	Vector2
`sizeA`	Vector2
`posB`	Vector2
`sizeB`	Vector2
`color`	string	<optional>

Source: src/engineDebug.js, line 141

(static) debugPoint(pos, coloropt, timeopt, angleopt)

Draw a debug point in world space

Parameters:

Name	Type	Attributes
`pos`	Vector2
`color`	string	<optional>
`time`	number	<optional>
`angle`	number	<optional>

Source: src/engineDebug.js, line 114

(static) debugPoly(pos, points, coloropt, timeopt, angleopt, fillopt)

Draw a debug poly in world space

Parameters:

Name	Type	Attributes	Default
`pos`	Vector2
`points`	Array.<Vector2>
`color`	string	<optional>	#fff
`time`	number	<optional>	0
`angle`	number	<optional>	0
`fill`	boolean	<optional>	false

Source: src/engineDebug.js, line 89

(static) debugRect(pos, sizeopt, coloropt, timeopt, angleopt, fillopt)

Draw a debug rectangle in world space

Parameters:

Name	Type	Attributes	Default
`pos`	Vector2
`size`	Vector2	<optional>	Vector2()
`color`	string	<optional>	#fff
`time`	number	<optional>	0
`angle`	number	<optional>	0
`fill`	boolean	<optional>	false

Source: src/engineDebug.js, line 73

(static) debugSaveCanvas(canvas, filenameopt, typeopt)

Save a canvas to disk

Parameters:

Name	Type	Attributes	Default
`canvas`	HTMLCanvasElement \| OffscreenCanvas
`filename`	string	<optional>	screenshot
`type`	string	<optional>	image/png

Source: src/engineDebug.js, line 182

(static) debugSaveDataURL(dataURL, filename)

Save a data url to disk

Parameters:

Name	Type	Description
`dataURL`	string
`filename`	string

Source: src/engineDebug.js, line 210

(static) debugSaveText(text, filenameopt, typeopt)

Save a text file to disk

Parameters:

Name	Type	Attributes	Default
`text`	string
`filename`	string	<optional>	text
`type`	string	<optional>	text/plain

Source: src/engineDebug.js, line 203

(static) debugScreenshot()

Trigger debug system to take a screenshot

Source: src/engineDebug.js, line 175

(static) debugShowErrors()

Show error as full page of red text

Source: src/engineDebug.js, line 219

(static) debugText(text, pos, sizeopt, coloropt, timeopt, angleopt, fontopt)

Draw a debug axis aligned bounding box in world space

Parameters:

Name	Type	Attributes	Default
`text`	string
`pos`	Vector2
`size`	number	<optional>	1
`color`	string	<optional>	#fff
`time`	number	<optional>	0
`angle`	number	<optional>	0
`font`	string	<optional>	monospace

Source: src/engineDebug.js, line 163

(static) debugVideoCaptureIsActive()

Check if video capture is active

Source: src/engineDebug.js, line 513

(static) debugVideoCaptureStart()

Start capturing video

Source: src/engineDebug.js, line 517

(static) debugVideoCaptureStop()

Stop capturing video and save to disk

Source: src/engineDebug.js, line 571

(static) setDebugKey(key)

Set key code used to toggle debug mode, Esc by default

Parameters:

Name	Type	Description
`key`	string

Source: src/engineSettings.js, line 551

(static) setShowWatermark(show)

Set if watermark with FPS should be shown

Parameters:

Name	Type	Description
`show`	boolean

Source: src/engineSettings.js, line 546