sprite.h

Go to the documentation of this file.

/*---------------------------------------------------------------------------------
 
    sprite.h -- definitions for SNES sprites
 
    Copyright (C) 2012-2025
        Alekmaul
 
    This software is provided 'as-is', without any express or implied
    warranty.  In no event will the authors be held liable for any
    damages arising from the use of this software.
 
    Permission is granted to anyone to use this software for any
    purpose, including commercial applications, and to alter it and
    redistribute it freely, subject to the following restrictions:
 
    1.  The origin of this software must not be misrepresented; you
    must not claim that you wrote the original software. If you use
    this software in a product, an acknowledgment in the product
    documentation would be appreciated but is not required.
 
    2.  Altered source versions must be plainly marked as such, and
    must not be misrepresented as being the original software.
 
    3.  This notice may not be removed or altered from any source
    distribution.
 
---------------------------------------------------------------------------------*/
#ifndef SNES_SPRITES_INCLUDE
#define SNES_SPRITES_INCLUDE
 
#include <snes/snestypes.h>
 
#define ATTR2_DISABLED (0xe8)
 
#define OBJ_SIZE8_L16 (0 << 5)  
#define OBJ_SIZE8_L32 (1 << 5)  
#define OBJ_SIZE8_L64 (2 << 5)  
#define OBJ_SIZE16_L32 (3 << 5) 
#define OBJ_SIZE16_L64 (4 << 5) 
#define OBJ_SIZE32_L64 (5 << 5) 
#define OBJ_SMALL (0)
#define OBJ_LARGE (1)
#define OBJ_SHOW (0)
#define OBJ_HIDE (1)
 
#define OBJ_SPRITE32 1 
#define OBJ_SPRITE16 2 
#define OBJ_SPRITE8 4  
#define OBJ_PAL(palofs) (palofs << 1) 
#define OBJ_FLIPX (0x40) 
#define OBJ_FLIPY (0x80) 
#define OBJ_PRIO(prio) (prio << 4) 
typedef struct
{
    s16 oamx;        
    s16 oamy;        
    u16 oamframeid;  
    u8 oamattribute; 
    u8 oamrefresh;   
    u8 *oamgraphics; 
    u16 dummy1;      
    u16 dummy2;
} t_sprites __attribute__((__packed__)); 
typedef struct
{
    s16 metsprofsx;                          
    s16 metsprofsy;                          
    u16 metsprframeid;                       
    u8 metsprattribute;                      
    u8 metsprtype;                           
    u8 *metsprgraphics;                      
    //u16 metsprend;                           /*!< 12..13 0xFFFF if it is the end of meta sprite definition */
    //u16 dummy1;                              /*!< 14..15 to be 16 aligned */
} t_metasprites __attribute__((__packed__)); 
typedef struct {
    u16 dx, dy;
    u16 dtile;
    u8 props;
    u8 unused; // to be sure to align on 16 bits
} t_metasprite;
 
#define metasprite_end -128
#define METASPR_ITEM(dx,dy,dt,a) {(dx),(dy),(dt),(a)}
#define METASPR_TERM {metasprite_end}
 
extern t_sprites oambuffer[128]; 
extern u8 oamMemory[128 * 4 + 8 * 4];
 
#define REG_OBSEL (*(vuint8 *)0x2101)
 
#define REG_OAMADDL (*(vuint8 *)0x2102)
#define REG_OAMADDH (*(vuint8 *)0x2103)
 
/*
  1st Access: Lower 8bit (even address)
  2nd Access: Upper 8bit (odd address)
*/
#define REG_OAMDATA (*(vuint8 *)0x2104) 
#define REG_RDOAM (*(vuint8 *)0x2138)   
void oamInit(void);
 
void oamUpdate(void);
 
void oamFlip(u16 id, u8 xf, u8 yf);
 
void oamSetAttr(u16 id, u16 xspr, u16 yspr, u16 gfxoffset, u8 attr);
 
#define OAM_ATTR(priority, hflip, vflip, gfxoffset, paletteoffset) ((vflip << 7) | (hflip << 6) | (priority << 4) | (paletteoffset << 1) | ((gfxoffset >> 8) & 1))
 
void oamSet(u16 id, u16 xspr, u16 yspr, u8 priority, u8 hflip, u8 vflip, u16 gfxoffset, u8 paletteoffset);
 
void oamSetXY(u16 id, u16 xspr, u16 yspr);
 
#define oamGetX(id) (oamMemory[id + 0])
 
#define oamGetY(id) (oamMemory[id + 1])
 
void oamSetGfxOffset(u16 id, u16 gfxoffset);
 
void oamSetEx(u16 id, u8 size, u8 hide);
 
void oamSetVisible(u16 id, u8 hide);
 
void oamClear(u16 first, u8 numEntries);
 
void oamInitGfxSet(u8 *tileSource, u16 tileSize, u8 *tilePalette, u16 paletteSize, u8 tilePaletteNumber, u16 address, u8 oamsize);
 
void oamInitGfxAttr(u16 address, u8 oamsize);
 
void oamInitDynamicSprite(u16 gfxsp0adr, u16 gfxsp1adr, u16 oamsp0init, u16 oamsp1init, u8 oamsize);
 
void oamInitDynamicSpriteScreen(void);
 
void oamInitDynamicSpriteEndFrame(void);
 
void oamVramQueueUpdate(void);
 
void oamDynamic32Draw(u16 id);
 
void oamFix32Draw(u16 id);
 
void oamDynamic16Draw(u16 id);
 
void oamFix16Draw(u16 id);
 
void oamDynamic8Draw(u16 id);
 
void oamFix8Draw(u16 id);
 
void oamDynamicMetaDraw(u16 id, s16 x, s16 y, u8 *sprmeta);
 
void oamMetaDrawDyn32(u16 id, s16 x,s16 y, u8 *sprmeta,u8 *gfxptr);
 
void oamMetaDraw32(u16 id, s16 x,s16 y, u8 *sprmeta, u16 ofsgfx);
 
void oamMetaDrawDyn16(u16 id, s16 x,s16 y, u8 *sprmeta,u8 *gfxptr, u16 sprsize);
 
void oamMetaDraw16(u16 id, s16 x,s16 y, u8 *sprmeta,u16 sprsize, u16 ofsgfx);
 
void oamMetaDrawDyn8(u16 id, s16 x,s16 y, u8 *sprmeta,u8 *gfxptr);
 
void oamMetaDraw8(u16 id, s16 x,s16 y, u8 *sprmeta, u16 ofsgfx);
 
#endif // SNES_SPRITES_INCLUDE