Heatmap

Presets

Installation

npm i @paper-design/shaders-react

Code

import { Heatmap } from '@paper-design/shaders-react';

<Heatmap
  width={1280}
  height={720}
  image="https://shaders.paper.design/images/logos/diamond.svg"
  colors={["#cc3333", "#cc9933", "#99cc33", "#33cc33", "#33cc99", "#3399cc", "#3333cc"]}
  colorBack="#000000"
  contour={0.5}
  angle={0}
  noise={0}
  innerGlow={0.5}
  outerGlow={0.5}
  speed={1}
  scale={0.75}
/>

Shader Props

Name	Description	Type	Values
image	The image to use for the effect	`HTMLImageElement \| string`	Image object or URL
colors	Up to 10 colors used to color the heatmap	`string[]`	Hex, RGB, or HSL color
colorBack	Background color	`string`	Hex, RGB, or HSL color
contour	The heat intensity near the edges of the input shape	`number`	0 to 1
angle	The direction of the heatwaves (angle relative to the shape)	`number`	0 to 360
noise	Grain applied across the entire graphic	`number`	0 to 1
innerGlow	The size of the heated area inside the input shape	`number`	0 to 1
outerGlow	The side of the heated area outside the input shape	`number`	0 to 1

Common Props

Name	Description	Type	Values
speed	Animation speed	`number`	—
frame	Starting animation frame	`number`	—
scale	Overall zoom level of the graphics	`number`	0.01 to 4
rotation	Overall rotation angle of the graphics	`number`	0 to 360
offsetX	Horizontal offset of the graphics center	`number`	-1 to 1
offsetY	Vertical offset of the graphics center	`number`	-1 to 1
width	CSS width style of the shader element	`number \| string`	—
height	CSS height style of the shader element	`number \| string`	—
fit	How to fit the rendered shader into the canvas dimensions	`enum`	\| `"contain"` \| `"cover"`
worldWidth	Virtual width of the graphic before it's scaled to fit the canvas	`number`	—
worldHeight	Virtual height of the graphic before it's scaled to fit the canvas	`number`	—
originX	Reference point for positioning world width in the canvas	`number`	0 to 1
originY	Reference point for positioning world height in the canvas	`number`	0 to 1
minPixelRatio	Minimum pixel ratio to use when rendering the shader	`number`	—
maxPixelCount	Maximum pixel count that the shader may process	`number`	—

Description

A glowing gradient of colors flowing through an input image. It can for example shift from cool blues to hot reds, like thermal energy radiating through the shape. The effect creates a smoothly animated wave of intensity across the image.