import {TextureEffect} from 'postprocessing'

public class | source

TextureEffect

Extends:

three~EventDispatcher → 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	aspectCorrection: Number this get was deprecated. Adjust the texture's offset, repeat, rotation and center instead. Indicates whether aspect correction is enabled.
public set	aspectCorrection
public get	texture: Texture The texture.
public set	texture
public get	uvTransform: Boolean this get was deprecated. Use texture.matrixAutoUpdate instead. Indicates whether the texture UV coordinates will be transformed using the transformation matrix of the texture.
public set	uvTransform

Method Summary

Public Methods
public	getTexture(): Texture this method was deprecated. Use texture instead. Returns the texture.
public	setTexture(value: Texture) this method was deprecated. Use texture instead. Sets the texture.
public	setTextureSwizzleRGBA(r: ColorChannel, g: ColorChannel, b: ColorChannel, a: ColorChannel) Sets the swizzles that will be applied to the components of a texel before it is written to the output color.
public	update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, deltaTime: Number) Updates this effect.

Inherited Summary

From class Effect
public get	inputColorSpace: ColorSpace this get is experimental. The input color space.
public set	mainCamera: Camera Sets the main camera.
public set	mainScene: Scene Sets the main scene.
public get	outputColorSpace: ColorSpace this get is experimental. The output color space.
protected set	inputColorSpace: ColorSpace this set is experimental.
protected set	outputColorSpace: ColorSpace this set is experimental.
public	blendMode: BlendMode The blend mode of this effect.
public	defines: Map<String, String> Preprocessor macro definitions.
public	extensions: Set<WebGLExtension> WebGL extensions that are required by this effect.
public	name: String The name of this effect.
public	uniforms: Map<String, Uniform> Shader uniforms.
protected	renderer: WebGLRenderer this member was deprecated. The renderer.
public	dispose() Performs a shallow search for properties that define a dispose method and deletes them.
public	getAttributes(): EffectAttribute Returns the effect attributes.
public	getBlendMode(): BlendMode this method was deprecated. Use blendMode instead. Returns the blend mode.
public	getDefines(): Map<String, String> this method was deprecated. Use defines instead. Returns the preprocessor macro definitions.
public	getExtensions(): Set<WebGLExtension> this method was deprecated. Use extensions instead. Returns the WebGL extensions that are required by this effect.
public	getFragmentShader(): String Returns the fragment shader.
public	getName(): String this method was deprecated. Use name instead. Returns the name of this effect.
public	getUniforms(): Map<String, Uniform> this method was deprecated. Use uniforms instead. Returns the uniforms of this effect.
public	getVertexShader(): String Returns the vertex shader.
public	initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number) Performs initialization tasks.
public	setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategies) Sets the depth texture.
public	setRenderer(renderer: WebGLRenderer) this method was deprecated. Sets the renderer.
public	setSize(width: Number, height: Number) Updates the size of this effect.
public	update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, deltaTime: Number) Updates this effect by performing supporting operations.
protected	setAttributes(attributes: EffectAttribute) Sets the effect attributes.
protected	setChanged() Informs the associated EffectPass that this effect 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 texture effect.

Override:

Effect#constructor

Params:

Name	Type	Attribute	Description
options	Object	optional	The options.
options.blendFunction	BlendFunction	optional	The blend function of this effect.
options.texture	Texture	optional	A texture.
options.aspectCorrection	Boolean	optional default: false	Deprecated. Adjust the texture's offset, repeat and center instead.

Public Members

public get aspectCorrection: Number source

this get was deprecated. Adjust the texture's offset, repeat, rotation and center instead.

Indicates whether aspect correction is enabled.

public set aspectCorrection source

public get texture: Texture source

The texture.

public set texture source

public get uvTransform: Boolean source

this get was deprecated. Use texture.matrixAutoUpdate instead.

Indicates whether the texture UV coordinates will be transformed using the transformation matrix of the texture.

public set uvTransform source

Public Methods

public getTexture(): Texture source

this method was deprecated. Use texture instead.

Returns the texture.

Return:

Texture

The texture.

public setTexture(value: Texture) source

this method was deprecated. Use texture instead.

Sets the texture.

Params:

Name	Type	Attribute	Description
value	Texture		The texture.

public setTextureSwizzleRGBA(r: ColorChannel, g: ColorChannel, b: ColorChannel, a: ColorChannel) source

Sets the swizzles that will be applied to the components of a texel before it is written to the output color.

Params:

Name	Type	Attribute	Description
r	ColorChannel		The swizzle for the `r` component.
g	ColorChannel	optional default: r	The swizzle for the `g` component.
b	ColorChannel	optional default: r	The swizzle for the `b` component.
a	ColorChannel	optional default: r	The swizzle for the `a` component.

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

Updates this effect.

Override:

Effect#update

Params:

Name	Type	Attribute	Description
renderer	WebGLRenderer		The renderer.
inputBuffer	WebGLRenderTarget		A frame buffer that contains the result of the previous pass.
deltaTime	Number	optional	The time between the last frame and the current one in seconds.