References

core

summary
public	C EffectComposer The EffectComposer may be used in place of a normal WebGLRenderer.
public	C EffectShaderData A collection of shader data.
public	C GaussKernel A Gauss kernel.
public	C OverrideMaterialManager An override material manager.
public	C Resolution A resolution.
public	C Selection An object selection.
public	C Timer this class was deprecated. Use `three/addons/misc/Timer.js` instead. A timer.
public	I Disposable The Disposable contract.
public	I ImmutableTimer A timer that provides read access to time data.
public	I Initializable The initializable contract.
public	I Resizable The Resizable contract.

effects

summary
public	C BloomEffect A bloom effect.
public	C BokehEffect this class was deprecated. Use DepthOfFieldEffect instead. A depth of field (bokeh) effect.
public	C BrightnessContrastEffect A brightness/contrast effect.
public	C ChromaticAberrationEffect A chromatic aberration effect.
public	C ColorAverageEffect A fast greyscale effect.
public	C ColorDepthEffect A color depth effect.
public	C DepthEffect A depth visualization effect.
public	C DepthOfFieldEffect A depth of field effect.
public	C DotScreenEffect A dot screen effect.
public	C Effect An abstract effect.
public	C FXAAEffect NVIDIA FXAA 3.11 by Timothy Lottes: https://developer.download.nvidia.com/assets/gamedev/files/sdk/11/FXAA_WhitePaper.pdf
public	C GammaCorrectionEffect this class was deprecated. Set WebGLRenderer.outputEncoding to sRGBEncoding instead. A gamma correction effect.
public	C GlitchEffect A glitch effect.
public	C GodRaysEffect A god rays effect.
public	C GridEffect A grid effect.
public	C HueSaturationEffect A hue/saturation effect.
public	C LUT1DEffect A 1D LUT effect.
public	C LUT3DEffect A LUT effect.
public	C LensDistortionEffect A lens distortion effect.
public	C NoiseEffect A noise effect.
public	C OutlineEffect An outline effect.
public	C PixelationEffect A pixelation effect.
public	C RealisticBokehEffect this class was deprecated. Use DepthOfFieldEffect instead. Depth of Field shader v2.4.
public	C SMAAEffect Subpixel Morphological Antialiasing (SMAA).
public	C SSAOEffect A Screen Space Ambient Occlusion effect.
public	C ScanlineEffect A scanline effect.
public	C SelectiveBloomEffect A selective bloom effect.
public	C SepiaEffect A sepia effect.
public	C ShockWaveEffect A shock wave effect.
public	C TextureEffect A texture effect.
public	C TiltShiftEffect A tilt shift effect.
public	C ToneMappingEffect A tone mapping effect.
public	C VignetteEffect A Vignette effect.

effects/blending

summary
public	C BlendMode A blend mode.

enums

summary
public	V BlendFunction: Object A blend function enumeration.
public	V ColorChannel: Object A color channel enumeration.
public	V DepthCopyMode: Object An enumeration of depth copy modes.
public	V DepthTestStrategy: Object An enumeration of depth test strategies.
public	V EdgeDetectionMode: Object An enumeration of edge detection modes.
public	V EffectAttribute: Object An enumeration of effect attributes.
public	V EffectShaderSection: Object An enumeration of effect shader placeholders.
public	V GlitchMode: Object A glitch mode enumeration.
public	V KernelSize: Object An enumeration of blur kernel sizes.
public	V LUTOperation: Object An enumeration of LUT worker operations.
public	V MaskFunction: Object A mask function enumeration.
public	V PredicationMode: Object An enumeration of SMAA predication modes.
public	V SMAAPreset: Object An enumeration of SMAA presets.
public	V ToneMappingMode: Object A tone mapping mode enumeration.
public	V VignetteTechnique: Object An enumeration of Vignette techniques.
public	V WebGLExtension: Object An enumeration of WebGL extensions.

loaders

summary
public	C LUT3dlLoader this class was deprecated. Use `three/addons/loaders/LUT3dlLoader.js` instead. A 3D LUT loader that supports the .3dl file format.
public	C LUTCubeLoader this class was deprecated. Use `three/addons/loaders/LUTCubeLoader.js` instead. A 3D LUT loader that supports the .cube file format.
public	C SMAAImageLoader this class was deprecated. Preloading the SMAA lookup textures is no longer required. this class is experimental. Added for testing, API might change in patch or minor releases. Requires three >= r108. An SMAA image loader.

materials

summary
public	C AdaptiveLuminanceMaterial An adaptive luminance shader material.
public	C BokehMaterial A bokeh disc blur material.
public	C BoxBlurMaterial A fast box blur material that supports depth-based bilateral filtering.
public	C CircleOfConfusionMaterial A Circle of Confusion shader material.
public	C CopyMaterial A simple copy shader material.
public	C DepthComparisonMaterial A depth comparison shader material.
public	C DepthCopyMaterial A depth copy shader material.
public	C DepthDownsamplingMaterial A depth downsampling shader material.
public	C DepthMaskMaterial A depth mask shader material.
public	C DownsamplingMaterial A downsampling material.
public	C EdgeDetectionMaterial An edge detection material.
public	C EffectMaterial An effect material for compound shaders.
public	C GaussianBlurMaterial An optimized Gaussian convolution shader material.
public	C GodRaysMaterial A crepuscular rays shader material.
public	C KawaseBlurMaterial An optimized convolution shader material.
public	C LuminanceMaterial A luminance shader material.
public	C MaskMaterial A mask shader material.
public	C OutlineMaterial An outline shader material.
public	C SMAAWeightsMaterial Subpixel Morphological Antialiasing.
public	C SSAOMaterial A Screen Space Ambient Occlusion (SSAO) shader material.
public	C TiltShiftBlurMaterial A tilt shift blur material.
public	C UpsamplingMaterial An upsampling material.

passes

summary
public	C AdaptiveLuminancePass A pass that renders an adaptive luminance map.
public	C BoxBlurPass A box blur pass.
public	C ClearMaskPass A pass that disables the stencil test.
public	C ClearPass A pass that clears the input buffer or the screen.
public	C CopyPass A pass that copies the contents of an input buffer to another render target.
public	C DepthCopyPass A pass that copies depth into a render target.
public	C DepthDownsamplingPass A pass that downsamples the scene depth by picking the most representative depth in 2x2 texel neighborhoods.
public	C DepthPass A pass that renders depth into an RGBA buffer.
public	C DepthPickingPass A depth picking pass.
public	C EffectPass An effect pass.
public	C GaussianBlurPass A Gaussian blur pass.
public	C KawaseBlurPass A Kawase blur pass.
public	C LambdaPass A pass that executes a given function.
public	C LuminancePass A pass that renders luminance.
public	C MaskPass A stencil mask pass.
public	C MipmapBlurPass A blur pass that produces a wide blur by downsampling and upsampling the input over multiple MIP levels.
public	C NormalPass A pass that renders the normals of a given scene.
public	C Pass An abstract pass.
public	C RenderPass A pass that renders a given scene into the input buffer or to screen.
public	C ShaderPass A shader pass.
public	C TiltShiftBlurPass A tilt shift blur pass.

textures

summary
public	C NoiseTexture A simple noise texture.
public	C RawImageData A container for raw RGBA image data.

textures/lut

summary
public	C LookupTexture A 3D lookup texture (LUT).
public	C TetrahedralUpscaler A tetrahedral upscaler that can be used to augment 3D LUTs.

textures/smaa

summary
public	C SMAAAreaImageData SMAA area image data.
public	C SMAAImageGenerator An SMAA image generator.
public	C SMAASearchImageData SMAA search image data.

utils

summary
public	C IdManager An ID manager.

Directories