Grid

A Grid effect

import { Grid } from '@react-three/postprocessing'
import { BlendFunction } from 'postprocessing'

return (
  <Grid
    blendFunction={BlendFunction.OVERLAY} // blend mode
    scale={1.0} // grid pattern scale
    lineWidth={0.0} // grid pattern line width
    size={{ width, height }} // overrides the default pass width and height
  />
)

Example

Grid demo

Props

NameTypeDefaultDescription
blendFunctionBlendFunctionBlendFunction.OVERLAYThe blend function of this effect.
scaleNumber1The scale of the grid pattern.
lineWidthNumber0The line width of the grid pattern.
size{ width: Number, height: Number }Overrides the default pass width and height.
opacityNumber1The opacity of this effect.