SGDK/vdp_8h_source.html

#ifndef _VDP_H_

#define _VDP_H_


#define VDP_DATA_PORT           0xC00000

#define VDP_CTRL_PORT           0xC00004

#define VDP_HVCOUNTER_PORT      0xC00008


#define GFX_DATA_PORT           _Pragma("GCC error \"This definition is deprecated, use VDP_DATA_PORT instead.\"")


#define GFX_CTRL_PORT           _Pragma("GCC error \"This definition is deprecated, use VDP_CTRL_PORT instead.\"")

#define GFX_HVCOUNTER_PORT      _Pragma("GCC error \"This definition is deprecated, use VDP_HVCOUNTER_PORT instead.\"")


#define VDP_FIFOEMPTY_FLAG      (1 << 9)

#define VDP_FIFOFULL_FLAG       (1 << 8)

#define VDP_VINTPENDING_FLAG    (1 << 7)

#define VDP_SPROVERFLOW_FLAG    (1 << 6)

#define VDP_SPRCOLLISION_FLAG   (1 << 5)

#define VDP_ODDFRAME_FLAG       (1 << 4)

#define VDP_VBLANK_FLAG         (1 << 3)

#define VDP_HBLANK_FLAG         (1 << 2)

#define VDP_DMABUSY_FLAG        (1 << 1)

#define VDP_PALMODE_FLAG        (1 << 0)


#define VDP_PLAN_A              _Pragma("GCC error \"This definition is deprecated, use VDP_BG_A instead.\"")

#define VDP_PLAN_B              _Pragma("GCC error \"This definition is deprecated, use VDP_BG_B instead.\"")

#define VDP_PLAN_WINDOW         _Pragma("GCC error \"This definition is deprecated, use VDP_WINDOW instead.\"")


#define VDP_BG_A                bga_addr

#define VDP_BG_B                bgb_addr

#define VDP_WINDOW              window_addr

#define VDP_HSCROLL_TABLE       hscrl_addr

#define VDP_SPRITE_TABLE        slist_addr

#define VDP_MAPS_START          maps_addr


#define HSCROLL_PLANE           0

#define HSCROLL_TILE            2

#define HSCROLL_LINE            3


#define VSCROLL_PLANE           0

#define VSCROLL_COLUMN          1

#define VSCROLL_2TILE           _Pragma("GCC error \"This definition is deprecated, use VSCROLL_COLUMN instead.\"")


#define INTERLACED_NONE         0

#define INTERLACED_MODE1        1

#define INTERLACED_MODE2        2


#define FONT_LEN    96


#define TILE_SIZE               32

#define TILE_INDEX_MASK         (0xFFFF / TILE_SIZE)


#define TILE_SPACE              VDP_MAPS_START


#define TILE_MAX_NUM            (TILE_SPACE / TILE_SIZE)

#define TILE_MAX_INDEX          (TILE_MAXNUM - 1)

#define TILE_SYSTEM_INDEX       0x0000

#define TILE_SYSTEM_LENGTH      16

#define TILE_USER_INDEX         (TILE_SYSTEM_INDEX + TILE_SYSTEM_LENGTH)

#define TILE_FONT_INDEX         (TILE_MAX_NUM - FONT_LEN)

#define TILE_SPRITE_INDEX       (TILE_FONT_INDEX - spriteVramSize)

#define TILE_USER_LENGTH        ((userTileMaxIndex - TILE_USER_INDEX) + 1)

#define TILE_USER_MAX_INDEX     userTileMaxIndex


#define TILE_MAXNUM             _Pragma("GCC error \"This definition is deprecated, use TILE_MAX_NUM instead.\"")

#define TILE_MAXINDEX           _Pragma("GCC error \"This definition is deprecated, use TILE_MAX_INDEX instead.\"")

#define TILE_SYSTEM_LENGHT      _Pragma("GCC error \"This definition is deprecated, use TILE_SYSTEM_LENGTH instead.\"")

#define TILE_SYSTEMLENGTH       _Pragma("GCC error \"This definition is deprecated, use TILE_SYSTEM_LENGTH instead.\"")

#define TILE_SYSTEMINDEX        _Pragma("GCC error \"This definition is deprecated, use TILE_SYSTEM_INDEX instead.\"")

#define TILE_USERINDEX          _Pragma("GCC error \"This definition is deprecated, use TILE_USER_INDEX instead.\"")

#define TILE_FONTINDEX          _Pragma("GCC error \"This definition is deprecated, use TILE_FONT_INDEX instead.\"")

#define TILE_SPRITEINDEX        _Pragma("GCC error \"This definition is deprecated, use TILE_SPRITE_INDEX instead.\"")

#define TILE_USERLENGTH         _Pragma("GCC error \"This definition is deprecated, use TILE_USER_LENGTH instead.\"")

#define TILE_USERMAXINDEX       _Pragma("GCC error \"This definition is deprecated, use TILE_USER_MAX_INDEX instead.\"")


#define TILE_SYSTEM             (TILE_SYSTEM_INDEX * TILE_SIZE)

#define TILE_USER               (TILE_USER_INDEX * TILE_SIZE)

#define TILE_FONT               (TILE_FONT_INDEX * TILE_SIZE)


#define PAL0                    0

#define PAL1                    1

#define PAL2                    2

#define PAL3                    3


#define VDP_READ_VRAM_ADDR(adr)     (((0x0000 + ((adr) & 0x3FFF)) << 16) + (((adr) >> 14) | 0x00))

#define VDP_READ_CRAM_ADDR(adr)     (((0x0000 + ((adr) & 0x7F)) << 16) + 0x20)

#define VDP_READ_VSRAM_ADDR(adr)    (((0x0000 + ((adr) & 0x7F)) << 16) + 0x10)


#define VDP_WRITE_VRAM_ADDR(adr)    (((0x4000 + ((adr) & 0x3FFF)) << 16) + (((adr) >> 14) | 0x00))

#define VDP_WRITE_CRAM_ADDR(adr)    (((0xC000 + ((adr) & 0x7F)) << 16) + 0x00)

#define VDP_WRITE_VSRAM_ADDR(adr)   (((0x4000 + ((adr) & 0x7F)) << 16) + 0x10)


#define VDP_DMA_VRAM_ADDR(adr)      (((0x4000 + ((adr) & 0x3FFF)) << 16) + (((adr) >> 14) | 0x80))

#define VDP_DMA_CRAM_ADDR(adr)      (((0xC000 + ((adr) & 0x7F)) << 16) + 0x80)

#define VDP_DMA_VSRAM_ADDR(adr)     (((0x4000 + ((adr) & 0x7F)) << 16) + 0x90)


#define VDP_DMA_VRAMCOPY_ADDR(adr)  (((0x4000 + ((adr) & 0x3FFF)) << 16) + (((adr) >> 14) | 0xC0))


#define VDP_VERT_SCROLL(adr)        VDP_WRITE_VSRAM_ADDR(adr)

#define VDP_HORZ_SCROLL(adr)        VDP_WRITE_VRAM_ADDR(VDP_SCROLL_H + (adr))


#define GFX_READ_VRAM_ADDR(adr)     _Pragma("GCC error \"This definition is deprecated, use VDP_READ_VRAM_ADDR instead.\""))

#define GFX_READ_CRAM_ADDR(adr)     _Pragma("GCC error \"This definition is deprecated, use VDP_READ_CRAM_ADDR instead.\"")

#define GFX_READ_VSRAM_ADDR(adr)    _Pragma("GCC error \"This definition is deprecated, use VDP_READ_VSRAM_ADDR instead.\"")

#define GFX_WRITE_VRAM_ADDR(adr)    _Pragma("GCC error \"This definition is deprecated, use VDP_WRITE_VRAM_ADDR instead.\"")

#define GFX_WRITE_CRAM_ADDR(adr)    _Pragma("GCC error \"This definition is deprecated, use VDP_WRITE_CRAM_ADDR instead.\"")

#define GFX_WRITE_VSRAM_ADDR(adr)   _Pragma("GCC error \"This definition is deprecated, use VDP_WRITE_VSRAM_ADDR instead.\"")

#define GFX_DMA_VRAM_ADDR(adr)      _Pragma("GCC error \"This definition is deprecated, use VDP_DMA_VRAM_ADDR instead.\"")

#define GFX_DMA_CRAM_ADDR(adr)      _Pragma("GCC error \"This definition is deprecated, use VDP_DMA_CRAM_ADDR instead.\"")

#define GFX_DMA_VSRAM_ADDR(adr)     _Pragma("GCC error \"This definition is deprecated, use VDP_DMA_VSRAM_ADDR instead.\"")

#define GFX_DMA_VRAMCOPY_ADDR(adr)  _Pragma("GCC error \"This definition is deprecated, use VDP_DMA_VRAMCOPY_ADDR instead.\"")

#define GFX_VERT_SCROLL(adr)        _Pragma("GCC error \"This definition is deprecated, use VDP_VERT_SCROLL instead.\"")

#define GFX_HORZ_SCROLL(adr)        _Pragma("GCC error \"This definition is deprecated, use VDP_HORZ_SCROLL instead.\"")


#define GET_VDP_STATUS(flag)         ((*(vu16*)(VDP_CTRL_PORT)) & (flag))

#define IS_PAL_SYSTEM                GET_VDP_STATUS(VDP_PALMODE_FLAG)


#define GET_HVCOUNTER               (*(vu16*)(VDP_HVCOUNTER_PORT))

#define GET_HCOUNTER                (GET_HVCOUNTER & 0xFF)

#define GET_VCOUNTER                (GET_HVCOUNTER >> 8)


typedef enum

{

    BG_A = 0, BG_B = 1, WINDOW = 2

} VDPPlane;


// used by define

extern u16 window_addr;

extern u16 bga_addr;

extern u16 bgb_addr;

extern u16 hscrl_addr;

extern u16 slist_addr;

extern u16 maps_addr;

extern u16 userTileMaxIndex;


extern u16 screenWidth;

extern u16 screenHeight;

extern u16 planeWidth;

extern u16 planeHeight;

extern u16 windowWidth;

extern u16 planeWidthSft;

extern u16 planeHeightSft;

extern u16 windowWidthSft;


void VDP_init(void);


void VDP_resetScreen(void);


u8   VDP_getReg(u16 reg);

void VDP_setReg(u16 reg, u8 value);


bool VDP_getEnable(void);

bool VDP_isEnable(void);

void VDP_setEnable(bool value);


u16  VDP_getScanlineNumber(void);

u16  VDP_getScreenHeight(void);

void VDP_setScreenHeight224(void);

void VDP_setScreenHeight240(void);

u16  VDP_getScreenWidth(void);

void VDP_setScreenWidth256(void);

void VDP_setScreenWidth320(void);


u16  VDP_getPlaneWidth(void);

u16  VDP_getPlaneHeight(void);

void VDP_setPlaneSize(u16 w, u16 h, bool setupVram);

#define VDP_setPlanSize(w, h)      _Pragma("GCC error \"This definition is deprecated, use VDP_setPlaneSize(..) instead.\"")


u8 VDP_getHorizontalScrollingMode(void);

u8 VDP_getVerticalScrollingMode(void);

void VDP_setScrollingMode(u16 hscroll, u16 vscroll);


u8 VDP_getBackgroundColor(void);

void VDP_setBackgroundColor(u8 value);


u8   VDP_getAutoInc(void);

void VDP_setAutoInc(u8 value);


u8 VDP_getDMAEnabled(void);

void VDP_setDMAEnabled(bool value);

u8 VDP_getHVLatching(void);

void VDP_setHVLatching(bool value);

void VDP_setVInterrupt(bool value);

void VDP_setHInterrupt(bool value);

void VDP_setExtInterrupt(bool value);

void VDP_setHilightShadow(bool value);


u8   VDP_getHIntCounter(void);

void VDP_setHIntCounter(u8 value);


u16 VDP_getBGAAddress(void);

u16 VDP_getBGBAddress(void);

#define VDP_getAPlanAddress() _Pragma("GCC error \"This definition is deprecated, use VDP_getBGAAddress() instead.\"")

#define VDP_getBPlanAddress() _Pragma("GCC error \"This definition is deprecated, use VDP_getBGBAddress() instead.\"")


u16 VDP_getWindowAddress(void);

#define VDP_getWindowPlanAddress() _Pragma("GCC error \"This definition is deprecated, use VDP_getWindowAddress() instead.\"")

u16 VDP_getSpriteListAddress(void);

u16 VDP_getHScrollTableAddress(void);


void VDP_setBGAAddress(u16 value);

void VDP_setBGBAddress(u16 value);


#define VDP_setAPlanAddress(value)      \

_Pragma("GCC error \"This definition is deprecated, use VDP_setBGAAddress(..) instead.\"")


#define VDP_setBPlanAddress(value)      \

_Pragma("GCC error \"This definition is deprecated, use VDP_setBGBAddress(..) instead.\"")


void VDP_setWindowAddress(u16 value);

#define VDP_setWindowPlanAddress(value)     _Pragma("GCC error \"This definition is deprecated, use VDP_setWindowAddress(..) instead.\"")

void VDP_setSpriteListAddress(u16 value);

void VDP_setHScrollTableAddress(u16 value);


void VDP_setScanMode(u16 mode);


void VDP_setWindowHPos(u16 right, u16 pos);

void VDP_setWindowVPos(u16 down, u16 pos);

void VDP_setWindowOff();

void VDP_setWindowOnTop(u16 rows);

void VDP_setWindowOnBottom(u16 rows);

void VDP_setWindowOnLeft(u16 cols);

void VDP_setWindowOnRight(u16 cols);

void VDP_setWindowFullScreen();


void VDP_waitDMACompletion(void);

void VDP_waitFIFOEmpty(void);


bool VDP_waitVInt(void);

bool VDP_waitVBlank(bool forceNext);

bool VDP_waitVSync(void);

void VDP_waitVActive(bool forceNext);


u16 VDP_getAdjustedVCounter(void);


void VDP_showFPS(u16 asFloat, u16 x, u16 y);

void VDP_showCPULoad(u16 x, u16 y);


#endif // _VDP_H_


VDP_setScanMode
void VDP_setScanMode(u16 mode)
Sets the scan mode of the display.
Definition vdp.c:764

VDP_setWindowOff
void VDP_setWindowOff()
Turns off the window.
Definition vdp.c:810

VDP_setSpriteListAddress
void VDP_setSpriteListAddress(u16 value)
Set VRAM address (location) of Sprite list.  The address should be at multiple of $400 in H40 and $20...
Definition vdp.c:735

VDP_setHIntCounter
void VDP_setHIntCounter(u8 value)
Set Horizontal interrupt counter value.
Definition vdp.c:656

VDP_setBGBAddress
void VDP_setBGBAddress(u16 value)
Set VRAM address (location) of BG B tilemap.  The address should be at multiple of $2000    Ex:  VDP_...
Definition vdp.c:706

VDP_getAutoInc
u8 VDP_getAutoInc(void)
Returns auto increment register value.
Definition vdp.c:558

VDP_waitFIFOEmpty
void VDP_waitFIFOEmpty(void)
Wait for VDP FIFO to be empty.
Definition vdp.c:846

VDP_setWindowOnBottom
void VDP_setWindowOnBottom(u16 rows)
Positions the window from the bottom edge of the screen by the specified number of rows (tiles).
Definition vdp.c:821

VDP_setWindowAddress
void VDP_setWindowAddress(u16 value)
Set VRAM address (location) of Window tilemap.  The address should be at multiple of $1000 in H40 and...
Definition vdp.c:719

VDP_setHInterrupt
void VDP_setHInterrupt(bool value)
Enable or Disable Horizontal interrupt.
Definition vdp.c:617

VDP_resetScreen
void VDP_resetScreen(void)
Reset background planes and palettes.
Definition vdp.c:133

VDPPlane
VDPPlane
Type used to define on which plane to work (used by some methods).
Definition vdp.h:521

VDP_setBGAAddress
void VDP_setBGAAddress(u16 value)
Set VRAM address (location) of BG A tilemap. The address should be at multiple of $2000    Ex:  VDP_s...
Definition vdp.c:693

VDP_getBackgroundColor
u8 VDP_getBackgroundColor(void)
Returns the background color index.
Definition vdp.c:542

VDP_setAutoInc
void VDP_setAutoInc(u8 value)
Set auto increment register value.
Definition vdp.c:563

VDP_setHVLatching
void VDP_setHVLatching(bool value)
Set HV counter latching on INT2 (used for light gun).
Definition vdp.c:595

VDP_waitVActive
void VDP_waitVActive(bool forceNext)
Wait for next vertical active area (end of vertical blank period).
Definition vdp.c:934

VDP_setVInterrupt
void VDP_setVInterrupt(bool value)
Enable or Disable Vertical interrupt (it's strongly recommanded to keep it enabled).
Definition vdp.c:606

VDP_setWindowOnTop
void VDP_setWindowOnTop(u16 rows)
Positions the window from the top edge of the screen by the specified number of rows (tiles).
Definition vdp.c:816

VDP_getSpriteListAddress
u16 VDP_getSpriteListAddress(void)
Get VRAM address (location) of Sprite list.
Definition vdp.c:682

planeWidth
u16 planeWidth
Current background plane width (in tile).
Definition vdp.c:54

VDP_setScreenHeight224
void VDP_setScreenHeight224(void)
Set vertical resolution to 224 pixels.
Definition vdp.c:350

VDP_getHVLatching
u8 VDP_getHVLatching(void)
Returns HV counter latching on INT2 (used for light gun).
Definition vdp.c:590

planeHeight
u16 planeHeight
Current background plane height (in tile).
Definition vdp.c:55

windowWidthSft
u16 windowWidthSft
Current window width bit shift.
Definition vdp.c:59

VDP_setWindowOnRight
void VDP_setWindowOnRight(u16 cols)
Positions the window from the right edge of the screen by the specified number of columns,...
Definition vdp.c:831

VDP_getScanlineNumber
u16 VDP_getScanlineNumber(void)
Returns number of total scanline.
Definition vdp.c:339

VDP_init
void VDP_init(void)
Initialize the whole VDP sub system.
Definition vdp.c:64

VDP_setReg
void VDP_setReg(u16 reg, u8 value)
Set VDP register value.
Definition vdp.c:199

VDP_setWindowHPos
void VDP_setWindowHPos(u16 right, u16 pos)
Sets the window Horizontal position.
Definition vdp.c:782

VDP_waitVSync
bool VDP_waitVSync(void)
Wait for Vertical Synchro.
Definition vdp.c:952

windowWidth
u16 windowWidth
Current window width (in tile).
Definition vdp.c:56

VDP_getScreenHeight
u16 VDP_getScreenHeight(void)
Returns vertical screen resolution.
Definition vdp.c:345

VDP_setHScrollTableAddress
void VDP_setHScrollTableAddress(u16 value)
Set VRAM address (location) of H Scroll table.  The address should be at multiple of $400    Ex:  VDP...
Definition vdp.c:751

screenHeight
u16 screenHeight
Current screen height (verticale resolution).
Definition vdp.c:53

VDP_setScreenWidth320
void VDP_setScreenWidth320(void)
Set horizontal resolution to 320 pixels.
Definition vdp.c:393

VDP_getBGAAddress
u16 VDP_getBGAAddress(void)
Get VRAM address (location) of BG A tilemap.
Definition vdp.c:667

VDP_setWindowVPos
void VDP_setWindowVPos(u16 down, u16 pos)
Sets the window Vertical position.
Definition vdp.c:796

VDP_getAdjustedVCounter
u16 VDP_getAdjustedVCounter(void)
Return an enhanced V Counter representation.
Definition vdp.c:989

VDP_getBGBAddress
u16 VDP_getBGBAddress(void)
Get VRAM address (location) of BG B tilemap.
Definition vdp.c:672

VDP_getHIntCounter
u8 VDP_getHIntCounter(void)
Get Horizontal interrupt counter value.
Definition vdp.c:651

VDP_setEnable
void VDP_setEnable(bool value)
Set VDP enable state.
Definition vdp.c:327

VDP_getReg
u8 VDP_getReg(u16 reg)
Get VDP register value.
Definition vdp.c:193

VDP_getDMAEnabled
u8 VDP_getDMAEnabled(void)
Returns DMA enabled state.
Definition vdp.c:574

VDP_showCPULoad
void VDP_showCPULoad(u16 x, u16 y)
Display the estimated CPU load (in %).
Definition vdp.c:1013

VDP_getEnable
bool VDP_getEnable(void)
Returns VDP enable state.
Definition vdp.c:317

VDP_getScreenWidth
u16 VDP_getScreenWidth(void)
Returns horizontal screen resolution.
Definition vdp.c:375

VDP_setExtInterrupt
void VDP_setExtInterrupt(bool value)
Enable or Disable External interrupt.
Definition vdp.c:628

VDP_waitDMACompletion
void VDP_waitDMACompletion(void)
Wait for DMA operation to complete - same as DMA_waitCompletion().
Definition vdp.c:841

VDP_waitVBlank
bool VDP_waitVBlank(bool forceNext)
Wait for next vertical blank period (same as VDP_waitVSync()).
Definition vdp.c:886

VDP_setBackgroundColor
void VDP_setBackgroundColor(u8 value)
Set the background color index.
Definition vdp.c:547

VDP_setScrollingMode
void VDP_setScrollingMode(u16 hscroll, u16 vscroll)
Set plane scrolling mode.
Definition vdp.c:530

VDP_setScreenWidth256
void VDP_setScreenWidth256(void)
Set horizontal resolution to 256 pixels.
Definition vdp.c:380

VDP_getPlaneHeight
u16 VDP_getPlaneHeight(void)
Return background plane height (in tile).
Definition vdp.c:412

VDP_setDMAEnabled
void VDP_setDMAEnabled(bool value)
Set DMA enabled state.
Definition vdp.c:579

VDP_setPlaneSize
void VDP_setPlaneSize(u16 w, u16 h, bool setupVram)
Set background plane size (in tile).  WARNING: take attention to properly setup VRAM so tilemaps has ...
Definition vdp.c:417

VDP_getHScrollTableAddress
u16 VDP_getHScrollTableAddress(void)
Get VRAM address (location) of H SCroll table.
Definition vdp.c:687

VDP_getWindowAddress
u16 VDP_getWindowAddress(void)
Get VRAM address (location) of Window tilemap.
Definition vdp.c:677

VDP_getHorizontalScrollingMode
u8 VDP_getHorizontalScrollingMode(void)
Returns plane horizontal scrolling mode.
Definition vdp.c:525

VDP_waitVInt
bool VDP_waitVInt(void)
Wait for next Vertical Interruption.
Definition vdp.c:852

planeHeightSft
u16 planeHeightSft
Current background plane height bit shift.
Definition vdp.c:58

VDP_setHilightShadow
void VDP_setHilightShadow(bool value)
Enable or Disable Hilight / Shadow effect.
Definition vdp.c:639

screenWidth
u16 screenWidth
Current screen width (horizontale resolution).
Definition vdp.c:52

VDP_getPlaneWidth
u16 VDP_getPlaneWidth(void)
Return background plane width (in tile).
Definition vdp.c:407

VDP_isEnable
bool VDP_isEnable(void)
Returns VDP enable state.
Definition vdp.c:322

planeWidthSft
u16 planeWidthSft
Current background plane width bit shift.
Definition vdp.c:57

VDP_showFPS
void VDP_showFPS(u16 asFloat, u16 x, u16 y)
Display number of Frame Per Second.
Definition vdp.c:995

VDP_getVerticalScrollingMode
u8 VDP_getVerticalScrollingMode(void)
Returns plane vertical scrolling mode.
Definition vdp.c:520

VDP_setWindowOnLeft
void VDP_setWindowOnLeft(u16 cols)
Positions the window from the left edge of the screen by the specified number of columns,...
Definition vdp.c:826

VDP_setScreenHeight240
void VDP_setScreenHeight240(void)
Set vertical resolution to 240 pixels.
Definition vdp.c:361

VDP_setWindowFullScreen
void VDP_setWindowFullScreen()
Positions the window to full screen.
Definition vdp.c:836

u16
unsigned short u16
Definition types.h:100

u8
unsigned char u8
Definition types.h:95