Method RemoveEnvironmentProbe

RemoveEnvironmentProbe(TrackableId)

Asynchronously removes the environment probe matching the trackable ID from the AR session.

Declaration

public bool RemoveEnvironmentProbe(TrackableId trackableId)

Parameters

Type	Name	Description
TrackableId	trackableId	Trackable ID of the environment probe to be removed from the AR session.

Returns

Type	Description
bool	true if the environment probe is found in the current AR session and will be removed. Otherwise, false.

Remarks

RemoveEnvironmentProbe can be used to remove both manually placed and automatically placed environment probes if the implementation supports such removals, as indicated by the descriptor properties supportsRemovalOfManual and supportsRemovalOfAutomatic.

Exceptions

Type	Condition
NotSupportedException	Thrown for platforms that do not support removal of the type of environment probe.