Reading this with an AI agent?

Read this page as plain text instead: https://www.nianticspatial.com/docs/llms-api-unity/NianticSpatial.NSDK.AR.SceneSegmentation.ARSceneSegmentationManager.TryAcquireSuppressionMaskCpuImage.txt — same content, easier to parse than this HTML, with each platform's steps kept separate.

Every page in the current release follows the same pattern, so you can build the URL directly instead of fetching an index: a page at /api/unity/<page>/ is at /llms-api-unity/<page>.txt.

For every page in this section, read https://www.nianticspatial.com/docs/llms-api-unity.txt; for every section of these docs, read https://www.nianticspatial.com/docs/llms.txt.

←API Reference ←NianticSpatial.NSDK.AR.SceneSegmentation ←ARSceneSegmentationManager

TryAcquireSuppressionMaskCpuImage

Declaration

public bool TryAcquireSuppressionMaskCpuImage(out XRCpuImage cpuImage, out Matrix4x4 samplerMatrix, Nullable<XRCameraParams> cameraParams = null)

Summary

Tries to acquire the latest suppression mask XRCpuImage. Each element of the XRCpuImage is a uint32 value
which can be used to interpolate between instantaneous depth and far field depth.

Returns

True if the CPU image was acquired. Otherwise, false

Parameters

Name	Type	Summary
cpuImage	XRCpuImage	If this method returns `true`, an acquired XRCpuImage. The CPU image must be disposed by the caller.
samplerMatrix	Matrix4x4	A matrix that converts from viewport to image coordinates according to the latest pose.
cameraParams	Nullable<XRCameraParams>	Params of the viewport to sample with. Defaults to current screen dimensions if null.

Method TryAcquireSuppressionMaskCpuImage TryAcquireSuppressionMaskCpuImage

Declaration​

Summary​

Returns​

Parameters​

TryAcquireSuppressionMaskCpuImage

Declaration

Summary

Returns

Parameters