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 from Rawbytes

Light Theme

Dark Theme

Add Runtime Candidate Image from Rawbytes

Windows

MacOS

Linux

Create an ARCandidateImage object from the raw pixel data 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 and PhysicalHeight 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 Google ARCore Session Function Library

Add Runtime Candidate Image from Rawbytes

Session Config

Select Asset

Image Grayscale Pixels

Image Width

Image Height

Friendly Name

Physical Width

0.0

Candidate Texture

Select Asset

Return Value

Select Asset

Inputs

	In Exec
	Session Config ARSession Config Object Reference
	Image Grayscale Pixels Array of Bytes
	Image Width Integer
	Image Height Integer
	Friendly Name String
	Physical Width Float
	Candidate Texture Texture 2D Object Reference

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