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

HueSaturationEffect

Extends:

three~EventDispatcherEffect → HueSaturationEffect

Indirect Implements:

A hue/saturation effect.

Reference: https://github.com/evanw/glfx.js

Constructor Summary

Public Constructor
public

constructor(options: Object)

Constructs a new hue/saturation effect.

Method Summary

Public Methods
public

setHue(hue: Number)

Sets the hue.

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 hue/saturation 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.hue Number
  • optional
  • default: 0.0

The hue in radians.

options.saturation Number
  • optional
  • default: 0.0

The saturation factor, ranging from -1 to 1, where 0 means no change.

Public Methods

public setHue(hue: Number) source

Sets the hue.

Params:

NameTypeAttributeDescription
hue Number

The hue in radians.