Home Reference Source
import {HueSaturationEffect} from 'postprocessing/src/effects/HueSaturationEffect.js'
public class | source

HueSaturationEffect

Extends:

Effect → 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

[key]: *

public

The effect attributes.

public

The blend mode of this effect.

public

Preprocessor macro definitions.

public

The fragment shader.

public

The name of this effect.

public

uniforms: Map<String, Uniform>

Shader uniforms.

public

The vertex shader.

public

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

public

initialize(renderer: WebGLRenderer, alpha: Boolean)

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, delta: Number)

Updates the effect by performing supporting operations.

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.