mirror/oot
1
0
Fork 0
mirror of https://github.com/zeldaret/oot synced 2026-08-13 04:09:38 -04:00
Code Issues Packages Projects Releases Wiki Activity

Rumble doc (#1375)

Browse Source 
* Rumble doc

* Fixes, suggested changes

* Improve padmgr retrace callback related code

* Name some rumble-adjacent things, further suggested changes

* Further suggested changes

* Suggested changes
This commit is contained in:
Tharo
2022-09-27 17:40:26 +01:00
committed by GitHub
parent 82e04ede5f
commit 4f65d08eb5
59 changed files with 533 additions and 393 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/functions.h
-12
View File
@@ -1288,15 +1288,6 @@ void SsSram_Init(u32 addr, u8 handleType, u8 handleDomain, u8 handleLatency, u8
u8 handlePulse, u32 handleSpeed);
void SsSram_Dma(void* dramAddr, size_t size, s32 direction);
void SsSram_ReadWrite(u32 addr, void* dramAddr, size_t size, s32 direction);
void func_800A9F30(PadMgr*, s32);
void func_800A9F6C(f32, u8, u8, u8);
void func_800AA000(f32, u8, u8, u8);
void func_800AA0B4(void);
void func_800AA0F0(void);
u32 func_800AA148(void);
void func_800AA15C(void);
void func_800AA16C(void);
void func_800AA178(u32);
View* View_New(GraphicsContext* gfxCtx);
void View_Free(View* view);
void View_Init(View*, GraphicsContext*);
@@ -1693,9 +1684,6 @@ u64* SysUcode_GetUCodeBoot(void);
size_t SysUcode_GetUCodeBootSize(void);
u64* SysUcode_GetUCode(void);
u64* SysUcode_GetUCodeData(void);
void func_800D2E30(UnkRumbleStruct* arg0);
void func_800D3140(UnkRumbleStruct* arg0);
void func_800D3178(UnkRumbleStruct* arg0);
void func_800D31A0(void);
void func_800D31F0(void);
void func_800D3210(void);
include/padmgr.h
+34 -2
View File
@@ -40,8 +40,8 @@ typedef struct PadMgr {
/* 0x045C */ vu8 rumbleOffTimer; // amount of VI retraces to not rumble for, takes priority over rumbleOnTimer
/* 0x045D */ vu8 rumbleOnTimer; // amount of VI retraces to rumble for
/* 0x045E */ u8 isResetting;
/* 0x0460 */ void (*retraceCallback)(struct PadMgr* padMgr, s32 arg);
/* 0x0464 */ s32 retraceCallbackValue;
/* 0x0460 */ void (*retraceCallback)(struct PadMgr* padMgr, void* arg);
/* 0x0464 */ void* retraceCallbackArg;
} PadMgr; // size = 0x468
extern PadMgr gPadMgr;
@@ -70,4 +70,36 @@ void PadMgr_RumbleReset(PadMgr* padMgr);
void PadMgr_RumbleSetSingle(PadMgr* padMgr, u32 port, u32 rumble);
void PadMgr_RumbleSet(PadMgr* padMgr, u8* enable);
// Retrace callback
/**
* Sets the padmgr retrace callback that runs while waiting for controller input. The callback may be passed a single
* user-provided argument. The callback function should be `void (*)(PadMgr*, void*)`.
*
* @param callback callback to run before rumble state is updated for the current VI
* @param arg the argument to pass to the calback
*
* @see PADMGR_UNSET_RETRACE_CALLACK
*/
#define PADMGR_SET_RETRACE_CALLACK(padmgr, callback, arg) \
do { \
(padmgr)->retraceCallback = (callback); \
(padmgr)->retraceCallbackArg = (arg); \
} while (0)
/**
* Unsets the current padmgr retrace callback if it and the argument are the same as the ones already registered.
*
* @param callback the callback to unset, if it is set
* @param arg the argument to unset, if it is set
*
* @see PADMGR_SET_RETRACE_CALLACK
*/
#define PADMGR_UNSET_RETRACE_CALLACK(padmgr, callback, arg) \
if ((padmgr)->retraceCallback == (callback) && (padmgr)->retraceCallbackArg == (arg)) { \
(padmgr)->retraceCallback = NULL; \
(padmgr)->retraceCallbackArg = NULL; \
} \
(void)0
#endif
include/regs.h
+3
View File
@@ -171,6 +171,9 @@
#define R_ITEM_AMMO_Y(i) VREG(68 + (i))
#define R_ITEM_ICON_WIDTH(i) VREG(76 + (i))
#define R_ITEM_BTN_WIDTH(i) VREG(80 + (i))
#define R_GAME_OVER_RUMBLE_STRENGTH VREG(90)
#define R_GAME_OVER_RUMBLE_DURATION VREG(91)
#define R_GAME_OVER_RUMBLE_DECREASE_RATE VREG(92)
#define R_DISABLE_INPUT_DISPLAY HREG(47)
#define R_ENABLE_PLAY_LOGS HREG(63)
#define R_EN_GOROIWA_SPEED mREG(12)
include/rumble.h
+51
View File
@@ -0,0 +1,51 @@
#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
include/z64.h
+1 -16
View File
@@ -36,6 +36,7 @@
#include "padmgr.h"
#include "fault.h"
#include "sched.h"
#include "rumble.h"
#define SCREEN_WIDTH 320
#define SCREEN_HEIGHT 240
@@ -1813,22 +1814,6 @@ typedef struct {
/* 0x08 */ Color_RGBA8_u32 envColor;
} struct_80166500; // size = 0x10
typedef struct {
/* 0x000 */ u8 rumbleEnable[4];
/* 0x004 */ u8 unk_04[0x40];
/* 0x044 */ u8 unk_44[0x40];
/* 0x084 */ u8 unk_84[0x40];
/* 0x0C4 */ u8 unk_C4[0x40];
/* 0x104 */ u8 unk_104;
/* 0x105 */ u8 unk_105;
/* 0x106 */ u16 unk_106;
/* 0x108 */ u16 unk_108;
/* 0x10A */ u8 unk_10A;
/* 0x10B */ u8 unk_10B;
/* 0x10C */ u8 unk_10C;
/* 0x10D */ u8 unk_10D;
} UnkRumbleStruct; // size = 0x10E
typedef struct {
/* 0x00 */ char unk_00[0x18];
/* 0x18 */ s32 unk_18;