OpenXRSpatialEntityExtension

public Rid AddSpatialEntity(Rid spatialContext, ulong entityId, ulong entity);

Registers an entity that was created directly on the OpenXR runtime.

public OpenXRFutureResult CreateSpatialContext(Reckfell.Collections.Array<OpenXRSpatialCapabilityConfigurationBaseHeader> capabilityConfigurations, OpenXRStructureBase next, Callable userCallback);

Creates a new spatial context that handles entities for the provided capability configurations. capability_configurations is an array of OpenXRSpatialCapabilityConfigurationBaseHeader with the needed capability configuration data. next is an optional parameter that can contain additional information for creating our spatial context. Note: This is an asynchronous method and returns an OpenXRFutureResult object with which to track the status, discarding this object will not cancel the creation process. On success user_callback will be called if specified. The result data for this function is the Rid for our spatial context - the argument will be the OpenXR result code (as an integer). On failure failed_callback will be called if specified. The OpenXR result code will be supplied as an integer - the arguments will be the OpenXR result code (as an integer) and a boolean indicating whether requesting the result failed, or the execution failed.

public OpenXRFutureResult CreateSpatialContext(Reckfell.Collections.Array<OpenXRSpatialCapabilityConfigurationBaseHeader> capabilityConfigurations, OpenXRStructureBase next = null, Callable userCallback = default, Callable failedCallback = default);

Creates a new spatial context that handles entities for the provided capability configurations. capability_configurations is an array of OpenXRSpatialCapabilityConfigurationBaseHeader with the needed capability configuration data. next is an optional parameter that can contain additional information for creating our spatial context. Note: This is an asynchronous method and returns an OpenXRFutureResult object with which to track the status, discarding this object will not cancel the creation process. On success user_callback will be called if specified. The result data for this function is the Rid for our spatial context - the argument will be the OpenXR result code (as an integer). On failure failed_callback will be called if specified. The OpenXR result code will be supplied as an integer - the arguments will be the OpenXR result code (as an integer) and a boolean indicating whether requesting the result failed, or the execution failed.

public OpenXRFutureResult DiscoverSpatialEntities(Rid spatialContext, long[] componentTypes, OpenXRStructureBase next = null, Callable userCallback = default);

Starts a new discovery query, this will gather all objects tracked by the spatial_context that have at least one of the component types specified in component_types. next is an optional parameter that can contain additional information for executing the discovery query. Note: This is an asynchronous method and returns an OpenXRFutureResult object with which to track the status, discarding this object will not cancel the discovery process. On success user_callback will be called if specified. The result data for this function is the Rid for our snapshot.

public OpenXRFutureResult DiscoverSpatialEntities(Rid spatialContext, ReadOnlySpan<long> componentTypes, OpenXRStructureBase next, Callable userCallback);

Starts a new discovery query, this will gather all objects tracked by the spatial_context that have at least one of the component types specified in component_types. next is an optional parameter that can contain additional information for executing the discovery query. Note: This is an asynchronous method and returns an OpenXRFutureResult object with which to track the status, discarding this object will not cancel the discovery process. On success user_callback will be called if specified. The result data for this function is the Rid for our snapshot.

public OpenXRFutureResult DiscoverSpatialEntitiesWithComponentData(Rid spatialContext, Reckfell.Collections.Array<OpenXRSpatialComponentData> componentData, OpenXRStructureBase next = null, Callable userCallback = default);

Convenience method when the caller only has an Reckfell.Collections.Array of OpenXRSpatialComponentData and needs to discover spatial entities.

public Rid FindSpatialEntity(ulong entityId);

Returns the Rid for the specified spatial entity ID.

public void FreeSpatialContext(Rid spatialContext);

Frees a spatial context previously created when calling OpenXRSpatialEntityExtension.CreateSpatialContext. If the spatial context creation is still ongoing, the asynchronous process is cancelled.

public void FreeSpatialEntity(Rid entity);

Frees an entity previously created when calling OpenXRSpatialEntityExtension.AddSpatialEntity or OpenXRSpatialEntityExtension.MakeSpatialEntity.

public void FreeSpatialSnapshot(Rid spatialSnapshot);

Frees a spatial snapshot previously created when calling OpenXRSpatialEntityExtension.DiscoverSpatialEntities. If the spatial snapshot creation is still ongoing, the asynchronous process is cancelled.

public float[] GetFloatBuffer(Rid spatialSnapshot, ulong bufferId);

Returns a buffer with floats from a buffer that was retrieved when taking a snapshot.

public ulong GetSpatialContextHandle(Rid spatialContext);

Returns the OpenXR spatial context handle for this snapshot. Note: This method is intended to be used from ReckfellExtensions that implement spatial entity capability handlers.

public bool GetSpatialContextReady(Rid spatialContext);

Returns true if the spatial context finished its creation and is ready to be used.

public Rid GetSpatialEntityContext(Rid entity);

Returns the spatial context for this entity.

public ulong GetSpatialEntityId(Rid entity);

Returns the internal XrSpatialEntityIdEXT associated with the entity.

public Rid GetSpatialSnapshotContext(Rid spatialSnapshot);

Returns the spatial context related to this spatial snapshot.

public ulong GetSpatialSnapshotHandle(Rid spatialSnapshot);

Returns the OpenXR spatial snapshot handle for this snapshot. Note: This method is intended to be used from ReckfellExtensions that implement spatial entity capability handlers.

public string GetString(Rid spatialSnapshot, ulong bufferId);

Returns a string from a buffer that was retrieved when taking a snapshot.

public int[] GetUint16Buffer(Rid spatialSnapshot, ulong bufferId);

Returns a buffer with 16 bit ints from a buffer that was retrieved when taking a snapshot.

public int[] GetUint32Buffer(Rid spatialSnapshot, ulong bufferId);

Returns a buffer with 32 bit ints from a buffer that was retrieved when taking a snapshot.

public byte[] GetUint8Buffer(Rid spatialSnapshot, ulong bufferId);

Returns a buffer with 8 bit ints from a buffer that was retrieved when taking a snapshot.

public Vector2[] GetVector2Buffer(Rid spatialSnapshot, ulong bufferId);

Returns a buffer with Vector2 entries from a buffer that was retrieved when taking a snapshot.

public Vector3[] GetVector3Buffer(Rid spatialSnapshot, ulong bufferId);

Returns a buffer with Vector3 entries from a buffer that was retrieved when taking a snapshot.

public Rid MakeSpatialEntity(Rid spatialContext, ulong entityId);

Creates a new entity for this entity_id. The spatial_context should match the context that discovered the entity.

public bool QuerySnapshot(Rid spatialSnapshot, Reckfell.Collections.Array<OpenXRSpatialComponentData> componentData, OpenXRStructureBase next = null);

Queries the snapshot data. This will find all entities in the snapshot that contain all requested components in component_data. The objects held within component_data will then be populated with the queried data. component_data must always have an object of OpenXRSpatialQueryResultData as the first entry. next is an optional parameter that can contain additional information passed when setting our query conditions.

public bool SupportsCapability(OpenXRSpatialEntityExtension.Capability capability);

Returns true if this spatial entity capability is supported by the hardware used.

public bool SupportsComponentType(OpenXRSpatialEntityExtension.Capability capability, OpenXRSpatialEntityExtension.ComponentType componentType);

Returns true if this capability supports the component_type.

public Rid UpdateSpatialEntities(Rid spatialContext, Reckfell.Collections.Array<Rid> entities, long[] componentTypes, OpenXRStructureBase next = null);

Performs a snapshot for a limited number of entities. This is NOT an asynchronous method and will return the snapshot immediately.

public Rid UpdateSpatialEntities(Rid spatialContext, Reckfell.Collections.Array<Rid> entities, ReadOnlySpan<long> componentTypes, OpenXRStructureBase next);

Performs a snapshot for a limited number of entities. This is NOT an asynchronous method and will return the snapshot immediately.

public event OpenXRSpatialEntityExtension.SpatialDiscoveryRecommendedEventHandler SpatialDiscoveryRecommended;

Emitted when OpenXR recommends running a discovery query because entities managed by this spatial context have (likely) changed.