Share via

GameInputForceFeedbackParams (v1)

  • Article

Defines the API-supported attributes of a force-feedback effect.

Syntax

struct GameInputForceFeedbackParams
{
    GameInputForceFeedbackEffectKind kind;
    union
    {
        GameInputForceFeedbackConstantParams  constant;
        GameInputForceFeedbackRampParams      ramp;
        GameInputForceFeedbackPeriodicParams  sineWave;
        GameInputForceFeedbackPeriodicParams  squareWave;
        GameInputForceFeedbackPeriodicParams  triangleWave;
        GameInputForceFeedbackPeriodicParams  sawtoothUpWave;
        GameInputForceFeedbackPeriodicParams  sawtoothDownWave;
        GameInputForceFeedbackConditionParams spring;
        GameInputForceFeedbackConditionParams friction;
        GameInputForceFeedbackConditionParams damper;
        GameInputForceFeedbackConditionParams inertia;
    } data;
};

Members

kind Type: GameInputForceFeedbackEffectKind

Defines the kind of a force-feedback effect.

constant Type: GameInputForceFeedbackConstantParams

Constant force-feedback effect. Force is applied at a constant level for the duration of the effect.

ramp Type: GameInputForceFeedbackRampParams

Ramp force-feedback effect. Force is applied gradually by being increased or decreased over the duration of the effect.

sineWave Type: GameInputForceFeedbackPeriodicParams

Sine-wave force-feedback effect. Force is applied in a sine-wave pattern.

squareWave Type: GameInputForceFeedbackPeriodicParams

Square-wave force-feedback effect. Force is applied in a square-wave pattern.

triangleWave Type: GameInputForceFeedbackPeriodicParams

Triangle-wave force-feedback effect. Force is applied in a triangle-wave pattern.

sawtoothUpWave Type: GameInputForceFeedbackPeriodicParams

Upward-sawtooth-wave force-feedback effect. Force is applied in an upward-sawtooth-wave pattern.

sawtoothDownWave Type: GameInputForceFeedbackPeriodicParams

Downward-sawtooth-wave force-feedback effect. Force is applied in a downward-sawtooth-wave pattern.

spring Type: GameInputForceFeedbackConditionParams

Spring force-feedback effect. Force is applied in opposition to a set state.

friction Type: GameInputForceFeedbackConditionParams

Friction force-feedback effect. Force is applied to mimic friction.

damper Type: GameInputForceFeedbackConditionParams

Damper force-feedback effect. Force is applied to mimic a damper effect.

inertia Type: GameInputForceFeedbackConditionParams

Inertia force-feedback effect. Force is applied to mimic an inertia effect.

Remarks

Forced-feedback effects are defined by their parameters. These effects are stored in the GameInputForceFeedbackParams structure. The actual parameters for each type of force-feedback effect vary slightly. The parameters for all kinds of effects define the magnitude of the effect along the motor's supported axes, and most allow for an envelope that affects the strength of the effect over time.

Requirements

Header: GameInput.h

Supported platforms: Windows

See also

Advanced GameInput topics Overview of GameInput GameInputForceFeedbackEffectKind GameInput