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

XRSceneSegmentationSubsystem

↳ extends UnityEngine.SubsystemsImplementation.SubsystemWithProvider
Defines an interface for interacting with semantic segmentation functionality.

Declaration

public class XRSceneSegmentationSubsystem : SubsystemWithProvider<XRSceneSegmentationSubsystem, XRSceneSegmentationSubsystemDescriptor, Provider>, ISubsystemWithModelMetadata

Constructors

public XRSceneSegmentationSubsystem()

Summary

Construct the subsystem by creating the functionality provider.


Properties

NameTypeSummary
readonly IsMetadataAvailablebool
True if channel names are available. The current implementation has this ready immediately, but this method is
required by the ISubsytemWithModelMetadata parent class, should be reworked in the future.
readonly LatestFrameIdNullable<uint>
Returns the frame id of the most recent semantic segmentation prediction.
SuppressionMaskChannelsHashSet<SceneSegmentationChannel>
-
TargetFrameRateuint
Specifies the target frame rate for the platform to target running semantic segmentation inference at.

Methods

NameTypeSummary
GetChannelsIReadOnlyList<SceneSegmentationChannel>
Get a list of the semantic channels for the current semantic model.
static Registerbool
Register the descriptor for the semantics subsystem implementation.
TryAcquirePackedSceneSegmentationChannelsCpuImagebool
Acquire the latest packed semantic channels XRCpuImage.
TryAcquireSceneSegmentationChannelCpuImagebool
Acquire the latest semantic channel CPU image.
TryAcquireSuppressionMaskCpuImagebool
Acquire the latest suppression mask XRCpuImage.
TryGetPackedSceneSegmentationChannelsbool
Get the packed semantics texture descriptor.
TryGetSceneSegmentationChannelbool
Get the XRTextureDescriptor for the specified semantic channel.
TryGetSuppressionMaskTexturebool
Get a semantic suppression texture descriptor.
TryResetChannelConfidenceThresholdsbool
Resets the confidence thresholds for all semantic channels to the default values from the current model.
TrySetChannelConfidenceThresholdsbool
Sets the confidence thresholds used for including the specified semantic channels in the packed semantic
channel buffer.

Relationships

derived: NsdkSceneSegmentationSubsystem
implements: ISubsystemWithModelMetadata