Renderer

Performs a manual clear operation. This method ignores autoClear properties.

Async version of Renderer#clear.

Performs a manual clear operation of the color buffer. This method ignores autoClear properties.

Async version of Renderer#clearColor.

Performs a manual clear operation of the depth buffer. This method ignores autoClear properties.

Async version of Renderer#clearDepth.

Performs a manual clear operation of the stencil buffer. This method ignores autoClear properties.

Async version of Renderer#clearStencil.

Alias for compileAsync().

Compiles all materials in the given scene. This can be useful to avoid a phenomenon which is called "shader compilation stutter", which occurs when rendering an object with a new shader for the first time.

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 and environment must be configured before calling this method.

Execute a single or an array of compute nodes. This method can only be called if the renderer has been initialized.

Execute a single or an array of compute nodes.

Copies the current bound framebuffer into the given texture.

Copies data of the given source texture into a destination texture.

Frees all internal resources of the renderer. Call this method if the renderer is no longer in use by your app.

Returns the active cube face.

Returns the active mipmap level.

Returns the current animation loop callback.

Can be used to transfer buffer data from a storage buffer attribute from the GPU to the CPU in context of compute shaders.

Returns the current canvas target.

Returns the clear alpha.

Returns the clear color.

Returns the clear depth.

Returns the clear stencil.

Returns the output buffer type.

Returns the rendering context.

Returns the drawing buffer size in physical pixels. This method honors the pixel ratio.

Returns the MRT configuration.

Returns the maximum available anisotropy for texture filtering.

Returns the output buffer type.

Returns the current output target.

Returns the pixel ratio.

Returns the current render object function.

Returns the current render target.

Returns the scissor rectangle.

Returns the scissor test value.

Returns the renderer's size in logical pixels. This method does not honor the pixel ratio.

Returns the viewport definition.

Checks if the given feature is supported by the selected backend. If the renderer has not been initialized, this method always returns false.

Checks if the given feature is supported by the selected backend.

Returns true when the renderer has been initialized.

Initializes the renderer so it is ready for usage.

Initializes the given texture. Useful for preloading a texture rather than waiting until first render (which can cause noticeable lags due to decode and GPU upload overhead).

This method can only be used if the renderer has been initialized.

Initializes the given textures. Useful for preloading a texture rather than waiting until first render (which can cause noticeable lags due to decode and GPU upload overhead).

This method performs an occlusion query for the given 3D object. It returns true if the given 3D object is fully occluded by other 3D objects in the scene.

Reads pixel data from the given render target.

Renders the scene or 3D object with the given camera. This method can only be called if the renderer has been initialized. When using render() inside an animation loop, it's guaranteed the renderer will be initialized. The animation loop must be defined with Renderer#setAnimationLoop though.

For all other use cases (like when using on-demand rendering), you must call Renderer#init before rendering.

The target of the method is the default framebuffer (meaning the canvas) or alternatively a render target when specified via setRenderTarget().

Renders the scene in an async fashion.

This method represents the default render object function that manages the render lifecycle of the object.

Applications are advised to always define the animation loop with this method and not manually with requestAnimationFrame() for best compatibility.

Sets the canvas target. The canvas target manages the HTML canvas or the offscreen canvas the renderer draws into.

Defines the clear alpha.

Defines the clear color and optionally the clear alpha.

Defines the clear depth.

Defines the clear stencil.

This method allows to define the drawing buffer size by specifying width, height and pixel ratio all at once. The size of the drawing buffer is computed with this formula:

size.x = width * pixelRatio;
size.y = height * pixelRatio;

Sets the given MRT configuration.

Defines a manual sort function for the opaque render list. Pass null to use the default sort.

Sets the output render target for the renderer.

Sets the given pixel ratio and resizes the canvas if necessary.

Sets the given render object function. Calling this method overwrites the default implementation which is Renderer#renderObject. Defining a custom function can be useful if you want to modify the way objects are rendered. For example you can define things like "every object that has material of a certain type should perform a pre-pass with a special overwrite material". The custom function must always call renderObject() in its implementation.

Use null as the first argument to reset the state.

Sets the given render target. Calling this method means the renderer does not target the default framebuffer (meaning the canvas) anymore but a custom framebuffer. Use null as the first argument to reset the state.

Defines the scissor rectangle.

Defines the scissor test.

Sets the size of the renderer.

Defines a manual sort function for the transparent render list. Pass null to use the default sort.

Defines the viewport.

Can be used to synchronize CPU operations with GPU tasks. So when this method is called, the CPU waits for the GPU to complete its operation (e.g. a compute task).