2ship2harkinian/mm/include/gfx.h
Archez 48f197c049 Better GFX debugging control and fix accidental opcode overwrites (#132)
* implement better gfx command debugging

* revert xlu crash fix back to source
2024-05-22 09:04:59 -05:00

311 lines
13 KiB
C

#ifndef GFX_H
#define GFX_H
#include "ultra64.h"
#include "PR/os_sched.h"
#include "thga.h"
#include "alignment.h"
#include "unk.h"
struct GameState;
#define TMEM_SIZE 0x1000
typedef enum SetupDL {
/* 0x00 */ SETUPDL_0,
/* 0x01 */ SETUPDL_1,
/* 0x02 */ SETUPDL_2,
/* 0x03 */ SETUPDL_3,
/* 0x04 */ SETUPDL_4,
/* 0x05 */ SETUPDL_5,
/* 0x06 */ SETUPDL_6,
/* 0x07 */ SETUPDL_7,
/* 0x08 */ SETUPDL_8,
/* 0x09 */ SETUPDL_9,
/* 0x0A */ SETUPDL_10,
/* 0x0B */ SETUPDL_11,
/* 0x0C */ SETUPDL_12,
/* 0x0D */ SETUPDL_13,
/* 0x0E */ SETUPDL_14,
/* 0x0F */ SETUPDL_15,
/* 0x10 */ SETUPDL_16,
/* 0x11 */ SETUPDL_17,
/* 0x12 */ SETUPDL_18,
/* 0x13 */ SETUPDL_19,
/* 0x14 */ SETUPDL_20,
/* 0x15 */ SETUPDL_21,
/* 0x16 */ SETUPDL_22,
/* 0x17 */ SETUPDL_23,
/* 0x18 */ SETUPDL_24,
/* 0x19 */ SETUPDL_25,
/* 0x1A */ SETUPDL_26,
/* 0x1B */ SETUPDL_27,
/* 0x1C */ SETUPDL_28,
/* 0x1D */ SETUPDL_29,
/* 0x1E */ SETUPDL_30,
/* 0x1F */ SETUPDL_31,
/* 0x20 */ SETUPDL_32,
/* 0x21 */ SETUPDL_33,
/* 0x22 */ SETUPDL_34,
/* 0x23 */ SETUPDL_35,
/* 0x24 */ SETUPDL_36,
/* 0x25 */ SETUPDL_37,
/* 0x26 */ SETUPDL_38,
/* 0x27 */ SETUPDL_39,
/* 0x28 */ SETUPDL_40,
/* 0x29 */ SETUPDL_41,
/* 0x2A */ SETUPDL_42,
/* 0x2B */ SETUPDL_43,
/* 0x2C */ SETUPDL_44,
/* 0x2D */ SETUPDL_45,
/* 0x2E */ SETUPDL_46,
/* 0x2F */ SETUPDL_47,
/* 0x30 */ SETUPDL_48,
/* 0x31 */ SETUPDL_49,
/* 0x32 */ SETUPDL_50,
/* 0x33 */ SETUPDL_51,
/* 0x34 */ SETUPDL_52,
/* 0x35 */ SETUPDL_53,
/* 0x36 */ SETUPDL_54,
/* 0x37 */ SETUPDL_55,
/* 0x38 */ SETUPDL_56,
/* 0x39 */ SETUPDL_57,
/* 0x3A */ SETUPDL_58,
/* 0x3B */ SETUPDL_59,
/* 0x3C */ SETUPDL_60,
/* 0x3D */ SETUPDL_61,
/* 0x3E */ SETUPDL_62,
/* 0x3F */ SETUPDL_63,
/* 0x40 */ SETUPDL_64,
/* 0x41 */ SETUPDL_65,
/* 0x42 */ SETUPDL_66,
/* 0x43 */ SETUPDL_67,
/* 0x44 */ SETUPDL_68,
/* 0x45 */ SETUPDL_69,
/* 0x46 */ SETUPDL_70,
/* 0x47 */ SETUPDL_71,
/* 0x48 */ SETUPDL_72,
/* 0x49 */ SETUPDL_MAX
} SetupDL;
typedef struct {
/* 0x000 */ Gfx taskStart[9];
/* 0x048 */ Gfx clearZBuffer[8]; // original name: clear_zb_dl
/* 0x088 */ Gfx clearFrameBuffer[5]; // original name: clear_fb_dl
/* 0x0B0 */ Gfx setupBuffers[6]; // setup framebuffer and zbuffer
/* 0x0E0 */ Gfx unk_E0[12]; // unused
/* 0x140 */ Gfx syncSegments[17];
/* 0x1C8 */ Gfx setScissor[2];
/* 0x1D8 */ Gfx unk_1D8[25]; // unused
/* 0x2A0 */ Gfx disps[5];
// #region 2S2H [Cosmetic] clearFillRect and fillRect increased to 4 instructions to account for gDPFillWideRectangle
/* 0x2C8 */ Gfx clearFillRect[4]; // fillrect for clearing buffers
/* 0x2E0 */ Gfx fillRect[4]; // fillrect for general purpose
// #endregion
/* 0x2F8 */ Gfx debugDisp[1];
} GfxMasterList; // size = 0x300
#define GFXPOOL_HEAD_MAGIC 0x1234
#define GFXPOOL_TAIL_MAGIC 0x5678
typedef struct GfxPool {
/* 0x00000 */ u16 headMagic; // GFXPOOL_HEAD_MAGIC
/* 0x00008 */ GfxMasterList master;
// #region 2S2H [Port] Doubled the size of the dlist buffers to account for additional instructions,
// and the fact that DLists that reference OTR resources are effectively doubled in size.
/* 0x00308 */ Gfx polyXluBuffer[0x1000];
/* 0x04308 */ Gfx overlayBuffer[0x800];
/* 0x06308 */ Gfx workBuffer[0x80];
/* 0x06508 */ Gfx debugBuffer[0x80];
/* 0x06708 */ Gfx polyOpaBuffer[0x6700];
// #endregion
/* 0x20308 */ u16 tailMagic; // GFXPOOL_TAIL_MAGIC
} GfxPool; // size = 0x20310
typedef struct GraphicsContext {
/* 0x000 */ Gfx* polyOpaBuffer; // Pointer to "Zelda 0"
/* 0x004 */ Gfx* polyXluBuffer; // Pointer to "Zelda 1"
/* 0x008 */ char unk_8[0x8]; // Unused, could this be pointers to "Zelda 2" / "Zelda 3"
/* 0x010 */ Gfx* overlayBuffer; // Pointer to "Zelda 4"
/* 0x014 */ u32 unk_14;
/* 0x018 */ char unk_18[0x20];
/* 0x038 */ OSMesg msgBuff[8];
/* 0x058 */ OSMesgQueue* schedMsgQ;
/* 0x05C */ OSMesgQueue queue;
/* 0x074 */ char unk_74[0x04];
/* 0x078 */ OSScTask task;
/* 0x0D0 */ char unk_D0[0xD0];
/* 0x1A0 */ Gfx* workBuffer;
/* 0x1A4 */ TwoHeadGfxArena work;
/* 0x1B4 */ Gfx* debugBuffer;
/* 0x1B8 */ TwoHeadGfxArena debug;
/* 0x1C8 */ UNK_TYPE1 unk_1C8[0xAC];
/* 0x274 */ OSViMode* viMode;
/* 0x278 */ void* zbuffer;
/* 0x27C */ char unk_27C[0x1C];
/* 0x298 */ TwoHeadGfxArena overlay; // "Zelda 4"
/* 0x2A8 */ TwoHeadGfxArena polyOpa; // "Zelda 0"
/* 0x2B8 */ TwoHeadGfxArena polyXlu; // "Zelda 1"
/* 0x2C8 */ u32 gfxPoolIdx;
/* 0x2CC */ u16* curFrameBuffer;
/* 0x2D0 */ char unk_2D0[0x4];
/* 0x2D4 */ u32 viConfigFeatures;
/* 0x2D8 */ char unk_2D8[0x2];
/* 0x2DA */ u8 updateViMode;
/* 0x2DB */ u8 framebufferIndex;
/* 0x2DC */ void (*callback)(struct GraphicsContext*, void*);
/* 0x2E0 */ void* callbackArg;
/* 0x2E4 */ f32 xScale;
/* 0x2E8 */ f32 yScale;
/* 0x2EC */ GfxMasterList* masterList;
} GraphicsContext; // size = 0x2F0
Gfx* Gfx_SetFog(Gfx* gfx, s32 r, s32 g, s32 b, s32 a, s32 n, s32 f);
Gfx* Gfx_SetFogWithSync(Gfx* gfx, s32 r, s32 g, s32 b, s32 a, s32 n, s32 f);
Gfx* Gfx_SetFog2(Gfx* gfx, s32 r, s32 g, s32 b, s32 a, s32 n, s32 f);
Gfx* Gfx_SetupDLImpl(Gfx* gfx, u32 i);
Gfx* Gfx_SetupDL(Gfx* gfx, u32 i);
void Gfx_SetupDLAtPtr(Gfx** gfxp, u32 i);
Gfx* Gfx_SetupDL57(Gfx* gfx);
Gfx* Gfx_SetupDL57_b(Gfx* gfx);
Gfx* Gfx_SetupDL52_NoCD(Gfx* gfx);
void Gfx_SetupDL58_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL57_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL50_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL51_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL52_Xlu(GraphicsContext* gfxCtx);
void Gfx_SetupDL53_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL54_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL55_Xlu(GraphicsContext* gfxCtx);
Gfx* Gfx_SetupDL26(Gfx* gfx);
void Gfx_SetupDL26_Opa(GraphicsContext* gfxCtx);
Gfx* Gfx_SetupDL23(Gfx* gfx);
void Gfx_SetupDL23_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL25_Xlu2(GraphicsContext* gfxCtx);
void func_8012C268(struct GameState* gameState);
void Gfx_SetupDL25_Opa(GraphicsContext* gfxCtx);
Gfx* Gfx_SetupDL71(Gfx* gfx);
void Gfx_SetupDL25_Xlu(GraphicsContext* gfxCtx);
Gfx* Gfx_SetupDL72(Gfx* gfx);
void Gfx_SetupDL31_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL32_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL33_Opa(GraphicsContext* gfxCtx);
Gfx* Gfx_SetupDL64(Gfx* gfx);
Gfx* Gfx_SetupDL34(Gfx* gfx);
void Gfx_SetupDL34_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL35_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL44_Xlu(GraphicsContext* gfxCtx);
void Gfx_SetupDL36_Opa(GraphicsContext* gfxCtx);
Gfx* Gfx_SetupDL28(Gfx* gfx);
void Gfx_SetupDL28_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL43_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL45_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL46_Overlay(GraphicsContext* gfxCtx);
void Gfx_SetupDL38_Xlu(GraphicsContext* gfxCtx);
void Gfx_SetupDL4_Xlu(GraphicsContext* gfxCtx);
void Gfx_SetupDL37_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL2_Opa(GraphicsContext* gfxCtx);
Gfx* Gfx_SetupDL39(Gfx* gfx);
void Gfx_SetupDL39_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL39_Overlay(GraphicsContext* gfxCtx);
void Gfx_SetupDL39_Ptr(Gfx** gfxp);
void Gfx_SetupDL40_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL41_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL47_Xlu(GraphicsContext* gfxCtx);
Gfx* Gfx_SetupDL66(Gfx* gfx);
Gfx* Gfx_SetupDL67(Gfx* gfx);
Gfx* Gfx_SetupDL68_NoCD(Gfx* gfx);
Gfx* Gfx_SetupDL69_NoCD(Gfx* gfx);
Gfx* Gfx_SetupDL65_NoCD(Gfx* gfx);
Gfx* Gfx_SetupDL70(Gfx* gfx);
Gfx* Gfx_SetupDL20_NoCD(Gfx* gfx);
void Gfx_SetupDL42_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL42_Overlay(GraphicsContext* gfxCtx);
void Gfx_SetupDL48_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL49_Xlu(GraphicsContext* gfxCtx);
void Gfx_SetupDL27_Xlu(GraphicsContext* gfxCtx);
void Gfx_SetupDL60_XluNoCD(GraphicsContext* gfxCtx);
void Gfx_SetupDL61_Xlu(GraphicsContext* gfxCtx);
void Gfx_SetupDL56_Opa(GraphicsContext* gfxCtx);
void Gfx_SetupDL56_Ptr(Gfx** gfxp);
void Gfx_SetupDL59_Opa(GraphicsContext* gfxCtx);
Gfx* Gfx_BranchTexScroll(Gfx** gfxp, u32 x, u32 y, s32 width, s32 height);
void func_8012CB04(Gfx** gfxp, u32 x, u32 y);
Gfx* func_8012CB28(GraphicsContext* gfxCtx, u32 x, u32 y);
Gfx* Gfx_TexScroll(GraphicsContext* gfxCtx, u32 x, u32 y, s32 width, s32 height);
Gfx* Gfx_TwoTexScroll(GraphicsContext* gfxCtx, s32 tile1, u32 x1, u32 y1, s32 width1, s32 height1, s32 tile2, u32 x2,
u32 y2, s32 width2, s32 height2);
Gfx* Gfx_TwoTexScrollEnvColor(GraphicsContext* gfxCtx, s32 tile1, u32 x1, u32 y1, s32 width1, s32 height1, s32 tile2,
u32 x2, u32 y2, s32 width2, s32 height2, s32 r, s32 g, s32 b, s32 a);
Gfx* Gfx_EnvColor(GraphicsContext* gfxCtx, s32 r, s32 g, s32 b, s32 a);
Gfx* Gfx_PrimColor(GraphicsContext* gfxCtx, s32 lodfrac, s32 r, s32 g, s32 b, s32 a);
void func_8012CF0C(GraphicsContext* gfxCtx, s32 clearFb, s32 clearZb, u8 r, u8 g, u8 b);
void func_8012D374(GraphicsContext* gfxCtx, u8 r, u8 g, u8 b);
void func_8012D40C(f32* param_1, f32* param_2, s16* param_3);
void gSPSegment(void* value, int segNum, uintptr_t target);
void gSPSegmentLoadRes(void* value, int segNum, uintptr_t target);
void gDPSetTextureImage(Gfx* pkt, u32 format, u32 size, u32 width, uintptr_t i);
void gDPSetTextureImageFB(Gfx* pkt, u32 format, u32 size, u32 width, int fb);
void gSPDisplayList(Gfx* pkt, Gfx* dl);
void gSPDisplayListOffset(Gfx* pkt, Gfx* dl, int offset);
void gSPVertex(Gfx* pkt, uintptr_t v, int n, int v0);
void gSPInvalidateTexCache(Gfx* pkt, uintptr_t texAddr);
extern Gfx gSetupDLs[SETUPDL_MAX][6];
extern Gfx gEmptyDL[];
#define WORK_DISP __gfxCtx->work.p
#define POLY_OPA_DISP __gfxCtx->polyOpa.p
#define POLY_XLU_DISP __gfxCtx->polyXlu.p
#define OVERLAY_DISP __gfxCtx->overlay.p
#define DEBUG_DISP __gfxCtx->debug.p
// __gfxCtx shouldn't be used directly.
// Use the DISP macros defined above when writing to display buffers.
// 2S2H [Port] Augmented to provide debug information and support interpolation
#define OPEN_DISPS(gfxCtx) \
{ \
void FrameInterpolation_RecordOpenChild(const void* a, int b); \
FrameInterpolation_RecordOpenChild(__FILE__, __LINE__); \
GraphicsContext* __gfxCtx = gfxCtx; \
Gfx* __dispRefs[3]; \
Gfx __dispVals[3]; \
Graph_OpenDisps(__dispRefs, __dispVals, gfxCtx, __FILE__, __LINE__)
#define CLOSE_DISPS(gfxCtx) \
(void)0; \
void FrameInterpolation_RecordCloseChild(void); \
FrameInterpolation_RecordCloseChild(); \
Graph_CloseDisps(__dispRefs, __dispVals, gfxCtx, __FILE__, __LINE__); \
} \
(void)0
#define GRAPH_ALLOC(gfxCtx, size) ((void*)((gfxCtx)->polyOpa.d = (Gfx*)((u8*)(gfxCtx)->polyOpa.d - ALIGN16(size))))
// Custom gbi macro
#define gDPSetTileCustom(pkt, fmt, siz, width, height, pal, cms, cmt, masks, maskt, shifts, shiftt) \
{ \
gDPPipeSync(pkt); \
gDPTileSync(pkt); \
gDPSetTile(pkt, fmt, siz, (((width)*siz##_TILE_BYTES) + 7) >> 3, 0, G_TX_LOADTILE, 0, cmt, maskt, shiftt, cms, \
masks, shifts); \
gDPTileSync(pkt); \
gDPSetTile(pkt, fmt, siz, (((width)*siz##_TILE_BYTES) + 7) >> 3, 0, G_TX_RENDERTILE, pal, cmt, maskt, shiftt, \
cms, masks, shifts); \
gDPSetTileSize(pkt, G_TX_RENDERTILE, 0, 0, ((width)-1) << G_TEXTURE_IMAGE_FRAC, \
((height)-1) << G_TEXTURE_IMAGE_FRAC); \
} \
(void)0
// used only by code_80140E80
#define gDPSetLODColor(pkt, c, m, l, d) \
_DW({ \
Gfx* _g = (Gfx*)(pkt); \
\
_g->words.w0 = (_SHIFTL(c, 24, 8) | _SHIFTL(m, 8, 8) | _SHIFTL(l, 0, 8)); \
_g->words.w1 = (unsigned int)(d); \
})
#endif