@jmu-cs/customscale-camanjs-filter

1.0.0 • Public • Published

customscale-camanjs-filter

Grayscale the input image, then map black and white to custom colors.

Example

Caman('#canvas', function () {
    this.revert(false)
    this.customscale()
    this.render()

The custom scale filter accepts four optional arguments (customscale([luminance[, black[, white[, scalingFunction]]]])):

  • luminance
    • whether to grayscale the image using "luminance" values (grayscale (r, g, b) == original (r * 0.299, g * 0.587, b * 0.114)) or simple average
    • default: true, so use the "luminance" values
  • black
    • the color to which grayscaled black should be mapped
    • default: JMU Purple = #450084
  • white
    • the color to which grayscaled white should be mapped
    • default: JMU Gold = #cbb677
  • scalingFunction
    • a function that accepts a percentage value (percent of max color value == input/255.0) and returns a new percentage to change the map from grayscale to customscale to a custom curve
    • default: linear (returns percentage without modification)

Readme

Keywords

none

Package Sidebar

Install

npm i @jmu-cs/customscale-camanjs-filter

Weekly Downloads

0

Version

1.0.0

License

ISC

Unpacked Size

2.87 kB

Total Files

3

Last publish

Collaborators

  • tgm