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: engineDebug.js, line 1

Members

(static, constant) debug :Boolean

True if debug is enabled

Type:

Boolean

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

(static) debugKey :String

Key code used to toggle debug mode, Esc by default

Type:

String

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

(static) debugOverlay :Boolean

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

Type:

Boolean

Source: engineDebug.js, line 47

(static, constant) debugPointSize :Number

Size to render debug points by default

Type:

Number

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

(static, constant) enableAsserts :Boolean

True if asserts are enaled

Type:

Boolean

Default Value: true
Source: 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: 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>

Source: engineDebug.js, line 59

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

Draw a debug circle in world space

Parameters:

Name	Type	Attributes	Default
`pos`	Vector2
`radius`	Number	<optional>	0
`color`	String	<optional>	#fff
`time`	Number	<optional>	0
`fill`	Boolean	<optional>	false

Source: engineDebug.js, line 100

(static) debugClear()

Clear all debug primitives in the list

Source: engineDebug.js, line 163

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

Draw a debug line in world space

Parameters:

Name	Type	Attributes	Default
`posA`	Vector2
`posB`	Vector2
`color`	String	<optional>
`thickness`	Number	<optional>	0.1
`time`	Number	<optional>

Source: engineDebug.js, line 125

(static) debugOverlap(pA, sA, pB, sB, coloropt)

Draw a debug combined axis aligned bounding box in world space

Parameters:

Name	Type	Attributes	Description
`pA`	Vector2		position A
`sA`	Vector2		size A
`pB`	Vector2		position B
`sB`	Vector2		size B
`color`	String	<optional>

Source: engineDebug.js, line 139

(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: engineDebug.js, line 112

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

Draw a debug poly in world space

Parameters:

Name	Type	Attributes	Default
`pos`	Vector2
`points`	Array
`color`	String	<optional>	#fff
`time`	Number	<optional>	0
`angle`	Number	<optional>	0
`fill`	Boolean	<optional>	false

Source: engineDebug.js, line 87

(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: engineDebug.js, line 73

(static) debugSaveCanvas(canvas, filenameopt, typeopt)

Save a canvas to disk

Parameters:

Name	Type	Attributes	Default
`canvas`	HTMLCanvasElement
`filename`	String	<optional>	screenshot
`type`	String	<optional>	image/png

Source: engineDebug.js, line 170

(static) debugSaveDataURL(dataURL, filename)

Save a data url to disk

Parameters:

Name	Type	Description
`dataURL`	String
`filename`	String

Source: engineDebug.js, line 185

(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: engineDebug.js, line 178

(static) debugShowErrors()

Show error as full page of red text

Source: engineDebug.js, line 194

(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: engineDebug.js, line 155

(static) setDebugKey(key)

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

Parameters:

Name	Type	Description
`key`	String

Source: engineSettings.js, line 493

(static) setShowWatermark(show)

Set if watermark with FPS should be shown

Parameters:

Name	Type	Description
`show`	Boolean

Source: engineSettings.js, line 488