Skip to main content
←API Reference ←NianticSpatial.NSDK.AR.XRSubsystems ←XRSceneSegmentationSubsystem

TryAcquireSuppressionMaskCpuImage

Acquire the latest suppression mask XRCpuImage.

Declaration​

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

Summary​

Acquire the latest suppression mask XRCpuImage.

Returns​

Returns true if an XRCpuImage was successfully acquired. Returns false otherwise.

Parameters​

NameTypeSummary
cpuImageXRCpuImage
The resulting XRCpuImage. The XRCpuImage must be disposed by the caller.
samplerMatrixMatrix4x4
The matrix that transforms from normalized viewport coordinates to normalized image coordinates.
cameraParamsNullable<XRCameraParams>
Describes the viewport the image is to be displayed on.

Overload​

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

Summary​

Acquire the latest suppression mask XRCpuImage.

Returns​

Returns true if an XRCpuImage was successfully acquired. Returns false otherwise.

Parameters​

NameTypeSummary
cpuImageXRCpuImage
The resulting XRCpuImage. The XRCpuImage must be disposed by the caller.
samplerMatrixMatrix4x4
The matrix that transforms from normalized viewport coordinates to normalized image coordinates.
cameraParamsNullable<XRCameraParams>
Describes the viewport the image is to be displayed on.