Import
AsciiEffect is an addon, and must be imported explicitly, see Installation#Addons.
import { AsciiEffect } from 'three/addons/effects/AsciiEffect.js';Constructor
new AsciiEffect( renderer : WebGLRenderer, charSet : string, options : AsciiEffect~Options )
Constructs a new ASCII effect.
| renderer |
The renderer. |
| charSet |
The char set. Default is |
| options |
The configuration parameter. |
Properties
.domElement : HTMLDivElement
The DOM element of the effect. This element must be used instead of the default WebGLRenderer#domElement.
Methods
.render( scene : Object3D, camera : Camera )
When using this effect, this method should be called instead of the default WebGLRenderer#render.
| scene |
The scene to render. |
| camera |
The camera. |
.setSize( w : number, h : number )
Resizes the effect.
| w |
The width of the effect in logical pixels. |
| h |
The height of the effect in logical pixels. |
Type Definitions
.Options
This type represents configuration settings of AsciiEffect.
|
resolution
number |
A higher value leads to more details. Default is |
|
scale
number |
The scale of the effect. Default is |
|
color
boolean |
Whether colors should be enabled or not. Better quality but slows down rendering. Default is |
|
alpha
boolean |
Whether transparency should be enabled or not. Default is |
|
block
boolean |
Whether blocked characters should be enabled or not. Default is |
|
invert
boolean |
Whether colors should be inverted or not. Default is |
|
strResolution
'low' | 'medium' | 'high' |
The string resolution. Default is |