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

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

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

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

trackingState

The TrackingState associated with this environment probe.

Declaration
public TrackingState trackingState { get; }
Property Value
Type Description
TrackingState
Implements

Methods

Equals(System.Object)

Declaration
public override bool Equals(System.Object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
Boolean

Equals(XREnvironmentProbe)

Declaration
public bool Equals(XREnvironmentProbe other)
Parameters
Type Name Description
XREnvironmentProbe other
Returns
Type Description
Boolean

GetDefault()

Creates an XREnvironmentProbe populated with default values.

Declaration
public static XREnvironmentProbe GetDefault()
Returns
Type Description
XREnvironmentProbe

A default environment probe.

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32

ToString()

Declaration
public override string ToString()
Returns
Type Description
String

ToString(String)

Declaration
public string ToString(string floatingPointformat)
Parameters
Type Name Description
String floatingPointformat
Returns
Type Description
String

Operators

Equality(XREnvironmentProbe, XREnvironmentProbe)

Declaration
public static bool operator ==(XREnvironmentProbe lhs, XREnvironmentProbe rhs)
Parameters
Type Name Description
XREnvironmentProbe lhs
XREnvironmentProbe rhs
Returns
Type Description
Boolean

Inequality(XREnvironmentProbe, XREnvironmentProbe)

Declaration
public static bool operator !=(XREnvironmentProbe lhs, XREnvironmentProbe rhs)
Parameters
Type Name Description
XREnvironmentProbe lhs
XREnvironmentProbe rhs
Returns
Type Description
Boolean