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

HmdRef Class

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

Properties

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.

Protected Functions

virtual void Awake ( )
virtual void Start ( )

Member Functions

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.
Parameters
pose
The struct to be populated with the HMD pose
Returns
True if the out argument was populated with a valid HMD pose, false otherwise
void InjectAllHmdRef
( IHmd hmd )
void InjectHmd
( IHmd hmd )
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta