object.h

Go to the documentation of this file.

 
#ifndef OPENSNES_OBJECT_H
#define OPENSNES_OBJECT_H
 
#include <snes/types.h>
 
/*============================================================================
 * Constants
 *============================================================================*/
 
#define OB_MAX              80
 
#define OB_TYPE_MAX         64
 
#define OB_SIZE             64
 
/*============================================================================
 * Object Structure (64 bytes, packed)
 *============================================================================*/
 
typedef struct {
    u16 prev;           
    u16 next;           
    u8 type;            
    u8 nID;             
    u16 sprnum;         
    u16 sprid3216;      
    u16 sprblk3216;     
    u8 sprflip;         
    u8 sprpal;          
    u16 sprframe;       
    u8 xpos[3];         
    u8 ypos[3];         
    u16 xofs;           
    u16 yofs;           
    u16 width;          
    u16 height;         
    u16 xmin;           
    u16 xmax;           
    s16 xvel;           
    s16 yvel;           
    u16 tilestand;      
    u16 tileabove;      
    u16 tilesprop;      
    u16 tilebprop;      
    u16 action;         
    u8 status;          
    u8 tempo;           
    u8 count;           
    u8 dir;             
    u16 parentID;       
    u8 hitpoints;       
    u8 sprrefresh;      
    u8 onscreen;        
    u8 objnotused[7];   
} t_objs;
 
/*============================================================================
 * Compile-time struct layout assertions
 * Must match the .STRUCT t_objs in object.asm exactly.
 *============================================================================*/
 
_Static_assert(sizeof(t_objs) == 64, "t_objs must be 64 bytes");
_Static_assert(__builtin_offsetof(t_objs, xpos) == 16, "xpos offset mismatch");
_Static_assert(__builtin_offsetof(t_objs, ypos) == 19, "ypos offset mismatch");
_Static_assert(__builtin_offsetof(t_objs, xvel) == 34, "xvel offset mismatch");
_Static_assert(__builtin_offsetof(t_objs, yvel) == 36, "yvel offset mismatch");
_Static_assert(__builtin_offsetof(t_objs, action) == 46, "action offset mismatch");
_Static_assert(__builtin_offsetof(t_objs, type) == 4, "type offset mismatch");
_Static_assert(__builtin_offsetof(t_objs, width) == 26, "width offset mismatch");
_Static_assert(__builtin_offsetof(t_objs, height) == 28, "height offset mismatch");
_Static_assert(__builtin_offsetof(t_objs, status) == 48, "status offset mismatch");
_Static_assert(__builtin_offsetof(t_objs, onscreen) == 56, "onscreen offset mismatch");
 
/*============================================================================
 * Exported Variables
 *============================================================================*/
 
/* --- Bank $00 SLOT 1 (C-accessible, < $2000) --- */
 
extern t_objs objWorkspace;
 
extern u16 objptr;
 
extern u8 objtokill;
 
extern u16 objgetid;
 
/* --- Bank $7E SLOT 2 (NOT C-accessible, ASM-only) --- */
/* The actual object buffer array lives in Bank $7E:
 *   objbuffers[OB_MAX]  — 80 x 64 = 5120 bytes
 *   objfctinit/upd/ref  — function pointer tables (256 bytes each)
 * Access these ONLY through the workspace pattern:
 *   objGetPointer(handle) copies objbuffers[N] → objWorkspace
 *   Engine functions copy objWorkspace → objbuffers[N] after callbacks
 */
 
/*============================================================================
 * Functions
 *============================================================================*/
 
void objInitEngine(void);
 
void objInitGravity(u16 objgravity, u16 objfriction);
 
void objInitFunctions(u8 objtype, void *initfct, void *updfct, void *reffct);
 
u16 objNew(u8 objtype, u16 x, u16 y);
 
void objGetPointer(u16 objhandle);
 
void objKill(u16 objhandle);
 
void objKillAll(void);
 
void objLoadObjects(u8 *sourceO);
 
void objUpdateAll(void);
 
void objRefreshAll(void);
 
void objCollidMap(u16 objhandle);
 
void objCollidMapWithSlopes(u16 objhandle);
 
void objCollidMap1D(u16 objhandle);
 
u16 objCollidObj(u16 objhandle1, u16 objhandle2);
 
void objUpdateXY(u16 objindex);
 
#endif /* OPENSNES_OBJECT_H */