Struct XREnvironmentProbe

Encapsulates all of the data provided for an individual environment probe in an AR session.

Namespace: UnityEngine.XR.ARSubsystems

Syntax

public struct XREnvironmentProbe : IEquatable<XREnvironmentProbe>, ITrackable

Properties

defaultValue

Creates an XREnvironmentProbe populated with default values.

Declaration

public static XREnvironmentProbe defaultValue { get; }

Property Value

Type	Description
XREnvironmentProbe

nativePtr

A native pointer associated with this environment probe. The data pointed to by this pointer is implementation-defined. Its lifetime is also implementation-defined, but will be valid at least until the next call to GetChanges(Allocator).

Declaration

public IntPtr nativePtr { get; }

Property Value

Type	Description
IntPtr

Implements

ITrackable.nativePtr

pose

Contains the pose (position and rotation) of the environment probe in the AR session.

Declaration

public Pose pose { get; }

Property Value

Type	Description
Pose	The pose (position and rotation) of the environment probe.

Implements

ITrackable.pose

scale

Contains the scale of the environment probe in the AR session.

Declaration

public Vector3 scale { get; }

Property Value

Type	Description
Vector3	The scale of the environment probe.

size

Specifies the volume size around the environment probe's position for use when projecting the environment texture for parallax correction.

Declaration

public Vector3 size { get; }

Property Value

Type	Description
Vector3	The bounding volume size of the environment probe.

Remarks

Note that size may validly be infinite.

textureDescriptor

Contains the texture descriptor captured from the device.

Declaration

public XRTextureDescriptor textureDescriptor { get; }

Property Value

Type	Description
XRTextureDescriptor	The texture descriptor of the environment probe.

Remarks

The environmentTextureData value may be invalid indicating that the device has yet to capture an environment texture for this probe. Newly created environment probes have no environment texture. The valid property should be used to determine whether the texture data is valid.

trackableId

Uniquely identifies each environment probe in an AR session.

Declaration

public TrackableId trackableId { get; }

Property Value

Type	Description
TrackableId	The unique trackable ID of the environment probe.

Implements

ITrackable.trackableId

trackingState

The TrackingState associated with this environment probe.

Declaration

public TrackingState trackingState { get; }

Property Value

Type	Description
TrackingState

Implements

ITrackable.trackingState

Methods

Equals(Object)

Tests for equality.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj	The object to compare against.

Returns

Type	Description
Boolean	True if obj is of type XREnvironmentProbe and Equals(XREnvironmentProbe) also returns true; otherwise false.

Overrides

ValueType.Equals(Object)

Equals(XREnvironmentProbe)

Tests for equality.

Declaration

public bool Equals(XREnvironmentProbe other)

Parameters

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

Returns

Type	Description
Boolean	True if every field in other is equal to this XREnvironmentProbe, otherwise false.

GetHashCode()

Generates a hash suitable for use with containers like HashSet and Dictionary.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	A hash code generated from this object's fields.

Overrides

ValueType.GetHashCode()

ToString()

Generates a string representation of this XREnvironmentProbe.

Declaration

public override string ToString()

Returns

Type	Description
String	A string representation of this XREnvironmentProbe.

Overrides

ValueType.ToString()

ToString(String)

Generates a string representation of this XREnvironmentProbe. Floating point values use floatingPointformat to generate their string representations.

Declaration

public string ToString(string floatingPointformat)

Parameters

Type	Name	Description
String	floatingPointformat	The format specifier used for floating point fields.

Returns

Type	Description
String	A string representation of this XREnvironmentProbe.

Operators

Equality(XREnvironmentProbe, XREnvironmentProbe)

Tests for equality. Same as Equals(XREnvironmentProbe).

Declaration

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

Parameters

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

Returns

Type	Description
Boolean	True if lhs is equal to rhs, otherwise false.

Inequality(XREnvironmentProbe, XREnvironmentProbe)

Tests for inequality. Same as !Equals(XREnvironmentProbe).

Declaration

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

Parameters

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

Returns

Type	Description
Boolean	True if lhs is not equal to rhs, otherwise false.