Skip to main content

Class: BaseRenderer

Core-API.BaseRenderer

Hierarchy

Implements

Accessors

composer

get composer(): EffectComposer2

Returns

EffectComposer2

Implementation of

IRenderer.composer

Defined in

webgi/src/core/threejs/BaseRenderer.ts:41


passes

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

Returns

IFilter<IPass, string>[]

Implementation of

IRenderer.passes

Defined in

webgi/src/core/threejs/BaseRenderer.ts:44


isWebGL2

get isWebGL2(): boolean

Returns

boolean

Implementation of

IRenderer.isWebGL2

Defined in

webgi/src/core/threejs/BaseRenderer.ts:47


composerTarget

get composerTarget(): IRenderTarget

Returns

IRenderTarget

Implementation of

IRenderer.composerTarget

Defined in

webgi/src/core/threejs/BaseRenderer.ts:50


renderSize

get renderSize(): Vector2

Returns

Vector2

Defined in

webgi/src/core/threejs/BaseRenderer.ts:55


displayCanvasScaling

get displayCanvasScaling(): number

Returns

number

Implementation of

IRenderer.displayCanvasScaling

Defined in

webgi/src/core/threejs/BaseRenderer.ts:59

set displayCanvasScaling(value): void

Parameters

NameType
valuenumber

Returns

void

Implementation of

IRenderer.displayCanvasScaling

Defined in

webgi/src/core/threejs/BaseRenderer.ts:63


frameCount

get frameCount(): number

Returns

number

Implementation of

IRenderer.frameCount

Defined in

webgi/src/core/threejs/BaseRenderer.ts:71


pipeline

get pipeline(): string[]

Returns

string[]

Implementation of

IRenderer.pipeline

Defined in

webgi/src/core/threejs/BaseRenderer.ts:78

set pipeline(value): void

Parameters

NameType
valuestring[]

Returns

void

Implementation of

IRenderer.pipeline

Defined in

webgi/src/core/threejs/BaseRenderer.ts:74


context

get context(): WebGLRenderingContext

Returns

WebGLRenderingContext

Implementation of

IRenderer.context

Defined in

webgi/src/core/threejs/BaseRenderer.ts:140


rendererObject

get rendererObject(): WebGLRenderer

Returns

WebGLRenderer

Implementation of

IRenderer.rendererObject

Defined in

webgi/src/core/threejs/BaseRenderer.ts:144


clock

get clock(): Clock

Returns

Clock

Defined in

webgi/src/core/threejs/BaseRenderer.ts:170

Properties

dirty

dirty: boolean = true

Implementation of

IRenderer.dirty

Defined in

webgi/src/core/threejs/BaseRenderer.ts:69


frameWaitTime

frameWaitTime: number = 0

Defined in

webgi/src/core/threejs/BaseRenderer.ts:150


maxTempPerKey

Readonly maxTempPerKey: 5

Defined in

webgi/src/core/threejs/BaseRenderer.ts:523

Methods

refreshPipeline

refreshPipeline(): string[]

Returns

string[]

Implementation of

IRenderer.refreshPipeline

Defined in

webgi/src/core/threejs/BaseRenderer.ts:82


registerPass

registerPass(pass, replaceId?): void

Parameters

NameTypeDefault value
passIFilter<IPass, string>undefined
replaceIdbooleantrue

Returns

void

Implementation of

IRenderer.registerPass

Defined in

webgi/src/core/threejs/BaseRenderer.ts:174


unregisterPass

unregisterPass(pass): void

Parameters

NameType
passIFilter<IPass, string>

Returns

void

Implementation of

IRenderer.unregisterPass

Defined in

webgi/src/core/threejs/BaseRenderer.ts:186


setSize

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

Parameters

NameTypeDefault value
width?numberundefined
height?numberundefined
forcebooleanfalse

Returns

void

Defined in

webgi/src/core/threejs/BaseRenderer.ts:252


blit

blit(source, destination, __namedParameters?): void

Parameters

NameType
sourceundefined | ITexture<any>
destinationundefined | IRenderTarget
__namedParametersIRenderOptions

Returns

void

Implementation of

IRenderer.blit

Defined in

webgi/src/core/threejs/BaseRenderer.ts:286


clearColor

clearColor(__namedParameters): void

Parameters

NameType
__namedParametersObject
__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

Defined in

webgi/src/core/threejs/BaseRenderer.ts:322


renderModel

renderModel(model, camera): void

Parameters

NameType
modelIModel<any>
cameraICamera<ICameraOptions, any, any>

Returns

void

Implementation of

IRenderer.renderModel

Defined in

webgi/src/core/threejs/BaseRenderer.ts:338


renderScene

renderScene(scene): void

Parameters

NameType
sceneIScene<any, ICamera<ICameraOptions, any, any>>

Returns

void

Implementation of

IRenderer.renderScene

Defined in

webgi/src/core/threejs/BaseRenderer.ts:342


render

render(): void

Returns

void

Defined in

webgi/src/core/threejs/BaseRenderer.ts:352


updateDirty

updateDirty(): void

Returns

void

Defined in

webgi/src/core/threejs/BaseRenderer.ts:364


reset

reset(): void

Returns

void

Implementation of

IRenderer.reset

Defined in

webgi/src/core/threejs/BaseRenderer.ts:368


resetShadows

resetShadows(): void

Returns

void

Implementation of

IRenderer.resetShadows

Defined in

webgi/src/core/threejs/BaseRenderer.ts:374


refreshPasses

refreshPasses(): void

Returns

void

Defined in

webgi/src/core/threejs/BaseRenderer.ts:378


dispose

dispose(): void

Returns

void

Defined in

webgi/src/core/threejs/BaseRenderer.ts:395


trackTarget

trackTarget(target): void

Parameters

NameType
targetIRenderTarget

Returns

void

Implementation of

IRenderer.trackTarget

Defined in

webgi/src/core/threejs/BaseRenderer.ts:401


removeTrackedTarget

removeTrackedTarget(target): void

Parameters

NameType
targetIRenderTarget

Returns

void

Implementation of

IRenderer.removeTrackedTarget

Defined in

webgi/src/core/threejs/BaseRenderer.ts:405


createTarget

createTarget(__namedParameters?, trackTarget?): IRenderTarget

Parameters

NameTypeDefault value
__namedParametersCreateRenderTargetOptions{}
trackTargetbooleantrue

Returns

IRenderTarget

Implementation of

IRenderer.createTarget

Defined in

webgi/src/core/threejs/BaseRenderer.ts:411


disposeTarget

disposeTarget(target): void

Parameters

NameType
targetIRenderTarget

Returns

void

Implementation of

IRenderer.disposeTarget

Defined in

webgi/src/core/threejs/BaseRenderer.ts:445


createTargetCustom

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

Type parameters

NameType
Textends IRenderTarget<T>

Parameters

NameType
__namedParametersObject
__namedParameters.widthnumber
__namedParameters.heightnumber
__namedParameters.count?number
optionsWebGLRenderTargetOptions
clazz?Class<T>

Returns

T

Implementation of

IRenderer.createTargetCustom

Defined in

webgi/src/core/threejs/BaseRenderer.ts:452


getTempTarget

getTempTarget(op?): IRenderTarget

Parameters

NameType
opCreateRenderTargetOptions

Returns

IRenderTarget

Implementation of

IRenderer.getTempTarget

Defined in

webgi/src/core/threejs/BaseRenderer.ts:502


releaseTempTarget

releaseTempTarget(target): void

Parameters

NameType
targetIRenderTarget

Returns

void

Implementation of

IRenderer.releaseTempTarget

Defined in

webgi/src/core/threejs/BaseRenderer.ts:525


updateShaderProperties

updateShaderProperties(material): BaseRenderer

Parameters

NameType
materialObject
material.definesRecord<string, undefined | string | number>
material.uniformsObject

Returns

BaseRenderer

Implementation of

IRenderer.updateShaderProperties

Defined in

webgi/src/core/threejs/BaseRenderer.ts:535


addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameType
type"update" | "animationLoop" | "resize"
listener(event: IEvent<"update" | "animationLoop" | "resize">) => void

Returns

void

Implementation of

IRenderer.addEventListener

Inherited from

SimpleEventDispatcher.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:48


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

NameType
type"update" | "animationLoop" | "resize"
listener(event: IEvent<"update" | "animationLoop" | "resize">) => void

Returns

boolean

Implementation of

IRenderer.hasEventListener

Inherited from

SimpleEventDispatcher.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:56


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

NameType
type"update" | "animationLoop" | "resize"
listener(event: IEvent<"update" | "animationLoop" | "resize">) => void

Returns

void

Implementation of

IRenderer.removeEventListener

Inherited from

SimpleEventDispatcher.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<"update" | "animationLoop" | "resize">

Returns

void

Implementation of

IRenderer.dispatchEvent

Inherited from

SimpleEventDispatcher.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74

Constructors

constructor

new BaseRenderer(__namedParameters)

Parameters

NameType
__namedParametersObject
__namedParameters.animationLoop?(ev: any) => void
__namedParameters.antialias?boolean
__namedParameters.alpha?boolean
__namedParameters.canvasHTMLCanvasElement
__namedParameters.targetOptionsCreateRenderTargetOptions

Overrides

SimpleEventDispatcher.constructor

Defined in

webgi/src/core/threejs/BaseRenderer.ts:196