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

IHmd Interface

Interaction SDK's fundamental concept of a head-mounted display device, such as a VR headset.
This interface encapsulates the core capabilities common to all HMDs supported by the Interaction SDK. Where possible, you should use this interface instead of concrete alternatives such as Hmd, which are less general and portable.

Events

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 Oculus.Interaction.Input.IHmd.WhenUpdated

Methods

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 Oculus.Interaction.Input.IHmd.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