effectPass()

function effectPass<U>(params: {
  target?: RenderTarget | null;
  targetParams?: RenderTargetParams;
  vertex?: string;
  gl?: WebGL2RenderingContext;
  fragment: string;
  attributes?: Record<string, Attribute>;
  blending?: "none" | "normal" | "additive";
  depthTest?: boolean;
  drawMode?:
    | "POINTS"
    | "LINES"
    | "LINE_STRIP"
    | "LINE_LOOP"
    | "TRIANGLES"
    | "TRIANGLE_STRIP"
    | "TRIANGLE_FAN";
  transformFeedbackVaryings?: string[];
  resolutionScale?: number;
  uniforms?: U;
}): EffectPass<U>;

Creates a post-processing effect pass that renders a full-screen quad.

Use with compositor() or glCanvas().

Example: Single pass

Type Parameters

U

U extends EffectUniforms

Parameters

params

Configuration for the effect pass.

target?

| RenderTarget | null

Caller-owned target, or null to render to the default framebuffer.

targetParams?

RenderTargetParams

Parameters for an effect-owned target, disposed with the effect.

Default

floatTargetConfig;

vertex?

string

Optional vertex shader. If omitted, the built-in full-screen triangle vertex shader is used and its UV varying is adapted to the fragment shader.

gl?

WebGL2RenderingContext

Optional WebGL2 context used to initialize the pass immediately.

Passes without a context are initialized by calling pass.initialize(gl) or using the compositor. Calling initialize() multiple times with the same context is a no-op.

fragment

string

Fragment shader source code.

attributes?

Record<string, Attribute>

Mapping of attribute names to their data and configuration.

blending?

"none" | "normal" | "additive"

Blending mode to use for this pass.

Default

"none";

depthTest?

boolean

Whether to enable depth testing.

Default

false;

drawMode?

| "POINTS" | "LINES" | "LINE_STRIP" | "LINE_LOOP" | "TRIANGLES" | "TRIANGLE_STRIP" | "TRIANGLE_FAN"

WebGL draw mode.

Default

"POINTS" if gl_PointSize is found in the vertex shader, otherwise "TRIANGLES".

transformFeedbackVaryings?

string[]

Array of varying names for Transform Feedback.

resolutionScale?

number

Scaling factor applied to the resolution when the pass is resized.

Default

1;

uniforms?

U

Uniform values, synchronous functions, promises, or media descriptors.

Returns

EffectPass<U>