Struct XREnvironmentProbe
Encapsulates all of the data provided for an individual environment probe in an AR session.
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
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.
|
textureDescriptor
Contains the texture descriptor captured from the device.
Declaration
public XRTextureDescriptor textureDescriptor { get; }
Property Value
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
Declaration
public TrackingState trackingState { get; }
Property Value
Implements
Methods
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
Type |
Name |
Description |
Object |
obj |
|
Returns
Overrides
Equals(XREnvironmentProbe)
Declaration
public bool Equals(XREnvironmentProbe other)
Parameters
Returns
GetDefault()
Declaration
public static XREnvironmentProbe GetDefault()
Returns
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Overrides
ToString()
Declaration
public override string ToString()
Returns
Overrides
ToString(String)
Declaration
public string ToString(string floatingPointformat)
Parameters
Type |
Name |
Description |
String |
floatingPointformat |
|
Returns
Operators
Equality(XREnvironmentProbe, XREnvironmentProbe)
Declaration
public static bool operator ==(XREnvironmentProbe lhs, XREnvironmentProbe rhs)
Parameters
Returns
Inequality(XREnvironmentProbe, XREnvironmentProbe)
Declaration
public static bool operator !=(XREnvironmentProbe lhs, XREnvironmentProbe rhs)
Parameters
Returns
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.