Import
Refractor is an addon, and must be imported explicitly, see Installation#Addons.
import { Refractor } from 'three/addons/objects/Refractor.js';Constructor
new Refractor( geometry : BufferGeometry, options : Refractor~Options )
Constructs a new refractor.
geometry |
The refractor's geometry. |
options |
The configuration options. |
Properties
.camera : PerspectiveCamera
The reflector's virtual camera.
.isRefractor : boolean (readonly)
This flag can be used for type testing.
Default is true.
Methods
.dispose()
Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.
.getRenderTarget() : WebGLRenderTarget
Returns the reflector's internal render target.
- Returns: The internal render target
Type Definitions
.Options
Constructor options of Refractor.
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
color |
number | Color | string |
<optional> |
0x7F7F7F | The refractor's color. |
textureWidth |
number |
<optional> |
512 | The texture width. A higher value results in more clear refractions but is also more expensive. |
textureHeight |
number |
<optional> |
512 | The texture height. A higher value results in more clear refractions but is also more expensive. |
clipBias |
number |
<optional> |
0 | The clip bias. |
shader |
Object |
<optional> |
Can be used to pass in a custom shader that defines how the refractive view is projected onto the reflector's geometry. |
|
multisample |
number |
<optional> |
4 | How many samples to use for MSAA. |