PeriodicForceEffect.SetParameters Method

Definition

Namespace:

Windows.Gaming.Input.ForceFeedback

Sets the parameters for the force feedback effect.

public:
 virtual void SetParameters(float3 vector, float frequency, float phase, float bias, TimeSpan duration) = SetParameters;

void SetParameters(float3 const& vector, float const& frequency, float const& phase, float const& bias, TimeSpan const& duration);

public void SetParameters(Vector3 vector, float frequency, float phase, float bias, System.TimeSpan duration);

function setParameters(vector, frequency, phase, bias, duration)

Public Sub SetParameters (vector As Vector3, frequency As Single, phase As Single, bias As Single, duration As TimeSpan)

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.

duration

TimeSpan TimeSpan

The duration of the effect.