Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > HeadMountedDisplay > IXRSystemAssets > IXRSystemAssets::GetDeviceId

Light Theme

Dark Theme

IXRSystemAssets::GetDeviceId

Provides a mapping for MotionControllers, so we can identify the device ID used for a specific hand (which in turn can be used in other functions, like CreateRenderComponent, etc.).

Windows

MacOS

Linux

References

Module	HeadMountedDisplay
Header	/Engine/Source/Runtime/HeadMountedDisplay/Public/IXRSystemAssets.h
Include	#include "IXRSystemAssets.h"

Syntax

int32 GetDeviceId
(
EControllerHand ControllerHand
)

Remarks

Provides a mapping for MotionControllers, so we can identify the device ID used for a specific hand (which in turn can be used in other functions, like CreateRenderComponent, etc.).

Some systems will not have an explicit mapping until the device is on and registered. In that case, this function will return an invalid device ID.

Not all XR systems support every EControllerHand value. If that's the case, then this will return an invalid device ID, though that specific value is undetermined and up to each XRSystem for interpretation.

Returns

A device ID that is specific to this XRSystem (can only be interpreted by other members belonging to the same IXRSystemIdentifier)

Parameters

Parameter	Description
ControllerHand	The UE specific hand identifier you want a system specific device ID for.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss