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 > UXRAssetFunctionLibrary > UXRAssetFunctionLibrary::AddNamedDeviceVisualizationComponentBlocking

Light Theme

Dark Theme

UXRAssetFunctionLibrary::AddNamedDeviceVisualizationComponentBlocking

Spawns a render component for the specified XR device.

Windows

MacOS

Linux

References

Module	HeadMountedDisplay
Header	/Engine/Source/Runtime/HeadMountedDisplay/Public/XRAssetFunctionLibrary.h
Include	#include "XRAssetFunctionLibrary.h"
Source	/Engine/Source/Runtime/HeadMountedDisplay/Private/XRAssetFunctionLibrary.cpp

Syntax

static UPrimitiveComponent * AddNamedDeviceVisualizationComponentBlocking
(
    AActor * Target,
    const FName SystemName,
    const FName DeviceName,
    bool bManualAttachment,
    const FTransform & RelativeTransform,
    FXRDeviceId & XRDeviceId
)

Remarks

Spawns a render component for the specified XR device.

NOTE: The associated XR system backend has to provide a model for this to work - if one is not available for the specific device, then this will fail and return an invalid (null) object.

Returns

A new component representing the specified device (invalid/null if a model for the device doesn't exist).

Parameters

Parameter	Description
Target	The intended owner for the component to attach to.
SystemName	(optional) Targets a specific XR system (i.e. 'Oculus', 'SteamVR', etc.). If left as 'None', then the first system found that can render the device will be used.
DeviceName	Source name of the specific device - expect the same names that the MotionControllerComponent's "MotionSource" field uses ('Left', 'Right', etc.).
bManualAttachment	If set, will leave the component unattached (mirror's the same option on the generic AddComponent node). When unset the component will attach to the actor's root.
RelativeTransform	Specifies the component initial transform (relative to its attach parent).

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

Take our survey

Dismiss