XrHapticAmplitudeEnvelopeVibrationFB(3)

C Specification

An application can trigger an amplitude envelope haptic effect by creating a XrHapticAmplitudeEnvelopeVibrationFB structure and calling xrApplyHapticFeedback.

The XrHapticAmplitudeEnvelopeVibrationFB structure is defined as:

// Provided by XR_FB_haptic_amplitude_envelope
typedef struct XrHapticAmplitudeEnvelopeVibrationFB {
    XrStructureType    type;
    const void*        next;
    XrDuration         duration;
    uint32_t           amplitudeCount;
    const float*       amplitudes;
} XrHapticAmplitudeEnvelopeVibrationFB;

Members

This structure describes an amplitude envelope haptic effect.

Description

Member Descriptions

type is the XrStructureType of this structure.
next is NULL or a pointer to the next structure in a structure chain.
duration is the duration of the haptic effect in nanoseconds. See https://registry.khronos.org/OpenXR/specs/1.0/html/xrspec.html#duration for more details.
amplitudeCount is the number of samples in the buffer.
amplitudes is the pointer to a float array that contains the samples.

The runtime should resample the provided samples in the amplitudes, and maintain an internal buffer which should be of XR_MAX_HAPTIC_AMPLITUDE_ENVELOPE_SAMPLES_FB length. The resampling should happen based on the duration, amplitudeCount, and the device’s sample rate.

Valid Usage (Implicit)

The XR_FB_haptic_amplitude_envelope extension must be enabled prior to using XrHapticAmplitudeEnvelopeVibrationFB
type must be XR_TYPE_HAPTIC_AMPLITUDE_ENVELOPE_VIBRATION_FB
next must be NULL or a valid pointer to the next structure in a structure chain
amplitudes must be a pointer to an array of amplitudeCount float values
The amplitudeCount parameter must be greater than 0

Document Notes

For more information, see the OpenXR Specification

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

This work is licensed under a Creative Commons Attribution 4.0 International License.

XrHapticAmplitudeEnvelopeVibrationFB(3) Manual Page

Name

C Specification

Members

Description

See Also

Document Notes

Copyright