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.