Class XRCameraSubsystem
Provides access to a device's camera.
Inheritance
Implements
Inherited Members
Namespace: UnityEngine .XR.ARSubsystems
Assembly: Unity.XR.ARSubsystems.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 if available.
Constructors
XRCameraSubsystem()
Construct the XRCamera
Declaration
public XRCameraSubsystem()
Properties
autoFocusEnabled
Indicates whether auto focus is enabled.
Declaration
public bool autoFocusEnabled { get; }
Property Value
See Also
autoFocusRequested
Get or set whether autofocus is requested.
Declaration
public bool autoFocusRequested { get; set; }
Property Value
cameraMaterial
Get the Material used by XRCamera
Declaration
public Material cameraMaterial { get; }
Property Value
Type | Description |
---|---|
Material | The Material to render the camera texture. |
currentCamera
Get the camera currently in use.
Declaration
public Feature currentCamera { get; }
Property Value
Type | Description |
---|---|
Feature | The current camera. |
currentCameraBackgroundRenderingMode
Get the current XRCamera
Declaration
public XRCameraBackgroundRenderingMode currentCameraBackgroundRenderingMode { get; }
Property Value
Type | Description |
---|---|
XRCamera |
The current camera background rendering mode. |
See Also
currentConfiguration
The current camera configuration.
Declaration
public virtual 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. |
currentLightEstimation
Get the current light estimation mode in use by the provider.
Declaration
public Feature currentLightEstimation { get; }
Property Value
Type | Description |
---|---|
Feature | The current light estimation mode. |
See Also
imageStabilizationEnabled
Indicate whether Image Stabilization is enabled.
Declaration
public bool imageStabilizationEnabled { get; }
Property Value
See Also
imageStabilizationRequested
Get or set whether Image Stabilization is requested.
Declaration
public bool imageStabilizationRequested { get; set; }
Property Value
invertCulling
Set this to true to invert the culling mode during rendering. Some front-facing camera modes might require this.
Declaration
public bool invertCulling { get; }
Property Value
Type | Description |
---|---|
bool |
permissionGranted
Indicates whether camera permission has been granted.
Declaration
public bool permissionGranted { get; }
Property Value
requestedCamera
Get or set the requested camera (that is, the Any
Declaration
public Feature requestedCamera { get; set; }
Property Value
Type | Description |
---|---|
Feature | The requested camera. |
requestedCameraBackgroundRenderingMode
Get or set the requested XRSupported
Declaration
public XRSupportedCameraBackgroundRenderingMode requestedCameraBackgroundRenderingMode { get; set; }
Property Value
Type | Description |
---|---|
XRSupported |
The requested camera background rendering mode. |
requestedLightEstimation
Get or set the requested light estimation mode.
Declaration
public Feature requestedLightEstimation { get; set; }
Property Value
Type | Description |
---|---|
Feature | The requested light estimation mode. |
supportedCameraBackgroundRenderingMode
Get the supported XRSupported
Declaration
public XRSupportedCameraBackgroundRenderingMode supportedCameraBackgroundRenderingMode { get; }
Property Value
Type | Description |
---|---|
XRSupported |
The supported camera background rendering modes. |
Methods
GetConfigurations(Allocator)
Get the supported camera configurations.
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. |
GetMaterialKeywords(out List<string>, out List<string>)
Get the enabled and disabled shader keywords for the material.
Declaration
[Obsolete("GetMaterialKeywords(out List<string>, out List<string>) has been deprecated in AR Foundation version 6.0. Use GetShaderKeywords() instead.")]
public void GetMaterialKeywords(out List<string> enabledKeywords, out List<string> disabledKeywords)
Parameters
Type | Name | Description |
---|---|---|
List<string> | enabledKeywords | The keywords to enable for the material. |
List<string> | disabledKeywords | The keywords to disable for the material. |
GetShaderKeywords()
Get the enabled and disabled shader keywords for the material.
Declaration
public ShaderKeywords GetShaderKeywords()
Returns
Type | Description |
---|---|
Shader |
Returns an Shader |
GetTextureDescriptors(Allocator)
Gets the XRTextureNativeArray
and is responsible for calling Dispose
on it.
Declaration
public NativeArray<XRTextureDescriptor> GetTextureDescriptors(Allocator allocator)
Parameters
Type | Name | Description |
---|---|---|
Allocator | allocator | The allocator to use when creating the returned |
Returns
Type | Description |
---|---|
Native |
An array of texture descriptors. |
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.
Declaration
public void OnBeforeBackgroundRender(int id)
Parameters
Type | Name | Description |
---|---|---|
int | id | Platform-specific identifier. |
Register(XRCameraSubsystemCinfo)
Registers a camera subsystem implementation based on the given subsystem parameters.
Declaration
[Obsolete("XRCameraSubsystem.Register(XRCameraSubsystemCinfo) has been deprecated in AR Foundation version 6.0. Use XRCameraSubsystemDescriptor.Register(XRCameraSubsystemDescriptor.Cinfo) instead.")]
public static bool Register(XRCameraSubsystemCinfo cameraSubsystemParams)
Parameters
Type | Name | Description |
---|---|---|
XRCamera |
cameraSubsystemParams | The parameters defining the camera subsystem functionality implemented by the subsystem provider. |
Returns
Exceptions
Type | Condition |
---|---|
Argument |
Thrown when the values specified in the XRCamera |
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 XRCpu |
Returns
Remarks
The returned XRCpu
Exceptions
Type | Condition |
---|---|
Not |
Thrown if the implementation does not support camera image. |
TryGetIntrinsics(out XRCameraIntrinsics)
Get the camera intrinsics information.
Declaration
public bool TryGetIntrinsics(out XRCameraIntrinsics cameraIntrinsics)
Parameters
Type | Name | Description |
---|---|---|
XRCamera |
cameraIntrinsics | The returned camera intrinsics information. |
Returns
Type | Description |
---|---|
bool | true if the method successfully gets the camera intrinsics information. Otherwise, false. |
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.
TryGetLatestFrame(XRCameraParams, out XRCameraFrame)
Get the latest frame from the provider.
Declaration
public bool TryGetLatestFrame(XRCameraParams cameraParams, out XRCameraFrame frame)
Parameters
Type | Name | Description |
---|---|---|
XRCamera |
cameraParams | The Unity |
XRCamera |
frame | The camera frame to be populated if the subsystem is running and successfully provides the latest camera frame. |
Returns
TryGetRenderingParameters(out XRCameraBackgroundRenderingParams)
Attempts to get the platform specific rendering parameters for rendering the camera background texture.
Declaration
public bool TryGetRenderingParameters(out XRCameraBackgroundRenderingParams cameraBackgroundRenderingParameters)
Parameters
Type | Name | Description |
---|---|---|
XRCamera |
cameraBackgroundRenderingParameters | The platform specific rendering parameters for rendering the camera background texture. |
Returns
Type | Description |
---|---|
bool | true if the platform provides specialized rendering parameters or false otherwise. |