Extensions

Summary

Enumerations
AndroidXRPermission{
  SceneUnderstandingCoarse = 0,
  SceneUnderstandingFine = 1,
  HandTracking = 2,
  EyeTrackingCoarse = 3,
  EyeTrackingFine = 4,
  FaceTracking = 5,
  BodyTracking = 9
} 		enum
Permissions required by Android XR tracking services.
XRAvatarSkeletonJointID{
  Invalid = 0,
  BeginMarker = 1,
  Hips = BeginMarker,
  Spine,
  Ribs,
  Chest,
  Neck,
  Head,
  LeftShoulder,
  RightShoulder,
  LeftUpperArm,
  RightUpperArm,
  LeftLowerArm,
  RightLowerArm,
  LeftHand,
  RightHand,
  LeftUpperLeg,
  RightUpperLeg,
  LeftLowerLeg,
  RightLowerLeg,
  LeftFoot,
  RightFoot,
  LeftToes,
  RightToes,
  EndMarker
} 		enum
Represents the type of an skeleton joint.
XRFaceConfidenceRegion{
  Lower = 0,
  LeftUpper = 1,
  RightUpper = 2
} 		enum
This is an enumeration of the face confidence regions.
XRFaceParameterIndices{
  BrowLowererL = 0,
  BrowLowererR = 1,
  CheekPuffL = 2,
  CheekPuffR = 3,
  CheekRaiserL = 4,
  CheekRaiserR = 5,
  CheekSuckL = 6,
  CheekSuckR = 7,
  ChinRaiserB = 8,
  ChinRaiserT = 9,
  DimplerL = 10,
  DimplerR = 11,
  EyesClosedL = 12,
  EyesClosedR = 13,
  EyesLookDownL = 14,
  EyesLookDownR = 15,
  EyesLookLeftL = 16,
  EyesLookLeftR = 17,
  EyesLookRightL = 18,
  EyesLookRightR = 19,
  EyesLookUpL = 20,
  EyesLookUpR = 21,
  InnerBrowRaiserL = 22,
  InnerBrowRaiserR = 23,
  JawDrop = 24,
  JawSidewaysLeft = 25,
  JawSidewaysRight = 26,
  JawThrust = 27,
  LidTightenerL = 28,
  LidTightenerR = 29,
  LipCornerDepressorL = 30,
  LipCornerDepressorR = 31,
  LipCornerPullerL = 32,
  LipCornerPullerR = 33,
  LipFunnelerLB = 34,
  LipFunnelerLT = 35,
  LipFunnelerRB = 36,
  LipFunnelerRT = 37,
  LipPressorL = 38,
  LipPressorR = 39,
  LipPuckerL = 40,
  LipPuckerR = 41,
  LipStretcherL = 42,
  LipStretcherR = 43,
  LipSuckLB = 44,
  LipSuckLT = 45,
  LipSuckRB = 46,
  LipSuckRT = 47,
  LipTightenerL = 48,
  LipTightenerR = 49,
  LipsToward = 50,
  LowerLipDepressorL = 51,
  LowerLipDepressorR = 52,
  MouthLeft = 53,
  MouthRight = 54,
  NoseWrinklerL = 55,
  NoseWrinklerR = 56,
  OuterBrowRaiserL = 57,
  OuterBrowRaiserR = 58,
  UpperLidRaiserL = 59,
  UpperLidRaiserR = 60,
  UpperLipRaiserL = 61,
  UpperLipRaiserR = 62,
  TongueOut = 63,
  TongueLeft = 64,
  TongueRight = 65,
  TongueUp = 66,
  TongueDown = 66
} 		enum
This is an enumeration of the blendshape values in the Google default vector format.
XRFaceTrackingStates{
  Paused,
  Stopped,
  Tracking
} 		enum
This is an enumeration of the possible face tracking states.
XRFoveationLevel{
  None = 0,
  Low = 1,
  Medium = 2,
  High = 3
} 		enum
Enum corresponding to XrFoveationLevelFB.
XRMarkerDictionary{
  ArUco4x4_50 = 0,
  ArUco4x4_100 = 1,
  ArUco4x4_250 = 2,
  ArUco4x4_1000 = 3,
  ArUco5x5_50 = 4,
  ArUco5x5_100 = 5,
  ArUco5x5_250 = 6,
  ArUco5x5_1000 = 7,
  ArUco6x6_50 = 8,
  ArUco6x6_100 = 9,
  ArUco6x6_250 = 10,
  ArUco6x6_1000 = 11,
  ArUco7X7_50 = 12,
  ArUco7X7_100 = 13,
  ArUco7X7_250 = 14,
  ArUco7X7_1000 = 15,
  AprilTag_16H5 = 16,
  AprilTag_25H9 = 17,
  AprilTag_36H10 = 18,
  AprilTag_36H11 = 19
} 		enum
Describes the type of Supported marker dictionaries.
XRMeshSemantics{
  OTHER = 0,
  FLOOR = 1,
  CEILING = 2,
  WALL = 3,
  TABLE = 4
} 		enum
An enum representing the vertex semantics of a scene mesh.
XRObjectLabel{
  Unknown = 0,
  Keyboard = 1,
  Mouse = 2,
  Laptop = 3
} 		enum
Describes the type of object that the system has identified.
XRPassthroughCameraStates{
  Disabled = 0,
  Initializing = 1,
  Ready = 2,
  Error = 3
} 		enum
Defines possible passthrough camera states.
XrInputModality{
  Unknown = 0,
  Hand = 1,
  Controller = 2,
  Mouse = 3,
  Eye = 4,
  HmdFallback = 5,
  DwellWithHead = 6,
  DwellWithEye = 7
} 		enum
The input modality state of the system.

Typedefs
PoseControl using
UnityEngine.XR.OpenXR.Input.PoseControl

Classes
Google.XR.Extensions.ARTrackedImageExtensions

Extensions to AR Foundation's ARTrackedImage class.

Google.XR.Extensions.ARTrackedObjectExtensions

Extensions to AR Foundation's ARTrackedObject class.

Google.XR.Extensions.AndroidXRHumanBodySubsystem

The Android XR implementation of the XRHumanBodySubsystem so it can work seamlessly with ARHumanBodyManager.

Google.XR.Extensions.AndroidXRImageTrackingSubsystem

The Android XR implementation of the XRImageTrackingSubsystem so it can work seamlessly with ARTrackedImageManager.

Google.XR.Extensions.AndroidXRMouseInteractionProfile

This OpenXRInteractionFeature enables the use of Android XR Mouse interaction profile in OpenXR.

Google.XR.Extensions.AndroidXRObjectTrackingSubsystem

The Android XR implementation of the XRObjectTrackingSubsystem so it can work seamlessly with ARTrackedObjectManager.

Google.XR.Extensions.AndroidXRPermissionExtensions

Helper class for AndroidXRPermission.

Google.XR.Extensions.AndroidXRPermissionUtil

Utility component to help manage runtime permission requests.

Google.XR.Extensions.AndroidXRRuntimeImageLibrary

Constructs a RuntimeReferenceImageLibrary which stores reference images for QR Code trackng at Android XR devices.

Google.XR.Extensions.AndroidXRSessionSubsystem

The Android XR implementation of the XRSessionSubsystem so it can work seamlessly with ARSession.

Google.XR.Extensions.XRAvatarSkeletonJointIDUtility

Utility class for XRAvatarSkeletonJointID.

Google.XR.Extensions.XRBodyTrackingFeature

This OpenXRInteractionFeature configures Android XR extensions XR_ANDROIDX_body_tracking at runtime and provides XRHumanBodySubsystem implementation that works on Android XR platform.

Google.XR.Extensions.XREnvironmentBlendModeFeature

This OpenXRInteractionFeature configures XrEnvironmentBlendMode

at OpenXR runtime.

Google.XR.Extensions.XRFaceTrackingFeature

This OpenXRInteractionFeature configures new extension

Google.XR.Extensions.XRFaceTrackingManager

This class provides the current eye information.

Google.XR.Extensions.XRFoveationFeature

This OpenXRInteractionFeature configures the XR_FB_foveation

extension at OpenXR runtime.

Google.XR.Extensions.XRHandMeshFeature

This feature provides access to the XR_ANDROID_hand_mesh extension.

Google.XR.Extensions.XRHumanBodyProportions

Defines the human body proportions to be used for computing the rest pose skeleton.

Google.XR.Extensions.XRMarkerDatabase

A marker database is a collection of XRMarkerDatabaseEntry which stores marker information used to configure marker tracking at runtime when XRMarkerTrackingFeature is enabled.

Google.XR.Extensions.XRMarkerTrackingFeature

This OpenXRInteractionFeature configures Android XR extensions XR_ANDROID_trackables and XR_ANDROID_trackables_marker at runtime and provides XRImageTrackingSubsystem implementation that works on Android XR platform.

Google.XR.Extensions.XRMeshSubsystemExtension

Extensions to AR Foundation's XRMeshSubsystem class.

Google.XR.Extensions.XRObjectTrackingFeature

This OpenXRInteractionFeature configures Android XR extensions XR_ANDROID_trackables and XR_ANDROID_trackables_object at runtime and provides XRObjectTrackingSubsystem implementation that works on Android XR platform.

Google.XR.Extensions.XRPassthroughFeature

This OpenXRInteractionFeature configures the XR_ANDROID_composition_layer_passthrough_mesh and XR_ANDROID_passthrough_camera_state extensions at OpenXR runtime and provides passthrough geometry capabilities in the OpenXR platform.

Google.XR.Extensions.XRPassthroughLayerData

Example of defining a layer data script for a passthrough layer.

Google.XR.Extensions.XRQrCodeTrackingFeature

This OpenXRInteractionFeature configures Android XR extensions XR_ANDROID_trackables and XR_ANDROID_trackables_qr_code at runtime and provides XRImageTrackingSubsystem implementation that works on Android XR platform.

Google.XR.Extensions.XRSceneMeshingFeature

This feature provides access to the XR_ANDROIDX_scene_meshing extension.

Google.XR.Extensions.XRSessionFeature

This OpenXRInteractionFeature provides Android XR session management for all extended Android XR features, and common session configurations.

Google.XR.Extensions.XRSystemStateFeature

This XRSystemStateFeature provides a function to query the system state information at runtime.

Google.XR.Extensions.XRUnboundedRefSpaceFeature

This XRUnboundedRefSpaceFeature makes the UNBOUNDED reference space available in this app and can be used by setting the XRInputSubsystem tracking origin mode.

Structs
Google.XR.Extensions.XRFaceState

This struct contains the blendshape parameter weights, current status of the face tracker and face joint poses.

Google.XR.Extensions.XRMarkerDatabaseEntry

Represents an entry in an XRMarkerDatabase with the specialized information that can be converted into a marker XRReferenceImage, then used at ARTrackedImageManager.referenceLibrary for runtime configuration.

Google.XR.Extensions.XrSystemState

Contains system state information.

Enumerations

AndroidXRPermission

 AndroidXRPermission

Permissions required by Android XR tracking services.

Properties
BodyTracking

Permission to enable body tracking.

EyeTrackingCoarse

Permission to enable coarse eye tracking.

EyeTrackingFine

Permission to enable eye gaze interaction and fine eye tracking.

FaceTracking

Permission to enable face tracking.

HandTracking

Permission to enable hand tracking.

SceneUnderstandingCoarse

Permission to enable coarse scene understanding features that relies on motion tracking, ToF sensor, and the VST RGB-left cameras.

SceneUnderstandingFine

Permission to enable fine scene understanding features that relies on motion tracking, such as depth texture and scene meshing.

XRAvatarSkeletonJointID

 XRAvatarSkeletonJointID

Represents the type of an skeleton joint.

If you wish to convert it to an index, Use XRAvatarSkeletonJointIDUtility.ToIndex(XRAvatarSkeletonJointID) on the joint ID.

Properties
BeginMarker

Marks the beginning of joints, or start of an array of data related to them.

Casting this to an integer type will not result in a correct start. Use XRAvatarSkeletonJointIDUtility.ToIndex(XRAvatarSkeletonJointID) instead.

Chest

Joint for the chest.

EndMarker

Marks the end of joints, or size of an array of data related to them.

Casting this to an integer type will not result in a correct count. Use XRAvatarSkeletonJointIDUtility.ToIndex(XRAvatarSkeletonJointID) instead.

Head

Joint for the head.

Hips

Joint for hips.

Invalid

Invalid ID.

LeftFoot

Joint for the left foot.

LeftHand

Joint for the left hand.

LeftLowerArm

Joint for the left lower arm.

LeftLowerLeg

Joint for the left lower leg.

LeftShoulder

Joint for the left shoulder.

LeftToes

Joint for left toes.

LeftUpperArm

Joint for the left upper arm.

LeftUpperLeg

Joint for the left upper leg.

Neck

Joint for the neck.

Ribs

Joint for ribs.

RightFoot

Joint for the right foot.

RightHand

Joint for the right hand.

RightLowerArm

Joint for the right lower arm.

RightLowerLeg

Joint for the right lower leg.

RightShoulder

Joint for the right shoulder.

RightToes

Joint for right toes.

RightUpperArm

Joint for the right upper arm.

RightUpperLeg

Joint for the right upper leg.

Spine

Joint for the spine.

XRFaceConfidenceRegion

 XRFaceConfidenceRegion

This is an enumeration of the face confidence regions.

Properties
LeftUpper

The confidence of the accuracy of the left upper face region.

Lower

The confidence of the accuracy of the lower face region.

RightUpper

TThe confidence of the accuracy of the right upper face region.

XRFaceParameterIndices

 XRFaceParameterIndices

This is an enumeration of the blendshape values in the Google default vector format.

Properties
BrowLowererL

Left eyebrow lowerer control parameter.

BrowLowererR

Right eyebrow lowerer control parameter.

CheekPuffL

Left cheek puff control parameter.

CheekPuffR

Right cheek puff control parameter.

CheekRaiserL

Left cheek raiser control parameter.

CheekRaiserR

Right cheek raiser control parameter.

CheekSuckL

Left cheek suck control parameter.

CheekSuckR

Right cheek puff control parameter.

ChinRaiserB

Bottom chin raiser control parameter.

ChinRaiserT

Top chin raiser control parameter.

DimplerL

Left dimpler control parameter.

DimplerR

Right dimpler control parameter.

EyesClosedL

Left eye closed control parameter.

EyesClosedR

Right eye closed control parameter.

EyesLookDownL

Left eye look down control parameter.

EyesLookDownR

Right eye look down control parameter.

EyesLookLeftL

Left eye look left control parameter.

EyesLookLeftR

Right eye look left control parameter.

EyesLookRightL

Left eye look right control parameter.

EyesLookRightR

Right eye look right control parameter.

EyesLookUpL

Left eye look up control parameter.

EyesLookUpR

Right eye look up control parameter.

InnerBrowRaiserL

Inner left eyebrow raiser control parameter.

InnerBrowRaiserR

Inner right eyebrow raiser control parameter.

JawDrop

Jaw drop control parameter.

JawSidewaysLeft

Jaw moved left control parameter.

JawSidewaysRight

Jaw moved right control parameter.

JawThrust

Jaw thrust forward control parameter.

LidTightenerL

Left lid tightener control parameter.

LidTightenerR

Right lid tightener control parameter.

LipCornerDepressorL

Lip left corner depressor control parameter.

LipCornerDepressorR

Lip right corner depressor control parameter.

LipCornerPullerL

Lip left corner puller control parameter.

LipCornerPullerR

Lip right corner puller control parameter.

LipFunnelerLB

Left bottom lip funnler control parameter.

LipFunnelerLT

Left top lip funnler control parameter.

LipFunnelerRB

Right bottom lip funnler control parameter.

LipFunnelerRT

Right top lip funnler control parameter.

LipPressorL

Left lip presser control parameter.

LipPressorR

Left lip presser control parameter.

LipPuckerL

Left lip pucker control parameter.

LipPuckerR

Right lip pucker control parameter.

LipStretcherL

Left lip stretch control parameter.

LipStretcherR

Right lip stretch control parameter.

LipSuckLB

Bottom left lip suck control parameter.

LipSuckLT

Left top suck control parameter.

LipSuckRB

Bottom right lip suck control parameter.

LipSuckRT

Right top suck control parameter.

LipTightenerL

Left lip tightener control parameter.

LipTightenerR

Right lip tightener control parameter.

LipsToward

Lips moved together control parameter.

LowerLipDepressorL

Lower left lip depresser control parameter.

LowerLipDepressorR

Lower right lip depresser control parameter.

MouthLeft

Mouth left motion control parameter.

MouthRight

Mouth right motion control parameter.

NoseWrinklerL

Left nose wrinkle control parameter.

NoseWrinklerR

Right nose wrinkle control parameter.

OuterBrowRaiserL

Outer left eyebrow raiser control parameter.

OuterBrowRaiserR

Outer right eyebrow raiser control parameter.

TongueDown

Upper left lip depresser control parameter.

TongueLeft

Upper left lip depresser control parameter.

TongueOut

Upper left lip depresser control parameter.

TongueRight

Upper left lip depresser control parameter.

TongueUp

Upper left lip depresser control parameter.

UpperLidRaiserL

Left upper lid raiser control parameter.

UpperLidRaiserR

Right upper lid raiser control parameter.

UpperLipRaiserL

Upper left lip depresser control parameter.

UpperLipRaiserR

Upper left lip depresser control parameter.

XRFaceTrackingStates

 XRFaceTrackingStates

This is an enumeration of the possible face tracking states.

Properties
Paused

Indicates that face tracking is paused but may be resumed in the future.

Stopped

Tracking is stopped and is currently not tracking.

Tracking

The face is currently tracked and its pose is current.

XRFoveationLevel

 XRFoveationLevel

Enum corresponding to XrFoveationLevelFB.

Properties
High

Corresponds to XR_FOVEATION_LEVEL_HIGH_FB - High foveation (lower periphery visual fidelity, higher performance).

Low

Corresponds to XR_FOVEATION_LEVEL_LOW_FB - Less foveation (higher periphery visual fidelity, lower performance).

Medium

Corresponds to XR_FOVEATION_LEVEL_MEDIUM_FB - Medium foveation (medium periphery visual fidelity, medium performance).

None

Corresponds to XR_FOVEATION_LEVEL_NONE_FB - No foveation.

XRMarkerDictionary

 XRMarkerDictionary

Describes the type of Supported marker dictionaries.

Properties
AprilTag_16H5

The predefined dictionary of AprilTag family 16H5.

AprilTag_25H9

The predefined dictionary of AprilTag family 25H9.

AprilTag_36H10

The predefined dictionary of AprilTag family 36H10.

AprilTag_36H11

The predefined dictionary of AprilTag family 36H11.

ArUco4x4_100

The predefined dictionary in the ArUco module, composed of 100 markers with size of 4x4 bits.

ArUco4x4_1000

The predefined dictionary in the ArUco module, composed of 1000 markers with size of 4x4 bits.

ArUco4x4_250

The predefined dictionary in the ArUco module, composed of 250 markers with size of 4x4 bits.

ArUco4x4_50

The predefined dictionary in the ArUco module, composed of 50 markers with size of 4x4 bits.

ArUco5x5_100

The predefined dictionary in the ArUco module, composed of 100 markers with size of 5x5 bits.

ArUco5x5_1000

The predefined dictionary in the ArUco module, composed of 1000 markers with size of 5x5 bits.

ArUco5x5_250

The predefined dictionary in the ArUco module, composed of 250 markers with size of 5x5 bits.

ArUco5x5_50

The predefined dictionary in the ArUco module, composed of 50 markers with size of 5x5 bits.

ArUco6x6_100

The predefined dictionary in the ArUco module, composed of 100 markers with size of 6x6 bits.

ArUco6x6_1000

The predefined dictionary in the ArUco module, composed of 1000 markers with size of 6x6 bits.

ArUco6x6_250

The predefined dictionary in the ArUco module, composed of 250 markers with size of 6x6 bits.

ArUco6x6_50

The predefined dictionary in the ArUco module, composed of 50 markers with size of 6x6 bits.

ArUco7X7_100

The predefined dictionary in the ArUco module, composed of 100 markers with size of 7x7 bits.

ArUco7X7_1000

The predefined dictionary in the ArUco module, composed of 1000 markers with size of 7x7 bits.

ArUco7X7_250

The predefined dictionary in the ArUco module, composed of 250 markers with size of 7x7 bits.

ArUco7X7_50

The predefined dictionary in the ArUco module, composed of 50 markers with size of 7x7 bits.

XRMeshSemantics

 XRMeshSemantics

An enum representing the vertex semantics of a scene mesh.

Properties
CEILING

Represents a vertex on the ceiling.

FLOOR

Represents a vertex on the floor.

OTHER

Represents a vertex with unknown semantic.

TABLE

Represents a vertex on the table.

WALL

Represents a vertex on the wall.

XRObjectLabel

 XRObjectLabel

Describes the type of object that the system has identified.

Properties
Keyboard

The object is a keyboard.

Laptop

The object is a laptop.

Mouse

The object is a mouse.

Unknown

It was not possible to label the object.

XRPassthroughCameraStates

 XRPassthroughCameraStates

Defines possible passthrough camera states.

Properties
Disabled

The camera has been disabled by an app, the system or the user.

Error

The camera is in an unrecoverable error state.

Initializing

The camera is still coming online and not yet ready to use.

Ready

The camera is ready to use.

XrInputModality

 XrInputModality

The input modality state of the system.

Properties
Controller

Controller input modality.

DwellWithEye

Dwell with eye input modality.

DwellWithHead

Dwell with head input modality.

Eye

Eye input modality.

Hand

Hand input modality.

HmdFallback

HMD fallback input modality.

Mouse

Mouse input modality.

Unknown

Unknown input modality.

Typedefs

PoseControl

UnityEngine.XR.OpenXR.Input.PoseControl PoseControl