Class TextureEffect

A texture effect.

Hierarchy (view full)

Effect
- TextureEffect

Constructors

constructor

new TextureEffect(options?): TextureEffect
Constructs a new texture effect.
Parameters
- Optional options: {
      aspectCorrection?: boolean;
      blendFunction?: BlendFunction;
      texture?: Texture;
  }
  The options.
  - Optional aspectCorrection?: boolean
    Deprecated. Adjust the texture's offset, repeat and center instead.
  - Optional blendFunction?: BlendFunction
    The blend function of this effect.
  - Optional texture?: Texture
    A texture.
Returns TextureEffect
Overrides Effect.constructor

Properties

`Readonly` blendMode

blendMode: BlendMode

The blend mode of this effect.

`Readonly` defines

defines: Map<string, string>

Preprocessor macro definitions.

Call Effect.setChanged after changing macro definitions.

`Readonly` extensions

extensions: Set<WebGLExtension>

WebGL extensions that are required by this effect.

Call Effect.setChanged after adding or removing extensions.

name

name: string

The name of this effect.

`Protected` renderer

renderer: WebGLRenderer

The renderer.

Deprecated

`Readonly` uniforms

uniforms: Map<string, Uniform<any>>

Shader uniforms.

Call Effect.setChanged after adding or removing uniforms.

Accessors

aspectCorrection

get aspectCorrection(): number
Indicates whether aspect correction is enabled.

Returns number
Deprecated
Adjust the texture's offset, repeat, rotation and center instead.
set aspectCorrection(arg): void
Parameters
- arg: number
Returns void

inputColorSpace

get inputColorSpace(): ColorSpace
Experimental
The input color space.

Returns ColorSpace
Inherited from Effect.inputColorSpace
set inputColorSpace(arg): void
Protected Experimental
Parameters
- arg: ColorSpace
Returns void
Inherited from Effect.inputColorSpace

mainCamera

set mainCamera(arg): void
Sets the main camera.
Parameters
- arg: Camera
Returns void
Inherited from Effect.mainCamera

mainScene

set mainScene(arg): void
Sets the main scene.
Parameters
- arg: Scene
Returns void
Inherited from Effect.mainScene

outputColorSpace

get outputColorSpace(): ColorSpace
Experimental
The output color space.

Should only be changed if this effect converts the input colors to a different color space.

Returns ColorSpace
Inherited from Effect.outputColorSpace
set outputColorSpace(arg): void
Protected Experimental
Parameters
- arg: ColorSpace
Returns void
Inherited from Effect.outputColorSpace

texture

get texture(): Texture
The texture.

Returns Texture
set texture(arg): void
Parameters
- arg: Texture
Returns void

uvTransform

get uvTransform(): boolean
Indicates whether the texture UV coordinates will be transformed using the transformation matrix of the texture.

Returns boolean
Deprecated
Use texture.matrixAutoUpdate instead.
set uvTransform(arg): void
Parameters
- arg: boolean
Returns void

Methods

dispose

dispose(): void
Performs a shallow search for properties that define a dispose method and deletes them.

The EffectComposer calls this method when it is being destroyed.

Returns void
Inherited from Effect.dispose

getAttributes

getAttributes(): EffectAttribute
Returns the effect attributes.

Returns EffectAttribute
The attributes.

Inherited from Effect.getAttributes

getBlendMode

getBlendMode(): BlendMode
Returns the blend mode.

The result of this effect will be blended with the result of the previous effect using this blend mode.

Returns BlendMode
The blend mode.

Deprecated
Use blendMode instead.

Inherited from Effect.getBlendMode

getDefines

getDefines(): Map<string, string>
Returns the preprocessor macro definitions.

Returns Map<string, string>
The extensions.

Deprecated
Use defines instead.

Inherited from Effect.getDefines

getExtensions

getExtensions(): Set<WebGLExtension>
Returns the WebGL extensions that are required by this effect.

Returns Set<WebGLExtension>
The extensions.

Deprecated
Use extensions instead.

Inherited from Effect.getExtensions

getFragmentShader

getFragmentShader(): string
Returns the fragment shader.

Returns string
The fragment shader.

Inherited from Effect.getFragmentShader

getName

getName(): string
Returns the name of this effect.

Returns string
The name.

Deprecated
Use name instead.

Inherited from Effect.getName

getTexture

getTexture(): Texture
Returns the texture.

Returns Texture
The texture.

Deprecated
Use texture instead.

getUniforms

getUniforms(): Map<string, Uniform<any>>
Returns the uniforms of this effect.

Returns Map<string, Uniform<any>>
The extensions.

Deprecated
Use uniforms instead.

Inherited from Effect.getUniforms

getVertexShader

getVertexShader(): string
Returns the vertex shader.

Returns string
The vertex shader.

Inherited from Effect.getVertexShader

initialize

initialize(renderer, alpha, frameBufferType): void
Performs initialization tasks.
Parameters
- renderer: WebGLRenderer
  The renderer.
- alpha: boolean
  Whether the renderer uses the alpha channel or not.
- frameBufferType: number
  The type of the main frame buffers.
Returns void
Overrides Effect.initialize

`Protected` setAttributes

setAttributes(attributes): void
Protected
Sets the effect attributes.

Effects that have the same attributes will be executed in the order in which they were registered. Some attributes imply a higher priority.
Parameters
- attributes: EffectAttribute
  The attributes.
Returns void
Inherited from Effect.setAttributes

`Protected` setChanged

setChanged(): void
Protected
Informs the associated EffectPass that this effect requires a shader recompilation.

Should be called after changing macros or extensions and after adding/removing uniforms.

Returns void
Inherited from Effect.setChanged

setDepthTexture

setDepthTexture(depthTexture, depthPacking?): void
Sets the depth texture.

You may override this method if your effect requires direct access to the depth texture that is bound to the associated EffectPass.
Parameters
- depthTexture: Texture
  A depth texture.
- Optional depthPacking: DepthPackingStrategies
  The depth packing.
Returns void
Inherited from Effect.setDepthTexture

`Protected` setFragmentShader

setFragmentShader(fragmentShader): void
Protected
Sets the fragment shader.
Parameters
- fragmentShader: string
  The fragment shader.
Returns void
Inherited from Effect.setFragmentShader

setRenderer

setRenderer(renderer): void
Sets the renderer.
Parameters
- renderer: WebGLRenderer
  The renderer.
Returns void
Deprecated
Inherited from Effect.setRenderer

setSize

setSize(width, height): void
Updates the size of this effect.

You may override this method if you want to be informed about the size of the backbuffer/canvas. This method is called before initialize and every time the size of the EffectComposer changes.
Parameters
- width: number
  The width.
- height: number
  The height.
Returns void
Inherited from Effect.setSize

setTexture

setTexture(value): void
Sets the texture.
Parameters
- value: Texture
  The texture.
Returns void
Deprecated
Use texture instead.

setTextureSwizzleRGBA

setTextureSwizzleRGBA(r, g?, b?, a?): void
Sets the swizzles that will be applied to the components of a texel before it is written to the output color.
Parameters
- r: ColorChannel
  The swizzle for the r component.
- Optional g: ColorChannel
  The swizzle for the g component.
- Optional b: ColorChannel
  The swizzle for the b component.
- Optional a: ColorChannel
  The swizzle for the a component.
Returns void

`Protected` setVertexShader

setVertexShader(vertexShader): void
Protected
Sets the vertex shader.
Parameters
- vertexShader: string
  The vertex shader.
Returns void
Inherited from Effect.setVertexShader

update

update(renderer, inputBuffer, deltaTime?): void
Updates this effect.
Parameters
- renderer: WebGLRenderer
  The renderer.
- inputBuffer: WebGLRenderTarget<Texture>
  A frame buffer that contains the result of the previous pass.
- Optional deltaTime: number
  The time between the last frame and the current one in seconds.
Returns void
Overrides Effect.update

Class TextureEffect

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: { aspectCorrection?: boolean; blendFunction?: BlendFunction; texture?: Texture; }

Optional aspectCorrection?: boolean

Optional blendFunction?: BlendFunction

Optional texture?: Texture

Returns TextureEffect

Properties

Readonly blendMode

Readonly defines

Readonly extensions

name

Protected renderer

Deprecated

Readonly uniforms

Accessors

aspectCorrection

Returns number

Deprecated

Parameters

arg: number

Returns void

inputColorSpace

Returns ColorSpace

Parameters

arg: ColorSpace

Returns void

mainCamera

Parameters

arg: Camera

Returns void

mainScene

Parameters

arg: Scene

Returns void

outputColorSpace

Returns ColorSpace

Parameters

arg: ColorSpace

Returns void

texture

Returns Texture

Parameters

arg: Texture

Returns void

uvTransform

Returns boolean

Deprecated

Parameters

arg: boolean

Returns void

Methods

dispose

Returns void

getAttributes

Returns EffectAttribute

getBlendMode

Returns BlendMode

Deprecated

getDefines

Returns Map<string, string>

Deprecated

getExtensions

Returns Set<WebGLExtension>

Deprecated

getFragmentShader

Returns string

getName

Returns string

Deprecated

getTexture

Returns Texture

`Optional` options: {
aspectCorrection?: boolean;
blendFunction?: BlendFunction;
texture?: Texture;
}

`Optional` aspectCorrection?: boolean

`Optional` blendFunction?: BlendFunction

`Optional` texture?: Texture

`Readonly` blendMode

`Readonly` defines

`Readonly` extensions

`Protected` renderer

`Readonly` uniforms

`Protected` setAttributes

`Protected` setChanged

`Optional` depthPacking: DepthPackingStrategies

`Protected` setFragmentShader

`Optional` g: ColorChannel

`Optional` b: ColorChannel

`Optional` a: ColorChannel

`Protected` setVertexShader

`Optional` deltaTime: number