createPassEffect

createPassEffect<S>(config): PassEffectClass<S>

Defined in: packages/three-flatland/src/pipeline/PassEffect.ts:525

Create a PassEffect class from a configuration object.

Type Parameters

S

S extends EffectSchema

Parameters

config

PassEffectConfig<S>

Returns

PassEffectClass<S>

Example

const VignetteEffect = createPassEffect({
  name: 'vignette',
  schema: { intensity: 0.5 },
  pass: ({ uniforms }) => (input, uv) => vignette(input, uv, uniforms.intensity),
})

const v = new VignetteEffect()
flatland.addPass(v)
v.intensity = 0.8  // zero-cost uniform update