Struct XREnvironmentProbe
Contains all of the data provided for an individual environment probe in an AR session.
Inherited Members
Namespace: UnityEngine .XR.ARSubsystems
Assembly: Unity.XR.ARSubsystems.dll
Syntax
public struct XREnvironmentProbe : IEquatable<XREnvironmentProbe>, ITrackable
Constructors
XREnvironmentProbe(TrackableId, Vector3, Pose, Vector3, XRTextureDescriptor, TrackingState, IntPtr)
Constructs an XREnvironment
Declaration
public XREnvironmentProbe(TrackableId trackableId, Vector3 scale, Pose pose, Vector3 size, XRTextureDescriptor descriptor, TrackingState trackingState, IntPtr nativePtr)
Parameters
Type | Name | Description |
---|---|---|
Trackable |
trackableId | The Trackable |
Vector3 | scale | The scale of the associated probe. |
Pose | pose | The |
Vector3 | size | The size (rendering bounds) of the associated probe. |
XRTexture |
descriptor | The XRTexture |
Tracking |
trackingState | The Tracking |
Int |
nativePtr | A native pointer associated with the probe's cubemap. |
Properties
defaultValue
Creates an XREnvironment
Declaration
public static XREnvironmentProbe defaultValue { get; }
Property Value
Type | Description |
---|---|
XREnvironment |
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 Get
Declaration
public IntPtr nativePtr { get; }
Property Value
Type | Description |
---|---|
Int |
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. |
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. This is used for for parallax correction when projecting the environment texture.
Declaration
public Vector3 size { get; }
Property Value
Type | Description |
---|---|
Vector3 | The bounding volume size of the environment probe. |
Remarks
Note that size
can be infinite. This is valid.
textureDescriptor
Contains the texture descriptor captured from the device.
Declaration
public XRTextureDescriptor textureDescriptor { get; }
Property Value
Type | Description |
---|---|
XRTexture |
The texture descriptor of the environment probe. |
Remarks
The environmentTextureData
value can be invalid, which indicates that the device has not captured an
environment texture for this probe yet. 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 |
---|---|
Trackable |
The unique trackable ID of the environment probe. |
trackingState
The Tracking
Declaration
public TrackingState trackingState { get; }
Property Value
Type | Description |
---|---|
Tracking |
Methods
Equals(object)
Tests for equality.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
object | obj | The |
Returns
Type | Description |
---|---|
bool |
|
Overrides
Equals(XREnvironmentProbe)
Tests for equality.
Declaration
public bool Equals(XREnvironmentProbe other)
Parameters
Type | Name | Description |
---|---|---|
XREnvironment |
other | The other XREnvironment |
Returns
Type | Description |
---|---|
bool |
|
GetHashCode()
Generates a hash suitable for use with containers like HashSet
and Dictionary
.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
int | A hash code generated from this object's fields. |
Overrides
ToString()
Generates a string representation of this XREnvironment
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string | A string representation of this XREnvironment |
Overrides
ToString(string)
Generates a string representation of this XREnvironmentfloatingPointformat
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 XREnvironment |
Operators
operator ==(XREnvironmentProbe, XREnvironmentProbe)
Tests for equality. Same as Equals(XREnvironment
Declaration
public static bool operator ==(XREnvironmentProbe lhs, XREnvironmentProbe rhs)
Parameters
Type | Name | Description |
---|---|---|
XREnvironment |
lhs | The left-hand side of the comparison. |
XREnvironment |
rhs | The right-hand side of the comparison. |
Returns
Type | Description |
---|---|
bool |
|
operator !=(XREnvironmentProbe, XREnvironmentProbe)
Tests for inequality. Same as !
Equals(XREnvironment
Declaration
public static bool operator !=(XREnvironmentProbe lhs, XREnvironmentProbe rhs)
Parameters
Type | Name | Description |
---|---|---|
XREnvironment |
lhs | The left-hand side of the comparison. |
XREnvironment |
rhs | The right-hand side of the comparison. |
Returns
Type | Description |
---|---|
bool |
|