Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SendHapticImpulse(uint, float, float)

Sends a haptic impulse to a device.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine.XR
  • Assembly: UnityEngine.XRModule
public bool SendHapticImpulse(uint channel, float amplitude, float duration = 1)

Parameters

channel

uint
The channel to receive the impulse.

amplitude

float
The normalized (0.0 to 1.0) amplitude value of the haptic impulse to play on the device.

duration

float
The duration in seconds that the haptic impulse will play. Only supported on Oculus.

Returns

Type

Description

boolReturns true if successful. Returns false otherwise.

Remarks

Sends an impulse (amplitude and frequency) to a device.
Note: Not all devices support all parameters (OpenVR currently only supports amplitude). To determine whether impulse haptics are supported, call the TryGetHapticCapabilities method and inspect the supportsImpulse property.