Skip to content

@orillusion/core


Class: RendererJob

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:29

The base render job for one View3D. Owns:

  • the per-view RenderGraphempty by default; subclasses compose pass sets via this.graph.add(...);
    • lifecycle (start/stop/pause/resume) and frame driving via renderFrame() (which invokes graph.execute(...));
  • the public addPost/removePost entry points used by PostProcessingComponent, which route into the graph's PostPass when one is registered.

RendererJob itself does NOT register any passes — that's the job of subclasses like ForwardRendererJob, or of user code extending RendererJob directly. This keeps the base class pipeline-agnostic so deferred / VR / custom flows can share it.

Extended by

Constructors

Constructor

new RendererJob(view): RendererJob

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:40

Parameters

view

View3D

Returns

RendererJob

Properties

graph

readonly graph: RenderGraph

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:30


occlusionSystem

occlusionSystem: OcclusionSystem

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:31


pauseRender

pauseRender: boolean = false

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:33


pickFire

pickFire: PickFire

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:34


renderState

renderState: boolean = false

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:35

Accessors

view

Get Signature

get view(): View3D

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:46

Returns

View3D

Set Signature

set view(view): void

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:49

Parameters
view

View3D

Returns

void

Methods

start()

start(): void

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:53

Returns

void


stop()

stop(): void

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:67

Returns

void


pause()

pause(): void

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:68

Returns

void


resume()

resume(): void

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:69

Returns

void


debug()

debug(): void

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:70

Returns

void


renderFrame()

renderFrame(): void

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:76

Drive one frame through the graph. Pre-graph bookkeeping that sits outside any pass (camera, light / reflection entries, occlusion snapshot) runs inline; everything else is owned by passes registered into this.graph.

Returns

void


addPost()

addPost(post): PostBase | PostBase[]

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:89

Attach a post-processing effect. Routes into the graph's PostPass; if no PostPass is in the graph (e.g. a custom job without a post chain), this is a no-op.

Parameters

post

PostBase

Returns

PostBase | PostBase[]


removePost()

removePost(post): void

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:95

Parameters

post

PostBase | PostBase[]

Returns

void


destroy()

destroy(_force?): void

Defined in: src/gfx/renderJob/jobs/RendererJob.ts:105

Parameters

_force?

boolean

Returns

void