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

PixelationEffect

Extends:

three~EventDispatcherEffect → PixelationEffect

Indirect Implements:

A pixelation effect.

Warning: This effect cannot be merged with convolution effects.

Constructor Summary

Public Constructor
public

constructor(granularity: Object)

Constructs a new pixelation effect.

Method Summary

Public Methods
public

Returns the pixel granularity.

public

setGranularity(granularity: Number)

Sets the pixel granularity.

public

setSize(width: Number, height: Number)

Updates the granularity.

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(granularity: Object) source

Constructs a new pixelation effect.

Override:

Effect#constructor

Params:

NameTypeAttributeDescription
granularity Object
  • optional
  • default: 30.0

The pixel granularity.

Public Methods

public getGranularity(): Number source

Returns the pixel granularity.

Return:

Number

The granularity.

public setGranularity(granularity: Number) source

Sets the pixel granularity.

A higher value yields coarser visuals.

Params:

NameTypeAttributeDescription
granularity Number

The new granularity.

public setSize(width: Number, height: Number) source

Updates the granularity.

Override:

Effect#setSize

Params:

NameTypeAttributeDescription
width Number

The width.

height Number

The height.