Package org.lwjgl.openxr

Class MNDXForceFeedbackCurl

java.lang.Object

org.lwjgl.openxr.MNDXForceFeedbackCurl

public class MNDXForceFeedbackCurl
extends Object

The XR_MNDX_force_feedback_curl extension.

This extension provides APIs for force feedback devices capable of restricting physical movement in a single direction along a single dimension.

The intended use for this extension is to provide simple force feedback capabilities to restrict finger movement for VR Gloves.

The application must also enable the XR_EXT_hand_tracking extension in order to use this extension.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_FORCE_FEEDBACK_CURL_LOCATION_INDEX_CURL_MNDX	XrForceFeedbackCurlLocationMNDX - Describes which location to apply force feedback
static final int	XR_FORCE_FEEDBACK_CURL_LOCATION_LITTLE_CURL_MNDX	XrForceFeedbackCurlLocationMNDX - Describes which location to apply force feedback
static final int	XR_FORCE_FEEDBACK_CURL_LOCATION_MIDDLE_CURL_MNDX	XrForceFeedbackCurlLocationMNDX - Describes which location to apply force feedback
static final int	XR_FORCE_FEEDBACK_CURL_LOCATION_RING_CURL_MNDX	XrForceFeedbackCurlLocationMNDX - Describes which location to apply force feedback
static final int	XR_FORCE_FEEDBACK_CURL_LOCATION_THUMB_CURL_MNDX	XrForceFeedbackCurlLocationMNDX - Describes which location to apply force feedback
static final String	XR_MNDX_FORCE_FEEDBACK_CURL_EXTENSION_NAME	The extension name.
static final int	XR_MNDX_force_feedback_curl_SPEC_VERSION	The extension specification version.
static final int	XR_TYPE_FORCE_FEEDBACK_CURL_APPLY_LOCATIONS_MNDX	Extends XrStructureType.
static final int	XR_TYPE_SYSTEM_FORCE_FEEDBACK_CURL_PROPERTIES_MNDX	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrApplyForceFeedbackCurlMNDX(XrHandTrackerEXT handTracker, long locations)	Unsafe version of: ApplyForceFeedbackCurlMNDX
static int	xrApplyForceFeedbackCurlMNDX(XrHandTrackerEXT handTracker, XrForceFeedbackCurlApplyLocationsMNDX locations)	Applies force feedback to a set of locations.

Methods inherited from class java.lang.Object

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

Field Details

XR_MNDX_force_feedback_curl_SPEC_VERSION

public static final int XR_MNDX_force_feedback_curl_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_MNDX_FORCE_FEEDBACK_CURL_EXTENSION_NAME

public static final String XR_MNDX_FORCE_FEEDBACK_CURL_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_SYSTEM_FORCE_FEEDBACK_CURL_PROPERTIES_MNDX

public static final int XR_TYPE_SYSTEM_FORCE_FEEDBACK_CURL_PROPERTIES_MNDX

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_FORCE_FEEDBACK_CURL_PROPERTIES_MNDX
• TYPE_FORCE_FEEDBACK_CURL_APPLY_LOCATIONS_MNDX

See Also:

• Constant Field Values

XR_TYPE_FORCE_FEEDBACK_CURL_APPLY_LOCATIONS_MNDX

public static final int XR_TYPE_FORCE_FEEDBACK_CURL_APPLY_LOCATIONS_MNDX

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_FORCE_FEEDBACK_CURL_PROPERTIES_MNDX
• TYPE_FORCE_FEEDBACK_CURL_APPLY_LOCATIONS_MNDX

See Also:

• Constant Field Values

XR_FORCE_FEEDBACK_CURL_LOCATION_THUMB_CURL_MNDX

public static final int XR_FORCE_FEEDBACK_CURL_LOCATION_THUMB_CURL_MNDX

XrForceFeedbackCurlLocationMNDX - Describes which location to apply force feedback

Enumerant Descriptions

• FORCE_FEEDBACK_CURL_LOCATION_THUMB_CURL_MNDX — force feedback for thumb curl
• FORCE_FEEDBACK_CURL_LOCATION_INDEX_CURL_MNDX — force feedback for index finger curl
• FORCE_FEEDBACK_CURL_LOCATION_MIDDLE_CURL_MNDX — force feedback for middle finger curl
• FORCE_FEEDBACK_CURL_LOCATION_RING_CURL_MNDX — force feedback for ring finger curl
• FORCE_FEEDBACK_CURL_LOCATION_LITTLE_CURL_MNDX — force feedback for little finger curl

See Also

XrForceFeedbackCurlApplyLocationMNDX

See Also:

• Constant Field Values

XR_FORCE_FEEDBACK_CURL_LOCATION_INDEX_CURL_MNDX

public static final int XR_FORCE_FEEDBACK_CURL_LOCATION_INDEX_CURL_MNDX

XrForceFeedbackCurlLocationMNDX - Describes which location to apply force feedback

Enumerant Descriptions

• FORCE_FEEDBACK_CURL_LOCATION_THUMB_CURL_MNDX — force feedback for thumb curl
• FORCE_FEEDBACK_CURL_LOCATION_INDEX_CURL_MNDX — force feedback for index finger curl
• FORCE_FEEDBACK_CURL_LOCATION_MIDDLE_CURL_MNDX — force feedback for middle finger curl
• FORCE_FEEDBACK_CURL_LOCATION_RING_CURL_MNDX — force feedback for ring finger curl
• FORCE_FEEDBACK_CURL_LOCATION_LITTLE_CURL_MNDX — force feedback for little finger curl

See Also

XrForceFeedbackCurlApplyLocationMNDX

See Also:

• Constant Field Values

XR_FORCE_FEEDBACK_CURL_LOCATION_MIDDLE_CURL_MNDX

public static final int XR_FORCE_FEEDBACK_CURL_LOCATION_MIDDLE_CURL_MNDX

XrForceFeedbackCurlLocationMNDX - Describes which location to apply force feedback

Enumerant Descriptions

• FORCE_FEEDBACK_CURL_LOCATION_THUMB_CURL_MNDX — force feedback for thumb curl
• FORCE_FEEDBACK_CURL_LOCATION_INDEX_CURL_MNDX — force feedback for index finger curl
• FORCE_FEEDBACK_CURL_LOCATION_MIDDLE_CURL_MNDX — force feedback for middle finger curl
• FORCE_FEEDBACK_CURL_LOCATION_RING_CURL_MNDX — force feedback for ring finger curl
• FORCE_FEEDBACK_CURL_LOCATION_LITTLE_CURL_MNDX — force feedback for little finger curl

See Also

XrForceFeedbackCurlApplyLocationMNDX

See Also:

• Constant Field Values

XR_FORCE_FEEDBACK_CURL_LOCATION_RING_CURL_MNDX

public static final int XR_FORCE_FEEDBACK_CURL_LOCATION_RING_CURL_MNDX

XrForceFeedbackCurlLocationMNDX - Describes which location to apply force feedback

Enumerant Descriptions

• FORCE_FEEDBACK_CURL_LOCATION_THUMB_CURL_MNDX — force feedback for thumb curl
• FORCE_FEEDBACK_CURL_LOCATION_INDEX_CURL_MNDX — force feedback for index finger curl
• FORCE_FEEDBACK_CURL_LOCATION_MIDDLE_CURL_MNDX — force feedback for middle finger curl
• FORCE_FEEDBACK_CURL_LOCATION_RING_CURL_MNDX — force feedback for ring finger curl
• FORCE_FEEDBACK_CURL_LOCATION_LITTLE_CURL_MNDX — force feedback for little finger curl

See Also

XrForceFeedbackCurlApplyLocationMNDX

See Also:

• Constant Field Values

XR_FORCE_FEEDBACK_CURL_LOCATION_LITTLE_CURL_MNDX

public static final int XR_FORCE_FEEDBACK_CURL_LOCATION_LITTLE_CURL_MNDX

XrForceFeedbackCurlLocationMNDX - Describes which location to apply force feedback

Enumerant Descriptions

• FORCE_FEEDBACK_CURL_LOCATION_THUMB_CURL_MNDX — force feedback for thumb curl
• FORCE_FEEDBACK_CURL_LOCATION_INDEX_CURL_MNDX — force feedback for index finger curl
• FORCE_FEEDBACK_CURL_LOCATION_MIDDLE_CURL_MNDX — force feedback for middle finger curl
• FORCE_FEEDBACK_CURL_LOCATION_RING_CURL_MNDX — force feedback for ring finger curl
• FORCE_FEEDBACK_CURL_LOCATION_LITTLE_CURL_MNDX — force feedback for little finger curl

See Also

XrForceFeedbackCurlApplyLocationMNDX

See Also:

• Constant Field Values

Method Details

nxrApplyForceFeedbackCurlMNDX

public static int nxrApplyForceFeedbackCurlMNDX(XrHandTrackerEXT handTracker,
 long locations)

Unsafe version of: ApplyForceFeedbackCurlMNDX

xrApplyForceFeedbackCurlMNDX

public static int xrApplyForceFeedbackCurlMNDX(XrHandTrackerEXT handTracker,
 XrForceFeedbackCurlApplyLocationsMNDX locations)

Applies force feedback to a set of locations.

C Specification

The ApplyForceFeedbackCurlMNDX function is defined as:

 XrResult xrApplyForceFeedbackCurlMNDX(
     XrHandTrackerEXT                            handTracker,
     const XrForceFeedbackCurlApplyLocationsMNDX* locations);

Description

The ApplyForceFeedbackCurlMNDX function applies force feedback to the set locations listed in XrForceFeedbackCurlApplyLocationsMNDX.

ApplyForceFeedbackCurlMNDX should be called every time an application wishes to update a set of force feedback locations.

Submits a request for force feedback for a set of locations. The runtime should deliver this request to the handTracker device. If the handTracker device is not available, the runtime may ignore this request for force feedback.

If the session associated with handTracker is not focused, the runtime must return SESSION_NOT_FOCUSED, and not apply force feedback.

When an application submits force feedback for a set of locations, the runtime must update the set of locations to that specified by the application. A runtime must set any locations not specified by the application when submitting force feedback to 0.

The runtime may discontinue force feedback if the application that set it loses focus. An application should call the function again after regaining focus if force feedback is still desired.

Valid Usage (Implicit)

• The XR_MNDX_force_feedback_curl extension must be enabled prior to calling ApplyForceFeedbackCurlMNDX
• handTracker must be a valid XrHandTrackerEXT handle
• locations must be a pointer to a valid XrForceFeedbackCurlApplyLocationsMNDX structure

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING
• SESSION_NOT_FOCUSED

On failure, this command returns

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

See Also

XrForceFeedbackCurlApplyLocationsMNDX

Parameters:

handTracker - an XrHandTrackerEXT handle previously created with CreateHandTrackerEXT.

locations - an XrForceFeedbackCurlApplyLocationsMNDX containing a set of locations to apply force feedback to.