ZenFG TypeScript API / webgpu / snapshot / CreateFrameGraphSnapshotOptions

Type Alias: CreateFrameGraphSnapshotOptions

CreateFrameGraphSnapshotOptions = object

Defined in: packages/webgpu/src/snapshot.ts:44

Inputs required to project one WebGPU frame into a portable snapshot.

Properties

capturedAt?

readonly optional capturedAt?: string

Defined in: packages/webgpu/src/snapshot.ts:68

Optional capture timestamp string. The default is an ISO-8601 timestamp generated from the current time.

Default Value

The current time from new Date().toISOString().

---

compilation

readonly compilation: FrameGraphCompilationReport

Defined in: packages/webgpu/src/snapshot.ts:49

Detached readonly report returned by recorder.compile({ report: true }). It must describe the same compiled frame as all provided timing reports.

---

cpuTiming?

readonly optional cpuTiming?: FrameGraphCpuTimingReport

Defined in: packages/webgpu/src/snapshot.ts:55

Optional synchronous CPU result from the same execution.

---

frameIndex

readonly frameIndex: number

Defined in: packages/webgpu/src/snapshot.ts:51

Caller-defined identity; every supplied timing report must match it.

---

gpuTiming?

readonly optional gpuTiming?: FrameGraphGpuTimingReport

Defined in: packages/webgpu/src/snapshot.ts:53

Optional resolved GPU result from the same execution, including unavailability.

---

producerVersion?

readonly optional producerVersion?: string

Defined in: packages/webgpu/src/snapshot.ts:70

Version of the application or library producing this capture.

---

resourcePool?

readonly optional resourcePool?: FrameGraphResourcePoolStats

Defined in: packages/webgpu/src/snapshot.ts:61

Optional aggregate pool counters. Read them after execution when the snapshot should include that execution's releases. Omission records an unavailable pool report with reason 'not-requested'.

---

runtime?

readonly optional runtime?: NonNullable<FrameGraphSnapshotProducer["runtime"]>

Defined in: packages/webgpu/src/snapshot.ts:75

Optional runtime implementation, graphics API, and backend metadata. graphicsApi defaults to 'webgpu' when omitted.