PeriodicForceEffect Class

Reference

Definition

Namespace:: Windows.Gaming.Input.ForceFeedback

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

A force feedback effect which applies a varying force, defined by a waveform, along a vector.

public ref class PeriodicForceEffect sealed

/// [Windows.Foundation.Metadata.Activatable(Windows.Gaming.Input.ForceFeedback.IPeriodicForceEffectFactory, 196608, "Windows.Foundation.UniversalApiContract")]
/// [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 PeriodicForceEffect final

[Windows.Foundation.Metadata.Activatable(typeof(Windows.Gaming.Input.ForceFeedback.IPeriodicForceEffectFactory), 196608, "Windows.Foundation.UniversalApiContract")]
[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 PeriodicForceEffect

function PeriodicForceEffect(effectKind)

Public NotInheritable Class PeriodicForceEffect

Inheritance: Object Platform::Object IInspectable PeriodicForceEffect

Attributes: ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements: IForceFeedbackEffect

Windows requirements

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

Constructors

PeriodicForceEffect(PeriodicForceEffectKind)

Creates an instance of PeriodicForceEffect.

Properties

Gain	Specifies the percentage by which to reduce the force of the effect.
Kind	The type of periodic force feedback effect.
State	The current state of the force feedback effect.

Methods

SetParameters(Vector3, Single, Single, Single, TimeSpan)	Sets the parameters for the force feedback effect.
SetParametersWithEnvelope(Vector3, Single, Single, Single, Single, Single, Single, TimeSpan, TimeSpan, TimeSpan, TimeSpan, UInt32)	Sets the parameters for the effect and sets an envelope for the effect.
Start()	Starts the force feedback effect.
Stop()	Stops the force feedback effect.

Applies to