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 > UHeadMountedDisplayFunctionLibrary > UHeadMountedDisplayFunctionLibrary::GetTrackingSensorParameters

Light Theme

Dark Theme

UHeadMountedDisplayFunctionLibrary::GetTrackingSensorParameters

If the HMD has a positional sensor, this will return the game-world location of it, as well as the parameters for the bounding region of tracking.

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 void GetTrackingSensorParameters
(
    FVector & Origin,
    FRotator & Rotation,
    float & LeftFOV,
    float & RightFOV,
    float & TopFOV,
    float & BottomFOV,
    float & Distance,
    float & NearPlane,
    float & FarPlane,
    bool & IsActive,
    int32 Index
)

Remarks

If the HMD has a positional sensor, this will return the game-world location of it, as well as the parameters for the bounding region of tracking. This allows an in-game representation of the legal positional tracking range. All values will be zeroed if the sensor is not available or the HMD does not support it.

Parameters

Parameter	Description
Index	(in) Index of the tracking sensor to query
Origin	(out) Origin, in world-space, of the sensor
Rotation	(out) Rotation, in world-space, of the sensor
LeftFOV	(out) Field-of-view, left from center, in degrees, of the valid tracking zone of the sensor
RightFOV	(out) Field-of-view, right from center, in degrees, of the valid tracking zone of the sensor
TopFOV	(out) Field-of-view, top from center, in degrees, of the valid tracking zone of the sensor
BottomFOV	(out) Field-of-view, bottom from center, in degrees, of the valid tracking zone of the sensor
Distance	(out) Nominal distance to sensor, in world-space
NearPlane	(out) Near plane distance of the tracking volume, in world-space
FarPlane	(out) Far plane distance of the tracking volume, in world-space
IsActive	(out) True, if the query for the specified sensor succeeded.

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

Take our survey

Dismiss