UHeadMountedDisplayFunctionLibrary::EnumerateTrackedDevices

Cross XR-System query that will list all XR devices currently being tracked.

Windows
MacOS
Linux

References

Module

HeadMountedDisplay

Header

/Engine/Source/Runtime/HeadMountedDisplay/Public/HeadMountedDisplayFunctionLibrary.h

Include

#include "HeadMountedDisplayFunctionLibrary.h"

Source

/Engine/Source/Runtime/HeadMountedDisplay/Private/HeadMountedDisplayFunctionLibrary.cpp

Syntax

static TArray< FXRDeviceId > EnumerateTrackedDevices
(
    const FName SystemId,
    EXRTrackedDeviceType DeviceType
)

Remarks

Cross XR-System query that will list all XR devices currently being tracked.

Returns

A list of device identifiers matching the query. Use these to query and operate on the device (e.g. through GetDevicePose, AddDeviceVisualizationComponent, etc.)

Parameters

Parameter

Description

SystemId

(Optional) Specifies an explicit system to poll devices from (use if you want only devices belonging to one explicit XR ecosystem, e.g. 'OculusHMD', or 'SteamVR')

DeviceType

Specifies the type of device to query for - defaults to 'Any' (meaning 'All').

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