Package org.lwjgl.openxr

Class FBSpatialEntityUser

java.lang.Object

org.lwjgl.openxr.FBSpatialEntityUser

public class FBSpatialEntityUser
extends Object

The XR_FB_spatial_entity_user extension.

This extension enables creation and management of user objects which can be used by the application to reference a user other than the current user.

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 String	XR_FB_SPATIAL_ENTITY_USER_EXTENSION_NAME	The extension name.
static final int	XR_FB_spatial_entity_user_SPEC_VERSION	The extension specification version.
static final int	XR_OBJECT_TYPE_SPACE_USER_FB	Extends XrObjectType.
static final int	XR_TYPE_SPACE_USER_CREATE_INFO_FB	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrCreateSpaceUserFB(XrSession session, long info, long user)	Unsafe version of: CreateSpaceUserFB
static int	nxrGetSpaceUserIdFB(XrSpaceUserFB user, long userId)	Unsafe version of: GetSpaceUserIdFB
static int	xrCreateSpaceUserFB(XrSession session, XrSpaceUserCreateInfoFB info, org.lwjgl.PointerBuffer user)	Creates a user other than the current user.
static int	xrDestroySpaceUserFB(XrSpaceUserFB user)	Destroys a user handle.
static int	xrGetSpaceUserIdFB(XrSpaceUserFB user, LongBuffer userId)	Gets the user ID for a given user handle.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_spatial_entity_user_SPEC_VERSION

public static final int XR_FB_spatial_entity_user_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_SPATIAL_ENTITY_USER_EXTENSION_NAME

public static final String XR_FB_SPATIAL_ENTITY_USER_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_SPACE_USER_CREATE_INFO_FB

public static final int XR_TYPE_SPACE_USER_CREATE_INFO_FB

Extends XrStructureType.

See Also:

• Constant Field Values

XR_OBJECT_TYPE_SPACE_USER_FB

public static final int XR_OBJECT_TYPE_SPACE_USER_FB

Extends XrObjectType.

See Also:

• Constant Field Values

Method Details

nxrCreateSpaceUserFB

public static int nxrCreateSpaceUserFB(XrSession session,
 long info,
 long user)

Unsafe version of: CreateSpaceUserFB

xrCreateSpaceUserFB

public static int xrCreateSpaceUserFB(XrSession session,
 XrSpaceUserCreateInfoFB info,
 org.lwjgl.PointerBuffer user)

Creates a user other than the current user.

C Specification

The CreateSpaceUserFB function is defined as:

 XrResult xrCreateSpaceUserFB(
     XrSession                                   session,
     const XrSpaceUserCreateInfoFB*              info,
     XrSpaceUserFB*                              user);

Description

The application can use this function to create a user handle with which it can then interact, such as sharing XrSpace objects.

Valid Usage (Implicit)

• The XR_FB_spatial_entity_user extension must be enabled prior to calling CreateSpaceUserFB
• session must be a valid XrSession handle
• info must be a pointer to a valid XrSpaceUserCreateInfoFB structure
• user must be a pointer to an XrSpaceUserFB handle

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_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED

See Also

XrSpaceUserCreateInfoFB

Parameters:

session - a handle to an XrSession.

info - a pointer to an XrSpaceUserCreateInfoFB structure containing information to create the user handle.

user - the output parameter that points to the handle of the user being created.

nxrGetSpaceUserIdFB

public static int nxrGetSpaceUserIdFB(XrSpaceUserFB user,
 long userId)

Unsafe version of: GetSpaceUserIdFB

xrGetSpaceUserIdFB

public static int xrGetSpaceUserIdFB(XrSpaceUserFB user,
 LongBuffer userId)

Gets the user ID for a given user handle.

C Specification

The GetSpaceUserIdFB function is defined as:

 XrResult xrGetSpaceUserIdFB(
     XrSpaceUserFB                               user,
     XrSpaceUserIdFB*                            userId);

Description

The application can use this function to retrieve the user ID of a given user handle.

Valid Usage (Implicit)

• The XR_FB_spatial_entity_user extension must be enabled prior to calling GetSpaceUserIdFB
• user must be a valid XrSpaceUserFB handle
• userId must be a pointer to an XrSpaceUserIdFB 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

Parameters:

user - a handle to an XrSpaceUserFB.

userId - the output parameter that points to the user ID of the user.

xrDestroySpaceUserFB

public static int xrDestroySpaceUserFB(XrSpaceUserFB user)

Destroys a user handle.

C Specification

The DestroySpaceUserFB function is defined as:

 XrResult xrDestroySpaceUserFB(
     XrSpaceUserFB                               user);

Description

The application should use this function to release resources tied to a given XrSpaceUserFB once the application no longer needs to reference the user.

Valid Usage (Implicit)

• The XR_FB_spatial_entity_user extension must be enabled prior to calling DestroySpaceUserFB
• user must be a valid XrSpaceUserFB handle

Thread Safety

• Access to user, and any child handles, must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID

Parameters:

user - a handle to the user object to be destroyed.