features

The Inspector


What Is It?

Babylon.js inspector is a debugging tool created to help pinpoint issues you may have with a scene. It offers multiple tools like:

  • A hierarchical view of your scene
  • Multiple property grids to let you dynamically change object properties
  • Specific helpers like the skeleton viewer, etc.

Its interface uses two panes:

  • The scene explorer pane
  • The inspector pane

debug layer overview

The two panes can also be opened in an embedded mode:

embed mode

Scene explorer pane

scene explorer

The scene explorer displays a hierarchical view of your scene. You can filter by name in the filter bar if you want to find a specific entry.

By clicking on a line you will select it and the inspector will automatically update to reflect the properties of the selected item.

Some entities offer shortcuts to contextual actions.

Scene actions

scene actions

The scene shortcuts are the following:

  • The first 3 actions will turn on a specific gizmo mode (translation, rotation, scaling). When you click on one of them you can then click on a node in the Scene explorer or directly in your scene and it will be controllable with a gizmo:

gizmo

  • The fourth action is a picker. Just pick a mesh in your scene and it will be selected in your scene explorer
  • The last one will force the scene explorer to update. For performance reasons, the scene explorer is not listening to all changes that can happen on the scene so you may end up needing to refresh it manually.

Mesh actions

mesh actions

The mesh shortcuts are the following:

  • The first action will enable the bounding box gizmo:

bounding box gizmo

  • The second action will show/hide the mesh.

Light actions

light actions

You can use the light action to turn a light on and off.

Camera actions

camera actions

You can use the camera action to switch the active camera (when they are multiple cameras in a scene).

GUI control actions

gui control actions

You can use the GUI control actions to:

  • Display outline of a control
  • Show / hide a specific control

Rendering pipeline actions

Rendering pipeline actions

When your scene does not contain a default rendering pipeline, you can right-click on the rendering pipelines node to get a context menu letting you create a new default rendering pipeline.

Inspector pane

The inspector pane contains 4 tabs:

inspector

  • The property grid which will display configurable controls for the current selected entity:

property grid

  • The debug pane will let you turn features on and off. It also let you display a grid and turn viewers (bones or physics) on and off:

debug pane

  • The statistics pane gives information about all metrics captured by the engine:

stats pane

  • The tools pane lets you access utilities (like screen capture or recording as well as several tools related to glTF):

tools

Popup mode

You can move any pane into a popup mode by clicking the icon right left to the close button in the pane header:

popup

Specific debug tools

Specific debug tools can be found across the inspector:

Render grid

This tool (available in the Debug pane) will render a grid on the (0,0,0) plane:

grid

Bones viewer

This tool (available in the skeleton property grid) will render your skeletons:

bones

Physics viewer

This tool (available in the Debug pane) will render your physics impostors:

physics

Normal painter

This tool (available in the property pane when you select a mesh) will paint the normals on your active mesh:

paint normal

Vertex normal viewer

This tool (available in the property pane when you select a mesh) will render the vertex normals of a mesh:

vertex normal

Texture painter

This tool (available in the property pane when you select a material with textures in it) will render the texture directly as an emissive one:

texture painter

Further Reading

How To Use The Inspector in Projects
How To Customize the Inspector
Dev log about the inspector