> Development branch documentation · commit 327c05c78d2f528e4f4a679fcc7a77d9aa161f48
> Package versions: @zenfg/webgpu 0.1.0, @zenfg/snapshot 0.1.0, @zenfg/inspector 0.1.0, zenfg 0.1.0, zenfg-snapshot 0.1.0
> Source: https://github.com/uinosoft/zenfg/blob/327c05c78d2f528e4f4a679fcc7a77d9aa161f48/packages/webgpu/src/snapshot.ts#L39

[ZenFG TypeScript API](/zenfg/docs/api/index.md) / [webgpu](/zenfg/docs/api/webgpu/index.md) / [snapshot](/zenfg/docs/api/webgpu/snapshot/index.md) / CreateFrameGraphSnapshotOptions

# Type Alias: CreateFrameGraphSnapshotOptions

> **CreateFrameGraphSnapshotOptions** = `object`

Defined in: [packages/webgpu/src/snapshot.ts:39](https://github.com/uinosoft/zenfg/blob/327c05c78d2f528e4f4a679fcc7a77d9aa161f48/packages/webgpu/src/snapshot.ts#L39)

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

## Properties

### capturedAt?

> `readonly` `optional` **capturedAt?**: `string`

Defined in: [packages/webgpu/src/snapshot.ts:61](https://github.com/uinosoft/zenfg/blob/327c05c78d2f528e4f4a679fcc7a77d9aa161f48/packages/webgpu/src/snapshot.ts#L61)

ISO-8601 capture timestamp.

#### Default Value

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

***

### compilation

> `readonly` **compilation**: [`FrameGraphCompilationReport`](/zenfg/docs/api/webgpu/root/type-aliases/FrameGraphCompilationReport.md)

Defined in: [packages/webgpu/src/snapshot.ts:44](https://github.com/uinosoft/zenfg/blob/327c05c78d2f528e4f4a679fcc7a77d9aa161f48/packages/webgpu/src/snapshot.ts#L44)

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

***

### cpuTiming?

> `readonly` `optional` **cpuTiming?**: [`FrameGraphCpuTimingReport`](/zenfg/docs/api/webgpu/root/type-aliases/FrameGraphCpuTimingReport.md)

Defined in: [packages/webgpu/src/snapshot.ts:50](https://github.com/uinosoft/zenfg/blob/327c05c78d2f528e4f4a679fcc7a77d9aa161f48/packages/webgpu/src/snapshot.ts#L50)

Optional synchronous CPU result from the same execution.

***

### frameIndex

> `readonly` **frameIndex**: `number`

Defined in: [packages/webgpu/src/snapshot.ts:46](https://github.com/uinosoft/zenfg/blob/327c05c78d2f528e4f4a679fcc7a77d9aa161f48/packages/webgpu/src/snapshot.ts#L46)

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

***

### gpuTiming?

> `readonly` `optional` **gpuTiming?**: [`FrameGraphGpuTimingReport`](/zenfg/docs/api/webgpu/root/type-aliases/FrameGraphGpuTimingReport.md)

Defined in: [packages/webgpu/src/snapshot.ts:48](https://github.com/uinosoft/zenfg/blob/327c05c78d2f528e4f4a679fcc7a77d9aa161f48/packages/webgpu/src/snapshot.ts#L48)

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

***

### producerVersion?

> `readonly` `optional` **producerVersion?**: `string`

Defined in: [packages/webgpu/src/snapshot.ts:63](https://github.com/uinosoft/zenfg/blob/327c05c78d2f528e4f4a679fcc7a77d9aa161f48/packages/webgpu/src/snapshot.ts#L63)

Version of the application or library producing this capture.

***

### resourcePool

> `readonly` **resourcePool**: [`FrameGraphResourcePoolStats`](/zenfg/docs/api/webgpu/root/type-aliases/FrameGraphResourcePoolStats.md)

Defined in: [packages/webgpu/src/snapshot.ts:55](https://github.com/uinosoft/zenfg/blob/327c05c78d2f528e4f4a679fcc7a77d9aa161f48/packages/webgpu/src/snapshot.ts#L55)

Aggregate pool counters to record with the capture. Read them after frame
execution when the snapshot should include that execution's releases.

***

### runtime?

> `readonly` `optional` **runtime?**: `NonNullable`\<[`FrameGraphSnapshotProducer`](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotProducer.md)\[`"runtime"`\]\>

Defined in: [packages/webgpu/src/snapshot.ts:68](https://github.com/uinosoft/zenfg/blob/327c05c78d2f528e4f4a679fcc7a77d9aa161f48/packages/webgpu/src/snapshot.ts#L68)

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