Home Reference Source
import {ColorDepthEffect} from 'postprocessing'
public class | source

ColorDepthEffect

Extends:

three~EventDispatcherEffect → ColorDepthEffect

Indirect Implements:

A color depth effect.

Simulates a hardware limitation to achieve a retro feel.

Constructor Summary

Public Constructor
public

constructor(options: Object)

Constructs a new color depth effect.

Method Summary

Public Methods
public

Returns the current color bit depth.

public

Sets the virtual amount of color bits.

Inherited Summary

From class Effect
public

The blend mode of this effect.

public

Preprocessor macro definitions.

public

WebGL extensions that are required by this effect.

public

The name of this effect.

public

uniforms: Map<String, Uniform>

Shader uniforms.

public

Performs a shallow search for properties that define a dispose method and deletes them.

public

Returns the effect attributes.

public

Returns the fragment shader.

public

Returns the vertex shader.

public

initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

Performs initialization tasks.

public

setDepthTexture(depthTexture: Texture, depthPacking: Number)

Sets the depth texture.

public

setSize(width: Number, height: Number)

Updates the size of this effect.

public

update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, deltaTime: Number)

Updates the effect by performing supporting operations.

protected

Sets the effect attributes.

protected

Informs the associated EffectPass that this effect has changed in a way that requires a shader recompilation.

protected

setFragmentShader(fragmentShader: String)

Sets the fragment shader.

protected

setVertexShader(vertexShader: String)

Sets the vertex shader.

Public Constructors

public constructor(options: Object) source

Constructs a new color depth effect.

Override:

Effect#constructor

Params:

NameTypeAttributeDescription
options Object
  • optional

The options.

options.blendFunction BlendFunction
  • optional
  • default: BlendFunction.NORMAL

The blend function of this effect.

options.bits Number
  • optional
  • default: 16

The color bit depth.

Public Methods

public getBitDepth(): Number source

Returns the current color bit depth.

Return:

Number

The color bit depth.

public setBitDepth(bits: Number) source

Sets the virtual amount of color bits.

Each color channel will use a third of the available bits. The alpha channel remains unaffected.

Note that the real color depth will not be altered by this effect.

Params:

NameTypeAttributeDescription
bits Number

The new color bit depth.