GenericXRSDKController.StartHapticImpulse(Single, Single) Method

Reference

Definition

Namespace:: Microsoft.MixedReality.Toolkit.XRSDK.Input

Assembly:: Microsoft.MixedReality.Toolkit.Providers.XRSDK.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Start haptic feedback by the input device.

public bool StartHapticImpulse (float intensity, float durationInSeconds = 3.402823E+38);

abstract member StartHapticImpulse : single * single -> bool
override this.StartHapticImpulse : single * single -> bool

Public Function StartHapticImpulse (intensity As Single, Optional durationInSeconds As Single = 3.402823E+38) As Boolean

Parameters

intensity: Single

The 0.0 to 1.0 strength of the haptic feedback based on the capability of the input device.

durationInSeconds: Single

The duration in seconds or float.MaxValue for indefinite duration (if supported by the platform).

Returns

Boolean

True if haptic feedback was successfully started.

Implements

StartHapticImpulse(Single, Single)

Applies to