Class ARCoreCameraSubsystem

The ARCore implementation of the XRCameraSubsystem. Do not create this directly. Use the SubsystemManager instead.

Inheritance
Object
XRCameraSubsystem
ARCoreCameraSubsystem
Inherited Members
Namespace: UnityEngine.XR.ARCore
Syntax
[Preserve]
public sealed class ARCoreCameraSubsystem : XRCameraSubsystem

Fields

backgroundShaderNames

The names for the background shaders based on the current render pipeline.

Declaration
public static readonly string[] backgroundShaderNames
Field Value
Type Description
String[]

The names for the background shaders based on the current render pipeline. Or, null if the current render pipeline is incompatible with the set of shaders.
Remarks

The value for the GraphicsSettings.currentRenderPipeline is not expected to change within the lifetime of the application.

There are two shaders in the Google ARCore Provider Package. One is used for rendering before opaques and one is used for rendering after opaques.

In order:

  1. Before Opaque Shader Name
  2. After Opaque Shader Name

Properties

backgroundShaderName

The name for the background shader based on the current render pipeline.

Declaration
[Obsolete("'backgroundShaderName' is obsolete, use 'backgroundShaderNames' instead. (2022/04/04)")]
public static string backgroundShaderName { get; }
Property Value
Type Description
String

The name for the background shader based on the current render pipeline. Or, null if the current render pipeline is incompatible with the set of shaders.
Remarks

The value for the GraphicsSettings.currentRenderPipeline is not expected to change within the lifetime of the application.

Events

beforeGetCameraConfiguration

Invoked from native code just before this subsystem calls ArSession_getSupportedCameraConfigsWithFilter.

Declaration
public event Action<ARCoreBeforeGetCameraConfigurationEventArgs> beforeGetCameraConfiguration
Event Type
Type Description
Action<ARCoreBeforeGetCameraConfigurationEventArgs>

An Action delegate that you can use to modify the camera config filter.
Remarks

This allows you to customize the ArCameraConfigFilter passed to ArSession_getSupportedCameraConfigsWithFilter.

Do not destroy the filter object in this callback. Doing so is undefined behavior and may crash.

The filter provided by filter is only guaranteed to exist for the duration of this callback. Accessing it from outside this callback is undefined behavior.