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 Blueprint API Reference > AR Augmented Reality > Session > Add Runtime Candidate Image

Light Theme

Dark Theme

Add Runtime Candidate Image

Windows

MacOS

Linux

Create an ARCandidateImage object and add it to the ARCandidateImageList of the given \c UARSessionConfig object.

Note that you need to restart the AR session with the \c 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.

Target is ARBlueprint Library

Add Runtime Candidate Image

Session Config

Select Asset

Candidate Texture

Select Asset

Friendly Name

Physical Width

0.0

Return Value

Select Asset

Inputs

	In Exec
	Session Config ARSession Config Object Reference
	Candidate Texture Texture 2D Object Reference
	Friendly Name String
	Physical Width Float

Outputs

	Out Exec
	Return Value ARCandidate Image Object Reference	A \c UARCandidateImage Object pointer if the underlying ARPlatform added the candidate image at runtime successfully. Return nullptr otherwise.

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

Take our survey

Dismiss