wsgPalette.h File Reference

Detailed Description

Provides palette swap functionality for Swadge.

Author

Jeremy Stintzcum (jerem.nosp@m.y.st.nosp@m.intzc.nosp@m.um@g.nosp@m.mail..nosp@m.com)

Version

1.0.0

Date

2024-09-20

Copyright

Copyright (c) 2024

Design Philosophy

Provides functionality to WSGs to use a palette a la the NES. See wsg.h for how these are implemented.

Clones all the current options for drawing WSGs, but all of them require a new parameter, 'palette' which is a array of paletteColor_t objects. The functions largely just intercepts the color given by the WSG and converts it based on the newColor map.

Usage

There are three setup functions:

• wsgPaletteReset(): Resets the provided palette to draw the default colors
• wsgPaletteSet(): Provided the palette, a color to overwrite and a new color to use, sets the color
• wsgPaletteSetGroup(): Does the same as above, but using lists to make generation easier

If wsgPaletteReset() isn't called for the palette being used, all colors not specifically assigned will be black.

There are four drawing functions provided with the palette

• drawWsgPalette(): Draws the WSG with the appropriate palette
• drawWsgPaletteSimple(): Draws the WSG with palette, but can't be rotated or flipped.
• drawWsgPaletteSimpleScaled(): Draws the WSG with palette at a larger size set by the provided scale (integer values, 2x, 3x, 4x...).
• drawWsgPaletteSimpleHalf(): Draws the WSG at half scale with the included palette.

Example

// In modeData_t
{
    wsgPalette_t pal;
}
 
// In modeEnter
{
    // Palette setup
    wsgPaletteReset(&pal);
    wsgPaletteSet(&pal, c000, c555);
}
 
// Where the WSG is drawn
{
    drawWsgPalette(&wsg, x, y, &pal, vertFlip, HorFlip, rotation);
}

Go to the source code of this file.

Data Structures
struct	wsgPalette_t

Functions
void	drawWsgPalette (const wsg_t *wsg, int16_t xOff, int16_t yOff, wsgPalette_t *palette, bool flipLR, bool flipUD, int16_t rotateDeg)
	Draw a WSG to the display utilizing a palette.
void	drawWsgPaletteSimple (const wsg_t *wsg, int16_t xOff, int16_t yOff, wsgPalette_t *palette)
	Draw a WSG to the display without flipping or rotation.
void	drawWsgPaletteSimpleScaled (const wsg_t *wsg, int16_t xOff, int16_t yOff, wsgPalette_t *palette, int16_t xScale, int16_t yScale)
	Draw a WSG to the display without flipping or rotation.
void	drawWsgPaletteSimpleHalf (const wsg_t *wsg, int16_t xOff, int16_t yOff, wsgPalette_t *palette)
	Draw a WSG to the display without flipping or rotation at half size.
void	wsgPaletteReset (wsgPalette_t *palette)
	Resets the palette to initial state.
void	wsgPaletteSet (wsgPalette_t *palette, paletteColor_t replaced, paletteColor_t newColor)
	Sets a single color to the provided palette.
void	wsgPaletteSetGroup (wsgPalette_t *palette, paletteColor_t *replacedColors, paletteColor_t *newColors, uint8_t arrSize)

---

Data Structure Documentation

wsgPalette_t

struct wsgPalette_t

Data Fields
paletteColor_t	newColors[217]	Color map.

Function Documentation

drawWsgPalette()

void drawWsgPalette	(	const wsg_t *	wsg,
		int16_t	xOff,
		int16_t	yOff,
		wsgPalette_t *	palette,
		bool	flipLR,
		bool	flipUD,
		int16_t	rotateDeg )

Draw a WSG to the display utilizing a palette.

Parameters

wsg	The WSG to draw to the display
xOff	The x offset to draw the WSG at
yOff	The y offset to draw the WSG at
palette	The new palette used to translate the colors
flipLR	true to flip the image across the Y axis
flipUD	true to flip the image across the X axis
rotateDeg	The number of degrees to rotate clockwise, must be 0-359

drawWsgPaletteSimple()

void drawWsgPaletteSimple	(	const wsg_t *	wsg,
		int16_t	xOff,
		int16_t	yOff,
		wsgPalette_t *	palette )

Draw a WSG to the display without flipping or rotation.

Parameters

wsg	The WSG to draw to the display
xOff	The x offset to draw the WSG at
yOff	The y offset to draw the WSG at
palette	Color Map to use

drawWsgPaletteSimpleScaled()

void drawWsgPaletteSimpleScaled	(	const wsg_t *	wsg,
		int16_t	xOff,
		int16_t	yOff,
		wsgPalette_t *	palette,
		int16_t	xScale,
		int16_t	yScale )

Draw a WSG to the display without flipping or rotation.

Parameters

wsg	The WSG to draw to the display
xOff	The x offset to draw the WSG at
yOff	The y offset to draw the WSG at
palette	Color Map to use
xScale	The amount to scale the image horizontally
yScale	The amount to scale the image vertically

drawWsgPaletteSimpleHalf()

void drawWsgPaletteSimpleHalf	(	const wsg_t *	wsg,
		int16_t	xOff,
		int16_t	yOff,
		wsgPalette_t *	palette )

Draw a WSG to the display without flipping or rotation at half size.

Parameters

wsg	The WSG to draw to the display
xOff	The x offset to draw the WSG at
yOff	The y offset to draw the WSG at
palette	Color Map to use

wsgPaletteReset()

void wsgPaletteReset

(

wsgPalette_t *

palette

)

Resets the palette to initial state.

Parameters

palette

Color map to modify

wsgPaletteSet()

void wsgPaletteSet	(	wsgPalette_t *	palette,
		paletteColor_t	replacedColor,
		paletteColor_t	newColor )

Sets a single color to the provided palette.

Parameters

palette	Color map to modify
replacedColor	Color to be replaced
newColor	Color that will replace the previous

wsgPaletteSetGroup()

void wsgPaletteSetGroup	(	wsgPalette_t *	palette,
		paletteColor_t *	replacedColors,
		paletteColor_t *	newColors,
		uint8_t	arrSize )