Developer

API Reference

IJOYSTICK_SetParm()

Brew Release
Brew MP 1.0.2
See Also
IJOYSTICK_GetParm()
Description
This function sets the joystick control parameters.
Parameters
  • pIJoystick
    []:
    Pointer to IJoystick Interface.
  • nParmID
    []:
    Command parameter that controls what will be set by this function.
  • p1
    []:
    Depends upon nParmID.
  • p2
    []:
    Depends upon nParmID.
Interface
IJOYSTICK
Prototype
   int IJOYSTICK_SetParm
   (
   IJoystick * pIJoystick,  
   int16 nParmID,
   int32 p1,
   int32 p2
   )
Return
SUCCESS: Successful. Operation is completed. EFAILED: General failure
Side Effect
None
Comment
Joystick Control Parms
   #define JOY_PARM_BASE           1                       // Base used by IJoystick
   
   #define JOY_PARM_SAMPLEFREQ     (JOY_PARM_BASE)         // [set] p1 = sampling freq, p2 ignored
   #define JOY_PARM_INACTIVITY     (JOY_PARM_BASE + 1)     // [set] p1 = inactivity count in ms, p2 ignored
   #define JOY_PARM_SF_IC          (JOY_PARM_BASE + 2)     // [set] p1 = sampling freq, p2 = inactivity count in ms

   #define JOY_PARM_MAXCOUNT       (JOY_PARM_BASE + 3)     // [get] returns max allowed inactivity count (ms)
   #define JOY_PARM_MAXFREQ        (JOY_PARM_BASE + 4)     // [get] returns max allowed sampling freq (Hz)
  • Follow