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 API Reference > Plugins > GoogleARCoreBase > UGoogleARCoreSessionFunctionLibrary

Light Theme

Dark Theme

UGoogleARCoreSessionFunctionLibrary

A function library that provides static/Blueprint functions associated with GoogleARCore session.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBlueprintFunctionLibrary

UGoogleARCoreSessionFunctionLibrary

References

Module	GoogleARCoreBase
Header	/Engine/Plugins/Runtime/AR/Google/GoogleARCore/Source/GoogleARCoreBase/Public/GoogleARCoreFunctionLibrary.h
Include	#include "GoogleARCoreFunctionLibrary.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UGoogleARCoreSessionFunctionLibrary : public UBlueprintFunctionLibrary

Remarks

A function library that provides static/Blueprint functions associated with GoogleARCore session.

Functions

	Name	Description
UARCandidate...	AddRuntimeCandidateImageFromRawbytes ( UARSessionConfig* SessionConfi..., const TArray< uint8 >& ImageGraysc..., int ImageWidth, int ImageHeight, FString FriendlyName, float PhysicalWidth, UTexture2D* CandidateTexture )	Create an ARCandidateImage object from the raw pixel data and add it to the ARCandidateImageList of the given `UARSessionConfig_ object.
void	CheckARCoreAvailability ( UObject* WorldContextObject, FLatentActionInfo LatentInfo, EGoogleARCoreAvailability& OutAvai... )	A Latent Action to check the availability of ARCore on this device.
EGoogleARCor...	CheckARCoreAvailableStatus()	A polling function to check the ARCore availability in C++.
void	GetAllAugmentedFaces ( TArray< UGoogleARCoreAugmentedFace ... )	Gets a list of all valid UGoogleARCoreAugmentedFace objects that ARCore is currently tracking.
void	GetAllAugmentedImages ( TArray< UGoogleARCoreAugmentedImage... )	Gets a list of all valid UGoogleARCoreAugmentedImage objects that ARCore is currently tracking.
void	GetAllPlanes ( TArray< UARPlaneGeometry* >& ... )	Gets a list of all valid UARPlaneGeometry objects that ARCore is currently tracking.
void	GetAllTrackable ( TArray< T* >& OutTrackableLis... )	Template function to get all trackables from a given type.
void	GetAllTrackablePoints ( TArray< UARTrackedPoint* >& O... )	Gets a list of all valid UARTrackedPoint objects that ARCore is currently tracking.
EGoogleARCor...	GetARCoreAPKInstallResult()	A polling function to check the ARCore install request result in C++.
bool	GetARCoreCameraConfig ( FGoogleARCoreCameraConfig& OutCurr... )	Get the FGoogleARCoreCameraConfig that the current ARCore session is using.
UGoogleARCor...	GetARCoreEventManager()	Get the UGoogleARCoreEventManager to bind BP events or c++ delegate in GoogleARCore plugins.
void	InstallARCoreService ( UObject* WorldContextObject, FLatentActionInfo LatentInfo, EGoogleARCoreInstallRequestResult&... )	A Latent Action to initiates installation of ARCore if required.
bool	IsPassthroughCameraRenderingEnabled()	Returns the state of the passthrough camera rendering in GoogleARCore ARSystem.
EGoogleARCor...	RequestInstallARCoreAPK()	Initiates installation of ARCore if required.
bool	SetARCoreCameraConfig ( FGoogleARCoreCameraConfig TargetCam... )	Configure the ARCoreSession with the desired camera configuration.
void	SetPassthroughCameraRenderingEnabled ( bool bEnable )	Enables/Disables the passthrough camera rendering in GoogleARCore ARSystem.
void	StartARCoreSession ( UObject* WorldContextObject, FLatentActionInfo LatentInfo, UGoogleARCoreSessionConfig* Co... )	Starts a new ARCore tracking session GoogleARCore specific configuration.

Deprecated Functions

		Name	Description
	void	GetPassthroughCameraImageUV ( const TArray< float >& InUV, TArray< float >& OutUV )	Use UGoogleARCoreFrameFunctionLibrary::TransformARCoordinates2D(EGoogleARCoreCoordinates2DType::Viewport, InUV, EGoogleARCoreCoordinates2DType::Texture, OutUV) instead.

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

Take our survey

Dismiss