Top Description Fields Constructors Methods
org.lwjgl.openxr

public Class FBSpatialEntityUser

extends Object
Class Inheritance
Imports
java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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 extensions section.

Field Summary

Modifier and TypeField and Description
public static final String
XR_FB_SPATIAL_ENTITY_USER_EXTENSION_NAME

The extension name.

public static final int
XR_FB_spatial_entity_user_SPEC_VERSION

The extension specification version.

public static final int
XR_OBJECT_TYPE_SPACE_USER_FB

Extends XrObjectType.

public static final int
XR_TYPE_SPACE_USER_CREATE_INFO_FB

Extends XrStructureType.

Constructor Summary

AccessConstructor and Description
protected
FBSpatialEntityUser()

Method Summary

Modifier and TypeMethod and Description
public static int
nxrCreateSpaceUserFB(XrSession session, long info, long user)

Unsafe version of: CreateSpaceUserFB

public static int
nxrGetSpaceUserIdFB(XrSpaceUserFB user, long userId)

Unsafe version of: GetSpaceUserIdFB

public static int
xrCreateSpaceUserFB(XrSession
a handle to an XrSession.
session, XrSpaceUserCreateInfoFB
a pointer to an XrSpaceUserCreateInfoFB structure containing information to create the user handle.
info, PointerBuffer
the output parameter that points to the handle of the user being created.
user)

Creates a user other than the current user.

public static int
xrDestroySpaceUserFB(XrSpaceUserFB
a handle to the user object to be destroyed.
user)

Destroys a user handle.

public static int
xrGetSpaceUserIdFB(XrSpaceUserFB
a handle to an XrSpaceUserFB.
user, LongBuffer
the output parameter that points to the user ID of the user.
userId)

Gets the user ID for a given user handle.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

XR_FB_SPATIAL_ENTITY_USER_EXTENSION_NAMEback to summary
public static final String XR_FB_SPATIAL_ENTITY_USER_EXTENSION_NAME

The extension name.

XR_FB_spatial_entity_user_SPEC_VERSIONback to summary
public static final int XR_FB_spatial_entity_user_SPEC_VERSION

The extension specification version.

XR_OBJECT_TYPE_SPACE_USER_FBback to summary
public static final int XR_OBJECT_TYPE_SPACE_USER_FB

Extends XrObjectType.

XR_TYPE_SPACE_USER_CREATE_INFO_FBback to summary
public static final int XR_TYPE_SPACE_USER_CREATE_INFO_FB

Extends XrStructureType.

Constructor Detail

FBSpatialEntityUserback to summary
protected FBSpatialEntityUser()

Method Detail

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

Unsafe version of: CreateSpaceUserFB

nxrGetSpaceUserIdFBback to summary
public static int nxrGetSpaceUserIdFB(XrSpaceUserFB user, long userId)

Unsafe version of: GetSpaceUserIdFB

xrCreateSpaceUserFBback to summary
public static int xrCreateSpaceUserFB(XrSession session, XrSpaceUserCreateInfoFB info, 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)
Return Codes
On success, this command returns
On failure, this command returns
See Also

XrSpaceUserCreateInfoFB

Parameters
session:XrSession

a handle to an XrSession.

info:XrSpaceUserCreateInfoFB

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

user:PointerBuffer

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

Annotations
@NativeType:XrResult
xrDestroySpaceUserFBback to summary
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)
Thread Safety
  • Access to user, and any child handles, must be externally synchronized
Return Codes
On success, this command returns
On failure, this command returns
Parameters
user:XrSpaceUserFB

a handle to the user object to be destroyed.

Annotations
@NativeType:XrResult
xrGetSpaceUserIdFBback to summary
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)
Return Codes
On success, this command returns
On failure, this command returns
Parameters
user:XrSpaceUserFB

a handle to an XrSpaceUserFB.

userId:LongBuffer

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

Annotations
@NativeType:XrResult