oot/include/rumble.h
Tharo 4f65d08eb5
Rumble doc (#1375)
* Rumble doc

* Fixes, suggested changes

* Improve padmgr retrace callback related code

* Name some rumble-adjacent things, further suggested changes

* Further suggested changes

* Suggested changes
2022-09-27 12:40:26 -04:00

52 lines
1.8 KiB
C

#ifndef RUMBLE_H
#define RUMBLE_H
#include "ultra64.h"
#define RUMBLE_MAX_REQUESTS 64
typedef enum {
RUMBLE_STATE_CLEAR,
RUMBLE_STATE_RUNNING,
RUMBLE_STATE_RESET
} RumbleState;
typedef struct {
/* 0x000 */ u8 rumbleEnable[MAXCONTROLLERS];
/* 0x004 */ u8 reqStrengths[RUMBLE_MAX_REQUESTS]; // Source strength modulated by distance to the source
/* 0x044 */ u8 reqDurations[RUMBLE_MAX_REQUESTS]; // Duration until decreaseRate kicks in
/* 0x084 */ u8 reqDecreaseRates[RUMBLE_MAX_REQUESTS]; // Decreases the strength by this much every Vertical Retrace, once the strength hits 0 the request slot is freed
/* 0x0C4 */ u8 reqAccumulators[RUMBLE_MAX_REQUESTS]; // Starts at 0, incremented by the strength every Vertical Retrace
/* 0x104 */ u8 state;
/* 0x105 */ u8 updateEnabled;
/* 0x106 */ u16 onTimer; // Duration for which there has been an active rumble request running
/* 0x108 */ u16 offTimer; // Duration for which there has not been an active rumble request running, capped at 5
/* 0x10A */ u8 overrideStrength; // overrides requests with these parameters
/* 0x10B */ u8 overrideDuration;
/* 0x10C */ u8 overrideDecreaseRate;
/* 0x10D */ u8 overrideAccumulator;
} RumbleMgr; // size = 0x10E
// internal
void RumbleMgr_Init(RumbleMgr* rumbleMgr);
void RumbleMgr_Destroy(RumbleMgr* rumbleMgr);
void RumbleMgr_Update(RumbleMgr* rumbleMgr);
// external
void Rumble_Override(f32 distSq, u8 sourceStrength, u8 duration, u8 decreaseRate);
void Rumble_Request(f32 distSq, u8 sourceStrength, u8 duration, u8 decreaseRate);
void Rumble_Init(void);
void Rumble_Destroy(void);
s32 Rumble_Controller1HasRumblePak(void);
void Rumble_Reset(void);
void Rumble_ClearRequests(void);
void Rumble_SetUpdateEnabled(u32 enable);
#endif