input.h

Go to the documentation of this file.

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

 
/*
 * SNES Joypad Register Layout (16-bit read as JOY1L | JOY1H << 8):
 *
 *   $4219 (JOY1H) → bits 15-8:  B, Y, Select, Start, Up, Down, Left, Right
 *   $4218 (JOY1L) → bits 7-0:   A, X, L, R, (signature bits)
 *
 * Bit layout (16-bit, active high):
 *   15   14   13   12   11   10   9    8    7    6    5    4    3-0
 *   B    Y    Sel  Sta  Up   Dn   Lt   Rt   A    X    L    R    ID
 *
 * Verified against fullsnes documentation and real hardware.
 */
 
/* High byte ($4219 → result bits 15-8) */
#define KEY_B       BIT(15)  
#define KEY_Y       BIT(14)  
#define KEY_SELECT  BIT(13)  
#define KEY_START   BIT(12)  
#define KEY_UP      BIT(11)  
#define KEY_DOWN    BIT(10)  
#define KEY_LEFT    BIT(9)   
#define KEY_RIGHT   BIT(8)   
 
/* Low byte ($4218 → result bits 7-0) */
#define KEY_A       BIT(7)   
#define KEY_X       BIT(6)   
#define KEY_L       BIT(5)   
#define KEY_R       BIT(4)   

#define KEY_DPAD    (KEY_UP | KEY_DOWN | KEY_LEFT | KEY_RIGHT)

#define KEY_FACE    (KEY_A | KEY_B | KEY_X | KEY_Y)

 
/*============================================================================
 * Functions
 *============================================================================*/

u16 padPressed(u8 pad);

u16 padHeld(u8 pad);

u16 padReleased(u8 pad);
 
/* padHeld() and padPressed() read one word that the NMI handler filled, so
 * they are also macros (since 2026-10-09): a call cost about 125 CPU cycles,
 * three times a frame in most games, for what is one load. The handler
 * already stores 0 for a port that holds no pad, which is all the functions
 * added. The functions remain — `(padHeld)(0)` calls one, and so does taking
 * its address. Unlike them the macros do not check `pad`: an index above 4
 * reads whatever follows the array. */
extern u16 pad_keys[5];      
extern u16 pad_keysold[5];   
extern u16 pad_keysdown[5];  
#define padHeld(pad)    (pad_keys[(pad)])
#define padPressed(pad) (pad_keysdown[(pad)])

u8 padIsConnected(u8 pad);
 
/*============================================================================
 * Mouse Constants
 *============================================================================*/

 
#define MOUSE_BUTTON_LEFT   0x01  
#define MOUSE_BUTTON_RIGHT  0x02  
 
#define MOUSE_SENS_LOW      0     
#define MOUSE_SENS_MEDIUM   1     
#define MOUSE_SENS_HIGH     2     

u8 mouseInit(u8 port);

u8 mouseIsConnected(u8 port);

s16 mouseGetX(u8 port);

s16 mouseGetY(u8 port);

u8 mouseButtonsHeld(u8 port);

u8 mouseButtonsPressed(u8 port);

void mouseSetSensitivity(u8 port, u8 sensitivity);

u8 mouseGetSensitivity(u8 port);

 
/*============================================================================
 * Super Scope Constants
 *============================================================================*/

 
#define SSC_FIRE        0x8000  
#define SSC_CURSOR      0x4000  
#define SSC_TURBO       0x2000  
#define SSC_PAUSE       0x1000  
#define SSC_OFFSCREEN   0x0200  
#define SSC_NOISE       0x0100  

u8 scopeInit(void);

u8 scopeIsConnected(void);

u16 scopeGetX(void);

u16 scopeGetY(void);

u16 scopeGetRawX(void);

u16 scopeGetRawY(void);

u16 scopeButtonsHeld(void);

u16 scopeButtonsPressed(void);

u16 scopeButtonsRepeat(void);

void scopeCalibrate(void);

void scopeSetHoldDelay(u16 frames);

void scopeSetRepeatDelay(u16 frames);

u16 scopeSinceShot(void);

 
#endif /* OPENSNES_INPUT_H */