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

TextureEffect

Extends:

Effect → TextureEffect

Indirect Implements:

A texture effect.

Constructor Summary

Public Constructor
public

constructor(options: Object)

Constructs a new texture effect.

Member Summary

Public Members
public get

Indicates whether aspect correction is enabled.

public set

Enables or disables aspect correction.

public

Inherited Summary

From class Effect
public

The effect attributes.

public

The blend mode of this effect.

public

Preprocessor macro definitions.

public

WebGL extensions that are required by this effect.

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

Updates the effect by performing supporting operations.

Public Constructors

public constructor(options: Object) source

Constructs a new texture 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.texture Texture
  • optional

A texture.

options.aspectCorrection Boolean
  • optional
  • default: false

Whether the texture coordinates should be affected by the aspect ratio.

Public Members

public get aspectCorrection: Boolean source

Indicates whether aspect correction is enabled.

If enabled, the texture can be scaled using the scale uniform.

public set aspectCorrection: Boolean source

Enables or disables aspect correction.

You'll need to call EffectPass#recompile after changing this value.

public vertexShader: * source

The vertex shader.

Override:

Effect#vertexShader