Navigation
API > API/Runtime > API/Runtime/AugmentedReality > API/Runtime/AugmentedReality/UARBlueprintLibrary
References
| Module | AugmentedReality |
| Header | /Engine/Source/Runtime/AugmentedReality/Public/ARBlueprintLibrary.h |
| Include | #include "ARBlueprintLibrary.h" |
| Source | /Engine/Source/Runtime/AugmentedReality/Private/ARBlueprintLibrary.cpp |
UFUNCTION (BlueprintCallable, Category="AR AugmentedReality|Session",
Meta=(Keywords="ar augmentedreality augmented reality candidate image"))
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.
Note 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. A `UARCandidateImage_ Object pointer if the underlying ARPlatform added the candidate image at runtime successfully. Return nullptr otherwise.