Fork me on GitHub

ForceFeedback Class

Summary

Interface class for dealing with Force Feedback devices
Namespace
SharpInputSystem
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["IInputObjectInterface"] click Interface0 "/sharpinputsystem/api/SharpInputSystem/IInputObjectInterface" Type["ForceFeedback"] class Type type-node

Syntax

public abstract class ForceFeedback : IInputObjectInterface

Properties

Name Value Summary
AutoCenterMode bool
If using Force Feedback effects, this should be turned off before uploading any effects. Auto centering is the motor moving the joystick back to center. DirectInput only has an on/off setting, whereas linux has levels.. Though, we go with DI's on/off mode only
MasterGain float
This is like setting the master volume of an audio device. Individual effects have gain levels; however, this affects all effects at once.
SupportedAxesCount int
Get the number of supported Axes for ForceFeedback usage
SupportedEffects EffectsList
Get a list of all supported effects

Methods

Name Value Summary
AddEffectType(Effect.EForce, Effect.EType) void
Modify(Effect) void
Modifies an effect that is currently playing
Remove(Effect) void
Remove the effect from the device
Upload(Effect) void
Creates and Plays the effect immediately. If the device is full of effects, it will fail to be uploaded. You will know this by an invalid Effect Handle