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

TryAcquireSceneSegmentationChannelCpuImage

Acquire the latest semantic channel CPU image.

Declaration​

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

Summary​

Acquire the latest semantic channel CPU image.

Returns​

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

Throws​

  • NotSupportedException — Thrown if the implementation does not support semantic channels CPU images.

Parameters​

NameTypeSummary
channelSceneSegmentationChannel
The semantics channel to acquire.
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.