Struct XRCameraFrameExifData

Represents EXIF data from the frame captured by the device camera.

Implements

IEquatable<XRCameraFrameExifData>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.ARSubsystems

Assembly: Unity.XR.ARSubsystems.dll

Syntax

public struct XRCameraFrameExifData : IEquatable<XRCameraFrameExifData>

Constructors

XRCameraFrameExifData(IntPtr, double, double, double, double, float, float, float, short, XRCameraFrameExifDataColorSpace, short, XRCameraFrameExifDataMeteringMode, XRCameraFrameExifDataProperties)

Creates a XRCameraFrameExifData.

Declaration

public XRCameraFrameExifData(IntPtr nativePtr, double apertureValue, double brightnessValue, double exposureTime, double shutterSpeedValue, float exposureBiasValue, float fNumber, float focalLength, short flash, XRCameraFrameExifDataColorSpace colorSpace, short photographicSensitivity, XRCameraFrameExifDataMeteringMode meteringMode, XRCameraFrameExifDataProperties properties)

Parameters

Type	Name	Description
IntPtr	nativePtr	The native pointer.
double	apertureValue	The lens aperture of the frame.
double	brightnessValue	The brightness of the frame.
double	exposureTime	The exposure Time of the frame.
double	shutterSpeedValue	The shutter speed of the frame.
float	exposureBiasValue	The exposure bias of the frame.
float	fNumber	The F number of the frame.
float	focalLength	The lens focal length of the frame.
short	flash	The flash status of the frame.
XRCameraFrameExifDataColorSpace	colorSpace	The color space of the frame.
short	photographicSensitivity	The photographicSensitivity of the frame.
XRCameraFrameExifDataMeteringMode	meteringMode	The metering mode of the frame.
XRCameraFrameExifDataProperties	properties	The set of flags that indicates which properties are included in the EXIF data of the frame.

Properties

hasAnyProperties

Indicates whether any property was assigned a value.

Declaration

public bool hasAnyProperties { get; }

Property Value

Type	Description
bool	true if any property was assigned a value. Otherwise, false.

nativePtr

Points to a provider-specific data structure in unmanaged memory that you can use to access additional EXIF properties. Refer to your provider's documentation to learn how to use this pointer.

Declaration

public IntPtr nativePtr { get; }

Property Value

Type	Description
IntPtr

Methods

Equals(object)

Compares for equality.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	An `object` to compare against.

Returns

Type	Description
bool	true if `obj` is an XRCameraFrameExifData and Equals(XRCameraFrameExifData) is also true. Otherwise, false.

Overrides

ValueType.Equals(object)

Equals(XRCameraFrameExifData)

Compares for equality.

Declaration

public bool Equals(XRCameraFrameExifData other)

Parameters

Type	Name	Description
XRCameraFrameExifData	other	The other XRCameraFrameExifData to compare against.

Returns

Type	Description
bool	true if the XRCameraFrameExifData represents the same object. Otherwise, false.

GetHashCode()

Generates a hash code suitable for use in HashSet and Dictionary.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash of this XRCameraFrameExifData.

Overrides

ValueType.GetHashCode()

ToString()

Generates a string representation of this XRCameraFrameExifData suitable for debugging purposes.

Declaration

public override string ToString()

Returns

Type	Description
string	A string representation of this XRCameraFrameExifData.

Overrides

ValueType.ToString()

TryGetApertureValue(out double)

Get the lens aperture of the frame if possible.

Declaration

public bool TryGetApertureValue(out double apertureValue)

Parameters

Type	Name	Description
double	apertureValue	The lens aperture of the camera frame.

Returns

Type	Description
bool	true if the EXIF data contains the lens aperture of the frame. Otherwise, false. Equal to hasApertureValue.

TryGetBrightnessValue(out double)

Get the brightness of the frame if possible.

Declaration

public bool TryGetBrightnessValue(out double brightnessValue)

Parameters

Type	Name	Description
double	brightnessValue	The brightness of the camera frame.

Returns

Type	Description
bool	true if the EXIF data contains the brightness of the frame. Otherwise, false. Equal to hasBrightnessValue.

TryGetColorSpace(out XRCameraFrameExifDataColorSpace)

Get the color space of the frame if possible.

Declaration

public bool TryGetColorSpace(out XRCameraFrameExifDataColorSpace colorSpace)

Parameters

Type	Name	Description
XRCameraFrameExifDataColorSpace	colorSpace	The color space of the camera frame.

Returns

Type	Description
bool	true if the EXIF data contains the color space of the frame. Otherwise, false. Equal to hasColorSpace.

TryGetExposureBiasValue(out float)

Get the exposure bias of the frame if possible.

Declaration

public bool TryGetExposureBiasValue(out float exposureBiasValue)

Parameters

Type	Name	Description
float	exposureBiasValue	The exposure bias of the camera frame.

Returns

Type	Description
bool	true if the EXIF data contains the exposure bias of the frame. Otherwise, false. Equal to hasExposureBiasValue.

TryGetExposureTime(out double)

Get the exposure time of the frame if possible.

Declaration

public bool TryGetExposureTime(out double exposureTime)

Parameters

Type	Name	Description
double	exposureTime	The exposure time of the camera frame.

Returns

Type	Description
bool	true if the EXIF data contains the exposure time of the frame. Otherwise, false. Equal to hasExposureTime.

TryGetFNumber(out float)

Get the F number of the frame if possible.

Declaration

public bool TryGetFNumber(out float fNumber)

Parameters

Type	Name	Description
float	fNumber	The F number of the camera frame.

Returns

Type	Description
bool	true if the EXIF data contains the F number of the frame. Otherwise, false. Equal to hasFNumber.

TryGetFlash(out short)

Get the flash status of the frame if possible.

Declaration

public bool TryGetFlash(out short flash)

Parameters

Type	Name	Description
short	flash	The flash status of the camera frame.

Returns

Type	Description
bool	true if the EXIF data contains the flash status of the frame. Otherwise, false. Equal to hasFlash.

TryGetFocalLength(out float)

Get the lens focal length of the frame if possible.

Declaration

public bool TryGetFocalLength(out float focalLength)

Parameters

Type	Name	Description
float	focalLength	The lens focal length of the camera frame.

Returns

Type	Description
bool	true if the EXIF data contains the lens focal length of the frame. Otherwise, false. Equal to hasFocalLength.

TryGetMeteringMode(out XRCameraFrameExifDataMeteringMode)

Get the metering mode of the frame if possible.

Declaration

public bool TryGetMeteringMode(out XRCameraFrameExifDataMeteringMode meteringMode)

Parameters

Type	Name	Description
XRCameraFrameExifDataMeteringMode	meteringMode	The metering mode of the camera frame.

Returns

Type	Description
bool	true if the EXIF data contains the metering mode of the frame. Otherwise, false. Equal to hasMeteringMode.

TryGetPhotographicSensitivity(out short)

Get the photographic sensitivity of the frame if possible.

Declaration

public bool TryGetPhotographicSensitivity(out short photographicSensitivity)

Parameters

Type	Name	Description
short	photographicSensitivity	The photographic sensitivity of the camera frame.

Returns

Type	Description
bool	true if the EXIF data contains the photographic sensitivity of the frame. Otherwise, false. Equal to hasPhotographicSensitivity.

TryGetShutterSpeedValue(out double)

Get the shutter speed of the frame if possible.

Declaration

public bool TryGetShutterSpeedValue(out double shutterSpeedValue)

Parameters

Type	Name	Description
double	shutterSpeedValue	The shutter speed of the camera frame.

Returns

Type	Description
bool	true if the EXIF data contains the shutter speed of the frame. Otherwise, false. Equal to hasShutterSpeedValue.

Operators

operator ==(XRCameraFrameExifData, XRCameraFrameExifData)

Compares lhs and rhs for equality using Equals(XRCameraFrameExifData).

Declaration

public static bool operator ==(XRCameraFrameExifData lhs, XRCameraFrameExifData rhs)

Parameters

Type	Name	Description
XRCameraFrameExifData	lhs	The left-hand-side XRCameraFrameExifData of the comparison.
XRCameraFrameExifData	rhs	The right-hand-side XRCameraFrameExifData of the comparison.

Returns

Type	Description
bool	true if `lhs` compares equal to `rhs`. Otherwise, false.

operator !=(XRCameraFrameExifData, XRCameraFrameExifData)

Compares lhs and rhs for inequality using Equals(XRCameraFrameExifData).

Declaration

public static bool operator !=(XRCameraFrameExifData lhs, XRCameraFrameExifData rhs)

Parameters

Type	Name	Description
XRCameraFrameExifData	lhs	The left-hand-side XRCameraFrameExifData of the comparison.
XRCameraFrameExifData	rhs	The right-hand-side XRCameraFrameExifData of the comparison.

Returns

Type	Description
bool	false if `lhs` compares equal to `rhs`. Otherwise, true.

Implements

IEquatable<T>