OpenXRSpatialCapabilityConfigurationAprilTag
AprilTag configuration with a selected dictionary.
Configuration for CreateSpatialContext, not a detected Entity, tracker or OS permission. Requires the capability in a running OpenXR session. Constructor success and a selected dictionary do not mean the device detects that type. HasValidConfiguration checks current usability; context creation is separately asynchronous.
GetConfiguration returns a borrowed native pointer: neither substitute it for a RID nor retain it beyond resource lifetime. GetEnabledComponents reads selected components and can be empty before configuration building. Reading retrieves no room/marker data.
Source observation: repeated supported GetConfiguration appends Marker/Bounded2D without clearing and can duplicate entries. Use a fresh configuration for a new context instead of repeatedly probing the native getter. Not reproduced with a supported session.
Spatial-entity setup. Twelve Windows XR-off checks covered inactive configurations/dictionary metadata. Real headers/context/discovery, session changes and headsets remain untested. Engine unchanged.
Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.
Constructors1
OpenXRSpatialCapabilityConfigurationAprilTagConstructor
public OpenXRSpatialCapabilityConfigurationAprilTag();Creates a caller-owned RefCounted configuration, not a capability singleton/context. Starts no OpenXR, detector or requests. The component list is empty before supported GetConfiguration; keep the resource alive during native use. Dispose owned instances after use/releasing references, not engine-owned configurations.
Properties1
AprilDictProperty
public OpenXRSpatialCapabilityConfigurationAprilTag.AprilTagDict AprilDict { get; set; }Selected AprilTag dictionary as AprilTagDict. Constructor reads project setting marker_tracking/april_tag_dict; current default 3 selects 36H11. Setter stores the choice for a new context; it adds no runtime support, decodes no code and starts no detector. Match the physical-marker dictionary.
Methods3
GetAprilDictOpenXRSpatialCapabilityConfigurationAprilTag.AprilTagDict
public OpenXRSpatialCapabilityConfigurationAprilTag.AprilTagDict GetAprilDict();Selected AprilTag dictionary as AprilTagDict. Constructor reads project setting marker_tracking/april_tag_dict; current default 3 selects 36H11. Setter stores the choice for a new context; it adds no runtime support, decodes no code and starts no detector. Match the physical-marker dictionary.
OpenXRSpatialCapabilityConfigurationAprilTag.AprilTagDictSelected AprilTag dictionary as AprilTagDict. Constructor reads project setting marker_tracking/april_tag_dict; current default 3 selects 36H11. Setter stores the choice for a new context; it adds no runtime support, decodes no code and starts no detector. Match the physical-marker dictionary.
GetEnabledComponentslong[]
public long[] GetEnabledComponents();Copy of stored component types as long[], not marker payload. Supported GetConfiguration appends Marker and Bounded2D; empty beforehand. Current marker implementations append without clearing on repeated calls, potentially duplicating entries. Active behavior was not reproduced; create a fresh configuration for a new context instead of repeatedly probing GetConfiguration.
long[]Copy of stored component types as long[], not marker payload. Supported GetConfiguration appends Marker and Bounded2D; empty beforehand. Current marker implementations append without clearing on repeated calls, potentially duplicating entries. Active behavior was not reproduced; create a fresh configuration for a new context instead of repeatedly probing GetConfiguration.
SetAprilDictvoid
public void SetAprilDict(OpenXRSpatialCapabilityConfigurationAprilTag.AprilTagDict aprilDict);Selected AprilTag dictionary as AprilTagDict. Constructor reads project setting marker_tracking/april_tag_dict; current default 3 selects 36H11. Setter stores the choice for a new context; it adds no runtime support, decodes no code and starts no detector. Match the physical-marker dictionary.
| Name | Type | Default |
|---|---|---|
aprilDict | OpenXRSpatialCapabilityConfigurationAprilTag.AprilTagDict | — |
aprilDictSelected AprilTag dictionary as AprilTagDict. Constructor reads project setting marker_tracking/april_tag_dict; current default 3 selects 36H11. Setter stores the choice for a new context; it adds no runtime support, decodes no code and starts no detector. Match the physical-marker dictionary.
OpenXRSpatialCapabilityConfigurationAprilTag.AprilTagDict
| Value | Description |
|---|---|
Dict16H5 = 1 | 4 by 4 bits, minimum Hamming distance between any two codes = 5, 30 codes. |
Dict25H9 = 2 | 5 by 5 bits, minimum Hamming distance between any two codes = 9, 35 codes. |
Dict36H10 = 3 | 6 by 6 bits, minimum Hamming distance between any two codes = 10, 2320 codes. |
Dict36H11 = 4 | 6 by 6 bits, minimum Hamming distance between any two codes = 11, 587 codes. |