Class ViewerRenderManager

autoBuildPipeline

defaultRenderToScreen

frameWaitTime

ReadonlymaxTempPerKey

shadowMap

shadowMapType

stableNoise

Static ReadonlyPOWER_PREFERENCE

clock

• get clock(): Clock

• Returns Clock

composer

• get composer(): EffectComposer2

• Returns EffectComposer2

composerTarget

• get composerTarget(): IRenderTarget

• Returns IRenderTarget

composerTarget2

• get composerTarget2(): IRenderTarget

• Returns IRenderTarget

context

• get context(): WebGLRenderingContext

• Returns WebGLRenderingContext

displayCanvasScaling

• get displayCanvasScaling(): number

• Returns number

  Deprecated

  use renderScale instead

• set displayCanvasScaling(value: number): void

• Parameters

  • value: number

  Returns void

  Deprecated

  use renderScale instead

frameCount

• get frameCount(): number

• Returns number

isWebGL2

• get isWebGL2(): boolean

• Returns boolean

needsRender

• get needsRender(): boolean

• Returns boolean

passes

• get passes(): IPipelinePass[]

• Returns IPipelinePass[]

pipeline

• get pipeline(): string[]

• Returns string[]

• set pipeline(value: string[]): void

• Parameters

  • value: string[]

  Returns void

renderer

• get renderer(): IWebGLRenderer<this>

• Returns IWebGLRenderer<this>

renderScale

• get renderScale(): number

• Returns number

• set renderScale(value: number): void

• Parameters

  • value: number

  Returns void

renderSize

• get renderSize(): Vector2

• The size set in the three.js renderer. Final size is renderSize * renderScale

  Returns Vector2

totalFrameCount

• get totalFrameCount(): number

• Returns number

useLegacyLights

• get useLegacyLights(): boolean

• Returns boolean

• set useLegacyLights(v: boolean): void

• Parameters

  • v: boolean

  Returns void

webglRenderer

• get webglRenderer(): WebGLRenderer

• Same as renderer

  Returns WebGLRenderer

blit

• blit(
      destination: undefined | null | IRenderTarget,
      __namedParameters?: RendererBlitOptions,
  ): void

• blit - blits a texture to the screen or another render target.

  Parameters

  • destination: undefined | null | IRenderTarget

    destination target, or screen if undefined or null
  • __namedParameters: RendererBlitOptions = {}

  Returns void

clearColor

• clearColor(
      __namedParameters: {
          a?: number;
          b?: number;
          depth?: boolean;
          g?: number;
          r?: number;
          stencil?: boolean;
          target?: IRenderTarget;
          viewport?: Vector4;
      },
  ): void

• Parameters

  • __namedParameters: {
        a?: number;
        b?: number;
        depth?: boolean;
        g?: number;
        r?: number;
        stencil?: boolean;
        target?: IRenderTarget;
        viewport?: Vector4;
    }

  Returns void

createTarget

• createTarget<T extends IRenderTarget = IRenderTarget>(
      __namedParameters?: CreateRenderTargetOptions,
      trackTarget?: boolean,
  ): T

• Type Parameters

  • T extends IRenderTarget = IRenderTarget

  Parameters

  • __namedParameters: CreateRenderTargetOptions = {}
  • trackTarget: boolean = true

  Returns T

createTargetCustom

• createTargetCustom<T extends IRenderTarget>(
      __namedParameters: { count?: number; height: number; width: number },
      options?: WebGLRenderTargetOptions,
      clazz?: Class<T>,
  ): T

• Type Parameters

  • T extends IRenderTarget

  Parameters

  • __namedParameters: { count?: number; height: number; width: number }
  • options: WebGLRenderTargetOptions = {}
  • Optionalclazz: Class<T>

  Returns T

dispose

• dispose(clear?: boolean): void

• Parameters

  • clear: boolean = true

  Returns void

disposeTarget

• disposeTarget(target: IRenderTarget, remove?: boolean): void

• Dispose and remove tracked target. Release target in-case of temporary target. To just dispose from the GPU memory and keep reference, call target.dispose() or target.dispose(false)

  Parameters

  • target: IRenderTarget
  • remove: boolean = true

  Returns void

exportRenderTarget

• exportRenderTarget(
      target: WebGLRenderTarget | WebGLMultipleRenderTargets,
      mimeType?: string,
      textureIndex?: number,
  ): BlobExt

• Exports a render target to a blob. The type is automatically picked from exr to png based on the render target.

  Parameters

  • target: WebGLRenderTarget | WebGLMultipleRenderTargets

    render target to export
  • mimeType: string = 'auto'

    mime type to use. If auto (default), then it will be picked based on the render target type.
  • textureIndex: number = 0

    index of the texture to use in the render target (only in case of multiple render target)

  Returns BlobExt

getTempTarget

• getTempTarget<T extends IRenderTarget = IRenderTarget>(
      op?: CreateRenderTargetOptions,
  ): T

• Type Parameters

  • T extends IRenderTarget = IRenderTarget

  Parameters

  • op: CreateRenderTargetOptions = {}

  Returns T

onPostFrame

• onPostFrame(): void

• Returns void

rebuildPipeline

• rebuildPipeline(setDirty?: boolean): void

• Parameters

  • setDirty: boolean = true

  Returns void

refreshPasses

• refreshPasses(): void

• Returns void

registerPass

• registerPass(pass: IPipelinePass, replaceId?: boolean): void

• Parameters

  • pass: IPipelinePass
  • replaceId: boolean = true

  Returns void

releaseTempTarget

• releaseTempTarget(target: IRenderTarget): void

• Parameters

  • target: IRenderTarget

  Returns void

removeTrackedTarget

• removeTrackedTarget(target: IRenderTarget): void

• Parameters

  • target: IRenderTarget

  Returns void

renderTargetToBuffer

• renderTargetToBuffer(
      target: WebGLRenderTarget | WebGLMultipleRenderTargets,
      textureIndex?: number,
  ): Uint8Array | Uint16Array | Float32Array

• Rend pixels from a render target into a new Uint8Array|Uint16Array|Float32Array buffer

  Parameters

  • target: WebGLRenderTarget | WebGLMultipleRenderTargets

    render target to read from
  • textureIndex: number = 0

    index of the texture to use in the render target (only in case of multiple render target)

  Returns Uint8Array | Uint16Array | Float32Array

renderTargetToDataUrl

• renderTargetToDataUrl(
      target: WebGLRenderTarget | IRenderTarget | WebGLMultipleRenderTargets,
      mimeType?: string,
      quality?: number,
      textureIndex?: number,
  ): string

• Converts a render target to a png/jpeg data url string. Note: this will clamp the values to [0, 1] and converts to srgb for float and half-float render targets.

  Parameters

  • target: WebGLRenderTarget | IRenderTarget | WebGLMultipleRenderTargets
  • mimeType: string = 'image/png'
  • quality: number = 90
  • textureIndex: number = 0

    index of the texture to use in the render target (only in case of multiple render target)

  Returns string

reset

• reset(): void

• Returns void

resetShadows

• resetShadows(): void

• Returns void

resetTotalFrameCount

• resetTotalFrameCount(): void

• Returns void

resizeTrackedTarget

• resizeTrackedTarget(target: IRenderTarget): void

• Parameters

  • target: IRenderTarget

  Returns void

resizeTrackedTargets

• resizeTrackedTargets(): void

• Resizes all tracked targets with a sizeMultiplier based on the current renderSize and renderScale. This must be automatically called by the renderer on resize, and manually when sizeMultiplier of a target changes.

  Returns void

setDirty

• setDirty(reset?: boolean): void

• Parameters

  • reset: boolean = false

  Returns void

setSize

• setSize(width?: number, height?: number, force?: boolean): void

• Parameters

  • Optionalwidth: number
  • Optionalheight: number
  • force: boolean = false

  Returns void

trackTarget

• trackTarget(target: IRenderTarget): void

• Parameters

  • target: IRenderTarget

  Returns void

unregisterPass

• unregisterPass(pass: IPipelinePass): void

• Parameters

  • pass: IPipelinePass

  Returns void

updateShaderProperties

• updateShaderProperties(
      material: {
          defines: Record<string, undefined | string | number>;
          uniforms: { [name: string]: IUniform };
      },
  ): this

• Parameters

  • material: {
        defines: Record<string, undefined | string | number>;
        uniforms: { [name: string]: IUniform };
    }

  Returns this