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
Grid Demo

Props

NameTypeDefaultDescription
blendFunctionBlendFunctionBlendFunction.NORMALThe blend function of this effect.
scaleNumber1The scale of the grid pattern.
lineWidthNumber0The blend function of this effect.
widthNumberOverrides the default pass width
heightNumberOverrides the default pass height