SGDK/vdp__spr_8h_source.html

#include "config.h"

#include "types.h"

#include "dma.h"


#ifndef _VDP_SPR_H_

#define _VDP_SPR_H_


#define SAT_MAX_SIZE            80


#define SPRITE_SIZE(w, h)   ((((w) - 1) << 2) | ((h) - 1))


typedef struct

{

    s16 y;  // 10 bits

    union

    {

        struct

        {

            u16 unused1  : 4;

            u16 sizeH    : 2;

            u16 sizeV    : 2;

            u16 unused2  : 1;

            u16 linkData : 7;

        };

        struct

        {

            u8 size;

            u8 link;

        };

        u16 size_link;

    };

    union

    {

        u16 attribut;

        struct

        {

            u16 priority : 1;

            u16 palette  : 2;

            u16 flipV    : 1;

            u16 flipH    : 1;

            u16 tile     : 11;

        };

    };

    s16 x;  // 10 bits

}  VDPSprite;


extern VDPSprite vdpSpriteCache[SAT_MAX_SIZE + 16];


extern VDPSprite* lastAllocatedVDPSprite;

extern s16 highestVDPSpriteIndex;


void VDP_resetSprites(void);


void VDP_releaseAllSprites(void);


s16 VDP_allocateSprites(u16 num);

void VDP_releaseSprites(u16 index, u16 num);

u16 VDP_getAvailableSprites(void);

s16 VDP_refreshHighestAllocatedSpriteIndex(void);


void VDP_clearSprites(void);

void VDP_setSpriteFull(u16 index, s16 x, s16 y, u8 size, u16 attribut, u8 link);

void VDP_setSprite(u16 index, s16 x, s16 y, u8 size, u16 attribut);

void VDP_setSpritePosition(u16 index, s16 x, s16 y);

void VDP_setSpriteSize(u16 index, u8 size);

void VDP_setSpriteAttribut(u16 index, u16 attribut);

void VDP_setSpriteLink(u16 index, u8 link);

VDPSprite* VDP_linkSprites(u16 index, u16 num);


void VDP_updateSprites(u16 num, TransferMethod tm);

void VDP_setSpritePriority(u16 index, bool priority);

bool VDP_getSpritePriority(u16 index);

void VDP_setSpritePalette(u16 index, u16 palette);

u16 VDP_getSpritePalette(u16 index);

void VDP_setSpriteFlip(u16 index, bool flipH, bool flipV);

void VDP_setSpriteFlipH(u16 index, bool flipH);

void VDP_setSpriteFlipV(u16 index, bool flipV);

bool VDP_getSpriteFlipH(u16 index);

bool VDP_getSpriteFlipV(u16 index);

void VDP_setSpriteTile(u16 index, u16 tile);

u16 VDP_getSpriteTile(u16 index);


#endif // _VDP_SPR_H_

config.h
Basic SGDK library configuration file.

dma.h
DMA support.

TransferMethod
TransferMethod
VRAM transfer method.
Definition dma.h:52

VDPSprite
VDP sprite definition structure replicating VDP hardware sprite.
Definition vdp_spr.h:66

types.h
Types definition.

s16
short s16
Definition types.h:84

u16
unsigned short u16
Definition types.h:100

u8
unsigned char u8
Definition types.h:95

VDP_setSpriteFull
void VDP_setSpriteFull(u16 index, s16 x, s16 y, u8 size, u16 attribut, u8 link)
Set a sprite (use sprite list cache).
Definition vdp_spr.c:160

VDP_setSpriteTile
void VDP_setSpriteTile(u16 index, u16 tile)
Set sprite tile index (use sprite list cache).
Definition vdp_spr.c:283

VDP_getAvailableSprites
u16 VDP_getAvailableSprites(void)
Returns the number of available VDP sprite from the SAT. WARNING: the SAT maximum size is 128 entries...
Definition vdp_spr.c:125

VDP_refreshHighestAllocatedSpriteIndex
s16 VDP_refreshHighestAllocatedSpriteIndex(void)
Compute and return the highest index of currently allocated VDP sprite.  A value of -1 mean no VDP Sp...
Definition vdp_spr.c:130

VDP_updateSprites
void VDP_updateSprites(u16 num, TransferMethod tm)
Send the cached sprite list to the VDP.
Definition vdp_spr.c:224

VDP_setSpriteFlipH
void VDP_setSpriteFlipH(u16 index, bool flipH)
Set sprite horizontal flip (use sprite list cache).
Definition vdp_spr.c:263

VDP_setSpriteLink
void VDP_setSpriteLink(u16 index, u8 link)
Set sprite link (use sprite list cache).
Definition vdp_spr.c:199

VDP_setSpriteFlipV
void VDP_setSpriteFlipV(u16 index, bool flipV)
Set sprite vertical flip (use sprite list cache).
Definition vdp_spr.c:268

VDP_setSpriteSize
void VDP_setSpriteSize(u16 index, u8 size)
Set sprite size (use sprite list cache).
Definition vdp_spr.c:189

VDP_linkSprites
VDPSprite * VDP_linkSprites(u16 index, u16 num)
Link sprites starting at the specified index.  Links are created in simple ascending order (1 --> 2 -...
Definition vdp_spr.c:204

VDP_allocateSprites
s16 VDP_allocateSprites(u16 num)
Allocate the specified number of hardware VDP sprites and link them together.
Definition vdp_spr.c:49

VDP_clearSprites
void VDP_clearSprites(void)
Clear all sprites.
Definition vdp_spr.c:151

VDP_releaseSprites
void VDP_releaseSprites(u16 index, u16 num)
Release specified number of VDP sprites.
Definition vdp_spr.c:103

VDP_getSpriteFlipV
bool VDP_getSpriteFlipV(u16 index)
Get sprite vertical flip (use sprite list cache).
Definition vdp_spr.c:278

VDP_getSpriteTile
u16 VDP_getSpriteTile(u16 index)
Get sprite tile index (use sprite list cache).
Definition vdp_spr.c:288

VDP_setSprite
void VDP_setSprite(u16 index, s16 x, s16 y, u8 size, u16 attribut)
Set a sprite (use sprite list cache).
Definition vdp_spr.c:171

VDP_setSpriteAttribut
void VDP_setSpriteAttribut(u16 index, u16 attribut)
Set sprite attributes (use sprite list cache).
Definition vdp_spr.c:194

VDP_resetSprites
void VDP_resetSprites(void)
Clear all sprites and reset VDP sprite allocation (if any).
Definition vdp_spr.c:27

SAT_MAX_SIZE
#define SAT_MAX_SIZE
Maximum size of Sprite Attribute Table (128 in VRAM but limited to 80 in VDP anyway)
Definition vdp_spr.h:22

VDP_setSpritePriority
void VDP_setSpritePriority(u16 index, bool priority)
Set sprite priority (use sprite list cache).
Definition vdp_spr.c:236

VDP_getSpritePalette
u16 VDP_getSpritePalette(u16 index)
Get sprite palette (use sprite list cache).
Definition vdp_spr.c:251

VDP_setSpriteFlip
void VDP_setSpriteFlip(u16 index, bool flipH, bool flipV)
Set sprite horizontal and vertical flip (use sprite list cache).
Definition vdp_spr.c:256

VDP_getSpritePriority
bool VDP_getSpritePriority(u16 index)
Get sprite priority (use sprite list cache).
Definition vdp_spr.c:241

VDP_getSpriteFlipH
bool VDP_getSpriteFlipH(u16 index)
Get sprite horizontal flip (use sprite list cache).
Definition vdp_spr.c:273

VDP_setSpritePalette
void VDP_setSpritePalette(u16 index, u16 palette)
Set sprite palette (use sprite list cache).
Definition vdp_spr.c:246

VDP_setSpritePosition
void VDP_setSpritePosition(u16 index, s16 x, s16 y)
Set sprite position (use sprite list cache).
Definition vdp_spr.c:181

VDP_releaseAllSprites
void VDP_releaseAllSprites(void)
Release all VDP sprite allocation.
Definition vdp_spr.c:35