PeriodicForceEffect.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 vector, float frequency, float phase, float bias, float attackGain, float sustainGain, float releaseGain, TimeSpan startDelay, TimeSpan attackDuration, TimeSpan sustainDuration, TimeSpan releaseDuration, unsigned int repeatCount) = SetParametersWithEnvelope;

void SetParametersWithEnvelope(float3 const& vector, float const& frequency, float const& phase, float const& bias, 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 vector, float frequency, float phase, float bias, float attackGain, float sustainGain, float releaseGain, System.TimeSpan startDelay, System.TimeSpan attackDuration, System.TimeSpan sustainDuration, System.TimeSpan releaseDuration, uint repeatCount);

function setParametersWithEnvelope(vector, frequency, phase, bias, attackGain, sustainGain, releaseGain, startDelay, attackDuration, sustainDuration, releaseDuration, repeatCount)

Public Sub SetParametersWithEnvelope (vector As Vector3, frequency As Single, phase As Single, bias As Single, 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

vector

Vector3 Vector3

float3

A vector describing the direction and magnitude of the effect on each axis. Each individual axis has a range of -1.0 to 1.0 and is independent of the other axes. Specifying a negative value for an axis reverses the input values from the axis.

frequency

Single

float

The number of times the periodic wave occurs in one second.

phase

Single

float

The phase offset from the origin of the periodic waveform, where 0.0 equals zero degrees of offset, and 1.0 equals 360 degrees of offset. For example, a phase value of 0.25 would correspond to a phase offset of 90 degrees.

bias

Single

float

The adjustment to add to the magnitude after calculating the wave and before applying the ramp or gain. Range is between -1 and 1.

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.