UARBlueprintLibrary::AddRuntimeCandidateImage

Navigation

API > API/Runtime > API/Runtime/AugmentedReality > API/Runtime/AugmentedReality/UARBlueprintLibrary

References

static UARCandidateImage &42; AddRuntimeCandidateImage  
&40;  
    UARSessionConfig &42; SessionConfig,  
    UTexture2D &42; CandidateTexture,  
    FString FriendlyName,  
    float PhysicalWidth  
&41;  
Copy full snippet

static UARCandidateImage &42; AddRuntimeCandidateImage &40;     UARSessionConfig &42; SessionConfig,     UTexture2D &42; CandidateTexture,     FString FriendlyName,     float PhysicalWidth &41;

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.