Namespace UnityEngine.XR.ARExtensions

Classes

AsyncCameraImageConversionStatusExtensions

Extension methods for the AsyncCameraImageConversionStatus enum.

PlaneDetectionFlagsMaskAttribute

An attribute that can be placed on MonoBehaviour fields to generate the correct UI for the PlaneDetectionFlags enum.

Promise<T>

A Promise is used for operations that retrieve data asynchronously. Use this object to determine the status of the operation (i.e., whether it has completed), and the resulting data.

SessionAvailabilityExtensions

Extensions to the SessionAvailability and SessionInstallationStatus enums.

XRCameraExtensions

Provides extensions to the XRCameraSubsystem.

XRPlaneExtensions

Provides extensions to the XRPlaneSubsystem.

XRReferencePointExtensions

Provides extensions to the XRReferencePointSubsystem.

XRSessionExtensions

Provides extensions to the XRSessionSubsystem.

Structs

AsyncCameraImageConversion

Holds information related to an asynchronous camera image conversion request. Returned by ConvertAsync(CameraImageConversionParams).

CameraConfiguration

Contains information regarding the camera configuration. Different devices support different camera configurations. This includes the resolution of the image and may include framerate on some platforms.

The camera image configuration affects the resolution of the image returned by .

CameraConfigurationCollection

An enumerable for CameraConfigurations.

See also Configurations(XRCameraSubsystem).

CameraConfigurationCollection.ConfigEnumerator

A custom enumerator for CameraConfigurations.

CameraImage

Represents a single, raw image from a device camera. Provides access to the raw image plane data, as well as conversion methods to convert to color and grayscale formats. See Convert(CameraImageConversionParams, IntPtr, Int32) and ConvertAsync(CameraImageConversionParams). Use to get a CameraImage.

CameraImages must be explicitly disposed. Failing to do so will leak resources and could prevent future camera image access.

CameraImageConversionParams

Describes a set of conversion parameters for use with CameraImage's conversion methods.

CameraImagePlane

Information about the camera image planes. An image "plane" refers to an image channel used in video encoding.

CameraIntrinsics

Camera intrinsics describe physical characteristics of a camera.

Interfaces

ICameraConfigApi

This interface is typically implemented by platform-specific implementations of the XRCameraSubsystem to support CameraConfigurations. End users do not need to implement this. Use . to get a CameraConfigurationCollection.

ICameraImageApi

This interface is typically implemented by platform-specific implementations of the XRCameraSubsystem to support CameraImage. End users do not need to implement this. Use to get a CameraImage.

Enums

AsyncCameraImageConversionStatus

Used to represent the status of an asynchronous camera image request.

CameraFocusMode

Represents the focus mode of the camera.

CameraImageFormat

Formats used by the raw CameraImage data. See format.

CameraImageTransformation

Describes transformations that may be applied to a camera image. See

PlaneDetectionFlags

Used to configure the types of planes to detect.

SessionAvailability

Flags used to determine session availability.

SessionInstallationStatus

An enum used to determine that current status of the software install.

Delegates

XRCameraExtensions.OnImageRequestCompleteDelegate

A delegate which implementors of AsyncCameraImageConversion must invoke when asynchronous camera image requests are made using the callback variant. See . Consumers of the XRCameraSubsystem API should use .

XRCameraExtensions.TryGetColorCorrectionDelegate

For internal use. Defines a delegate that a platform-specific camera provider can implement to provide color correction data.

XRCameraExtensions.TryGetIntrinsicsDelegate

Delegate to retrieve camera instrinics for a physical camera.

XRReferencePointExtensions.AttachReferencePointDelegate

A delegate which defines the AttachReferencePoint method which may be implemented by platform-specific packages.

XRSessionExtensions.AsyncDelegate<T>

A delegate used for asynchronous operations that retrieve data of type T.