Import
ReflectorForSSRPass is an addon, and must be imported explicitly, see Installation#Addons.
import { ReflectorForSSRPass } from 'three/addons/objects/ReflectorForSSRPass.js';Constructor
new ReflectorForSSRPass( geometry : BufferGeometry, options : ReflectorForSSRPass~Options )
Constructs a new reflector.
| geometry |
The reflector's geometry. |
| options |
The configuration options. |
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 ReflectorForSSRPass.
|
color
number | Color | string |
The reflector's color. Default is |
|
textureWidth
number |
The texture width. A higher value results in more clear reflections but is also more expensive. Default is |
|
textureHeight
number |
The texture height. A higher value results in more clear reflections but is also more expensive. Default is |
|
clipBias
number |
The clip bias. Default is |
|
shader
Object |
Can be used to pass in a custom shader that defines how the reflective view is projected onto the reflector's geometry. |
|
useDepthTexture
boolean |
Whether to store depth values in a texture or not. Default is |
|
resolution
Vector2 |
Resolution for the Reflector Pass. |