ZenFG TypeScript API / webgpu / root / CompiledFrameExecuteOptions

Type Alias: CompiledFrameExecuteOptions

CompiledFrameExecuteOptions = object

Defined in: packages/webgpu/src/types.ts:1200

Beta

Optional per-execution hooks and diagnostic identity supplied to CompiledFrame.execute.

Recording and compilation of another frame remain valid during these hooks. Recursive execution, pool clearing, and runtime destruction are rejected.

Properties

afterSubmit?

readonly optional afterSubmit?: SynchronousCallback<CompiledFrameAfterSubmitContext>

Defined in: packages/webgpu/src/types.ts:1227

Runs after queue submission and before transient resources are released back to the pool. This callback must complete synchronously and return undefined; FrameGraph does not await it.

---

beforeSubmit?

readonly optional beforeSubmit?: SynchronousCallback<CompiledFrameSubmitContext>

Defined in: packages/webgpu/src/types.ts:1221

Records caller-owned commands after graph nodes have been encoded and before the command buffer is finished and submitted. This callback must complete synchronously and return undefined; FrameGraph does not await it.

---

frameIndex?

readonly optional frameIndex?: number

Defined in: packages/webgpu/src/types.ts:1207

Logical frame identifier used by callbacks and GPU timing reports. It must be a non-negative safe integer.

Default Value

0

---

gpuDebugGroups?

readonly optional gpuDebugGroups?: boolean

Defined in: packages/webgpu/src/types.ts:1215

Emits retained recording groups through WebGPU debug commands. Groups are balanced independently per FrameGraph-owned execution segment; opaque external submissions are not wrapped.

Default Value

false