Home Reference Source

Variable

Static Public Summary
public

A blend function enumeration.

public

A color channel enumeration.

public

An enumeration of depth copy modes.

public

An enumeration of edge detection modes.

public

An enumeration of effect attributes.

public

A glitch mode enumeration.

public

A kernel size enumeration.

public

An enumeration of LUT worker operations.

public

A mask function enumeration.

public
this variable was deprecated. Use OutlineMaterial instead.

An outline shader material.

public

An enumeration of predication modes.

public

An enumeration of SMAA presets.

public

An enumeration of shader code placeholders used by the EffectPass.

public

A tone mapping mode enumeration.

public

An enumeration of WebGL extensions.

Static Public

public BlendFunction: Object source

import {BlendFunction} from 'postprocessing'

A blend function enumeration.

Properties:

NameTypeAttributeDescription
SKIP Number

No blending. The effect will not be included in the final shader.

ADD Number

Additive blending. Fast, but may produce washed out results.

ALPHA Number

Alpha blending. Blends based on the alpha value of the new color.

AVERAGE Number

Average blending.

COLOR_BURN Number

Color burn.

COLOR_DODGE Number

Color dodge.

DARKEN Number

Prioritize darker colors.

DIFFERENCE Number

Color difference.

EXCLUSION Number

Color exclusion.

LIGHTEN Number

Prioritize lighter colors.

MULTIPLY Number

Color multiplication.

DIVIDE Number

Color division.

NEGATION Number

Color negation.

NORMAL Number

Normal blending. The new color overwrites the old one.

OVERLAY Number

Color overlay.

REFLECT Number

Color reflection.

SCREEN Number

Screen blending. The two colors are effectively projected on a white screen simultaneously.

SOFT_LIGHT Number

Soft light blending.

SUBTRACT Number

Color subtraction.

public ColorChannel: Object source

import {ColorChannel} from 'postprocessing'

A color channel enumeration.

Properties:

NameTypeAttributeDescription
RED Number

Red.

GREEN Number

Green.

BLUE Number

Blue.

ALPHA Number

Alpha.

public DepthCopyMode: Object source

import {DepthCopyMode} from 'postprocessing'

An enumeration of depth copy modes.

Properties:

NameTypeAttributeDescription
FULL Number

Copies the full depth texture every frame.

SINGLE Number

Copies a single texel from the depth texture on demand.

public EdgeDetectionMode: Object source

import {EdgeDetectionMode} from 'postprocessing'

An enumeration of edge detection modes.

Properties:

NameTypeAttributeDescription
DEPTH Number

Depth-based edge detection.

LUMA Number

Luminance-based edge detection.

COLOR Number

Chroma-based edge detection.

public EffectAttribute: Object source

import {EffectAttribute} from 'postprocessing'

An enumeration of effect attributes.

Attributes can be concatenated using the bitwise OR operator.

Properties:

NameTypeAttributeDescription
NONE Number

No attributes. Most effects don't need to specify any attributes.

DEPTH Number

Describes effects that require a depth texture.

CONVOLUTION Number

Describes effects that fetch additional samples from the input buffer. There cannot be more than one effect with this attribute per EffectPass.

Example:

const attributes = EffectAttribute.CONVOLUTION | EffectAttribute.DEPTH;

public GlitchMode: Object source

import {GlitchMode} from 'postprocessing'

A glitch mode enumeration.

Properties:

NameTypeAttributeDescription
DISABLED Number

No glitches.

SPORADIC Number

Sporadic glitches.

CONSTANT_MILD Number

Constant mild glitches.

CONSTANT_WILD Number

Constant wild glitches.

public KernelSize: Object source

import {KernelSize} from 'postprocessing'

A kernel size enumeration.

Properties:

NameTypeAttributeDescription
VERY_SMALL Number

A very small kernel that matches a 7x7 Gauss blur kernel.

SMALL Number

A small kernel that matches a 15x15 Gauss blur kernel.

MEDIUM Number

A medium sized kernel that matches a 23x23 Gauss blur kernel.

LARGE Number

A large kernel that matches a 35x35 Gauss blur kernel.

VERY_LARGE Number

A very large kernel that matches a 63x63 Gauss blur kernel.

HUGE Number

A huge kernel that matches a 127x127 Gauss blur kernel.

public LUTOperation: Object source

import {LUTOperation} from 'postprocessing'

An enumeration of LUT worker operations.

Properties:

NameTypeAttributeDescription
SCALE_UP String

Tetrahedral upscale operation.

public MaskFunction: Object source

import {MaskFunction} from 'postprocessing'

A mask function enumeration.

Properties:

NameTypeAttributeDescription
DISCARD Number

Discards elements when the respective mask value is zero.

MULTIPLY Number

Multiplies the input buffer with the mask texture.

MULTIPLY_RGB_SET_ALPHA Number

Multiplies the input RGB values with the mask and sets alpha to the mask value.

public OutlineEdgesMaterial: * source

import {OutlineEdgesMaterial} from 'postprocessing'
this variable was deprecated. Use OutlineMaterial instead.

An outline shader material.

public PredicationMode: Object source

import {PredicationMode} from 'postprocessing'

An enumeration of predication modes.

Properties:

NameTypeAttributeDescription
DISABLED Number

No predicated thresholding.

DEPTH Number

Depth-based predicated thresholding.

CUSTOM Number

Predicated thresholding using a custom buffer.

public SMAAPreset: Object source

import {SMAAPreset} from 'postprocessing'

An enumeration of SMAA presets.

Properties:

NameTypeAttributeDescription
LOW Number

Results in around 60% of the maximum quality.

MEDIUM Number

Results in around 80% of the maximum quality.

HIGH Number

Results in around 95% of the maximum quality.

ULTRA Number

Results in around 99% of the maximum quality.

public Section: Object source

import {Section} from 'postprocessing'

An enumeration of shader code placeholders used by the EffectPass.

Properties:

NameTypeAttributeDescription
FRAGMENT_HEAD String

A placeholder for function and variable declarations inside the fragment shader.

FRAGMENT_MAIN_UV String

A placeholder for UV transformations inside the fragment shader.

FRAGMENT_MAIN_IMAGE String

A placeholder for color calculations inside the fragment shader.

VERTEX_HEAD String

A placeholder for function and variable declarations inside the vertex shader.

VERTEX_MAIN_SUPPORT String

A placeholder for supporting calculations inside the vertex shader.

public ToneMappingMode: Object source

import {ToneMappingMode} from 'postprocessing'

A tone mapping mode enumeration.

Properties:

NameTypeAttributeDescription
REINHARD Number

Simple Reinhard tone mapping.

REINHARD2 Number

Modified Reinhard tone mapping.

REINHARD2_ADAPTIVE Number

Simulates the optic nerve responding to the amount of light it is receiving.

OPTIMIZED_CINEON Number

Optimized filmic operator by Jim Hejl and Richard Burgess-Dawson.

ACES_FILMIC Number

ACES tone mapping with a scale of 1.0/0.6.

public WebGLExtension: Object source

import {WebGLExtension} from 'postprocessing'

An enumeration of WebGL extensions.

Properties:

NameTypeAttributeDescription
DERIVATIVES String

Enables derivatives by adding the functions dFdx, dFdy and fwidth.

FRAG_DEPTH String

Enables gl_FragDepthEXT to set a depth value of a fragment from within the fragment shader.

DRAW_BUFFERS String

Enables multiple render targets (MRT) support.

SHADER_TEXTURE_LOD String

Enables explicit control of texture LOD.