Method TryAcquireSmoothedEnvironmentDepthCpuImage

TryAcquireSmoothedEnvironmentDepthCpuImage(out XRCpuImage)

Tries to acquire the latest smoothed environment depth CPU image.

Declaration

public bool TryAcquireSmoothedEnvironmentDepthCpuImage(out XRCpuImage cpuImage)

Parameters

Type	Name	Description
XRCpuImage	cpuImage	If this method returns true, an acquired XRCpuImage. The CPU image must be disposed by the caller.

Returns

Type	Description
bool	Returns true if the smoothed environment depth CPU image was acquired. Returns false otherwise.

Remarks

This method differs from TryAcquireEnvironmentDepthCpuImage(out XRCpuImage) in that it always tries to acquire the temporally smoothed depth image, whereas the image provided by TryAcquireEnvironmentDepthCpuImage(out XRCpuImage) depends on the value of environmentDepthTemporalSmoothingEnabled.

The type of smoothing applied is implementation dependent; refer to the documentation for the specific provider in use.