colormath.h

Go to the documentation of this file.

 
#ifndef OPENSNES_COLORMATH_H
#define OPENSNES_COLORMATH_H
 
#include <snes/types.h>
#include <snes/registers.h>  /* REG_CGWSEL / REG_CGADSUB / REG_COLDATA */
 
/* Removed on 2026-10-05 (1.0 plan, lot C): colorMathEnable.
 * The replacements are in docs/UPGRADING.md; `make check-upgrade` names them. */
 
/*============================================================================
 * Layer Masks (for colorMathSetLayers)
 *============================================================================*/
 
/* The layers are named by LAYER_BG1..LAYER_BG4 and LAYER_OBJ (video.h), the
 * same bits everywhere a call takes a set of layers. The backdrop is the one
 * bit only color math has. */

#define COLORMATH_BACKDROP  BIT(5)

#define COLORMATH_ALL       0x3F
 
/* COLORMATH_BG1..COLORMATH_BG4 and COLORMATH_OBJ were removed on 2026-10-05: use
 * LAYER_BG1..LAYER_OBJ (video.h), the same values (docs/UPGRADING.md). */
 
/*============================================================================
 * Color Math Operations
 *============================================================================*/

#define COLORMATH_ADD       0

#define COLORMATH_SUB       1
 
/*============================================================================
 * Color Math Source
 *============================================================================*/

#define COLORMATH_SRC_SUBSCREEN 0

#define COLORMATH_SRC_FIXED     1
 
/*============================================================================
 * Color Math Enable Conditions
 *============================================================================*/

#define COLORMATH_ALWAYS    0

#define COLORMATH_INSIDE    1

#define COLORMATH_OUTSIDE   2

#define COLORMATH_NEVER     3
 
/*============================================================================
 * Fixed Color Channel Masks
 *============================================================================*/

#define COLDATA_RED     0x20

#define COLDATA_GREEN   0x40

#define COLDATA_BLUE    0x80

#define COLDATA_ALL     (COLDATA_RED | COLDATA_GREEN | COLDATA_BLUE)
 
/*============================================================================
 * Core Color Math Functions
 *============================================================================*/

void colorMathInit(void);

void colorMathSetLayers(u8 layers);

void colorMathDisable(void);

void colorMathSetOp(u8 op);

void colorMathSetHalf(u8 enable);

void colorMathSetSource(u8 source);

void colorMathSetCondition(u8 condition);

void colorMathSetDirectColor(u8 enable);

void colorMathSetFixedColor(u8 r, u8 g, u8 b);

void colorMathSetChannel(u8 channel, u8 intensity);
 
/*============================================================================
 * Color Math Effect Helpers
 *============================================================================*/

void colorMathTransparency50(u8 layers);

void colorMathShadow(u8 layers, u8 intensity);

void colorMathTint(u8 layers, u8 r, u8 g, u8 b);

void colorMathSetBrightness(u8 brightness);
 
#endif /* OPENSNES_COLORMATH_H */