module:extras/colormatrixshader

Back to documentation index.

### module:extras/colormatrixshader()

The extras/colormatrixshader.js module. To import all symbols in this module, either of the following can be used:

import * from "extras/colormatrixshader.js";
// -- or --
import * as CustomModuleName from "extras/colormatrixshader.js";

Members

• colorMatrixShader
  GLSL shader data for a family of image processing filters, which modify colors based on a transformation matrix, a 4 × 4 matrix that is multiplied by the red/green/blue color to get a new color.

Methods

• getColorMatrix
  Gets a specific kind of color matrix for the color matrix shader.

### module:extras/colormatrixshader.colorMatrixShader (constant)

GLSL shader data for a family of image processing filters, which modify colors based on a transformation matrix, a 4 × 4 matrix that is multiplied by the red/green/blue color to get a new color. The shader program takes three uniforms: “sampler”, which is the texture to which the filter is to be applied, “t”, a value from 0 to 1 indicating how strongly to apply the color matrix, and “matrix”, which is the 4 × 4 matrix just described.

### (static) module:extras/colormatrixshader.getColorMatrix(kind)

Gets a specific kind of color matrix for the color matrix shader.

Parameters

• kind (Type: string)
  One of the following:<ul> <li>“grayscale” - Filter that averages the red, green, and blue components to result in black, white, or a shade of gray. <li>“boosted-red” - Filter that boosts the red component of the image’s colors. <li>“boosted-blue” - Filter that boosts the blue component of the image’s colors. <li>“sepia” or “sepia2” - One of two filters that adjust the colors of the image to achieve a sepia coloring. <li>“invert” - Filter that inverts the colors of the image so the effect looks like a film negative. </ul>

Return Value

4 × 4 color matrix. (Type: Array.<number>)

Back to documentation index.