@thi.ng/color/sort.d.ts

Array-based color types, CSS parsing, conversions, transformations, declarative theme generation, gradients, presets

import type { Fn } from "@thi.ng/api";
import type { ColorDistance, ReadonlyColor, TypedColor } from "./api.js";
export declare const selectChannel: (id: number) => (col: ReadonlyColor) => number;
/**
 * Takes a `target` color and optional `distance` function (default:
 * {@link distEucledian3}). Returns a new function which can be used as `key`
 * function for {@link sort} to compute the distance metric of a color to the
 * given `target`.
 *
 * @param target -
 * @param dist -
 */
export declare const proximity: (target: ReadonlyColor, dist?: ColorDistance) => (col: ReadonlyColor) => number;
/**
 * Similar to {@link proximity}, but intended as syntax sugar for {@link ABGR}
 * input colors. The proximity will still be computed using given distance
 * function (default: {@link distEucledian3}) and will be in sRGB space. Hence
 * given `target` color should be provided in the same space too.
 *
 * @param target -
 * @param dist -
 */
export declare const proximityABGR32: (target: ReadonlyColor, dist?: ColorDistance) => (col: ReadonlyColor) => number;
export declare const sort: <T extends ReadonlyColor>(colors: T[], key: Fn<ReadonlyColor, number>, isReverse?: boolean) => T[];
/**
 * Similar to {@link sort}, but only for memory mapped colors (e.g. mapping a
 * pixel buffer). Does NOT change the order of elements in given `colors` array,
 * BUT sorts the **apparent** order by swapping the contents of the backing
 * memory.
 *
 * ```ts tangle:../export/sort-mapped.ts
 * import { css, luminanceSrgb, sortMapped, srgb } from "@thi.ng/color";
 *
 * // memory buffer of 4 sRGB colors
 * const buf = new Float32Array([
 *   0, 1, 0, 1, 0, 0.5, 0, 1, 0, 0.25, 0, 1, 0, 0.75, 0, 1,
 * ]);
 *
 * // map buffer (creates 4 SRGB instances linked to the buffer)
 * const pix = srgb.mapBuffer(buf);
 *
 * // display original order
 * console.log(pix.map((x) => css(x)));
 * // [ '#00ff00', '#008000', '#004000', '#00bf00' ]
 *
 * // sort colors (buffer!) by luminance
 * sortMapped(pix, luminanceSrgb);
 *
 * // new order
 * console.log(pix.map((x) => css(x)));
 * // [ '#004000', '#008000', '#00bf00', '#00ff00' ]
 *
 * // buffer contents have been re-ordered
 * console.log(buf);
 * // Float32Array(16) [
 * //     0, 0.25, 0, 1,
 * //     0, 0.5, 0, 1,
 * //     0, 0.75, 0, 1,
 * //     0, 1, 0, 1
 * // ]
 * ```
 *
 * @param colors -
 * @param key -
 * @param isReverse -
 */
export declare const sortMapped: <T extends TypedColor<any>>(colors: T[], key: Fn<ReadonlyColor, number>, isReverse?: boolean) => T[];
export declare const mostSimilar: <T extends ReadonlyColor>(colors: T[], key: Fn<ReadonlyColor, number>) => T;
//# sourceMappingURL=sort.d.ts.map