Method TryAddEnvironmentProbe
TryAddEnvironmentProbe(Pose, Vector3, Vector3, out XREnvironmentProbe)
Tries to create an environment probe.
Declaration
public bool TryAddEnvironmentProbe(Pose pose, Vector3 scale, Vector3 size, out XREnvironmentProbe environmentProbe)
Parameters
Type |
Name |
Description |
Pose |
pose |
The position and rotation at which to create the environment probe.
|
Vector3 |
scale |
The scale at which to create the environment probe.
|
Vector3 |
size |
The size (dimensions) of the environment probe to create.
|
XREnvironmentProbe |
environmentProbe |
If successful, populated with the newly created environment probe. Otherwise, it will contain default values.
|
Returns
Type |
Description |
bool |
true if the environment probe was successfully added, otherwise false .
|
Exceptions
Type |
Condition |
InvalidOperationException |
Thrown when the environment probe subsystem is not running and
this method is called to an add environment probe.
|
NotSupportedException |
Thrown for platforms that do not support manual placement of
environment probes.
|
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.