import { type Random } from "../data/random.js"; /** * Color palettes that can be used to quickly colorize a drawing. */ export declare const PALETTES: number[][]; /** * The indices of pre-defined palettes, with friendly names. * @see {@linkcode PALETTES} */ export declare const NamedPalettes: { /** * ![Autumn lake colors](../../docs/media/palette-autumn-lake.png) */ AutumnLake: number; /** * ![Camouflage colors](../../docs/media/palette-camouflage.png) */ Camouflage: number; /** * ![Frog pond colors](../../docs/media/palette-frog-pond.png) */ FrogPond: number; /** * ![Lillypads colors](../../docs/media/palette-lillypads.png) */ Lillypads: number; /** * ![Midnight colors](../../docs/media/palette-midnight.png) */ Midnight: number; /** * ![Plight colors](../../docs/media/palette-plight.png) */ Plight: number; /** * ![Riverside colors](../../docs/media/palette-riverside.png) */ Riverside: number; /** * ![Seaside colors](../../docs/media/palette-seaside.png) */ Seaside: number; /** * ![Spring colors](../../docs/media/palette-spring.png) */ Spring: number; /** * ![Sunflower field colors](../../docs/media/palette-sunflower-field.png) */ SunflowerField: number; /** * ![Terminator colors](../../docs/media/palette-terminator.png) */ Terminator: number; /** * ![Terra colors](../../docs/media/palette-terra.png) */ Terra: number; /** * ![Tundra colors](../../docs/media/palette-tundra.png) */ Tundra: number; }; /** * Retrieves a friendly name for a pallete index. * @param paletteIndex - The index of the pre-defined palette. * @returns The friendly name of the palette, or `""`. */ export declare const paletteName: (paletteIndex: number) => string; /** * Provides pre-defined color values for drawing operations. */ export declare class Palette { #private; /** * Retrieve the index of the currently selected, pre-defined palette values. * @see {@linkcode PALETTES} * @returns The index of the currently selected, pre-defined palette values. */ get paletteIndex(): number; /** * Retrieve the 24bit color values of the currently selected palette. * @returns The colors in the palette. */ get colors(): ReadonlyArray; /** * Constructs a new palette. * @param paletteIndex - The index of the pre-defined palette to use. */ constructor(paletteIndex?: number); /** * Uses the next pre-defined color value set for this palette. * @returns This instance. */ nextPalette(): this; /** * Retrieve a random color from the palette. * @param randomInstance - The PRNG to use. Ideally, supply your own. * @returns A random color from the palette. */ someColor(randomInstance?: Random): number; } /** * A pre-constructed palette instance, for convenience. */ export declare const palette: Palette; /** * Retrieves a random color from the current global palette. * Uses the global {@linkcode random} object. * @returns A random color. */ export declare const someColor: () => number; /** * Switches the global palette to the next available preset. * @returns The new new global palette. * @deprecated Use {@linkcode Palette} instead. */ export declare const nextPalette: () => number[]; export declare const hslPalette: (entries: number, shift?: number, saturation?: number, luminance?: number) => Array<[number, number, number]>; export declare const hsvPalette: (entries: number, shift?: number, saturation?: number, value?: number) => Array<[number, number, number]>;