Class ARCameraManager
Manages the life cycle of the XRCameraCamera
in your scene
if you want camera texture and light estimation information to be available.
Inheritance
Implements
Inherited Members
Namespace: UnityEngine .XR.ARFoundation
Assembly: Unity.XR.ARFoundation.dll
Syntax
[DefaultExecutionOrder(-2147483647)]
[DisallowMultipleComponent]
[RequireComponent(typeof(Camera))]
public sealed class ARCameraManager : SubsystemLifecycleManager<XRCameraSubsystem, XRCameraSubsystemDescriptor, XRCameraSubsystem.Provider>, ISerializationCallbackReceiver
Properties
autoFocusEnabled
Get the current focus mode in use by the subsystem.
Declaration
public bool autoFocusEnabled { get; }
Property Value
Type | Description |
---|---|
bool | true if auto focus is enabled. false if fixed focus is enabled
or if there is no loaded XRCamera |
autoFocusRequested
Get or set whether auto focus is requested.
Declaration
public bool autoFocusRequested { get; set; }
Property Value
Type | Description |
---|---|
bool |
cameraMaterial
The Material used in background rendering.
Declaration
public Material cameraMaterial { get; }
Property Value
Type | Description |
---|---|
Material | The Material used in background rendering. |
currentConfiguration
The current camera configuration.
Declaration
public XRCameraConfiguration? currentConfiguration { get; set; }
Property Value
Type | Description |
---|---|
XRCamera |
The current camera configuration, if it exists. Otherwise, null. |
Exceptions
Type | Condition |
---|---|
Not |
Thrown when setting the current configuration if the implementation does not support camera configurations. |
Argument |
Thrown when setting the current configuration if the given configuration is null. |
Argument |
Thrown when setting the current configuration if the given configuration is not a supported camera configuration. |
Invalid |
Thrown when setting the current configuration if the implementation is unable to set the current camera configuration. |
currentFacingDirection
The current camera facing direction. This should usually match requested
Declaration
public CameraFacingDirection currentFacingDirection { get; }
Property Value
Type | Description |
---|---|
Camera |
currentLightEstimation
Get the current light estimation mode used by the subsystem, or LightEstimation.None
if there is no subsystem.
Declaration
public LightEstimation currentLightEstimation { get; }
Property Value
Type | Description |
---|---|
Light |
currentRenderingMode
The current XRCamera
Declaration
public XRCameraBackgroundRenderingMode currentRenderingMode { get; }
Property Value
Type | Description |
---|---|
XRCamera |
The current camera background rendering mode. |
imageStabilizationEnabled
Get whether Image Stabilization in enabled.
Declaration
public bool imageStabilizationEnabled { get; }
Property Value
Type | Description |
---|---|
bool | true if EIS is enabled. false if EIS is not enabled
or if there is no loaded XRCamera |
imageStabilizationRequested
Get or set whether Image Stabilization is requested.
Declaration
public bool imageStabilizationRequested { get; set; }
Property Value
Type | Description |
---|---|
bool |
permissionGranted
Indicates whether camera permission has been granted.
Declaration
public bool permissionGranted { get; }
Property Value
requestedBackgroundRenderingMode
The current requested Camera
Declaration
public CameraBackgroundRenderingMode requestedBackgroundRenderingMode { get; set; }
Property Value
Type | Description |
---|---|
Camera |
requestedFacingDirection
Get or set the requested camera facing direction.
Declaration
public CameraFacingDirection requestedFacingDirection { get; set; }
Property Value
Type | Description |
---|---|
Camera |
requestedLightEstimation
Get or set the requested Light
Declaration
public LightEstimation requestedLightEstimation { get; set; }
Property Value
Type | Description |
---|---|
Light |
The light estimation mode for the camera. |
Methods
GetConfigurations(Allocator)
Get the camera configurations currently supported for the implementation.
Declaration
public NativeArray<XRCameraConfiguration> GetConfigurations(Allocator allocator)
Parameters
Type | Name | Description |
---|---|---|
Allocator | allocator | The allocation strategy to use for the returned data. |
Returns
Type | Description |
---|---|
Native |
The supported camera configurations. |
OnAfterDeserialize()
Part of the ISerializationCallbackReceiver interface. Invoked after deserialization.
Declaration
public void OnAfterDeserialize()
OnBeforeSerialize()
Part of the ISerializationCallbackReceiver interface. Invoked before serialization.
Declaration
public void OnBeforeSerialize()
OnBeforeStart()
Invoked after creating the subsystem and before calling Start on it.
The subsystem is not null
.
Declaration
protected override void OnBeforeStart()
Overrides
OnDisable()
Stops the TSubsystem
.
Declaration
protected override void OnDisable()
Overrides
TryAcquireLatestCpuImage(out XRCpuImage)
Attempts to acquire the latest camera image. This provides direct access to the raw pixel data, as well as to utilities to convert to RGB and Grayscale formats.
Declaration
public bool TryAcquireLatestCpuImage(out XRCpuImage cpuImage)
Parameters
Type | Name | Description |
---|---|---|
XRCpu |
cpuImage | A valid |
Returns
Remarks
The XRCpu
TryGetIntrinsics(out XRCameraIntrinsics)
Tries to get camera intrinsics. Camera intrinsics refers to properties of a physical camera which might be useful when performing additional computer vision processing on the camera image.
Declaration
public bool TryGetIntrinsics(out XRCameraIntrinsics cameraIntrinsics)
Parameters
Type | Name | Description |
---|---|---|
XRCamera |
cameraIntrinsics | The camera intrinsics to be populated if the camera supports intrinsics. |
Returns
Remarks
Note
The intrinsics may change each frame. You should call this each frame that you need intrinsics in order to ensure you are using the intrinsics for the current frame.
Events
frameReceived
An event which fires each time a new camera frame is received.
Declaration
public event Action<ARCameraFrameEventArgs> frameReceived
Event Type
Type | Description |
---|---|
Action<ARCamera |