GameInputForceFeedbackRampParams

  • Article

Defines the parameters for a ramp force-feedback effect.

Syntax

typedef struct GameInputForceFeedbackRampParams {  
    GameInputForceFeedbackEnvelope envelope;  
    GameInputForceFeedbackMagnitude startMagnitude;  
    GameInputForceFeedbackMagnitude endMagnitude;  
} GameInputForceFeedbackRampParams

Members

envelope
Type: GameInputForceFeedbackEnvelope

The envelope that modifies a force-feedback effect.

startMagnitude
Type: GameInputForceFeedbackMagnitude

The starting magnitude of the force-feedback effect.

endMagnitude
Type: GameInputForceFeedbackMagnitude

The ending magnitude of the force-feedback effect.

Remarks

The GameInputForceFeedbackRampParams structure is a member of GameInputForceFeedbackParams. 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, Xbox One family consoles and Xbox Series consoles

See also

Advanced GameInput topics
Overview of GameInput
GameInputForceFeedbackParams
GameInput