Package org.lwjgl.openxr

Class FBSpatialEntitySharing

java.lang.Object

org.lwjgl.openxr.FBSpatialEntitySharing

public class FBSpatialEntitySharing
extends Object

The XR_FB_spatial_entity_sharing extension.

This extension enables spatial entities to be shared between users. If the SPACE_COMPONENT_TYPE_SHARABLE_FB component has been enabled on the spatial entity, application developers may share XrSpace entities between users.

In order to enable the functionality of this extension, you must pass the name of the extension into CreateInstance via the XrInstanceCreateInfo::enabledExtensionNames parameter as indicated in the extension section.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_ERROR_SPACE_CLOUD_STORAGE_DISABLED_FB	Extends XrResult.
static final int	XR_ERROR_SPACE_LOCALIZATION_FAILED_FB	Extends XrResult.
static final int	XR_ERROR_SPACE_MAPPING_INSUFFICIENT_FB	Extends XrResult.
static final int	XR_ERROR_SPACE_NETWORK_REQUEST_FAILED_FB	Extends XrResult.
static final int	XR_ERROR_SPACE_NETWORK_TIMEOUT_FB	Extends XrResult.
static final String	XR_FB_SPATIAL_ENTITY_SHARING_EXTENSION_NAME	The extension name.
static final int	XR_FB_spatial_entity_sharing_SPEC_VERSION	The extension specification version.
static final int	XR_TYPE_EVENT_DATA_SPACE_SHARE_COMPLETE_FB	Extends XrStructureType.
static final int	XR_TYPE_SPACE_SHARE_INFO_FB	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrShareSpacesFB(XrSession session, long info, long requestId)	Unsafe version of: ShareSpacesFB
static int	xrShareSpacesFB(XrSession session, XrSpaceShareInfoFB info, LongBuffer requestId)	Shares spatial entities with specified users.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_spatial_entity_sharing_SPEC_VERSION

public static final int XR_FB_spatial_entity_sharing_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_SPATIAL_ENTITY_SHARING_EXTENSION_NAME

public static final String XR_FB_SPATIAL_ENTITY_SHARING_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_SPACE_SHARE_INFO_FB

public static final int XR_TYPE_SPACE_SHARE_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_SPACE_SHARE_INFO_FB
• TYPE_EVENT_DATA_SPACE_SHARE_COMPLETE_FB

See Also:

• Constant Field Values

XR_TYPE_EVENT_DATA_SPACE_SHARE_COMPLETE_FB

public static final int XR_TYPE_EVENT_DATA_SPACE_SHARE_COMPLETE_FB

Extends XrStructureType.

Enum values:

• TYPE_SPACE_SHARE_INFO_FB
• TYPE_EVENT_DATA_SPACE_SHARE_COMPLETE_FB

See Also:

• Constant Field Values

XR_ERROR_SPACE_MAPPING_INSUFFICIENT_FB

public static final int XR_ERROR_SPACE_MAPPING_INSUFFICIENT_FB

Extends XrResult.

Enum values:

• ERROR_SPACE_MAPPING_INSUFFICIENT_FB
• ERROR_SPACE_LOCALIZATION_FAILED_FB
• ERROR_SPACE_NETWORK_TIMEOUT_FB
• ERROR_SPACE_NETWORK_REQUEST_FAILED_FB
• ERROR_SPACE_CLOUD_STORAGE_DISABLED_FB

See Also:

• Constant Field Values

XR_ERROR_SPACE_LOCALIZATION_FAILED_FB

public static final int XR_ERROR_SPACE_LOCALIZATION_FAILED_FB

Extends XrResult.

Enum values:

• ERROR_SPACE_MAPPING_INSUFFICIENT_FB
• ERROR_SPACE_LOCALIZATION_FAILED_FB
• ERROR_SPACE_NETWORK_TIMEOUT_FB
• ERROR_SPACE_NETWORK_REQUEST_FAILED_FB
• ERROR_SPACE_CLOUD_STORAGE_DISABLED_FB

See Also:

• Constant Field Values

XR_ERROR_SPACE_NETWORK_TIMEOUT_FB

public static final int XR_ERROR_SPACE_NETWORK_TIMEOUT_FB

Extends XrResult.

Enum values:

• ERROR_SPACE_MAPPING_INSUFFICIENT_FB
• ERROR_SPACE_LOCALIZATION_FAILED_FB
• ERROR_SPACE_NETWORK_TIMEOUT_FB
• ERROR_SPACE_NETWORK_REQUEST_FAILED_FB
• ERROR_SPACE_CLOUD_STORAGE_DISABLED_FB

See Also:

• Constant Field Values

XR_ERROR_SPACE_NETWORK_REQUEST_FAILED_FB

public static final int XR_ERROR_SPACE_NETWORK_REQUEST_FAILED_FB

Extends XrResult.

Enum values:

• ERROR_SPACE_MAPPING_INSUFFICIENT_FB
• ERROR_SPACE_LOCALIZATION_FAILED_FB
• ERROR_SPACE_NETWORK_TIMEOUT_FB
• ERROR_SPACE_NETWORK_REQUEST_FAILED_FB
• ERROR_SPACE_CLOUD_STORAGE_DISABLED_FB

See Also:

• Constant Field Values

XR_ERROR_SPACE_CLOUD_STORAGE_DISABLED_FB

public static final int XR_ERROR_SPACE_CLOUD_STORAGE_DISABLED_FB

Extends XrResult.

Enum values:

• ERROR_SPACE_MAPPING_INSUFFICIENT_FB
• ERROR_SPACE_LOCALIZATION_FAILED_FB
• ERROR_SPACE_NETWORK_TIMEOUT_FB
• ERROR_SPACE_NETWORK_REQUEST_FAILED_FB
• ERROR_SPACE_CLOUD_STORAGE_DISABLED_FB

See Also:

• Constant Field Values

Method Details

nxrShareSpacesFB

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

Unsafe version of: ShareSpacesFB

xrShareSpacesFB

public static int xrShareSpacesFB(XrSession session,
 XrSpaceShareInfoFB info,
 LongBuffer requestId)

Shares spatial entities with specified users.

C Specification

The ShareSpacesFB function is defined as:

 XrResult xrShareSpacesFB(
     XrSession                                   session,
     const XrSpaceShareInfoFB*                   info,
     XrAsyncRequestIdFB*                         requestId);

Description

This operation is asynchronous and the runtime must post an XrEventDataSpaceShareCompleteFB event when the operation completes successfully or encounters an error. If this function returns a failure code, no event is posted. The requestId can be used to later refer to the request, such as identifying which request has completed when an XrEventDataSpaceShareCompleteFB is posted to the event queue.

Valid Usage (Implicit)

• The XR_FB_spatial_entity_sharing extension must be enabled prior to calling ShareSpacesFB
• session must be a valid XrSession handle
• info must be a pointer to a valid XrSpaceShareInfoFB 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_SPACE_NETWORK_TIMEOUT_FB
• ERROR_SPACE_NETWORK_REQUEST_FAILED_FB
• ERROR_SPACE_MAPPING_INSUFFICIENT_FB
• ERROR_SPACE_LOCALIZATION_FAILED_FB
• ERROR_SPACE_COMPONENT_NOT_ENABLED_FB
• ERROR_SPACE_CLOUD_STORAGE_DISABLED_FB
• ERROR_FEATURE_UNSUPPORTED

See Also

XrSpaceShareInfoFB

Parameters:

session - a handle to an XrSession.

info - a pointer to an XrSpaceShareInfoFB structure containing information about which spatial entities to share with which users.

requestId - the output parameter that points to the ID of this asynchronous request.