Package org.lwjgl.openxr

Class METASpatialEntitySharing

java.lang.Object

org.lwjgl.openxr.METASpatialEntitySharing

public class METASpatialEntitySharing
extends Object

The XR_META_spatial_entity_sharing extension.

The XR_META_spatial_entity_sharing extension enables applications to share spatial entities.

This base extension provides a generic space sharing endpoint. This extension depends on other extensions (such as XR_META_spatial_entity_group_sharing) to define concrete "recipient info" structures, which are passed into the generic endpoint introduced in this extension.

The scope/lifetime of the sharing action is dependent on the recipient type of the sharing. Therefore, the scope/lifetime of the sharing action is defined in the extensions which provide concrete "recipient info" structures.

XR_META_spatial_entity_sharing is a more generic and extendable alternative to XR_FB_spatial_entity_sharing (which is tightly coupled with XrSpaceUserFB).

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_MAX_SPACES_PER_SHARE_REQUEST_META	XR_MAX_SPACES_PER_SHARE_REQUEST_META
static final String	XR_META_SPATIAL_ENTITY_SHARING_EXTENSION_NAME	The extension name.
static final int	XR_META_spatial_entity_sharing_SPEC_VERSION	The extension specification version.
static final int	XR_TYPE_EVENT_DATA_SHARE_SPACES_COMPLETE_META	Extends XrStructureType.
static final int	XR_TYPE_SHARE_SPACES_INFO_META	Extends XrStructureType.
static final int	XR_TYPE_SYSTEM_SPATIAL_ENTITY_SHARING_PROPERTIES_META	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrShareSpacesMETA(XrSession session, long info, long requestId)	Unsafe version of: ShareSpacesMETA
static int	xrShareSpacesMETA(XrSession session, XrShareSpacesInfoMETA info, LongBuffer requestId)	Share a spatial entity.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

XR_META_spatial_entity_sharing_SPEC_VERSION

public static final int XR_META_spatial_entity_sharing_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_META_SPATIAL_ENTITY_SHARING_EXTENSION_NAME

public static final String XR_META_SPATIAL_ENTITY_SHARING_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_MAX_SPACES_PER_SHARE_REQUEST_META

public static final int XR_MAX_SPACES_PER_SHARE_REQUEST_META

XR_MAX_SPACES_PER_SHARE_REQUEST_META

See Also:

• Constant Field Values

XR_TYPE_SYSTEM_SPATIAL_ENTITY_SHARING_PROPERTIES_META

public static final int XR_TYPE_SYSTEM_SPATIAL_ENTITY_SHARING_PROPERTIES_META

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_SPATIAL_ENTITY_SHARING_PROPERTIES_META
• TYPE_SHARE_SPACES_INFO_META
• TYPE_EVENT_DATA_SHARE_SPACES_COMPLETE_META

See Also:

• Constant Field Values

XR_TYPE_SHARE_SPACES_INFO_META

public static final int XR_TYPE_SHARE_SPACES_INFO_META

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_SPATIAL_ENTITY_SHARING_PROPERTIES_META
• TYPE_SHARE_SPACES_INFO_META
• TYPE_EVENT_DATA_SHARE_SPACES_COMPLETE_META

See Also:

• Constant Field Values

XR_TYPE_EVENT_DATA_SHARE_SPACES_COMPLETE_META

public static final int XR_TYPE_EVENT_DATA_SHARE_SPACES_COMPLETE_META

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_SPATIAL_ENTITY_SHARING_PROPERTIES_META
• TYPE_SHARE_SPACES_INFO_META
• TYPE_EVENT_DATA_SHARE_SPACES_COMPLETE_META

See Also:

• Constant Field Values

Method Details

nxrShareSpacesMETA

public static int nxrShareSpacesMETA(XrSession session,
 long info,
 long requestId)

Unsafe version of: ShareSpacesMETA

xrShareSpacesMETA

public static int xrShareSpacesMETA(XrSession session,
 XrShareSpacesInfoMETA info,
 LongBuffer requestId)

Share a spatial entity.

C Specification

The ShareSpacesMETA function is defined as:

 XrResult xrShareSpacesMETA(
     XrSession                                   session,
     const XrShareSpacesInfoMETA*                info,
     XrAsyncRequestIdFB*                         requestId);

Description

The application may use the ShareSpacesMETA function to share spaces (XrSpace) if the SPACE_COMPONENT_TYPE_SHARABLE_FB component has been enabled on the space.

This is an asynchronous operation. Completion results are conveyed in the event XrEventDataShareSpacesCompleteMETA.

If the asynchronous operation is scheduled successfully, the runtime must return SUCCESS.

If and only if the runtime returns SUCCESS, the runtime must queue a single XrEventDataShareSpacesCompleteMETA event identified with a requestId field matching the value output by this function, referred to as the "corresponding completion event."

(If the runtime returns anything other than SUCCESS, the runtime must not queue any XrEventDataShareSpacesCompleteMETA events with requestId field matching the requestId populated by this function.)

If the asynchronous operation is successful, the runtime must set the XrEventDataShareSpacesCompleteMETA::result field to SUCCESS in the corresponding completion event.

If the asynchronous operation is scheduled but not successful, in the corresponding completion event, the runtime must set the XrEventDataShareSpacesCompleteMETA::result field to an appropriate error code instead of SUCCESS.

Valid Usage (Implicit)

• The XR_META_spatial_entity_sharing extension must be enabled prior to calling ShareSpacesMETA
• session must be a valid XrSession handle
• info must be a pointer to a valid XrShareSpacesInfoMETA structure
• requestId must be a pointer to an XrAsyncRequestIdFB value

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_FEATURE_UNSUPPORTED

See Also

XrShareSpacesInfoMETA

Parameters:

session - an XrSession in which the spatial entity will be active.

info - a pointer to XrShareSpacesInfoMETA structure to specify the spatial entity sharing details.

requestId - a pointer to an XrAsyncRequestIdFB variable in which the generated async request ID will be stored. It is used to identify the corresponding XrEventDataShareSpacesCompleteMETA completion event.