Documentation / scene / RenderGraphExecutor

Class: RenderGraphExecutor<TTexture>

Defined in: libs/scene/src/render/rendergraph/executor.ts:70

Executes compiled graphs with automatic resource lifetimes.

Type Parameters

TTexture

TTexture = BaseTexture

Constructors

Constructor

new RenderGraphExecutor<TTexture>(allocator, backbufferWidth, backbufferHeight, options?): RenderGraphExecutor<TTexture>

Defined in: libs/scene/src/render/rendergraph/executor.ts:93

Parameters

allocator

RGTextureAllocator<TTexture>

backbufferWidth

number

backbufferHeight

number

options?

RenderGraphExecutorOptions<TTexture>

Returns

RenderGraphExecutor<TTexture>

Methods

setDefaultProfilingOptions()

static setDefaultProfilingOptions(options): void

Defined in: libs/scene/src/render/rendergraph/executor.ts:110

Set profiling defaults for new executors.

Parameters

options

boolean | RGProfilingOptions

Returns

void

---

getLatestProfileResult()

static getLatestProfileResult(): RGProfileResult

Defined in: libs/scene/src/render/rendergraph/executor.ts:115

Return the latest resolved result from any executor.

Returns

RGProfileResult

---

resolveProfileResult()

static resolveProfileResult(): Promise<RGProfileResult>

Defined in: libs/scene/src/render/rendergraph/executor.ts:120

Resolve the latest pending result from any executor.

Returns

Promise<RGProfileResult>

---

setProfilingOptions()

setProfilingOptions(options): void

Defined in: libs/scene/src/render/rendergraph/executor.ts:128

Update timestamp profiling for this executor.

Parameters

options

boolean | RGProfilingOptions

Returns

void

---

getLatestProfileResult()

getLatestProfileResult(): RGProfileResult

Defined in: libs/scene/src/render/rendergraph/executor.ts:133

Return this executor's latest resolved profile.

Returns

RGProfileResult

---

resolveProfileResult()

resolveProfileResult(): Promise<RGProfileResult>

Defined in: libs/scene/src/render/rendergraph/executor.ts:138

Resolve this executor's latest pending profile.

Returns

Promise<RGProfileResult>

---

setBackbufferSize()

setBackbufferSize(width, height): void

Defined in: libs/scene/src/render/rendergraph/executor.ts:146

Update dimensions used for backbuffer-relative resources.

Parameters

width

number

height

number

Returns

void

---

setImportedTexture()

setImportedTexture(handle, texture): void

Defined in: libs/scene/src/render/rendergraph/executor.ts:152

Bind an imported texture for execution.

Parameters

handle

RGHandle

texture

TTexture

Returns

void

---

execute()

execute(compiled, bindings?): void

Defined in: libs/scene/src/render/rendergraph/executor.ts:157

Execute a compiled graph and manage its transient resources.

Parameters

compiled

CompiledRenderGraph

bindings?

RenderGraphExecutionBindings<TTexture>

Returns

void

---

reset()

reset(): void

Defined in: libs/scene/src/render/rendergraph/executor.ts:354

Release remaining resources and clear imported bindings.

Returns

void