Reading this with an AI agent?

Read this page as plain text instead: https://www.nianticspatial.com/docs/llms-api-unity/NianticSpatial.NSDK.AR.XRSubsystems.XRSceneSegmentationSubsystem.Provider.TryAcquireSceneSegmentationChannelCpuImage.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.XRSubsystems ←XRSceneSegmentationSubsystem ←Provider

TryAcquireSceneSegmentationChannelCpuImage

Acquire the latest semantic channel CPU image.

Declaration

public virtual 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

Name	Type	Summary
channel	SceneSegmentationChannel	The semantics channel to acquire.
cpuImage	XRCpuImage	The resulting XRCpuImage. The XRCpuImage must be disposed by the caller.
samplerMatrix	Matrix4x4	The matrix that transforms from normalized viewport coordinates to normalized image coordinates.
cameraParams	Nullable<XRCameraParams>	Describes the viewport the image is to be displayed on.

Method TryAcquireSceneSegmentationChannelCpuImage TryAcquireSceneSegmentationChannelCpuImage

Declaration​

Summary​

Returns​

Throws​

Parameters​