Class XRCameraSubsystem

Provides access to a device's camera.

Inheritance

object

SubsystemWithProvider

SubsystemWithProvider<XRCameraSubsystem, XRCameraSubsystemDescriptor, XRCameraSubsystem.Provider>

XRCameraSubsystem

Implements

ISubsystem

Inherited Members

SubsystemWithProvider<XRCameraSubsystem, XRCameraSubsystemDescriptor, XRCameraSubsystem.Provider>.OnCreate()

SubsystemWithProvider<XRCameraSubsystem, XRCameraSubsystemDescriptor, XRCameraSubsystem.Provider>.OnStart()

SubsystemWithProvider<XRCameraSubsystem, XRCameraSubsystemDescriptor, XRCameraSubsystem.Provider>.OnStop()

SubsystemWithProvider<XRCameraSubsystem, XRCameraSubsystemDescriptor, XRCameraSubsystem.Provider>.OnDestroy()

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

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

SubsystemWithProvider.Start()

SubsystemWithProvider.OnStart()

SubsystemWithProvider.Stop()

SubsystemWithProvider.OnStop()

SubsystemWithProvider.Destroy()

SubsystemWithProvider.OnDestroy()

SubsystemWithProvider.running

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: UnityEngine.XR.ARSubsystems

Assembly: solution.dll

Syntax

public class XRCameraSubsystem : SubsystemWithProvider<XRCameraSubsystem, XRCameraSubsystemDescriptor, XRCameraSubsystem.Provider>, ISubsystem

Remarks

The XRCameraSubsystem links a Unity Camera to a device camera for video overlay (pass-thru rendering). It also allows developers to query for environmental light estimation, when available.

Constructors

Name	Description
XRCameraSubsystem()	Construct the XRCameraSubsystem.

Properties

Name	Description
autoFocusEnabled	Get the current focus mode in use by the provider.
autoFocusRequested	Get or set the focus mode for the camera.
cameraMaterial	Get the material used by XRCameraSubsystem to render the camera texture.
currentCamera	Gets the camera currently in use.
currentConfiguration	The current camera configuration.
currentLightEstimation	Returns the current light estimation mode in use by the provider.
invertCulling	Set this to true to invert the culling mode during rendering. Some front-facing camera modes might require this.
permissionGranted	Determines whether camera permission has been granted.
requestedCamera	Get or set the requested camera (that is, the AnyCamera bits).
requestedLightEstimation	Get or set the requested light estimation mode.

Methods

Name	Description
GetConfigurations(Allocator)	Queries for the supported camera configurations.
GetMaterialKeywords(out List<string>, out List<string>)	Get the enabled and disabled shader keywords for the material.
GetTextureDescriptors(Allocator)	Gets the XRTextureDescriptors associated with the current frame. The caller owns the returned NativeArray and is responsible for calling Dispose on it.
OnBeforeBackgroundRender(int)	Method to be called on the render thread to handle any required platform-specific functionality immediately before rendering the camera background. This method will always be called on the render thread and should only be called by the code responsible for executing background rendering on mobile AR platforms.
Register(XRCameraSubsystemCinfo)	Registers a camera subsystem implementation based on the given subsystem parameters.
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.
TryGetIntrinsics(out XRCameraIntrinsics)	Returns the camera intrinsics information.
TryGetLatestFrame(XRCameraParams, out XRCameraFrame)	Get the latest frame from the provider.
TryGetLatestImage(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. This method is obsolete. Use TryAcquireLatestCpuImage(out XRCpuImage) instead.