Android XR Unreal Reference

API Reference for Android XR Unreal Extensions

Pages

FAndroidXRAmbientLightData The ambient light estimate data.
FAndroidXRAnchor Contains FAndroidXRSpace associated with an anchor, along with an FGuid that uniquely identifies the anchor (if persisted).
FAndroidXRAnchorPersistence Contains opaque pointer to XrDeviceAnchorPersistenceANDROID.
FAndroidXRCubemapConfiguration The cubemap configuration to create an estimator.
FAndroidXRCubemapEstimator An AndroidXR cubemap light estimator.
FAndroidXRCubemapLightData The cubemap light estimate data.
FAndroidXRDepthAcquireResult Depth acquire result.
FAndroidXRDepthSwapchain Contains opaque pointer to an XrDepthSwapchainANDROID.
FAndroidXRDepthSwapchainImage Contains opaque pointer to an XrDepthSwapchainImageANDROID.
FAndroidXRDepthView Depth view (essentially an eye's view)
FAndroidXRDirectionalLightData The directional light estimate data.
FAndroidXREye An eye data obtained from eye tracking.
FAndroidXREyeTracker Represents an eye tracker.
FAndroidXREyes The eyes data obtained from eye tracking.
FAndroidXRFaceState The face tracking state and the facial expression blend shapes.
FAndroidXRFaceTracker Contains opaque pointer to XrFaceTrackerANDROID.
FAndroidXRFieldOfView Field of view.
FAndroidXRLightEstimator An AndroidXR light estimator.
FAndroidXRPassthroughLayer Contains opaque pointer to XrPassthroughLayerANDROID.
FAndroidXRPassthroughLayerMeshInfo The passthrough layer mesh info.
FAndroidXRPerformanceMetricsCounter Performance metrics counter.
FAndroidXRRaycastHit Raycast hit.
FAndroidXRSceneMeshSnapshot Contains opaque pointer to an XrSceneMeshSnapshotANDROID Also stores whether or not the snapshot was created from a tracker with normals enabled, so we don't have to also pass the tracker around.
FAndroidXRSceneMeshingTracker Contains opaque pointer to an XrSceneMeshingTrackerANDROID Also stores whether or not the tracker was created with normals, so we know whether or not to supply storage.
FAndroidXRSceneSubmeshData The submesh data.
FAndroidXRSceneSubmeshState The Scene submesh state.
FAndroidXRSpace Contains opaque pointer to an XrSpace.
FAndroidXRSpatialCapabilityInfo
FAndroidXRSphericalHarmonics The spherical harmonics container for each channel.
FAndroidXRSphericalHarmonicsData The spherical harmonics light estimate data.
FAndroidXRSystemExtensionInformation System Extension Information.
FAndroidXRSystemPassthroughProperties The passthrough layer properties supported by the system.
FAndroidXRTrackable Contains opaque pointer to XrTrackableANDROID.
FAndroidXRTrackableObject The trackables object.
FAndroidXRTrackablePlane Trackable plane.
FAndroidXRTrackableTracker Contains opaque pointer to XrTrackableTrackerANDROID.
FAndroidXRViewportFeatheringInsetInfo The trackables object.
FSpatialContext
FSpatialMarkerTrackingConfig The marker tracking configuration for all the marker types.
FSpatialMarkerTrackingFeature The configuration settings for a specific marker type.
FSpatialPlaneMesh A spatial plane's mesh data.
FSpatialPlanePolygon A spatial plane's polygon data.
FSpatialRaycastConfig The ray configuration to perform raycasts with.
FSpatialRaycastEntityResult The raycast entity hit result.
FSpatialRaycastHitInfo The raycast hit information.
FSpatialRaycastPlaneResult The raycast plane hit result.
IAndroidXRModule The public interface to this module.
UAndroidXRAnchorPersistenceAsyncAction
UAndroidXRAnchorPersistenceBlueprintFunctionLibrary Determines whether or not an FAndroidXRAnchorPersistence is valid. Determines whether or not anchor persistence is supported. Enumerates the types of trackables which support persistent anchors. Creates an anchor persistence. Destroys an anchor persistence. Gets the persist state of an anchor. Enumerates the persisted anchors associated with an anchor persistence.
UAndroidXRBlueprintFunctionLibrary Determines whether or not an FAndroidXRSpace is valid. Locates the underlying XrSpace and provides its current transform (base space is the HMD's). Destroys the underlying XrSpace. Gets the AndroidXR event proxy, which allows users to bind to delegates which fired in response to XrEvents. Returns whether or not camera passthrough is supported. Gets the passthrough camera state. Set the performance level for a settings domain. Enumerates the available display refresh rates. Gets the current display refresh rate. Requests a display refresh rate.
UAndroidXRDepthTextureBlueprintFunctionLibrary
UAndroidXREventProxy
UAndroidXREyeTrackingBlueprintFunctionLibrary
UAndroidXREyeTrackingComponent AndroidXR Eye Tracking scene component.
UAndroidXREyeTrackingSubsystem AndroidXR Eye Tracking Subsystem.
UAndroidXRFaceTrackingBlueprintFunctionLibrary Determines whether or not an FAndroidXRFaceTracker is valid. Creates a face tracker. Destroys a face tracker. Gets the calibration state of the face tracker. Gets the blend shapes of a facial expression.
UAndroidXRFaceTrackingComponent AndroidXR Face Tracking Component.
UAndroidXRFaceTrackingSubsystem AndroidXR Face Tracking Subsystem.
UAndroidXRGlobalDimmingBlueprintFunctionLibrary Gets the AndroidXRGlobalDimming event proxy, which allows users to bind to delegates which fired in response to XrEvents. Checks if global dimming is supported by the system. Enumerates the global dimming levels supported by the system. Sets the preferred global dimming level. Gets the current global dimming level.
UAndroidXRGlobalDimmingEventProxy
UAndroidXRLightEstimationBlueprintFunctionLibrary Returns whether or not light estimation is supported on the device. Creates a light estimator. Destroys a light estimator. Gets the directional light data. Gets the ambient light data. Gets the spherical harmonics data. Returns whether light estimation cubemap is supported for the device. Gets the supported cubemap formats. Gets the supported cubemap resolutions. Creates a cubemap light estimator. Gets the cubemap data. Destroys a cubemap estimator. Creates a cubemap texture for a cubemap light estimator. Applies a cubemap data to a texture cube.
UAndroidXRPassthroughMeshBlueprintFunctionLibrary Checks if the passthrough layer is valid. Gets the passthrough mesh system properties. Creates a passthrough layer for the mesh info. Updates the passthrough layer's transform. Updates the passthrough layer texture's opacity. Updates the passthrough layer's mesh. Destroys the passthrough layer.
UAndroidXRPassthroughMeshComponent AndroidXRPassthrough static mesh component.
UAndroidXRPassthroughMeshSubsystem AndroidXR Passthrough Mesh subsystem.
UAndroidXRPerformanceMetricsBlueprintFunctionLibrary Enumerates all performance metrics counter paths supported by the runtime. Enables or disables the performance metrics system. Returns whether or not the performance metrics system is enabled. Queries a performance metrics counter.
UAndroidXRRecommendedResolutionBlueprintFunctionLibrary Gets the AndroidXRRecommendedResolution event proxy, which allows users to bind to delegates which fired in response to XrEvents.
UAndroidXRRecommendedResolutionEventProxy
UAndroidXRSceneMeshingBlueprintFunctionLibrary Determines whether or not an FAndroidXRSceneMeshingTracker is valid. Determines whether or not an FAndroidXRSceneMeshSnapshot is valid.
UAndroidXRSceneMeshingComponent
UAndroidXRSettings
UAndroidXRSpatialAnchorEntity A tracked Anchor entity.
UAndroidXRSpatialAnchorsComponent The anchor component that can be added to create, destroy, and persist an anchor.
UAndroidXRSpatialAnchorsPersistenceAsyncAction The async operations associated with spatial anchors.
UAndroidXRSpatialAnchorsSubsystem The Spatial Anchors subsystem.
UAndroidXRSpatialComponentBase
UAndroidXRSpatialDepthRaycastAsyncAction The asynchronous operation for depth raycast.
UAndroidXRSpatialDepthRaycastAsyncActionBase The base class for depth async operations (has to be a base class due to how blueprint async nodes display only one delegate per class definition in its output node)
UAndroidXRSpatialDepthRaycastSubsystem
UAndroidXRSpatialDiscoveryRaycastSubsystem The spatial discovery raycast subsystem.
UAndroidXRSpatialEntitiesSubsystem The base class of all spatial tracking subsystems.
UAndroidXRSpatialEntity The base class for all spatial tracked entities.
UAndroidXRSpatialMarkerEntity A spatial marker entity.
UAndroidXRSpatialMarkerTrackingSubsystem The marker tracking subsystem.
UAndroidXRSpatialMarkersNotifierComponent The component that keeps track of tracked marker entities.
UAndroidXRSpatialPlaneEntity A spatial plane entity.
UAndroidXRSpatialPlaneTrackingSubsystem The plane tracking subsystem.
UAndroidXRSpatialPlanesNotifierComponent The plane tracking component that keeps track of spatial planes tracked by the runtime.
UAndroidXRSystemExtensionsBlueprintFunctionLibrary Gets the AndroidXRSystemExtensions event proxy, which allows users to bind to delegates which fired in response to XrEvents. Get the current extensions on the system.
UAndroidXRSystemExtensionsEventProxy
UAndroidXRTrackablesCoreBlueprintFunctionLibrary Determines whether or not an FAndroidXRTrackable is valid. Determines whether or not a FAndroidXRTrackableTracker is valid. Enumerates the trackable types supported by the Trackables API. Enumerates the anchor trackable types supported by the Trackables API. Creates a trackable tracker for the specified trackable type. Destroys a trackable tracker. Gets all trackables of the specified trackable tracker type. Gets an FAndroidXRTrackablePlane from an FAndroidXRTrackable. Returns whether or not anchors are supported and provides the maximum number of anchors. Creates an anchor space. Enumerates the trackable types supported by the Raycast API. Performs a raycast against the specified trackable trackers.
UAndroidXRTrackablesObjectBlueprintFunctionLibrary Creates a trackable tracker for the specified trackable object labels. Gets an FAndroidXRTrackableObject from an FAndroidXRTrackable.
UAndroidXRTrackingSubsystem The base class for all AndroidXR tracking subsystems.
UAndroidXRViewportFeatheringBlueprintFunctionLibrary Acquire information about the feathered insets for each side of the view. Check if Viewport Feathering is supported on the device.
UCreatePersistedAnchorSpace
UHandInteractionBlueprintFunctionLibrary Gets an interaction's current pose transform. Gets an interaction's current float value. Gets the ready state of an interaction.
UHandTrackingMeshBlueprintFunctionLibrary Creates a hand mesh for a specified hand. Sets the hand mesh scale via OpenXR settings. Gets the transforms for the joints. Gets the hand mesh bone name from an EHandKeypoint value.
UPersistAnchor
UUnpersistAnchor