romdev-mcp 0.1.1

package/src/platforms/genesis/lib/sgdk/include/vdp.h

@@ -0,0 +1,1150 @@
+/**
+ *  \file vdp.h
+ *  \brief VDP main
+ *  \author Stephane Dallongeville
+ *  \date 08/2011
+ *  \addtogroup VDP VDP
+ *  \{ 
+ *
+ * This unit provides general VDP (Video Display Processor) methods:<br>
+ * - initialisation<br>
+ * - get / set register<br>
+ * - get / set resolution<br>
+ * - enable / disable VDP features<br>
+ * <br>
+ * <b>WARNING:</b> It's very important that VRAM is organized with tile data being located before tilemaps and tables:<br>
+ * 0000-XXXX = tile data<br>
+ * XXXX-FFFF = tilemaps & tables (H scroll table, sprite table, B/A plane and window plane).<br>
+ * <br>
+ * If you don't respect that you may get in troubles as SGDK expect it ;)
+ */
+
+#ifndef _VDP_H_
+#define _VDP_H_
+
+
+/**
+ *  \brief
+ *      VDP Data port address.
+ */
+#define VDP_DATA_PORT           0xC00000
+/**
+ *  \brief
+ *      VDP Control port address.
+ */
+#define VDP_CTRL_PORT           0xC00004
+/**
+ *  \brief
+ *      VDP HV counter port address.
+ */
+#define VDP_HVCOUNTER_PORT      0xC00008
+
+/**
+ *  \deprecated
+ *      Use #VDP_DATA_PORT instead
+ */
+#define GFX_DATA_PORT           _Pragma("GCC error \"This definition is deprecated, use VDP_DATA_PORT instead.\"")
+
+/**
+ *  \deprecated
+ *      Use #VDP_CTRL_PORT instead
+ */
+#define GFX_CTRL_PORT           _Pragma("GCC error \"This definition is deprecated, use VDP_CTRL_PORT instead.\"")
+/**
+ *  \deprecated
+ *      Use #VDP_HVCOUNTER_PORT instead
+ */
+#define GFX_HVCOUNTER_PORT      _Pragma("GCC error \"This definition is deprecated, use VDP_HVCOUNTER_PORT instead.\"")
+
+
+/**
+ *  \brief
+ *      VDP FIFO empty flag.
+ */
+#define VDP_FIFOEMPTY_FLAG      (1 << 9)
+/**
+ *  \brief
+ *      VDP FIFO full flag.
+ */
+#define VDP_FIFOFULL_FLAG       (1 << 8)
+/**
+ *  \brief
+ *      VDP Vertical interrupt pending flag.
+ */
+#define VDP_VINTPENDING_FLAG    (1 << 7)
+/**
+ *  \brief
+ *      VDP sprite overflow flag.
+ */
+#define VDP_SPROVERFLOW_FLAG    (1 << 6)
+/**
+ *  \brief
+ *      VDP sprite collision flag.
+ */
+#define VDP_SPRCOLLISION_FLAG   (1 << 5)
+/**
+ *  \brief
+ *      VDP odd frame flag.
+ */
+#define VDP_ODDFRAME_FLAG       (1 << 4)
+/**
+ *  \brief
+ *      VDP Vertical blanking flag.
+ */
+#define VDP_VBLANK_FLAG         (1 << 3)
+/**
+ *  \brief
+ *      VDP Horizontal blanking flag.
+ */
+#define VDP_HBLANK_FLAG         (1 << 2)
+/**
+ *  \brief
+ *      VDP DMA busy flag.
+ */
+#define VDP_DMABUSY_FLAG        (1 << 1)
+/**
+ *  \brief
+ *      VDP PAL mode flag.
+ */
+#define VDP_PALMODE_FLAG        (1 << 0)
+
+/**
+ *  \deprecated
+ *      Use VDP_BG_A instead
+ */
+#define VDP_PLAN_A              _Pragma("GCC error \"This definition is deprecated, use VDP_BG_A instead.\"")
+/**
+ *  \deprecated
+ *      Use VDP_BG_B instead
+ */
+#define VDP_PLAN_B              _Pragma("GCC error \"This definition is deprecated, use VDP_BG_B instead.\"")
+/**
+ *  \deprecated
+ *      Use VDP_WINDOW instead
+ */
+#define VDP_PLAN_WINDOW         _Pragma("GCC error \"This definition is deprecated, use VDP_WINDOW instead.\"")
+
+/**
+ *  \brief
+ *      VDP background A tilemap address in VRAM.
+ */
+#define VDP_BG_A                bga_addr
+/**
+ *  \brief
+ *      VDP background B tilemap address in VRAM.
+ */
+#define VDP_BG_B                bgb_addr
+/**
+ *  \brief
+ *      VDP window tilemap address in VRAM.
+ */
+#define VDP_WINDOW              window_addr
+/**
+ *  \brief
+ *      VDP horizontal scroll table address in VRAM.
+ */
+#define VDP_HSCROLL_TABLE       hscrl_addr
+/**
+ *  \brief
+ *      VDP sprite list table address in VRAM.
+ */
+#define VDP_SPRITE_TABLE        slist_addr
+/**
+ *  \brief
+ *      Address in VRAM where tilemaps start (= address of first tilemap / table in VRAM).
+ */
+#define VDP_MAPS_START          maps_addr
+
+/**
+ *  \brief
+ *      Definition to set horizontal scroll to mode plane.
+ */
+#define HSCROLL_PLANE           0
+/**
+ *  \brief
+ *      Definition to set horizontal scroll to mode tile.
+ */
+#define HSCROLL_TILE            2
+/**
+ *  \brief
+ *      Definition to set horizontal scroll to mode line.
+ */
+#define HSCROLL_LINE            3
+
+/**
+ *  \brief
+ *      Definition to set vertical scroll to mode plane.
+ */
+#define VSCROLL_PLANE           0
+/**
+ *  \brief
+ *      Definition to set vertical scroll to mode column (2 tiles width).
+ */
+#define VSCROLL_COLUMN          1
+/**
+ *  \deprecated
+ *      Use VSCROLL_COLUMN instead
+ */
+#define VSCROLL_2TILE           _Pragma("GCC error \"This definition is deprecated, use VSCROLL_COLUMN instead.\"")
+
+/**
+ *  \brief
+ *      Interlaced scanning mode disabled.<br>
+ *      That is the default mode for the VDP.
+ */
+#define INTERLACED_NONE         0
+/**
+ *  \brief
+ *      Interlaced Scanning Mode 1 - 8x8 dots per cell (normal vertical resolution)<br>
+ *      In Interlaced Mode 1, the same pattern will be displayed on the adjacent lines of even and odd numbered fields.
+ */
+#define INTERLACED_MODE1        1
+/**
+ *  \brief
+ *      Interlaced Scanning Mode 2 - 8x16 dots per cell (double vertical resolution)<br>
+ *      In Interlaced Mode 2, different patterns can be displayed on the adjacent lines of even and odd numbered fields.
+ */
+#define INTERLACED_MODE2        2
+
+/**
+ *  \brief
+ *      SGDK font length
+ */
+#define FONT_LENGTH             96
+#define FONT_LEN                _Pragma("GCC error \"This definition is deprecated, use FONT_LENGTH instead.\"")
+
+/**
+ *  \brief
+ *      Size of a single tile in byte.
+ */
+#define TILE_SIZE               32
+#define TILE_INDEX_MASK         (0xFFFF / TILE_SIZE)
+
+/**
+ *  \brief
+ *      Space in byte for tile in VRAM (tile space ends where tilemaps starts)
+ */
+#define TILE_SPACE              VDP_MAPS_START
+
+/**
+ *  \brief
+ *      Maximum number of tile in VRAM (related to TILE_SPACE).
+ */
+#define TILE_MAX_NUM            (TILE_SPACE / TILE_SIZE)
+/**
+ *  \brief
+ *      Maximum tile index in VRAM (related to TILE_MAXNUM).
+ */
+#define TILE_MAX_INDEX          (TILE_MAXNUM - 1)
+/**
+ *  \brief
+ *      System base tile index in VRAM.
+ */
+#define TILE_SYSTEM_INDEX       0x0000
+/**
+ *  \brief
+ *      Number of system tile.
+ */
+#define TILE_SYSTEM_LENGTH      16
+/**
+ *  \brief
+ *      User base tile index.
+ */
+#if (LEGACY_FONT_LOCATION != 0)
+#define TILE_USER_INDEX         (TILE_SYSTEM_INDEX + TILE_SYSTEM_LENGTH)
+#else
+#define TILE_USER_INDEX         (TILE_SYSTEM_INDEX + TILE_SYSTEM_LENGTH + FONT_LENGTH)
+#endif
+/**
+ *  \brief
+ *      Font base tile index.
+ */
+#if (LEGACY_FONT_LOCATION != 0)
+#define TILE_FONT_INDEX         (TILE_MAX_NUM - FONT_LENGTH)
+#else
+#define TILE_FONT_INDEX         (TILE_SYSTEM_INDEX + TILE_SYSTEM_LENGTH)
+#endif
+/**
+ *  \brief
+ *      Sprite engine base tile index (should be located at the end of tileset space)
+ */
+#if (LEGACY_FONT_LOCATION != 0)
+#define TILE_SPRITE_INDEX       (TILE_FONT_INDEX - spriteVramSize)
+#else
+#define TILE_SPRITE_INDEX       (TILE_MAX_NUM - spriteVramSize)
+#endif
+/**
+ *  \brief
+ *      Number of available user tile.
+ */
+#define TILE_USER_LENGTH        ((userTileMaxIndex - TILE_USER_INDEX) + 1)
+/**
+ *  \brief
+ *      Maximum tile index in VRAM reserved for user (for background and user managed sprites)
+ */
+#define TILE_USER_MAX_INDEX     userTileMaxIndex
+
+/**
+ *  \deprecated
+ *      Use TILE_MAX_NUM instead
+ */
+#define TILE_MAXNUM             _Pragma("GCC error \"This definition is deprecated, use TILE_MAX_NUM instead.\"")
+/**
+ *  \deprecated
+ *      Use TILE_MAX_INDEX instead
+ */
+#define TILE_MAXINDEX           _Pragma("GCC error \"This definition is deprecated, use TILE_MAX_INDEX instead.\"")
+/**
+ *  \deprecated Use TILE_SYSTEM_LENGTH instead.
+ */
+#define TILE_SYSTEM_LENGHT      _Pragma("GCC error \"This definition is deprecated, use TILE_SYSTEM_LENGTH instead.\"")
+/**
+ *  \deprecated
+ *      Use TILE_SYSTEM_LENGTH instead
+ */
+#define TILE_SYSTEMLENGTH       _Pragma("GCC error \"This definition is deprecated, use TILE_SYSTEM_LENGTH instead.\"")
+/**
+ *  \deprecated
+ *      Use TILE_SYSTEM_INDEX instead
+ */
+#define TILE_SYSTEMINDEX        _Pragma("GCC error \"This definition is deprecated, use TILE_SYSTEM_INDEX instead.\"")
+/**
+ *  \deprecated
+ *      Use TILE_USER_INDEX instead
+ */
+#define TILE_USERINDEX          _Pragma("GCC error \"This definition is deprecated, use TILE_USER_INDEX instead.\"")
+/**
+ *  \deprecated
+ *      Use TILE_FONT_INDEX instead
+ */
+#define TILE_FONTINDEX          _Pragma("GCC error \"This definition is deprecated, use TILE_FONT_INDEX instead.\"")
+/**
+ *  \deprecated
+ *      Use TILE_SPRITE_INDEX instead
+ */
+#define TILE_SPRITEINDEX        _Pragma("GCC error \"This definition is deprecated, use TILE_SPRITE_INDEX instead.\"")
+/**
+ *  \deprecated
+ *      Use TILE_USER_LENGTH instead
+ */
+#define TILE_USERLENGTH         _Pragma("GCC error \"This definition is deprecated, use TILE_USER_LENGTH instead.\"")
+/**
+ *  \deprecated
+ *      Use TILE_USER_MAX_INDEX instead
+ */
+#define TILE_USERMAXINDEX       _Pragma("GCC error \"This definition is deprecated, use TILE_USER_MAX_INDEX instead.\"")
+
+/**
+ *  \brief
+ *      System tile address in VRAM.
+ */
+#define TILE_SYSTEM             (TILE_SYSTEM_INDEX * TILE_SIZE)
+/**
+ *  \brief
+ *      User tile address in VRAM.
+ */
+#define TILE_USER               (TILE_USER_INDEX * TILE_SIZE)
+/**
+ *  \brief
+ *      Font tile address in VRAM.
+ */
+#define TILE_FONT               (TILE_FONT_INDEX * TILE_SIZE)
+
+/**
+ *  \brief
+ *      Palette 0
+ */
+#define PAL0                    0
+/**
+ *  \brief
+ *      Palette 1
+ */
+#define PAL1                    1
+/**
+ *  \brief
+ *      Palette 2
+ */
+#define PAL2                    2
+/**
+ *  \brief
+ *      Palette 3
+ */
+#define PAL3                    3
+
+/**
+ *  \brief
+ *      Set VDP command to read specified VRAM address.
+ */
+#define VDP_READ_VRAM_ADDR(adr)     (((0x0000 + ((adr) & 0x3FFF)) << 16) + (((adr) >> 14) | 0x00))
+/**
+ *  \brief
+ *      Set VDP command to read specified CRAM address.
+ */
+#define VDP_READ_CRAM_ADDR(adr)     (((0x0000 + ((adr) & 0x7F)) << 16) + 0x20)
+/**
+ *  \brief
+ *      Set VDP command to read specified VSRAM address.
+ */
+#define VDP_READ_VSRAM_ADDR(adr)    (((0x0000 + ((adr) & 0x7F)) << 16) + 0x10)
+
+/**
+ *  \brief
+ *      Set VDP command to write at specified VRAM address.
+ */
+#define VDP_WRITE_VRAM_ADDR(adr)    (((0x4000 + ((adr) & 0x3FFF)) << 16) + (((adr) >> 14) | 0x00))
+/**
+ *  \brief
+ *      Set VDP command to write at specified CRAM address.
+ */
+#define VDP_WRITE_CRAM_ADDR(adr)    (((0xC000 + ((adr) & 0x7F)) << 16) + 0x00)
+/**
+ *  \brief
+ *      Set VDP command to write at specified VSRAM address.
+ */
+#define VDP_WRITE_VSRAM_ADDR(adr)   (((0x4000 + ((adr) & 0x7F)) << 16) + 0x10)
+
+/**
+ *  \brief
+ *      Set VDP command to issue a DMA transfert to specified VRAM address.
+ */
+#define VDP_DMA_VRAM_ADDR(adr)      (((0x4000 + ((adr) & 0x3FFF)) << 16) + (((adr) >> 14) | 0x80))
+/**
+ *  \brief
+ *      Set VDP command to issue a DMA transfert to specified CRAM address.
+ */
+#define VDP_DMA_CRAM_ADDR(adr)      (((0xC000 + ((adr) & 0x7F)) << 16) + 0x80)
+/**
+ *  \brief
+ *      Set VDP command to issue a DMA transfert to specified VSRAM address.
+ */
+#define VDP_DMA_VSRAM_ADDR(adr)     (((0x4000 + ((adr) & 0x7F)) << 16) + 0x90)
+
+/**
+ *  \brief
+ *      Set VDP command to issue a DMA VRAM copy to specified VRAM address.
+ */
+#define VDP_DMA_VRAMCOPY_ADDR(adr)  (((0x4000 + ((adr) & 0x3FFF)) << 16) + (((adr) >> 14) | 0xC0))
+
+/**
+ *  \brief
+ *      Helper to write in vertical scroll table (same as VDP_WRITE_VSRAM_ADDR).
+ */
+#define VDP_VERT_SCROLL(adr)        VDP_WRITE_VSRAM_ADDR(adr)
+/**
+ *  \brief
+ *      Helper to write in horizontal scroll table (same as VDP_WRITE_VRAM_ADDR(VDP_SCROLL_H + adr)).
+ */
+#define VDP_HORZ_SCROLL(adr)        VDP_WRITE_VRAM_ADDR(VDP_SCROLL_H + (adr))
+
+/**
+ *  \deprecated
+ *      Use #VDP_READ_VRAM_ADDR instead
+ */
+#define GFX_READ_VRAM_ADDR(adr)     _Pragma("GCC error \"This definition is deprecated, use VDP_READ_VRAM_ADDR instead.\""))
+/**
+ *  \deprecated
+ *      Use #VDP_READ_CRAM_ADDR instead
+ */
+#define GFX_READ_CRAM_ADDR(adr)     _Pragma("GCC error \"This definition is deprecated, use VDP_READ_CRAM_ADDR instead.\"")
+/**
+ *  \deprecated
+ *      Use #VDP_READ_VSRAM_ADDR instead
+ */
+#define GFX_READ_VSRAM_ADDR(adr)    _Pragma("GCC error \"This definition is deprecated, use VDP_READ_VSRAM_ADDR instead.\"")
+/**
+ *  \deprecated
+ *      Use #VDP_WRITE_VRAM_ADDR instead
+ */
+#define GFX_WRITE_VRAM_ADDR(adr)    _Pragma("GCC error \"This definition is deprecated, use VDP_WRITE_VRAM_ADDR instead.\"")
+/**
+ *  \deprecated
+ *      Use #VDP_WRITE_CRAM_ADDR instead
+ */
+#define GFX_WRITE_CRAM_ADDR(adr)    _Pragma("GCC error \"This definition is deprecated, use VDP_WRITE_CRAM_ADDR instead.\"")
+/**
+ *  \deprecated
+ *      Use #VDP_WRITE_VSRAM_ADDR instead
+ */
+#define GFX_WRITE_VSRAM_ADDR(adr)   _Pragma("GCC error \"This definition is deprecated, use VDP_WRITE_VSRAM_ADDR instead.\"")
+/**
+ *  \deprecated
+ *      Use #VDP_DMA_VRAM_ADDR instead
+ */
+#define GFX_DMA_VRAM_ADDR(adr)      _Pragma("GCC error \"This definition is deprecated, use VDP_DMA_VRAM_ADDR instead.\"")
+/**
+ *  \deprecated
+ *      Use #VDP_DMA_CRAM_ADDR instead
+ */
+#define GFX_DMA_CRAM_ADDR(adr)      _Pragma("GCC error \"This definition is deprecated, use VDP_DMA_CRAM_ADDR instead.\"")
+/**
+ *  \deprecated
+ *      Use #VDP_DMA_VSRAM_ADDR instead
+ */
+#define GFX_DMA_VSRAM_ADDR(adr)     _Pragma("GCC error \"This definition is deprecated, use VDP_DMA_VSRAM_ADDR instead.\"")
+/**
+ *  \deprecated
+ *      Use #VDP_DMA_VRAMCOPY_ADDR instead
+ */
+#define GFX_DMA_VRAMCOPY_ADDR(adr)  _Pragma("GCC error \"This definition is deprecated, use VDP_DMA_VRAMCOPY_ADDR instead.\"")
+/**
+ *  \deprecated
+ *      Use #VDP_VERT_SCROLL instead
+ */
+#define GFX_VERT_SCROLL(adr)        _Pragma("GCC error \"This definition is deprecated, use VDP_VERT_SCROLL instead.\"")
+/**
+ *  \deprecated
+ *      Use #VDP_HORZ_SCROLL instead
+ */
+#define GFX_HORZ_SCROLL(adr)        _Pragma("GCC error \"This definition is deprecated, use VDP_HORZ_SCROLL instead.\"")
+
+
+/**
+ *  \brief
+ *      Tests VDP status against specified flag (see VDP_XXX_FLAG).
+ */
+#define GET_VDP_STATUS(flag)         ((*(vu16*)(VDP_CTRL_PORT)) & (flag))
+/**
+ *  \brief
+ *      Tests if current system is a PAL system (50 Hz).
+ */
+#define IS_PAL_SYSTEM                GET_VDP_STATUS(VDP_PALMODE_FLAG)
+
+/**
+ *  \brief
+ *      Returns HV counter.
+ */
+#define GET_HVCOUNTER               (*(vu16*)(VDP_HVCOUNTER_PORT))
+/**
+ *  \brief
+ *      Returns Horizontal counter.
+ */
+#define GET_HCOUNTER                (GET_HVCOUNTER & 0xFF)
+/**
+ *  \brief
+ *      Returns Vertical counter.
+ */
+#define GET_VCOUNTER                (GET_HVCOUNTER >> 8)
+
+
+/**
+ *  \brief
+ *      Type used to define on which plane to work (used by some methods).
+ */
+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;
+
+/**
+ *  \brief
+ *      Current screen width (horizontale resolution)
+ */
+extern u16 screenWidth;
+/**
+ *  \brief
+ *      Current screen height (verticale resolution)
+ */
+extern u16 screenHeight;
+/**
+ *  \brief
+ *      Current background plane width (in tile)
+ *
+ *  Possible values are: 32, 64, 128
+ */
+extern u16 planeWidth;
+/**
+ *  \brief
+ *      Current background plane height (in tile)
+ *
+ *  Possible values are: 32, 64, 128
+ */
+extern u16 planeHeight;
+/**
+ *  \brief
+ *      Current window width (in tile)
+ *
+ *  Possible values are: 32, 64
+ */
+extern u16 windowWidth;
+/**
+ *  \brief
+ *      Current background plane width bit shift
+ *
+ *  Possible values are: 5, 6 or 7 (corresponding to plane width 32, 64 and 128)
+ */
+extern u16 planeWidthSft;
+/**
+ *  \brief
+ *      Current background plane height bit shift
+ *
+ *  Possible values are: 5, 6 or 7 (corresponding to plane height 32, 64 and 128)
+ */
+extern u16 planeHeightSft;
+/**
+ *  \brief
+ *      Current window width bit shift
+ *
+ *  Possible values are: 5 or 6 (corresponding to window width 32 or 64)
+ */
+extern u16 windowWidthSft;
+
+
+/**
+ *  \brief
+ *      Initialize the whole VDP sub system.
+ *
+ * Reset VDP registers, reset sprites then call #VDP_resetScreen() to reset BG and palettes.
+ */
+void VDP_init(void);
+
+/**
+ *  \brief
+ *      Reset background planes and palettes.
+ *
+ *  Reset VRAM (clear BG planes and reload font), reset scrolls and reset palettes (set to default grey / red / green / blue ramps).
+ */
+void VDP_resetScreen(void);
+
+/**
+ *  \brief
+ *      Get VDP register value.
+ *
+ *  \param reg
+ *      Register number we want to retrieve value.
+ *  \return specified register value.
+ */
+u8   VDP_getReg(u16 reg);
+/**
+ *  \brief
+ *      Set VDP register value.
+ *
+ *  \param reg
+ *      Register number we want to set value.
+ *      Note that setting bit 7 of register number (reg | 0x80) allows the value to be written to the VDP
+ *      without being 'cached' in the SGDK register array so VDP_getReg(reg) will return previous value.
+ *  \param value
+ *      value to set.
+ */
+void VDP_setReg(u16 reg, u8 value);
+
+/**
+ *  \brief
+ *      Returns VDP enable state.
+ */
+bool VDP_getEnable(void);
+/**
+ *  \brief
+ *      Returns VDP enable state.
+ */
+bool VDP_isEnable(void);
+/**
+ *  \brief
+ *      Set VDP enable state.
+ *
+ *  You can temporary disable VDP to speed up VDP memory transfert.
+ */
+void VDP_setEnable(bool value);
+
+/**
+ *  \brief
+ *      Returns number of total scanline.
+ *
+ *  312 for PAL system and 262 for NTSC system.
+ */
+u16  VDP_getScanlineNumber(void);
+/**
+ *  \brief
+ *      Returns vertical screen resolution.
+ *
+ *  Always returns 224 on NTSC system as they only support this mode.<br>
+ *  PAL system supports 240 pixels mode.
+ */
+u16  VDP_getScreenHeight(void);
+/**
+ *  \brief
+ *      Set vertical resolution to 224 pixels.
+ *
+ *  This is the only accepted mode for NTSC system.
+ */
+void VDP_setScreenHeight224(void);
+/**
+ *  \brief
+ *      Set vertical resolution to 240 pixels.
+ *
+ *  Only work on PAL system.
+ */
+void VDP_setScreenHeight240(void);
+/**
+ *  \brief
+ *      Returns horizontal screen resolution.
+ *
+ *  Returns 320 or 256 depending current horizontal resolution mode.
+ */
+u16  VDP_getScreenWidth(void);
+/**
+ *  \brief
+ *      Set horizontal resolution to 256 pixels.
+ */
+void VDP_setScreenWidth256(void);
+/**
+ *  \brief
+ *      Set horizontal resolution to 320 pixels.
+ */
+void VDP_setScreenWidth320(void);
+
+/**
+ *  \brief
+ *      Return background plane width (in tile).
+ */
+u16  VDP_getPlaneWidth(void);
+/**
+ *  \brief
+ *      Return background plane height (in tile).
+ */
+u16  VDP_getPlaneHeight(void);
+/**
+ *  \brief
+ *      Set background plane size (in tile).<br>
+ *      WARNING: take attention to properly setup VRAM so tilemaps has enough space.
+ *
+ *  \param w
+ *      width in tile.<br>
+ *      Possible values are 32, 64 or 128.
+ *  \param h
+ *      height in tile.<br>
+ *      Possible values are 32, 64 or 128.
+ *  \param setupVram
+ *      If set to TRUE then tilemaps and tables will be automatically remapped in VRAM depending
+ *      the plane size. If you don't know what that means then it's better to keep this value to TRUE :p<br>
+ *      Be careful to redraw your backgrounds, also the sprite engine may need to re-allocate its VRAM region if location changed.
+ */
+void VDP_setPlaneSize(u16 w, u16 h, bool setupVram);
+/**
+ *  \deprecated
+ *      Use #VDP_setPlaneSize(..) instead.
+ */
+#define VDP_setPlanSize(w, h)      _Pragma("GCC error \"This definition is deprecated, use VDP_setPlaneSize(..) instead.\"")
+
+/**
+ *  \brief
+ *      Returns plane horizontal scrolling mode.
+ *
+ *  Possible values are: HSCROLL_PLANE, HSCROLL_TILE, HSCROLL_LINE
+ *
+ *  \see VDP_setScrollingMode for more informations about scrolling mode.
+ */
+u8 VDP_getHorizontalScrollingMode(void);
+/**
+ *  \brief
+ *      Returns plane vertical scrolling mode.
+ *
+ *  Possible values are: VSCROLL_PLANE, VSCROLL_2TILE
+ *
+ *  \see VDP_setScrollingMode for more informations about scrolling mode.
+ */
+u8 VDP_getVerticalScrollingMode(void);
+/**
+ *  \brief
+ *      Set plane scrolling mode.
+ *
+ *  \param hscroll
+ *      Horizontal scrolling mode :<br>
+ *      <b>HSCROLL_PLANE</b> = Scroll offset is applied to the whole plane.<br>
+ *      <b>HSCROLL_TILE</b> = Scroll offset is applied on a tile basis granularity (8 pixels bloc).<br>
+ *      <b>HSCROLL_LINE</b> = Scroll offset is applied on a line basis granularity (1 pixel).<br>
+ *  \param vscroll
+ *      Vertical scrolling mode :<br>
+ *      <b>VSCROLL_PLANE</b> = Scroll offset is applied to the whole plane.<br>
+ *      <b>VSCROLL_2TILE</b> = Scroll offset is applied on 2 tiles basis granularity (16 pixels bloc).<br>
+ *
+ *  \see VDP_setHorizontalScroll() to set horizontal scroll offset in mode plane.<br>
+ *  \see VDP_setHorizontalScrollTile() to set horizontal scroll offset(s) in mode tile.<br>
+ *  \see VDP_setHorizontalScrollLine() to set horizontal scroll offset(s) in mode line.<br>
+ *  \see VDP_setVerticalScroll() to set vertical scroll offset in mode plane.<br>
+ *  \see VDP_setVerticalScrollTile() to set vertical scroll offset(s) in mode 2-tile.<br>
+ */
+void VDP_setScrollingMode(u16 hscroll, u16 vscroll);
+
+/**
+ *  \brief
+ *      Returns the background color index.
+ */
+u8 VDP_getBackgroundColor(void);
+/**
+ *  \brief
+ *      Set the background color index.
+ */
+void VDP_setBackgroundColor(u8 value);
+
+/**
+ *  \brief
+ *      Returns auto increment register value.
+ */
+u8   VDP_getAutoInc(void);
+/**
+ *  \brief
+ *      Set auto increment register value.
+ */
+void VDP_setAutoInc(u8 value);
+
+/**
+ *  \brief
+ *      Returns DMA enabled state
+ */
+u8 VDP_getDMAEnabled(void);
+/**
+ *  \brief
+ *      Set DMA enabled state.
+ *
+ *  Note that by default SGDK always enable DMA (there is no reason to disable it)
+ */
+void VDP_setDMAEnabled(bool value);
+/**
+ *  \brief
+ *      Returns HV counter latching on INT2 (used for light gun)
+ */
+u8 VDP_getHVLatching(void);
+/**
+ *  \brief
+ *      Set HV counter latching on INT2 (used for light gun)
+ *
+ *  You can ask the HV Counter to fix its value on INT2 for accurate light gun positionning.
+ */
+void VDP_setHVLatching(bool value);
+/**
+ *  \brief
+ *      Enable or Disable Vertical interrupt (it's *strongly* recommanded to keep it enabled).
+ *
+ *  \see VDP_setHInterrupt()
+ */
+void VDP_setVInterrupt(bool value);
+/**
+ *  \brief
+ *      Enable or Disable Horizontal interrupt.
+ *
+ *  \see VDP_setHIntCounter()
+ */
+void VDP_setHInterrupt(bool value);
+/**
+ *  \brief
+ *      Enable or Disable External interrupt.
+ *
+ *  \see VDP_setExtIntCounter()
+ */
+void VDP_setExtInterrupt(bool value);
+/**
+ *  \brief
+ *      Enable or Disable Hilight / Shadow effect.
+ */
+void VDP_setHilightShadow(bool value);
+
+/**
+ *  \brief
+ *      Get Horizontal interrupt counter value.
+ */
+u8   VDP_getHIntCounter(void);
+/**
+ *  \brief
+ *      Set Horizontal interrupt counter value.
+ *
+ *  When Horizontal interrupt is enabled, setting 5 here means that H int will occurs each (5+1) scanline.<br>
+ *  Set value 0 to get H int at each scanline.
+ */
+void VDP_setHIntCounter(u8 value);
+
+/**
+ *  \brief
+ *      Get VRAM address (location) of BG A tilemap.
+ */
+u16 VDP_getBGAAddress(void);
+/**
+ *  \brief
+ *      Get VRAM address (location) of BG B tilemap.
+ */
+u16 VDP_getBGBAddress(void);
+/**
+ *  \deprecated
+ *      Use #VDP_getBGAAddress(..) instead.
+ */
+#define VDP_getAPlanAddress() _Pragma("GCC error \"This definition is deprecated, use VDP_getBGAAddress() instead.\"")
+/**
+ *  \deprecated
+ *      Use #VDP_getBGBAddress(..) instead.
+ */
+#define VDP_getBPlanAddress() _Pragma("GCC error \"This definition is deprecated, use VDP_getBGBAddress() instead.\"")
+
+/**
+ *  \brief
+ *      Get VRAM address (location) of Window tilemap.
+ */
+u16 VDP_getWindowAddress(void);
+/**
+ *  \deprecated
+ *      Use #VDP_getWindowAddress(..) instead.
+ */
+#define VDP_getWindowPlanAddress() _Pragma("GCC error \"This definition is deprecated, use VDP_getWindowAddress() instead.\"")
+/**
+ *  \brief
+ *      Get VRAM address (location) of Sprite list.
+ */
+u16 VDP_getSpriteListAddress(void);
+/**
+ *  \brief
+ *      Get VRAM address (location) of H SCroll table.
+ */
+u16 VDP_getHScrollTableAddress(void);
+
+/**
+ *  \brief
+ *      Set VRAM address (location) of BG A tilemap.
+ *      The address should be at multiple of $2000<br>
+ *      <br>
+ *      Ex:<br>
+ *      VDP_setBGAAddress(0xC000)<br>
+ *      Will set the BG A to at address 0xC000 in VRAM.
+ */
+void VDP_setBGAAddress(u16 value);
+/**
+ *  \brief
+ *      Set VRAM address (location) of BG B tilemap.<br>
+ *      The address should be at multiple of $2000<br>
+ *      <br>
+ *      Ex:<br>
+ *      VDP_setBGBAddress(0xE000)<br>
+ *      Will set the BG B tilemap at address 0xE000 in VRAM.
+ */
+void VDP_setBGBAddress(u16 value);
+/**
+ *  \deprecated
+ *      Use #VDP_setBGAAddress(..) instead.
+ */
+#define VDP_setAPlanAddress(value)      \
+_Pragma("GCC error \"This definition is deprecated, use VDP_setBGAAddress(..) instead.\"")
+/**
+ *  \deprecated
+ *      Use #VDP_setBGBAddress(..) instead.
+ */
+#define VDP_setBPlanAddress(value)      \
+_Pragma("GCC error \"This definition is deprecated, use VDP_setBGBAddress(..) instead.\"")
+/**
+ *  \brief
+ *      Set VRAM address (location) of Window tilemap.<br>
+ *      The address should be at multiple of $1000 in H40 and $800 in H32<br>
+ *      <br>
+ *      Ex:<br>
+ *      VDP_setWindowAddress(0xA000)<br>
+ *      Will set the Window tilemap at address 0xA000 in VRAM.
+ */
+void VDP_setWindowAddress(u16 value);
+/**
+ *  \deprecated
+ *      Use #VDP_setWindowAddress(..) instead.
+ */
+#define VDP_setWindowPlanAddress(value)     _Pragma("GCC error \"This definition is deprecated, use VDP_setWindowAddress(..) instead.\"")
+/**
+ *  \brief
+ *      Set VRAM address (location) of Sprite list.<br>
+ *      The address should be at multiple of $400 in H40 and $200 in H32<br>
+ *      <br>
+ *      Ex:<br>
+ *      VDP_setSpriteListAddress(0xD800)<br>
+ *      Will set the Sprite list to at address 0xD800 in VRAM.
+ */
+void VDP_setSpriteListAddress(u16 value);
+/**
+ *  \brief
+ *      Set VRAM address (location) of H Scroll table.<br>
+ *      The address should be at multiple of $400<br>
+ *      <br>
+ *      Ex:<br>
+ *      VDP_setHScrollTableAddress(0xD400)<br>
+ *      Will set the HScroll table to at address 0xD400 in VRAM.
+ */
+void VDP_setHScrollTableAddress(u16 value);
+
+/**
+ *  \brief
+ *      Sets the scan mode of the display.
+ *
+ *  \param mode
+ *      Accepted values : #INTERLACED_NONE, #INTERLACED_MODE1, #INTERLACED_MODE2
+ *
+ * This function changes the scanning mode on the next display blanking period.<br>
+ * In Interlaced Mode 1, the same pattern will be displayed on the adjacent lines of even and odd numbered fields.<br>
+ * In Interlaced Mode 2, different patterns can be displayed on the adjacent lines of even and odd numbered fields.<br>
+ * The number of cells on the screen stays the same regardless of which scanning mode is active.
+ */
+void VDP_setScanMode(u16 mode);
+
+/**
+ *  \brief
+ *      Sets the window Horizontal position.
+ *
+ *  \param right
+ *      If set to <i>FALSE</i> the window is displayed from column 0 up to column <i>pos</i>
+ *      If set to <i>TRUE</i> the window is displayed from column <i>pos</i> up to last column
+ *  \param pos
+ *      The Horizontal position of the window in 2 tiles unit (16 pixels).
+ */
+void VDP_setWindowHPos(u16 right, u16 pos);
+/**
+ *  \brief
+ *      Sets the window Vertical position.
+ *
+ *  \param down
+ *      If set to <i>FALSE</i> the window is displayed from row 0 up to row <i>pos</i>
+ *      If set to <i>TRUE</i> the window is displayed from row <i>pos</i> up to last row
+ *  \param pos
+ *      The Vertical position of the window in 1 tile unit (8 pixels).
+ */
+void VDP_setWindowVPos(u16 down, u16 pos);
+/**
+ *  \brief
+ *      Turns off the window.
+ */
+void VDP_setWindowOff();
+/**
+ *  \brief
+ *      Positions the window from the top edge of the screen by the specified number of rows (tiles).
+ *
+ *  \param rows
+ *      The number of rows, expressed in tiles.
+ */
+void VDP_setWindowOnTop(u16 rows);
+/**
+ *  \brief
+ *      Positions the window from the bottom edge of the screen by the specified number of rows (tiles).
+ *
+ *  \param rows
+ *      The number of rows, expressed in tiles.
+ */
+void VDP_setWindowOnBottom(u16 rows);
+/**
+ *  \brief
+ *      Positions the window from the left edge of the screen by the specified number of columns, each 2 tiles wide (16 pixels).
+ *
+ *  \param cols
+ *      The number of columns, expressed in double tiles.
+ */
+void VDP_setWindowOnLeft(u16 cols);
+/**
+ *  \brief
+ *      Positions the window from the right edge of the screen by the specified number of columns, each 2 tiles wide (16 pixels).
+ *
+ *  \param cols
+ *      The number of columns, expressed in double tiles.
+ */
+void VDP_setWindowOnRight(u16 cols);
+/**
+ *  \brief
+ *      Positions the window to full screen.
+ */
+void VDP_setWindowFullScreen();
+
+/**
+ *  \brief
+ *      Wait for DMA operation to complete - same as #DMA_waitCompletion()
+ */
+void VDP_waitDMACompletion(void);
+/**
+ *  \brief
+ *      Wait for VDP FIFO to be empty.
+ */
+void VDP_waitFIFOEmpty(void);
+
+/**
+ *  \brief
+ *      Wait for next Vertical Interruption.
+ *  \return
+ *      TRUE if a frame miss was detected (more than 1 frame elapsed since last call)
+ *
+ *  The method actually wait for the start of Vertical Interruption.
+ *  It returns immediately if we are already in V-Int handler.
+ */
+bool VDP_waitVInt(void);
+/**
+ *  \brief
+ *      Wait for next vertical blank period (same as #VDP_waitVSync())
+ *  \return
+ *      TRUE if a frame miss was detected (more than 1 frame elapsed since last call)
+ *
+ *  \param forceNext
+ *      Force waiting for next start of VBlank if we are already in VBlank period when calling the method.
+ *
+ *  The method wait until we are in Vertical blanking area/period.
+ */
+bool VDP_waitVBlank(bool forceNext);
+/**
+ *  \brief
+ *      Wait for Vertical Synchro.
+ *  \return
+ *      TRUE if a frame miss was detected (more than 1 frame elapsed since last call)
+ *
+ *  The method actually wait for the *next* start of Vertical blanking.
+ */
+bool VDP_waitVSync(void);
+/**
+ *  \brief
+ *      Wait for next vertical active area (end of vertical blank period)
+ *
+ *  \param forceNext
+ *      Force waiting for next start of V-Active if we are already in V-Active period when calling the method.
+ *
+ *  The method wait until we are in Vertical active area/period.
+ */
+void VDP_waitVActive(bool forceNext);
+
+/**
+ *  \brief
+ *      Return an enhanced V Counter representation.
+ *
+ *  Using direct V counter from VDP may give troubles as the VDP V-Counter rollback during V-Blank period.<br>
+ *  This function aim to make ease the use of V-Counter by adjusting it to a [0-255] range where 0 is the start of VBlank area and 255 the end of active display area.
+ */
+u16 VDP_getAdjustedVCounter(void);
+
+/**
+ *  \brief
+ *      Display number of Frame Per Second.
+ *
+ *  \param asFloat
+ *      Display in float number format.
+ *  \param x
+ *      X coordinate (in tile).
+ *  \param y
+ *      y coordinate (in tile).
+ *
+ * This function actually display the number of time it was called in the last second.<br>
+ * i.e: for benchmarking you should call this method only once per frame update.
+ *
+ * \see #SYS_getFPS(..)
+ */
+void VDP_showFPS(u16 asFloat, u16 x, u16 y);
+/**
+ *  \brief
+ *      Display the estimated CPU load (in %).
+ * 
+*  \param x
+ *      X coordinate (in tile).
+ *  \param y
+ *      y coordinate (in tile).
+ *
+ * This function actually display an estimation of the CPU load (in %) for the last frame.
+ *
+ * \see #SYS_getCPULoad()
+ */
+void VDP_showCPULoad(u16 x, u16 y);
+
+#endif // _VDP_H_
+
+/** \} */