Class BpxCanvasSnapshotColorMapping

Staticfrom

• from(colorMappingEntries): BpxCanvasSnapshotColorMapping

• Creates a simplified color mapping, based on a map of canvas snapshot colors to the new ones.

  Parameters

  • colorMappingEntries: [BpxRgbColor, BpxRgbColor][]

  Returns BpxCanvasSnapshotColorMapping

  Example

  BpxCanvasSnapshotColorMapping.from([
    [$rgb_red, $rgb_green],
    [$rgb_blue, $rgb_green],
    [$rgb_yellow, $rgb_red],
  ]);
  Copy

Staticof

• of(mapper): BpxCanvasSnapshotColorMapping

• Creates a color mapping which uses a function to map a canvas snapshot color into a new one.

  Parameters

  • mapper: BpxColorMapper

  Returns BpxCanvasSnapshotColorMapping

  Example

  BpxCanvasSnapshotColorMapping.of((color: BpxRgbColor | null, spriteX: number, spriteY: number) =>
    color
      ? $rgb(255 - color.r, 255 - color.g, 255 - color.b)
      : null
  );
  Copy

getMappedColor

• getMappedColor(snapshot, canvasX, canvasY): null | BpxRgbColor

• The main method of this class, used to get a mapped color for a given color on the canvas snapshot.

  Parameters

  • snapshot: null | BpxCanvasSnapshot
  • canvasX: number
  • canvasY: number

  Returns null | BpxRgbColor

Readonlytype

const c:
  | null
  | BpxRgbColor
  | BpxPatternColors
  | BpxSpriteColorMapping
  | BpxCanvasSnapshotColorMapping
  = getColor();
if (c == null) {
  // c is transparent here
} else if (c.type === "rgb") {
  // c is BpxRgbColor here
} else if (c.type === "pattern") {
  // c is BpxPatternColors here
} else if (c.type === "sprite_mapping") {
  // c is BpxSpriteColorMapping here
} else if (c.type === "canvas_snapshot_mapping") {
  // c is BpxCanvasSnapshotColorMapping here
} else {
  $u.assertUnreachable(c);
}
Copy