UARBlueprintLibrary::AddRuntimeCandidateImage

Create an ARCandidateImage object and add it to the ARCandidateImageList of the given `[UARSessionConfig](API\Runtime\AugmentedReality\UARSessionConfig)_ object.

Choose your operating system:

Windows

macOS

Linux

References

Module	AugmentedReality
Header	/Engine/Source/Runtime/AugmentedReality/Public/ARBlueprintLibrary.h
Include	#include "ARBlueprintLibrary.h"
Source	/Engine/Source/Runtime/AugmentedReality/Private/ARBlueprintLibrary.cpp

Syntax

static UARCandidateImage * AddRuntimeCandidateImage
(
    UARSessionConfig * SessionConfig,
    UTexture2D * CandidateTexture,
    FString FriendlyName,
    float PhysicalWidth
)

Remarks

Create an ARCandidateImage object and add it to the ARCandidateImageList of the given `UARSessionConfig_ object.

that you need to restart the AR session with the `UARSessionConfig_ you are adding to to make the change take effect. On ARCore platform, you can leave the PhysicalWidth to 0 if you don't know the physical size of the image or the physical size is dynamic. And this function takes time to perform non-trivial image processing (20ms - 30ms), and should be run on a background thread.

Returns

A `UARCandidateImage_ Object pointer if the underlying ARPlatform added the candidate image at runtime successfully. Return nullptr otherwise.