Class: BaseRenderer

Core-API.BaseRenderer

Hierarchy

• SimpleEventDispatcher<"animationLoop" | "update" | "resize" | "contextLost" | "contextRestored">

  ↳ BaseRenderer

Implements

• IRenderer

Accessors

composer

• get composer(): EffectComposer2

Returns

EffectComposer2

Implementation of

IRenderer.composer

---

passes

• get passes(): IFilter<IPass, string>[]

Returns

IFilter<IPass, string>[]

Implementation of

IRenderer.passes

---

isWebGL2

• get isWebGL2(): boolean

Returns

boolean

Implementation of

IRenderer.isWebGL2

---

composerTarget

• get composerTarget(): IRenderTarget

Returns

IRenderTarget

Implementation of

IRenderer.composerTarget

---

renderSize

• get renderSize(): Vector2

Returns

Vector2

---

displayCanvasScaling

• get displayCanvasScaling(): number

Returns

number

Implementation of

IRenderer.displayCanvasScaling

• set displayCanvasScaling(value): void

Parameters

Name	Type
value	number

Returns

void

Implementation of

IRenderer.displayCanvasScaling

---

frameCount

• get frameCount(): number

Returns

number

Implementation of

IRenderer.frameCount

---

totalFrameCount

• get totalFrameCount(): number

Returns

number

---

pipeline

• get pipeline(): string[]

Returns

string[]

Implementation of

IRenderer.pipeline

• set pipeline(value): void

Parameters

Name	Type
value	string[]

Returns

void

Implementation of

IRenderer.pipeline

---

context

• get context(): WebGLRenderingContext

Returns

WebGLRenderingContext

Implementation of

IRenderer.context

---

rendererObject

• get rendererObject(): WebGLRenderer & { outputColorSpace: ColorSpace }

Returns

WebGLRenderer & { outputColorSpace: ColorSpace }

Implementation of

IRenderer.rendererObject

---

clock

• get clock(): Clock

Returns

Clock

---

useLegacyLights

• get useLegacyLights(): boolean

deprecated will be removed in the future

Returns

boolean

• set useLegacyLights(v): void

deprecated will be removed in the future

Parameters

Name	Type
v	boolean

Returns

void

---

useTotalFrameCount

• get useTotalFrameCount(): boolean

deprecated use {@see stableNoise} instead

Returns

boolean

• set useTotalFrameCount(v): void

deprecated use stableNoise instead

Parameters

Name	Type
v	boolean

Returns

void

---

renderScale

• get renderScale(): number

Returns

number

• set renderScale(value): void

Parameters

Name	Type
value	number

Returns

void

Properties

dirty

• dirty: boolean = true

Implementation of

IRenderer.dirty

---

frameWaitTime

• frameWaitTime: number = 0

---

maxHDRIntensity

• Readonly maxHDRIntensity: number

---

defaultRenderToScreen

• defaultRenderToScreen: boolean = true

Default value for renderToScreen in render

---

maxTempPerKey

• Readonly maxTempPerKey: 5

---

stableNoise

• stableNoise: boolean = false

Use total frame count, if this is set to true, then frameCount won't be reset when the viewer is set to dirty. Which will generate different random numbers for each frame during postprocessing steps. With TAA set properly, this will give a smoother result.

Methods

refreshPipeline

▸ refreshPipeline(): string[]

Returns

string[]

Implementation of

IRenderer.refreshPipeline

---

registerPass

▸ registerPass(pass, replaceId?): void

Parameters

Name	Type	Default value
pass	IFilter<IPass, string>	undefined
replaceId	boolean	true

Returns

void

Implementation of

IRenderer.registerPass

---

unregisterPass

▸ unregisterPass(pass): void

Parameters

Name	Type
pass	IFilter<IPass, string>

Returns

void

Implementation of

IRenderer.unregisterPass

---

setSize

▸ setSize(width?, height?, force?): void

Parameters

Name	Type	Default value
width?	number	undefined
height?	number	undefined
force	boolean	false

Returns

void

---

blit

▸ blit(source, destination, __namedParameters?): void

Parameters

Name	Type
source	undefined | ITexture<any>
destination	undefined | IRenderTarget
__namedParameters	IRenderOptions

Returns

void

Implementation of

IRenderer.blit

---

clearColor

▸ clearColor(__namedParameters): void

Parameters

Name	Type
__namedParameters	Object
__namedParameters.r?	number
__namedParameters.g?	number
__namedParameters.b?	number
__namedParameters.a?	number
__namedParameters.target?	IRenderTarget
__namedParameters.depth?	boolean
__namedParameters.stencil?	boolean

Returns

void

Implementation of

IRenderer.clearColor

---

renderModel

▸ renderModel(model, camera): void

Parameters

Name	Type
model	IModel<any, IObject3DEventMap>
camera	ICamera<ICameraOptions, any, any>

Returns

void

Implementation of

IRenderer.renderModel

---

renderScene

▸ renderScene(scene): void

Parameters

Name	Type
scene	IScene<any, ICamera<ICameraOptions, any, any>, ISceneEventMap>

Returns

void

Implementation of

IRenderer.renderScene

---

render

▸ render(renderToScreen?): void

Parameters

Name	Type
renderToScreen?	boolean

Returns

void

---

updateDirty

▸ updateDirty(): void

Returns

void

---

reset

▸ reset(): void

Returns

void

Implementation of

IRenderer.reset

---

resetShadows

▸ resetShadows(): void

Returns

void

Implementation of

IRenderer.resetShadows

---

refreshPasses

▸ refreshPasses(): void

Returns

void

---

dispose

▸ dispose(): void

Returns

void

---

trackTarget

▸ trackTarget(target): void

Parameters

Name	Type
target	IRenderTarget

Returns

void

Implementation of

IRenderer.trackTarget

---

removeTrackedTarget

▸ removeTrackedTarget(target): void

Parameters

Name	Type
target	IRenderTarget

Returns

void

Implementation of

IRenderer.removeTrackedTarget

---

createTarget

▸ createTarget(__namedParameters?, trackTarget?): IRenderTarget

Parameters

Name	Type	Default value
__namedParameters	CreateRenderTargetOptions	{}
trackTarget	boolean	true

Returns

IRenderTarget

Implementation of

IRenderer.createTarget

---

disposeTarget

▸ disposeTarget(target): void

Parameters

Name	Type
target	IRenderTarget

Returns

void

Implementation of

IRenderer.disposeTarget

---

createTargetCustom

▸ createTargetCustom<T>(__namedParameters, options?, clazz?): T

Type parameters

Name	Type
T	extends IRenderTarget<T>

Parameters

Name	Type
__namedParameters	Object
__namedParameters.width	number
__namedParameters.height	number
__namedParameters.count?	number
options	WebGLRenderTargetOptions
clazz?	Class<T>

Returns

T

Implementation of

IRenderer.createTargetCustom

---

getTempTarget

▸ getTempTarget(op?): IRenderTarget

Parameters

Name	Type
op	CreateRenderTargetOptions

Returns

IRenderTarget

Implementation of

IRenderer.getTempTarget

---

releaseTempTarget

▸ releaseTempTarget(target): void

Parameters

Name	Type
target	IRenderTarget

Returns

void

Implementation of

IRenderer.releaseTempTarget

---

updateShaderProperties

▸ updateShaderProperties(material): BaseRenderer

Parameters

Name	Type
material	Object
material.defines	Record<string, undefined | string | number>
material.uniforms	Object

Returns

BaseRenderer

Implementation of

IRenderer.updateShaderProperties

---

renderTargetToDataUrl

▸ renderTargetToDataUrl(target, mimeType?, quality?, textureIndex?): string

Parameters

Name	Type	Default value
target	WebGLMultipleRenderTargets | WebGLRenderTarget<Texture<TextureEventMap>>	undefined
mimeType	string	'image/png'
quality	number	90
textureIndex	number	0

Returns

string

---

renderTargetToBuffer

▸ renderTargetToBuffer(target, textureIndex?): Uint8Array | Uint16Array

Parameters

Name	Type	Default value
target	WebGLMultipleRenderTargets | WebGLRenderTarget<Texture<TextureEventMap>>	undefined
textureIndex	number	0

Returns

Uint8Array | Uint16Array

Constructors

constructor

• new BaseRenderer(__namedParameters)

Parameters

Name	Type
__namedParameters	Object
__namedParameters.animationLoop?	(ev: any) => void
__namedParameters.antialias?	boolean
__namedParameters.alpha?	boolean
__namedParameters.canvas	HTMLCanvasElement
__namedParameters.targetOptions	CreateRenderTargetOptions
__namedParameters.maxHDRIntensity?	number

Overrides

SimpleEventDispatcher<'animationLoop' | 'update' | 'resize' | 'contextLost' | 'contextRestored'\>.constructor