Struct XRCameraFrame
Parameters of the Unity Camera that may be necessary/useful to the provider.
Namespace: UnityEngine.XR.ARSubsystems
Syntax
public struct XRCameraFrame : IEquatable<XRCameraFrame>Properties
averageBrightness
The estimated brightness of the scene.
Declaration
public readonly float averageBrightness { get; }Property Value
| Type | Description |
|---|---|
| Single | The estimated brightness of the scene. |
averageColorTemperature
The estimated color temperature of the scene.
Declaration
public readonly float averageColorTemperature { get; }Property Value
| Type | Description |
|---|---|
| Single | The estimated color temperature of the scene. |
colorCorrection
The estimated color correction value of the scene.
Declaration
public readonly Color colorCorrection { get; }Property Value
| Type | Description |
|---|---|
| Color | The estimated color correction value of the scene. |
displayMatrix
The 4x4 display matrix for the camera frame.
Declaration
public readonly Matrix4x4 displayMatrix { get; }Property Value
| Type | Description |
|---|---|
| Matrix4x4 | The 4x4 display matrix for the camera frame. |
hasAverageBrightness
Whether the frame has an average brightness.
Declaration
public readonly bool hasAverageBrightness { get; }Property Value
| Type | Description |
|---|---|
| Boolean | Whether the frame has an average brightness. |
hasAverageColorTemperature
Whether the frame has an average color temperature.
Declaration
public readonly bool hasAverageColorTemperature { get; }Property Value
| Type | Description |
|---|---|
| Boolean | Whether the frame has an average color temperature. |
hasColorCorrection
Whether the frame has a color correction value.
Declaration
public readonly bool hasColorCorrection { get; }Property Value
| Type | Description |
|---|---|
| Boolean | Whether the frame has a color correction value. |
hasDisplayMatrix
Whether the frame has a display matrix.
Declaration
public readonly bool hasDisplayMatrix { get; }Property Value
| Type | Description |
|---|---|
| Boolean | Whether the frame has a display matrix. |
hasProjectionMatrix
Whether the frame has a projection matrix.
Declaration
public readonly bool hasProjectionMatrix { get; }Property Value
| Type | Description |
|---|---|
| Boolean | Whether the frame has a projection matrix. |
hasTimestamp
Whether the frame has a timestamp.
Declaration
public readonly bool hasTimestamp { get; }Property Value
| Type | Description |
|---|---|
| Boolean | Whether the frame has a timestamp. |
nativePtr
A native pointer associated with this frame. The data pointed to by this pointer is specific to provider implementation.
Declaration
public readonly IntPtr nativePtr { get; }Property Value
| Type | Description |
|---|---|
| IntPtr | The native pointer associated with this frame. |
projectionMatrix
The 4x4 projection matrix for the camera frame.
Declaration
public readonly Matrix4x4 projectionMatrix { get; }Property Value
| Type | Description |
|---|---|
| Matrix4x4 | The 4x4 projection matrix for the camera frame. |
properties
The set of all flags indicating which properties are included in the frame.
Declaration
public readonly XRCameraFrameProperties properties { get; }Property Value
| Type | Description |
|---|---|
| XRCameraFrameProperties | The set of all flags indicating which properties are included in the frame. |
timestampNs
The timestamp, in nanoseconds, associated with this frame.
Declaration
public readonly long timestampNs { get; }Property Value
| Type | Description |
|---|---|
| Int64 | The timestamp, in nanoseconds, associated with this frame. |
trackingState
The TrackingState associated with the camera.
Declaration
public readonly TrackingState trackingState { get; }Property Value
| Type | Description |
|---|---|
| TrackingState | The tracking state associated with the camera. |
Methods
Equals(System.Object)
Declaration
public override bool Equals(System.Object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj |
Returns
| Type | Description |
|---|---|
| Boolean |
Equals(XRCameraFrame)
Declaration
public bool Equals(XRCameraFrame other)Parameters
| Type | Name | Description |
|---|---|---|
| XRCameraFrame | other |
Returns
| Type | Description |
|---|---|
| Boolean |
GetHashCode()
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| Int32 |
ToString()
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String |
TryGetAverageBrightness(out Single)
Provides brightness for the whole image as an average of all pixels' brightness.
Declaration
public bool TryGetAverageBrightness(out float averageBrightness)Parameters
| Type | Name | Description |
|---|---|---|
| Single | averageBrightness | An estimated average brightness for the environment. |
Returns
| Type | Description |
|---|---|
| Boolean |
|
TryGetAverageColorTemperature(out Single)
Provides color temperature for the whole image as an average of all pixels' color temperature.
Declaration
public bool TryGetAverageColorTemperature(out float averageColorTemperature)Parameters
| Type | Name | Description |
|---|---|---|
| Single | averageColorTemperature | An estimated color temperature. |
Returns
| Type | Description |
|---|---|
| Boolean |
|
TryGetDisplayMatrix(out Matrix4x4)
Provides display matrix defining how texture is being rendered on the screen.
Declaration
public bool TryGetDisplayMatrix(out Matrix4x4 displayMatrix)Parameters
| Type | Name | Description |
|---|---|---|
| Matrix4x4 | displayMatrix | The display matrix for rendering. |
Returns
| Type | Description |
|---|---|
| Boolean |
|
TryGetProjectionMatrix(out Matrix4x4)
Provides projection matrix for the camera frame.
Declaration
public bool TryGetProjectionMatrix(out Matrix4x4 projectionMatrix)Parameters
| Type | Name | Description |
|---|---|---|
| Matrix4x4 | projectionMatrix | The projection matrix used by the |
Returns
| Type | Description |
|---|---|
| Boolean |
|
TryGetTimestamp(out Int64)
Provides timestamp of the camera frame.
Declaration
public bool TryGetTimestamp(out long timestampNs)Parameters
| Type | Name | Description |
|---|---|---|
| Int64 | timestampNs | The timestamp of the camera frame. |
Returns
| Type | Description |
|---|---|
| Boolean |
|
Operators
Equality(XRCameraFrame, XRCameraFrame)
Declaration
public static bool operator ==(XRCameraFrame lhs, XRCameraFrame rhs)Parameters
| Type | Name | Description |
|---|---|---|
| XRCameraFrame | lhs | |
| XRCameraFrame | rhs |
Returns
| Type | Description |
|---|---|
| Boolean |
Inequality(XRCameraFrame, XRCameraFrame)
Declaration
public static bool operator !=(XRCameraFrame lhs, XRCameraFrame rhs)Parameters
| Type | Name | Description |
|---|---|---|
| XRCameraFrame | lhs | |
| XRCameraFrame | rhs |
Returns
| Type | Description |
|---|---|
| Boolean |