ForceFeedbackMotor Class

Definition

Namespace:

Windows.Gaming.Input.ForceFeedback

Encapsulates the force feedback hardware for a given input device.

public ref class ForceFeedbackMotor sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ForceFeedbackMotor final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ForceFeedbackMotor

Public NotInheritable Class ForceFeedbackMotor

Inheritance

Object Platform::Object IInspectable ForceFeedbackMotor

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v3.0)

Properties

AreEffectsPaused	Boolean indicating whether force feedback effects are paused.
IsEnabled	Boolean indicating whether the force feedback motor is enabled.
MasterGain	Specifies the percentage by which to reduce the force of all effects on the controller.
SupportedAxes	The axes supported by the force feedback motor.

Methods

LoadEffectAsync(IForceFeedbackEffect)	Attempts to asynchronously load a feedback effect to the device's internal memory.
PauseAllEffects()	Pauses all force feedback effects being executed.
ResumeAllEffects()	Resumes all force feedback effects being executed.
StopAllEffects()	Stops all force feedback effects.
TryDisableAsync()	Attempts to asynchronously disable the force feedback motor.
TryEnableAsync()	Try to asynchronously enable the force feedback motor of the device.
TryResetAsync()	Attempts to asynchronously reset the device back to its initial state.
TryUnloadEffectAsync(IForceFeedbackEffect)	Attempts to asynchronously unload a feedback effect from the device's internal memory.