KnownSimpleHapticsControllerWaveforms Class

Reference

Definition

Namespace:: Windows.Devices.Haptics

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.

Edit

Provides a set of well-known haptic waveform types (based on the Haptic Usage Page HID specification.

public ref class KnownSimpleHapticsControllerWaveforms abstract sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 262144)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class KnownSimpleHapticsControllerWaveforms final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 262144)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public static class KnownSimpleHapticsControllerWaveforms

Public Class KnownSimpleHapticsControllerWaveforms

Inheritance: Object Platform::Object IInspectable KnownSimpleHapticsControllerWaveforms

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10 Creators Update (introduced in 10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v4.0)

Examples

The following fully functional samples demonstrate haptic features across various devices.

Pen haptics

See the Pen haptics sample for working examples of the following functionality:

Get a SimpleHapticsController from pen input: Go from PointerPoint.PointerId to PenDevice to SimpleHapticsController (requires both a haptic-capable pen and a device that supports the pen).
Check pen haptics capabilities: A SimpleHapticsController exposes properties for pen hardware capabilities, including IsIntensitySupported, IsPlayCountSupported, SupportedFeedback, and so on.
Start and stop haptic feedback: Use the SendHapticFeedback and StopFeedback methods appropriately.
Trigger haptic feedback: Feedback for both inking feedback and interaction feedback.

RadialController haptics

See the RadialController for examples of how to use haptics with RadialController devices such as the Surface Dial.

Mixed reality controller haptics

See the Spatial interaction source sample for an example of how to use haptics with Six Degree of Freedom (6DOF) Controllers on Windows Mixed Reality Desktop.

Properties

BrushContinuous	Gets a buzz waveform that is generated continuously for a pen device while in contact with the digitizer surface.
BuzzContinuous	Gets a buzz waveform that is generated continuously until terminated.
ChiselMarkerContinuous	Gets a buzz waveform that is generated continuously for a pen device (in marker/highlighter mode) while in contact with the digitizer surface.
Click	Gets a click waveform.
EraserContinuous	Gets a buzz waveform that is generated continuously for a pen device (in eraser mode) while in contact with the digitizer surface.
Error	Gets a strong buzz waveform used to signal that an action has failed, or an error has occurred.
GalaxyPenContinuous	Gets a buzz waveform that is generated continuously for special ink tools (such as a multi-colored brush) while in contact with the digitizer surface.
Hover	Gets a buzz waveform that indicates the pointer has started hovering over an interactive UI element.
InkContinuous	Gets a buzz waveform that is generated continuously for a pen device (in ink mode) while in contact with the digitizer surface.
MarkerContinuous	Gets a buzz waveform that is generated continuously without interruption for a pen device (in marker mode) while in contact with the digitizer surface.
PencilContinuous	Gets a buzz waveform that is generated continuously for a pen device (in ink pencil mode) while in contact with the digitizer surface.
Press	Gets a buzz waveform that indicates when a user presses an interactive UI element in an incremental action (see Release).
Release	Gets a buzz waveform that indicates when a user releases an interactive UI element in an incremental action (see Press).
RumbleContinuous	Gets a rumble waveform that is generated continuously until terminated.
Success	Gets a buzz waveform that is generated for a pen device when ink recognition is successful.

Applies to