import {ASCIIEffect} from 'postprocessing'

public class | source

ASCIIEffect

Extends:

three~EventDispatcher → Effect → ASCIIEffect

Indirect Implements:

An ASCII effect.

Warning: This effect cannot be merged with convolution effects.

Constructor Summary

Public Constructor
public	constructor(options: Object) Constructs a new ASCII effect.

Member Summary

Public Members
public get	asciiTexture: ASCIITexture The current ASCII lookup texture.
public set	asciiTexture
public get	cellSize: Number The cell size.
public set	cellSize
public get	color: Color \| String \| Number \| null A color that overrides the scene colors.
public set	color
public get	inverted: Boolean Controls whether the effect should be inverted.
public set	inverted

Method Summary

Public Methods
public	dispose() Deletes internal render targets and textures.
public	setSize(width: Number, height: Number) Updates the size of this pass.

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 ASCII effect.

Override:

Effect#constructor

Params:

Name	Type	Attribute	Description
options	Object	optional	The options.
options.asciiTexture	ASCIITexture	optional	An ASCII character lookup texture.
options.cellSize	Number	optional default: 16	The cell size. It's recommended to use even numbers.
options.color	Number	optional default: null	A color to use instead of the scene colors.
options.inverted	Boolean	optional default: false	Inverts the effect.

Public Members

public get asciiTexture: ASCIITexture source

The current ASCII lookup texture.

public set asciiTexture source

public get cellSize: Number source

The cell size.

public set cellSize source

public get color: Color | String | Number | null source

A color that overrides the scene colors.

public set color source

public get inverted: Boolean source

Controls whether the effect should be inverted.

public set inverted source

Public Methods

public dispose() source

Deletes internal render targets and textures.

Override:

Effect#dispose

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

Updates the size of this pass.

Override:

Effect#setSize

Params:

Name	Type	Attribute	Description
width	Number		The width.
height	Number		The height.