API reference
API reference
Select your platform
No SDKs available
No versions available

HmdRef Class

Extends MonoBehaviour
Implements IHmd
A set of constants that are passed to each child of a Hand modifier tree from the root DataSource.

Properties

WhenUpdated : Action
Event signaled when the HMD is updated with the latest data available from the system.
For situations where only the most up-to-date HMD pose data will suffice, TryGetRootPose(out Pose) can be called from within a handler to this event.
Signature 
Action WhenUpdated

Protected Methods

Awake ()
Signature 
virtual void Awake()
Returns
void
Start ()
Signature 
virtual void Start()
Returns
void

Methods

InjectAllHmdRef ( hmd )
Signature 
void InjectAllHmdRef(IHmd hmd)
Parameters
hmd: IHmd
Returns
void
InjectHmd ( hmd )
Signature 
void InjectHmd(IHmd hmd)
Parameters
hmd: IHmd
Returns
void
TryGetRootPose ( pose )
Attempts to retrieve the world-space pose (position and orientation) of the HMD.
If a valid HMD pose is available, it will be stored in the pose argument and this method will return true; otherwise, the pose argument will be set to the identity pose and the method will return false.
Signature 
bool TryGetRootPose(out Pose pose)
Parameters
pose: out Pose  The struct to be populated with the HMD pose
Returns
bool  True if the out argument was populated with a valid HMD pose, false otherwise
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta