Package org.lwjgl.openxr

Class FBHapticPcm

java.lang.Object

org.lwjgl.openxr.FBHapticPcm

public class FBHapticPcm
extends Object

The XR_FB_haptic_pcm extension.

This extension enables applications to trigger haptic effects using Pulse Code Modulation (PCM) buffers.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_FB_HAPTIC_PCM_EXTENSION_NAME	The extension name.
static final int	XR_FB_haptic_pcm_SPEC_VERSION	The extension specification version.
static final int	XR_MAX_HAPTIC_PCM_BUFFER_SIZE_FB	API Constants
static final int	XR_TYPE_DEVICE_PCM_SAMPLE_RATE_GET_INFO_FB	Extends XrStructureType.
static final int	XR_TYPE_DEVICE_PCM_SAMPLE_RATE_STATE_FB	Extends XrStructureType.
static final int	XR_TYPE_HAPTIC_PCM_VIBRATION_FB	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrGetDeviceSampleRateFB(XrSession session, long hapticActionInfo, long deviceSampleRate)	Unsafe version of: GetDeviceSampleRateFB
static int	xrGetDeviceSampleRateFB(XrSession session, XrHapticActionInfo hapticActionInfo, XrDevicePcmSampleRateGetInfoFB deviceSampleRate)	Get device sample rate.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_haptic_pcm_SPEC_VERSION

public static final int XR_FB_haptic_pcm_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_HAPTIC_PCM_EXTENSION_NAME

public static final String XR_FB_HAPTIC_PCM_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_HAPTIC_PCM_VIBRATION_FB

public static final int XR_TYPE_HAPTIC_PCM_VIBRATION_FB

Extends XrStructureType.

Enum values:

• TYPE_HAPTIC_PCM_VIBRATION_FB
• TYPE_DEVICE_PCM_SAMPLE_RATE_STATE_FB
• TYPE_DEVICE_PCM_SAMPLE_RATE_GET_INFO_FB

See Also:

• Constant Field Values

XR_TYPE_DEVICE_PCM_SAMPLE_RATE_STATE_FB

public static final int XR_TYPE_DEVICE_PCM_SAMPLE_RATE_STATE_FB

Extends XrStructureType.

Enum values:

• TYPE_HAPTIC_PCM_VIBRATION_FB
• TYPE_DEVICE_PCM_SAMPLE_RATE_STATE_FB
• TYPE_DEVICE_PCM_SAMPLE_RATE_GET_INFO_FB

See Also:

• Constant Field Values

XR_TYPE_DEVICE_PCM_SAMPLE_RATE_GET_INFO_FB

public static final int XR_TYPE_DEVICE_PCM_SAMPLE_RATE_GET_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_HAPTIC_PCM_VIBRATION_FB
• TYPE_DEVICE_PCM_SAMPLE_RATE_STATE_FB
• TYPE_DEVICE_PCM_SAMPLE_RATE_GET_INFO_FB

See Also:

• Constant Field Values

XR_MAX_HAPTIC_PCM_BUFFER_SIZE_FB

public static final int XR_MAX_HAPTIC_PCM_BUFFER_SIZE_FB

API Constants

See Also:

• Constant Field Values

Method Details

nxrGetDeviceSampleRateFB

public static int nxrGetDeviceSampleRateFB(XrSession session,
 long hapticActionInfo,
 long deviceSampleRate)

Unsafe version of: GetDeviceSampleRateFB

xrGetDeviceSampleRateFB

public static int xrGetDeviceSampleRateFB(XrSession session,
 XrHapticActionInfo hapticActionInfo,
 XrDevicePcmSampleRateGetInfoFB deviceSampleRate)

Get device sample rate.

C Specification

 XrResult xrGetDeviceSampleRateFB(
     XrSession                                   session,
     const XrHapticActionInfo*                   hapticActionInfo,
     XrDevicePcmSampleRateGetInfoFB*             deviceSampleRate);

Description

The runtime must use the hapticActionInfo to get the sample rate of the currently bound device on which haptics is triggered and populate the deviceSampleRate structure. The device is determined by the XrHapticActionInfo::action and XrHapticActionInfo::subactionPath. If the hapticActionInfo is bound to more than one device, then runtime should assume that the all these bound devices have the same deviceSampleRate and the runtime should return the sampleRate for any of those bound devices. If the device is invalid, the runtime must populate the deviceSampleRate of XrDevicePcmSampleRateStateFB as 0. A device can be invalid if the runtime does not find any device (which can play haptics) connected to the headset, or if the device does not support PCM haptic effect.

Valid Usage (Implicit)

• The XR_FB_haptic_pcm extension must be enabled prior to calling GetDeviceSampleRateFB
• session must be a valid XrSession handle
• hapticActionInfo must be a pointer to a valid XrHapticActionInfo structure
• deviceSampleRate must be a pointer to an XrDevicePcmSampleRateGetInfoFB structure

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_PATH_UNSUPPORTED
• ERROR_PATH_INVALID
• ERROR_ACTION_TYPE_MISMATCH
• ERROR_ACTIONSET_NOT_ATTACHED

See Also

XrDevicePcmSampleRateGetInfoFB, XrDevicePcmSampleRateStateFB, XrHapticActionInfo

Parameters:

session - the specified XrSession.

hapticActionInfo - the XrHapticActionInfo used to provide action and subaction paths

deviceSampleRate - a pointer to XrDevicePcmSampleRateStateFB which is populated by the runtime.