Share via


RampForceEffect Class

Definition

A force feedback effect which applies a linearly increasing or decreasing force along a vector.

public ref class RampForceEffect sealed
/// [Windows.Foundation.Metadata.Activatable(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 RampForceEffect final
[Windows.Foundation.Metadata.Activatable(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 RampForceEffect
function RampForceEffect()
Public NotInheritable Class RampForceEffect
Inheritance
Object Platform::Object IInspectable RampForceEffect
Attributes
Implements

Windows requirements

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

Constructors

RampForceEffect()

Creates an instance of RampForceEffect.

Properties

Gain

Specifies the percentage by which to reduce the force of the effect.

State

The current state of the effect.

Methods

SetParameters(Vector3, Vector3, TimeSpan)

Sets the parameters for the ramp force feedback effect.

SetParametersWithEnvelope(Vector3, Vector3, 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 effect.

Applies to

See also