Skip to main content

Interface: IRenderer

Core-API.IRenderer

Hierarchy

  • IEventDispatcher<"animationLoop" | "update" | "resize" | "contextLost" | "contextRestored" | string>

  • IShaderPropertiesUpdater

    IRenderer

Implemented by

Methods

updateShaderProperties

updateShaderProperties(material): IRenderer

Parameters

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

Returns

IRenderer

Inherited from

IShaderPropertiesUpdater.updateShaderProperties


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


blit

blit(source, destination, options?): void

Parameters

NameType
sourceundefined | ITexture<any>
destinationundefined | IRenderTarget
options?IRenderOptions

Returns

void


renderScene

renderScene(scene): void

Parameters

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

Returns

void


renderModel

renderModel(model, camera): void

Parameters

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

Returns

void


refreshPipeline

refreshPipeline(): string[]

Returns

string[]


reset

reset(): void

Returns

void


resetShadows

resetShadows(): void

Returns

void


registerPass

registerPass(pass, replaceId?): void

Parameters

NameType
passIFilter<IPass, string>
replaceId?boolean

Returns

void


unregisterPass

unregisterPass(pass): void

Parameters

NameType
passIFilter<IPass, string>

Returns

void


createTarget

createTarget(options?): IRenderTarget

Parameters

NameType
options?CreateRenderTargetOptions

Returns

IRenderTarget


createTargetCustom

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

Type parameters

NameType
Textends IRenderTarget<T>

Parameters

NameType
__namedParametersObject
__namedParameters.widthnumber
__namedParameters.heightnumber
options?WebGLRenderTargetOptions
clazz?Class<T>

Returns

T


disposeTarget

disposeTarget(target): void

Parameters

NameType
targetIRenderTarget

Returns

void


trackTarget

trackTarget(target): void

Parameters

NameType
targetIRenderTarget

Returns

void


removeTrackedTarget

removeTrackedTarget(target): void

Parameters

NameType
targetIRenderTarget

Returns

void


getTempTarget

getTempTarget(op?): IRenderTarget

Parameters

NameType
op?CreateRenderTargetOptions

Returns

IRenderTarget


releaseTempTarget

releaseTempTarget(target): void

Parameters

NameType
targetIRenderTarget

Returns

void

Properties

passes

passes: IFilter<IPass, string>[]


dirty

dirty: boolean


composer

composer: IEffectComposer


isWebGL2

isWebGL2: boolean


frameCount

frameCount: number


displayCanvasScaling

displayCanvasScaling: number


context

context: WebGLRenderingContext


rendererObject

rendererObject: any


pipeline

pipeline: string[]


composerTarget

composerTarget: IRenderTarget