Optionalcanvas: HTMLCanvasElementIf autoClear is true, defines whether the renderer should clear the color buffer. Default is true.
If autoClear is true, defines whether the renderer should clear the depth buffer. Default is true.
If autoClear is true, defines whether the renderer should clear the stencil buffer. Default is true.
Protected ReadonlychildrenCompiles all materials in the scene with the camera. This is useful to precompile shaders before the first rendering. If you want to add a 3D object to an existing scene, use the third optional parameter for applying the target scene. Note that the (target) scene's lighting should be configured before calling this method.
Asynchronous version of compile(). The method returns a Promise that resolves when the given scene can be rendered without unnecessary stalling due to shader compilation. This method makes use of the KHR_parallel_shader_compile WebGL extension.
Debug configurations.
A Canvas where the renderer draws its output. This is automatically created by the renderer in the constructor (if not provided already); you just need to add it to your page.
ProtectednowOptionaloceanOptionalskyboxDefines whether the renderer should sort objects. Default is true.
OptionalstatsThe normalized resolution scale for the transmission render target, measured in percentage of viewport
dimensions. Lowering this value can result in significant improvements to MeshPhysicalMaterial
transmission performance. Default is 1.
Use .xr instead.
Protected StaticbackgroundProtectedanimationTells the renderer to clear its color, depth or stencil drawing buffer(s). Arguments default to true
Optionalcolor: booleanOptionaldepth: booleanOptionalstencil: booleanCopies a region of the currently bound framebuffer into the selected mipmap level of the selected texture. This region is defined by the size of the destination texture's mip level, offset by the input position.
Specifies the destination texture.
Optionalposition: Vector2Specifies the pixel offset from which to copy out of the framebuffer.
Optionallevel: numberSpecifies the destination mipmap level of the texture.
Copies the pixels of a texture in the bounds [srcRegion]Box3 in the destination texture starting from the given position. 2D Texture, 3D Textures, or a mix of the two can be used as source and destination texture arguments for copying between layers of 3d textures
The depthTexture and texture property of render targets are supported as well.
When using render target textures as srcTexture and dstTexture, you must make sure both render targets are
initialized e.g. via .initRenderTarget().
Specifies the source texture.
Specifies the destination texture.
OptionalsrcRegion: Box3 | Box2Specifies the bounds
OptionaldstPosition: Vector2 | Vector3Specifies the pixel offset into the dstTexture where the copy will occur.
OptionalsrcLevel: numberSpecifies the source mipmap level of the texture.
OptionaldstLevel: numberSpecifies the destination mipmap level of the texture.
ProtectedcreateReturns the current active cube face.
Returns the current active mipmap level.
Returns a float with the current clear alpha. Ranges from 0 to 1.
Returns a THREE.Color instance with the current clear color.
Return the WebGL context.
Returns the current render target. If no render target is set, null is returned.
Copies the scissor area into target.
Returns true if scissor test is enabled; returns false otherwise.
Copies the viewport into target.
Initializes the given WebGLRenderTarget memory. Useful for initializing a render target so data can be copied into it using WebGLRenderer.copyTextureToTexture before it has been rendered to.
Initializes the given texture. Can be used to preload a texture rather than waiting until first render (which can cause noticeable lags due to decode and GPU upload overhead).
The texture to Initialize.
OptionalactiveCubeFaceIndex: numberOptionaltextureIndex: numberOptionalactiveCubeFaceIndex: numberOptionaltextureIndex: numberRender a scene or an object using a camera. The render is done to a previously specified WebGLRenderTarget#renderTarget .renderTarget set by calling WebGLRenderer#setRenderTarget .setRenderTarget or to the canvas as usual.
By default render buffers are cleared before rendering but you can prevent this by setting the property autoClear to false. If you want to prevent only certain buffers being cleared you can set either the autoClearColor, autoClearStencil or autoClearDepth properties to false. To forcibly clear one ore more buffers call .clear.
Can be used to reset the internal WebGL state.
A build in function that can be used instead of requestAnimationFrame. For WebXR projects this function must be used.
The function will be called every available frame. If null is passed it will stop any already ongoing animation.
Sets the clear color, using color for the color and alpha for the opacity.
Optionalalpha: numberSets the custom opaque sort function for the WebGLRenderLists. Pass null to use the default painterSortStable function.
Sets the active render target.
The WebGLRenderTarget renderTarget that needs to be activated. When null is given, the canvas is set as the active render target instead.
OptionalactiveCubeFace: numberSpecifies the active cube side (PX 0, NX 1, PY 2, NY 3, PZ 4, NZ 5) of WebGLCubeRenderTarget.
OptionalactiveMipmapLevel: numberSpecifies the active mipmap level.
Sets the scissor area from (x, y) to (x + width, y + height).
Optionaly: numberOptionalwidth: numberOptionalheight: numberEnable the scissor test. When this is enabled, only the pixels within the defined scissor area will be affected by further renderer actions.
Resizes the output canvas to (width, height), and also sets the viewport to fit that size, starting in (0, 0).
OptionalupdateStyle: booleanSets the custom transparent sort function for the WebGLRenderLists. Pass null to use the default reversePainterSortStable function.
Sets the viewport to render from (x, y) to (x + width, y + height). (x, y) is the lower-left corner of the region.
Optionaly: numberOptionalwidth: numberOptionalheight: numberStaticcreate
Defines whether the renderer should automatically clear its output before rendering.