hdma.h

Go to the documentation of this file.

 
#ifndef OPENSNES_HDMA_H
#define OPENSNES_HDMA_H
 
#include <snes/types.h>
 
/* Removed on 2026-10-05 (1.0 plan, lot C): hdmaSetupBank.
 * The replacements are in docs/UPGRADING.md; `make check-upgrade` names them. */
 
/*============================================================================
 * HDMA Channel Definitions
 *============================================================================*/

#define HDMA_CHANNEL_0  0
#define HDMA_CHANNEL_1  1
#define HDMA_CHANNEL_2  2
#define HDMA_CHANNEL_3  3
#define HDMA_CHANNEL_4  4
#define HDMA_CHANNEL_5  5
#define HDMA_CHANNEL_6  6
#define HDMA_CHANNEL_7  7
 
/*============================================================================
 * HDMA Transfer Modes
 *============================================================================*/

#define HDMA_MODE_1REG      0x00

#define HDMA_MODE_2REG      0x01

#define HDMA_MODE_1REG_2X   0x02

#define HDMA_MODE_2REG_2X   0x03

#define HDMA_MODE_4REG      0x04

#define HDMA_INDIRECT       0x40
 
/*============================================================================
 * Common Destination Registers
 *============================================================================*/

#define HDMA_DEST_CGADD     0x21

#define HDMA_DEST_CGDATA    0x22

#define HDMA_DEST_BG1HOFS   0x0D

#define HDMA_DEST_BG1VOFS   0x0E

#define HDMA_DEST_BG2HOFS   0x0F

#define HDMA_DEST_BG2VOFS   0x10

#define HDMA_DEST_BG3HOFS   0x11

#define HDMA_DEST_BG3VOFS   0x12

#define HDMA_DEST_WH0       0x26

#define HDMA_DEST_WH1       0x27

#define HDMA_DEST_COLDATA   0x32

#define HDMA_DEST_INIDISP   0x00

#define HDMA_DEST_BGMODE    0x05

#define HDMA_DEST_TM        0x2C

#define HDMA_DEST_M7A       0x1B

#define HDMA_DEST_M7B       0x1C

#define HDMA_DEST_M7C       0x1D

#define HDMA_DEST_M7D       0x1E
 
/*============================================================================
 * Core HDMA Functions
 *============================================================================*/

void hdmaSetup(u8 channel, u8 mode, u8 destReg, const void *table);

void hdmaSetupIndirect(u8 channel, u8 mode, u8 destReg, const void *table,
                       u8 dataBank);

void hdmaEnableMask(u8 channelMask);

void hdmaDisableMask(u8 channelMask);

void hdmaEnable(u8 channel);

void hdmaDisable(u8 channel);

void hdmaDisableAll(void);

u8 hdmaGetEnabled(void);

void hdmaSetTable(u8 channel, const void *table);
 
/*============================================================================
 * HDMA Effect Helpers
 *============================================================================*/

void hdmaParallax(u8 channel, u8 bg, const void *scrollTable);

void hdmaGradient(u8 channel, const void *colorTable);

void hdmaWindowShape(u8 channel, const void *windowTable);
 
/*============================================================================
 * HDMA Wave Effect Functions
 *============================================================================*/

void hdmaWaveInit(void);

void hdmaWaveH(u8 channel, u8 bg, u8 amplitude, u8 frequency);

void hdmaWaveUpdate(void);

void hdmaWaveStop(void);

void hdmaWaveSetSpeed(u8 speed);
 
/*============================================================================
 * HDMA Brightness Gradient
 *============================================================================*/

void hdmaBrightnessGradient(u8 channel, u8 topBrightness, u8 bottomBrightness);

void hdmaBrightnessGradientStop(u8 channel);
 
/*============================================================================
 * HDMA Color Gradient
 *============================================================================*/

void hdmaColorGradient(u8 channel, u8 colorIndex, u16 topColor, u16 bottomColor);

void hdmaColorGradientStop(u8 channel);
 
/*============================================================================
 * HDMA Iris Wipe (Circular Window)
 *============================================================================*/

void hdmaIrisWipe(u8 channel, u8 layers, u8 centerX, u8 centerY, u8 radius);

void hdmaIrisWipeStop(u8 channel);
 
/*============================================================================
 * HDMA Water Ripple
 *============================================================================*/

void hdmaWaterRipple(u8 channel, u8 bg, u8 amplitude, u8 speed);
 
#endif /* OPENSNES_HDMA_H */