Colors & Palette

Pal(args ...interface{})

Configures draw palette mappings, mimicking PICO-8's pal(c0, c1, p). When color c0 is requested for drawing, c1 is used instead.

Parameters:

Example:

p8.Pal(8, 12) // draw color 8 (red) as color 12 (blue) instead
p8.Pal()      // reset all palette mappings

See also: Colors and Palette

Palt(args ...interface{})

Sets color transparency for drawing. With no arguments, resets to default (only black transparent).

Parameters:

Note: the real signature is variadic (args ...interface{}); color and transparent are extracted positionally from args rather than being named parameters (the same pattern used by Cursor/Print).

Example:

p8.Spr(1, 10, 10)  // default transparency (black transparent)
p8.Palt(8, true)   // make red transparent
p8.Spr(1, 20, 10)  // now red pixels in the sprite are transparent
p8.Palt()          // reset to default transparency

See also: Colors and Palette

Color(colorIndex int)

Sets the current draw color used by subsequent drawing operations.

Parameters:

Example:

p8.Color(8)   // set current draw color to red
p8.Sset(10, 20) // draws a red pixel on the spritesheet at (10, 20)

See also: Colors and Palette

GetPaletteColor(colorIndex int) color.Color

Returns the color.Color at the given palette index, or nil if out of range.

Parameters:

Example:

c := p8.GetPaletteColor(3)

See also: Colors and Palette

GetPaletteSize() int

Returns the current number of colors in the active palette.

Example:

size := p8.GetPaletteSize()
p8.Print(fmt.Sprintf("Palette has %d colors", size), 10, 10, 7)

See also: Colors and Palette

SetPalette(newPalette []color.Color)

Replaces the entire color palette. Resizes the transparency array to match, resetting only index 0 as transparent by default.

Parameters:

Example:

grayscale := []color.Color{
	color.RGBA{0, 0, 0, 255},
	color.RGBA{85, 85, 85, 255},
	color.RGBA{170, 170, 170, 255},
	color.RGBA{255, 255, 255, 255},
}
p8.SetPalette(grayscale)

See also: Palette Effects

SetPaletteColor(colorIndex int, newColor color.Color)

Replaces a single palette color at the given index. No-op if the index is out of range.

Parameters:

Example:

p8.SetPaletteColor(7, color.RGBA{200, 220, 255, 255}) // change white to light blue

See also: Palette Effects