Class: WebGLRenderer

Constructor

new WebGLRenderer(contextopt)

Create a WebGLRenderer.

Parameters:

Name	Type	Attributes	Description
`context`	WebGLRenderingContext	<optional>	The WebGL Rendering Context privided by canvas. If not provided, you must call WebGLRenderer.init method with a valid context before using this renderer.

Extends

ThinRenderer

Members

capabilities :WebGLCapabilities

An object containing details about the capabilities of the current RenderingContext.

Type:

WebGLCapabilities

Overrides: ThinRenderer#capabilities

context :WebGLRenderingContext|WebGPURenderingContext

The Rendering Context privided by canvas.

Type:

WebGLRenderingContext | WebGPURenderingContext

Overrides: ThinRenderer#context

(readonly) id :number

The unique id of this renderer. This will be incremented when the context is lost and restored.

Type:

number

Overrides: ThinRenderer#id

lightingOptions :object

The lighting options.

Type:

object

Properties

Name Type Description

clustered

object

The clustered lighting options.

Properties

Name	Type	Description
`enabled`	boolean	Whether to use clustered lighting, defaults to false.
`maxClusterLights`	number	The maximum number of lights, defaults to 1024.
`useFloatPrecision`	boolean	Whether the lights are stored as floats, defaults to false (half floats).
`gridDimensions`	Vector3	The number of cells in each dimension, defaults to Vector3(16, 8, 32).
`maxLightsPerCell`	number	The maximum number of lights per cell, defaults to 256.
`zClip`	Vector2	The near and far clipping planes for the cells, defaults to Vector2(-1, -1) (clip based on camera near and far planes).
`version`	number	The version of the clustered lighting options. If the options change, the version should be incremented, defaults to 0.

Overrides: ThinRenderer#lightingOptions

shaderCompileOptions :object

The shader compiler options.

Type:

object

Properties

Name	Type	Description
`checkErrors`	boolean	Whether to use error checking when compiling shaders, defaults to true.
`compileAsynchronously`	boolean	Whether to compile shaders asynchronously, defaults to false.
`maxMaterialPrograms`	number	The maximum number of programs that one material can cache, defaults to 5.

Overrides: ThinRenderer#shaderCompileOptions

Methods

beginOcclusionQuery(index)

Begin an occlusion query.

Parameters:

Name	Type	Description
`index`	number	The query index in the current occlusion query set.

Overrides: ThinRenderer#beginOcclusionQuery

beginRender(renderTarget)

Begin rendering.

Parameters:

Name	Type	Description
`renderTarget`	RenderTargetBase	The render target to render to.

Overrides: ThinRenderer#beginRender

blitRenderTarget(read, draw, coloropt, depthopt, stencilopt)

Copy a frame buffer to another. This copy process can be used to perform multi-sampling (MSAA).

Parameters:

Name	Type	Attributes	Default	Description
`read`	RenderTargetBase			The source renderTarget.
`draw`	RenderTargetBase			The destination renderTarget.
`color`	boolean	<optional>	true	Copy color buffer.
`depth`	boolean	<optional>	true	Copy depth buffer.
`stencil`	boolean	<optional>	true	Copy stencil buffer.

Overrides: ThinRenderer#blitRenderTarget

endOcclusionQuery()

End the current occlusion query.

Overrides: ThinRenderer#endOcclusionQuery

endRender()

End rendering.

Overrides: ThinRenderer#endRender

generateMipmaps(texture)

Generate mipmaps for the texture you pass in.

Parameters:

Name	Type	Description
`texture`	TextureBase	The texture to update.

Overrides: ThinRenderer#generateMipmaps

(protected) increaseId() → {number}

Used for context lost and restored.

Overrides: ThinRenderer#increaseId

Returns:

Type:: number

init(context, optionsopt) → {Promise.<ThinRenderer>}

Initialize this renderer with a rendering context. This method is called automatically by WebGLRenderer constructor when a context is provided. For WebGPURenderer, you must call this method manually and wait for the promise to resolve.

Parameters:

Name	Type	Attributes	Description
`context`	WebGLRenderingContext \| WebGPURenderingContext		The rendering context.
`options`	object	<optional>	The options for initializing this renderer.

Overrides: ThinRenderer#init

Returns:

A promise that resolves when initialization completes.

Type:: Promise.<ThinRenderer>

readQuerySetResults(querySet, dstBuffer, firstQueryopt, queryCountopt) → {Promise.<(Array|TypedArray)>}

Read back the results of a query set. This is an asynchronous operation.

Parameters:

Name	Type	Attributes	Default	Description
`querySet`	QuerySet			The query set to read from.
`dstBuffer`	Array \| TypedArray			The buffer to store the results.
`firstQuery`	number	<optional>	0	The first query index to read.
`queryCount`	number	<optional>	querySet.count	The number of queries to read.

Overrides: ThinRenderer#readQuerySetResults

Returns:

A promise that resolves with the passed in buffer after it has been filled with the results.

Type:: Promise.<(Array|TypedArray)>

readTexturePixels(texture, x, y, width, height, buffer, zIndexopt, mipLevelopt) → {Promise.<TypedArray>}

Read pixels from a texture. This is an asynchronous operation. See ThinRenderer#readTexturePixelsSync for the synchronous version.

Parameters:

Name	Type	Attributes	Default	Description
`texture`	TextureBase			The texture to read from.
`x`	number			The x coordinate of the rectangle to read from.
`y`	number			The y coordinate of the rectangle to read from.
`width`	number			The width of the rectangle to read from.
`height`	number			The height of the rectangle to read from.
`buffer`	TypedArray			The buffer to store the pixel data.
`zIndex`	number	<optional>	0	For CubeTexture, the face index; for Texture3D/TextureArray, the layer/slice index.
`mipLevel`	number	<optional>	0	The mip level to read.

Overrides: ThinRenderer#readTexturePixels

Returns:

A promise that resolves with the passed in buffer after it has been filled with the pixel data.

Type:: Promise.<TypedArray>

readTexturePixelsSync(texture, x, y, width, height, buffer, zIndexopt, mipLevelopt) → {TypedArray}

Read pixels from a texture. This is a synchronous operation. See ThinRenderer#readTexturePixels for the asynchronous version.

Parameters:

Name	Type	Attributes	Default	Description
`texture`	TextureBase			The texture to read from.
`x`	number			The x coordinate of the rectangle to read from.
`y`	number			The y coordinate of the rectangle to read from.
`width`	number			The width of the rectangle to read from.
`height`	number			The height of the rectangle to read from.
`buffer`	TypedArray			The buffer to store the pixel data.
`zIndex`	number	<optional>	0	For CubeTexture, the face index; for Texture3D/TextureArray, the layer/slice index.
`mipLevel`	number	<optional>	0	The mip level to read.

Overrides: ThinRenderer#readTexturePixelsSync

Returns:

The passed in buffer after it has been filled with the pixel data.

Type:: TypedArray

renderRenderableItem(renderable, renderStates, optionsopt)

Render a single renderable item with render states.

Parameters:

Name	Type	Attributes	Description
`renderable`	object		The renderable item.
`renderStates`	RenderStates		The render states.
`options`	RenderOptions	<optional>	The render options for this render task.

Overrides: ThinRenderer#renderRenderableItem

renderRenderableList(renderables, renderStates, optionsopt)

Render a single renderable list with render states.

Parameters:

Name	Type	Attributes	Description
`renderables`	Array		Array of renderable.
`renderStates`	RenderStates		Render states.
`options`	RenderOptions	<optional>	The render options for this render task.

Overrides: ThinRenderer#renderRenderableList

renderScene(scene, camera, renderTarget, optionsopt)

Render a scene with a particular camera. This method will render all layers in scene's RenderQueue by default. If you need a customized rendering process, it is recommended to use renderRenderableList method.

Parameters:

Name	Type	Attributes	Description
`scene`	Scene		The scene to render.
`camera`	Camera		The camera used to render the scene.
`renderTarget`	RenderTargetBase		The render target to render to.
`options`	RenderOptions	<optional>	The render options for this scene render task.

Overrides: ThinRenderer#renderScene

resetState()

Reset all render states cached in this renderer. This is useful when you use multiple renderers in one application.

Overrides: ThinRenderer#resetState

resetVertexArrayBindings(forceopt)

Reset vertex array object bindings.

Parameters:

Name	Type	Attributes	Default	Description
`force`	boolean	<optional>	false	Whether clear the current vertex array object.

Overrides: ThinRenderer#resetVertexArrayBindings

setBufferExternal(buffer, webglBuffer)

Bind webglBuffer to Buffer.

Parameters:

Name	Type	Description
`buffer`	Buffer
`webglBuffer`	WebGLBuffer

setFramebufferExternal(renderTarget, webglFramebuffer)

Bind webglFramebuffer to RenderTarget.

Parameters:

Name	Type	Description
`renderTarget`	RenderTarget
`webglFramebuffer`	WebGLFramebuffer

setRenderBufferExternal(renderBuffer, webglRenderbuffer)

Bind webglRenderbuffer to RenderBuffer.

Parameters:

Name	Type	Description
`renderBuffer`	RenderBuffer
`webglRenderbuffer`	WebGLRenderbuffer

setTextureExternal(texture, webglTexture)

Bind webglTexture to Texture.

Parameters:

Name	Type	Description
`texture`	TextureBase
`webglTexture`	WebGLTexture