API reference
DebugMember Class
Extends PreserveAttribute
Annotate field, property, functions with this will show in Immersive Debugger panel in runtime.
Without additional parameters specified, by default we're watching fields/properties, and provide a button to call function without parameter. For more info about Immersive Debugger, check out the official doc
Public Statics
static const string DisplayNameTooltip[Get]
Fields
DebugGizmoType GizmoType[Get]
The type of the gizmo to draw in space according to the runtime value of the field/property data.
The gizmoType must match the runtime value's type, check out DebugGizmoType for reference.
bool ShowGizmoByDefault[Get]
Whether the gizmo will be turned on by default at startup.
You can always turn the gizmo off by clicking the "eye" button next to the row of the debug option.
Color Color[Get]
The color used for DebugGizmo line drawing and inspector row pill icon, note it doesn't apply to the Axis typed gizmo as it's drawing R/G/B colors for 3 axis.
bool Tweakable[Get]
Specify whether this field/property is tweakable, will show control UI in headset panel (inspector).
For now, it only supports two types: 1. boolean with checkboxes shown in headset panel, and
- float/int which can be used together with Min, Max param with slider shown in headset panel. By default, to true and can be turned off if no need.
float Min[Get]
Minimum value for the tweak slider, only applicable for float/int data when Tweakable is true.
float Max[Get]
Maximum value for the tweak slider, only applicable for float/int data when Tweakable is true.
string Category[Get]
Optional category for a specific tab in Inspector Panel.
string Description[Get]
Description for the attributed field to be used in the Inspector Panel.
string DisplayName[Get]
Optional name override to be used in the Inspector Panel.
Member Functions
DebugMember
( DebugColor color )
Constructor of the DebugMember.
Parameters
color
The DebugColor typed color used for DebugGizmo line drawing and inspector row pill icon, default to Gray
DebugMember
( string colorString )
Constructor of the DebugMember.
Parameters
colorString
The string typed color used for DebugGizmo line drawing and inspector row pill icon, default to Gray. Could be Hex code or literal colors from Unity https://docs.unity3d.com/ScriptReference/ColorUtility.TryParseHtmlString.html
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2025 Meta