Class ARCoreCameraSubsystem

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

Inheritance

object

SubsystemWithProvider

SubsystemWithProvider<XRCameraSubsystem, XRCameraSubsystemDescriptor, XRCameraSubsystem.Provider>

XRCameraSubsystem

ARCoreCameraSubsystem

Implements

ISubsystem

Inherited Members

XRCameraSubsystem.currentCamera

XRCameraSubsystem.requestedCamera

XRCameraSubsystem.currentCameraBackgroundRenderingMode

XRCameraSubsystem.requestedCameraBackgroundRenderingMode

XRCameraSubsystem.supportedCameraBackgroundRenderingMode

XRCameraSubsystem.autoFocusEnabled

XRCameraSubsystem.autoFocusRequested

XRCameraSubsystem.imageStabilizationEnabled

XRCameraSubsystem.imageStabilizationRequested

XRCameraSubsystem.currentLightEstimation

XRCameraSubsystem.requestedLightEstimation

XRCameraSubsystem.cameraMaterial

XRCameraSubsystem.TryGetRenderingParameters(out XRCameraBackgroundRenderingParams)

XRCameraSubsystem.permissionGranted

XRCameraSubsystem.invertCulling

XRCameraSubsystem.currentConfiguration

XRCameraSubsystem.GetTextureDescriptors(Allocator)

XRCameraSubsystem.OnBeforeBackgroundRender(int)

XRCameraSubsystem.TryGetIntrinsics(out XRCameraIntrinsics)

XRCameraSubsystem.GetConfigurations(Allocator)

XRCameraSubsystem.TryGetLatestFrame(XRCameraParams, out XRCameraFrame)

XRCameraSubsystem.GetMaterialKeywords(out List<string>, out List<string>)

XRCameraSubsystem.GetShaderKeywords()

XRCameraSubsystem.TryAcquireLatestCpuImage(out XRCpuImage)

XRCameraSubsystem.Register(XRCameraSubsystemCinfo)

SubsystemWithProvider<XRCameraSubsystem, XRCameraSubsystemDescriptor, XRCameraSubsystem.Provider>.subsystemDescriptor

SubsystemWithProvider.Start()

SubsystemWithProvider.Stop()

SubsystemWithProvider.Destroy()

SubsystemWithProvider.running

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.XR.ARCore

Assembly: Unity.XR.ARCore.dll

Syntax

[Preserve]
public sealed class ARCoreCameraSubsystem : XRCameraSubsystem, ISubsystem

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:

Before Opaque Shader Name
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.

Implements

ISubsystem