RampForceEffect.SetParametersWithEnvelope Method

Definition

Namespace:

Windows.Gaming.Input.ForceFeedback

Sets the parameters for the effect and sets an envelope for the effect.

public:
 virtual void SetParametersWithEnvelope(float3 startVector, float3 endVector, float attackGain, float sustainGain, float releaseGain, TimeSpan startDelay, TimeSpan attackDuration, TimeSpan sustainDuration, TimeSpan releaseDuration, unsigned int repeatCount) = SetParametersWithEnvelope;

void SetParametersWithEnvelope(float3 const& startVector, float3 const& endVector, float const& attackGain, float const& sustainGain, float const& releaseGain, TimeSpan const& startDelay, TimeSpan const& attackDuration, TimeSpan const& sustainDuration, TimeSpan const& releaseDuration, uint32_t const& repeatCount);

public void SetParametersWithEnvelope(Vector3 startVector, Vector3 endVector, float attackGain, float sustainGain, float releaseGain, System.TimeSpan startDelay, System.TimeSpan attackDuration, System.TimeSpan sustainDuration, System.TimeSpan releaseDuration, uint repeatCount);

function setParametersWithEnvelope(startVector, endVector, attackGain, sustainGain, releaseGain, startDelay, attackDuration, sustainDuration, releaseDuration, repeatCount)

Public Sub SetParametersWithEnvelope (startVector As Vector3, endVector As Vector3, attackGain As Single, sustainGain As Single, releaseGain As Single, startDelay As TimeSpan, attackDuration As TimeSpan, sustainDuration As TimeSpan, releaseDuration As TimeSpan, repeatCount As UInteger)

Parameters

startVector

Vector3 Vector3

float3

The start vector of the effect.

endVector

Vector3 Vector3

float3

The end vector of the effect.

attackGain

Single

float

Percentage by which to reduce the strength of the effect when it is ramping up.

sustainGain

Single

float

Percentage by which to reduce the strength of the effect when it is sustaining.

releaseGain

Single

float

Percentage by which to reduce the strength of the effect when it is ramping down.

startDelay

TimeSpan TimeSpan

Time to delay the effect before starting.

attackDuration

TimeSpan TimeSpan

Time to ramp up to the effect's full strength.

sustainDuration

TimeSpan TimeSpan

Time to maintain the effect at full strength.

releaseDuration

TimeSpan TimeSpan

Time to ramp down from full strength to zero.

repeatCount

UInt32

unsigned int

uint32_t

The number of times to repeat the effect.