Skip to main content

HUD API

The HUD (heads up display) API allows you to enable and disable Capture mode, check the status and set the HUD's position.

Enable the HUD#

Hud.Enable();
The user will need to restart the app after enabling Capture mode. The user will be promoted with the message: "Please restart the app to enable capture mode."

Disable the HUD#

Hud.Disable();

HUD status#

The IsEnabled API returns true if the HUD is enabled.

Hud.IsEnabled();

HUD Position#

This API will change the position of the HUD, and positions are based on Unity TextAnchor (see docs).

Hud.SetHudAnchorPosition(TextAnchor anchor);