Interface IRenderManager<E, ET>

interface IRenderManager<E, ET> {
    clock: Clock;
    composer: EffectComposer2;
    composerTarget: IRenderTarget;
    context: WebGLRenderingContext;
    frameCount: number;
    isWebGL2: boolean;
    maxTempPerKey: 5;
    needsRender: boolean;
    passes: IPipelinePass<string>[];
    pipeline: string[];
    renderScale: number;
    renderSize: Vector2;
    renderer: IWebGLRenderer<IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>>;
    totalFrameCount: number;
    useLegacyLights: boolean;
    webglRenderer: WebGLRenderer;
    _createTargetClass(clazz, size, options): IRenderTarget;
    _processNewTarget(target, sizeMultiplier, trackTarget): IRenderTarget;
    blit(destination, options?): void;
    clearColor(__namedParameters): void;
    createTarget<T>(__namedParameters?, trackTarget?): T;
    createTargetCustom<T>(__namedParameters, options?, clazz?): T;
    dispose(clear?): void;
    disposeTarget(target, remove?): void;
    exportRenderTarget(target, mimeType?): BlobExt;
    getTempTarget<T>(op?): T;
    rebuildPipeline(setDirty?): void;
    refreshPasses(): void;
    registerPass(pass, replaceId?): void;
    releaseTempTarget(target): void;
    removeTrackedTarget(target): void;
    render(scene): void;
    renderTargetToBuffer(target): Uint8Array | Uint16Array | Float32Array;
    renderTargetToDataUrl(target, mimeType?, quality?): string;
    reset(): void;
    resetShadows(): void;
    resizeTrackedTarget(target): void;
    resizeTrackedTargets(): void;
    setSize(width, height): void;
    trackTarget(target): void;
    unregisterPass(pass): void;
    updateShaderProperties(material): this;
}

Properties

clock

clock: Clock

composer

composer: EffectComposer2

`Readonly` composerTarget

composerTarget: IRenderTarget

`Readonly` context

context: WebGLRenderingContext

`Readonly` frameCount

frameCount: number

`Readonly` isWebGL2

isWebGL2: boolean

`Readonly` maxTempPerKey

maxTempPerKey: 5 = 5

`Readonly` needsRender

needsRender: boolean

`Readonly` passes

passes: IPipelinePass<string>[]

pipeline

pipeline: string[]

renderScale

renderScale: number

`Readonly` renderSize

renderSize: Vector2

`Readonly` renderer

renderer: IWebGLRenderer<IRenderManager<IRenderManagerEvent, IRenderManagerEventTypes>>

`Readonly` totalFrameCount

totalFrameCount: number

useLegacyLights

useLegacyLights: boolean

webglRenderer

webglRenderer: WebGLRenderer

Methods

`Protected` `Abstract` _createTargetClass

_createTargetClass(clazz, size, options): IRenderTarget
Parameters
- clazz: Class<WebGLRenderTarget>
- size: number[]
- options: WebGLRenderTargetOptions
Returns IRenderTarget
Inherited from RenderTargetManager._createTargetClass
- Defined in src/rendering/RenderTargetManager.ts:151

`Protected` _processNewTarget

_processNewTarget(target, sizeMultiplier, trackTarget): IRenderTarget
Parameters
- target: IRenderTarget
- sizeMultiplier: undefined | number
- trackTarget: boolean
Returns IRenderTarget
Inherited from RenderTargetManager._processNewTarget
- Defined in src/rendering/RenderTargetManager.ts:204

blit

blit(destination, options?): void
Parameters
- destination: undefined | null | IRenderTarget
- Optional options: RendererBlitOptions
Returns void
- Defined in src/core/IRenderer.ts:66

clearColor

clearColor(__namedParameters): void
Parameters
- __namedParameters: {
      a?: number;
      b?: number;
      depth?: boolean;
      g?: number;
      r?: number;
      stencil?: boolean;
      target?: IRenderTarget;
      viewport?: Vector4;
  }
  - Optional a?: number
  - Optional b?: number
  - Optional depth?: boolean
  - Optional g?: number
  - Optional r?: number
  - Optional stencil?: boolean
  - Optional target?: IRenderTarget
  - Optional viewport?: Vector4
Returns void
- Defined in src/core/IRenderer.ts:67

createTarget

createTarget<T>(__namedParameters?, trackTarget?): T
Type Parameters
- T extends IRenderTarget = IRenderTarget
Parameters
- __namedParameters: CreateRenderTargetOptions = {}
- trackTarget: boolean = true
Returns T
Inherited from RenderTargetManager.createTarget
- Defined in src/rendering/RenderTargetManager.ts:55

createTargetCustom

createTargetCustom<T>(__namedParameters, options?, clazz?): T
Type Parameters
- T extends IRenderTarget
Parameters
- __namedParameters: {
      count?: number;
      height: number;
      width: number;
  }
  - Optional count?: number
  - height: number
  - width: number
- options: WebGLRenderTargetOptions = {}
- Optional clazz: Class<T>
Returns T
Inherited from RenderTargetManager.createTargetCustom
- Defined in src/rendering/RenderTargetManager.ts:128

dispose

dispose(clear?): void
Parameters
- clear: boolean = true
Returns void
Inherited from RenderTargetManager.dispose
- Defined in src/rendering/RenderTargetManager.ts:153

disposeTarget

disposeTarget(target, remove?): 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
Inherited from RenderTargetManager.disposeTarget
- Defined in src/rendering/RenderTargetManager.ts:95

exportRenderTarget

exportRenderTarget(target, mimeType?): BlobExt
Parameters
- target: WebGLRenderTarget
- Optional mimeType: string
Returns BlobExt
- Defined in src/core/IRenderer.ts:74

getTempTarget

getTempTarget<T>(op?): T
Type Parameters
- T extends IRenderTarget = IRenderTarget
Parameters
- op: CreateRenderTargetOptions = {}
Returns T
Inherited from RenderTargetManager.getTempTarget
- Defined in src/rendering/RenderTargetManager.ts:103

rebuildPipeline

rebuildPipeline(setDirty?): void
Parameters
- Optional setDirty: boolean
Returns void
- Defined in src/core/IRenderer.ts:42

refreshPasses

refreshPasses(): void
Returns void
- Defined in src/core/IRenderer.ts:48

registerPass

registerPass(pass, replaceId?): void
Parameters
- pass: IPipelinePass<string>
- Optional replaceId: boolean
Returns void
- Defined in src/core/IRenderer.ts:50

releaseTempTarget

releaseTempTarget(target): void
Parameters
- target: IRenderTarget
Returns void
Inherited from RenderTargetManager.releaseTempTarget
- Defined in src/rendering/RenderTargetManager.ts:116

removeTrackedTarget

removeTrackedTarget(target): void
Parameters
- target: IRenderTarget
Returns void
Inherited from RenderTargetManager.removeTrackedTarget
- Defined in src/rendering/RenderTargetManager.ts:49

render

render(scene): void
Parameters
- scene: IScene<ISceneEvent<ISceneEventTypes>, ISceneEventTypes>
Returns void
- Defined in src/core/IRenderer.ts:45

renderTargetToBuffer

renderTargetToBuffer(target): Uint8Array | Uint16Array | Float32Array
Parameters
- target: WebGLRenderTarget
Returns Uint8Array | Uint16Array | Float32Array
- Defined in src/core/IRenderer.ts:72

renderTargetToDataUrl

renderTargetToDataUrl(target, mimeType?, quality?): string
Parameters
- target: WebGLRenderTarget
- Optional mimeType: string
- Optional quality: number
Returns string
- Defined in src/core/IRenderer.ts:70

reset

reset(): void
Returns void
- Defined in src/core/IRenderer.ts:46

resetShadows

resetShadows(): void
Returns void
- Defined in src/core/IRenderer.ts:47

resizeTrackedTarget

resizeTrackedTarget(target): void
Parameters
- target: IRenderTarget
Returns void
Inherited from RenderTargetManager.resizeTrackedTarget
- Defined in src/rendering/RenderTargetManager.ts:170

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
Inherited from RenderTargetManager.resizeTrackedTargets
- Defined in src/rendering/RenderTargetManager.ts:167

setSize

setSize(width, height): void
Parameters
- width: number
- height: number
Returns void
- Defined in src/core/IRenderer.ts:43

trackTarget

trackTarget(target): void
Parameters
- target: IRenderTarget
Returns void
Inherited from RenderTargetManager.trackTarget
- Defined in src/rendering/RenderTargetManager.ts:45

unregisterPass

unregisterPass(pass): void
Parameters
- pass: IPipelinePass<string>
Returns void
- Defined in src/core/IRenderer.ts:51

updateShaderProperties

updateShaderProperties(material): this
Parameters
- material: {
      defines: Record<string, undefined | string | number>;
      uniforms: {
          [name: string]: IUniform;
      };
  }
  - defines: Record<string, undefined | string | number>
  - uniforms: {
    [name: string]: IUniform;
    }
    - [name: string]: IUniform
Returns this
Inherited from IShaderPropertiesUpdater.updateShaderProperties
- Defined in src/materials/MaterialExtension.ts:105

Interface IRenderManager<E, ET>

Type Parameters

E extends IRenderManagerEvent = IRenderManagerEvent

ET extends string = IRenderManagerEventTypes

Hierarchy (view full)

Implemented by

Index

Properties

Methods

Properties

clock

composer

Readonly composerTarget

Readonly context

Readonly frameCount

Readonly isWebGL2

Readonly maxTempPerKey

Readonly needsRender

Readonly passes

pipeline

renderScale

Readonly renderSize

Readonly renderer

Readonly totalFrameCount

useLegacyLights

webglRenderer

Methods

Protected Abstract _createTargetClass

Parameters

clazz: Class<WebGLRenderTarget>

size: number[]

options: WebGLRenderTargetOptions

Returns IRenderTarget

Protected _processNewTarget

Parameters

target: IRenderTarget

sizeMultiplier: undefined | number

trackTarget: boolean

Returns IRenderTarget

blit

Parameters

destination: undefined | null | IRenderTarget

Optional options: RendererBlitOptions

Returns void

clearColor

Parameters

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

Optional a?: number

Optional b?: number

Optional depth?: boolean

Optional g?: number

Optional r?: number

Optional stencil?: boolean

Optional target?: IRenderTarget

Optional viewport?: Vector4

Returns void

createTarget

Type Parameters

T extends IRenderTarget = IRenderTarget

Parameters

__namedParameters: CreateRenderTargetOptions = {}

trackTarget: boolean = true

Returns T

createTargetCustom

Type Parameters

T extends IRenderTarget

Parameters

__namedParameters: { count?: number; height: number; width: number; }

Optional count?: number

height: number

width: number

options: WebGLRenderTargetOptions = {}

Optional clazz: Class<T>

Returns T

dispose

Parameters

clear: boolean = true

Returns void

disposeTarget

Parameters

`Readonly` composerTarget

`Readonly` context

`Readonly` frameCount

`Readonly` isWebGL2

`Readonly` maxTempPerKey

`Readonly` needsRender

`Readonly` passes

`Readonly` renderSize

`Readonly` renderer

`Readonly` totalFrameCount

`Protected` `Abstract` _createTargetClass

`Protected` _processNewTarget

`Optional` options: RendererBlitOptions

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

`Optional` a?: number

`Optional` b?: number

`Optional` depth?: boolean

`Optional` g?: number

`Optional` r?: number

`Optional` stencil?: boolean

`Optional` target?: IRenderTarget

`Optional` viewport?: Vector4

__namedParameters: {
count?: number;
height: number;
width: number;
}

`Optional` count?: number

`Optional` clazz: Class<T>

`Optional` mimeType: string

`Optional` setDirty: boolean

`Optional` replaceId: boolean

`Optional` mimeType: string

`Optional` quality: number