> 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/tree/327c05c78d2f528e4f4a679fcc7a77d9aa161f48/packages

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

# root

Reads, validates, migrates, and writes portable ZenFG FrameGraph Snapshot
1.2 documents, with explicit migration of 1.1.

Use [parseFrameGraphSnapshot](/zenfg/docs/api/snapshot/root/functions/parseFrameGraphSnapshot.md) for JSON text and
[decodeFrameGraphSnapshot](/zenfg/docs/api/snapshot/root/functions/decodeFrameGraphSnapshot.md) for already-parsed values. Both return a
discriminated result instead of throwing for untrusted input, and both
canonicalize supported legacy captures to [FrameGraphSnapshot](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshot.md).

## Classes

- [FrameGraphSnapshotValidationError](/zenfg/docs/api/snapshot/root/classes/FrameGraphSnapshotValidationError.md)

## Type Aliases

- [FrameGraphSnapshot](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshot.md)
- [FrameGraphSnapshotAccess](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotAccess.md)
- [FrameGraphSnapshotAccessKind](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotAccessKind.md)
- [FrameGraphSnapshotAllocation](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotAllocation.md)
- [FrameGraphSnapshotBufferDescriptor](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotBufferDescriptor.md)
- [FrameGraphSnapshotBufferRange](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotBufferRange.md)
- [FrameGraphSnapshotBufferUsageFlag](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotBufferUsageFlag.md)
- [FrameGraphSnapshotCapture](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotCapture.md)
- [FrameGraphSnapshotCpuTimings](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotCpuTimings.md)
- [FrameGraphSnapshotDecodeResult](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotDecodeResult.md)
- [FrameGraphSnapshotDependency](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotDependency.md)
- [FrameGraphSnapshotDiagnostic](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotDiagnostic.md)
- [FrameGraphSnapshotEntityId](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotEntityId.md)
- [FrameGraphSnapshotGpuTimings](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotGpuTimings.md)
- [FrameGraphSnapshotGraph](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotGraph.md)
- [FrameGraphSnapshotGroup](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotGroup.md)
- [FrameGraphSnapshotInitialContents](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotInitialContents.md)
- [FrameGraphSnapshotIssue](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotIssue.md)
- [FrameGraphSnapshotMemory](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotMemory.md)
- [FrameGraphSnapshotMigration](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotMigration.md)
- [FrameGraphSnapshotNode](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotNode.md)
- [FrameGraphSnapshotNodeKind](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotNodeKind.md)
- [FrameGraphSnapshotProducer](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotProducer.md)
- [FrameGraphSnapshotResource](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotResource.md)
- [FrameGraphSnapshotResourceKind](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotResourceKind.md)
- [FrameGraphSnapshotResourceOrigin](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotResourceOrigin.md)
- [FrameGraphSnapshotResourceRange](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotResourceRange.md)
- [FrameGraphSnapshotRoot](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotRoot.md)
- [FrameGraphSnapshotRootReason](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotRootReason.md)
- [FrameGraphSnapshotRootResolution](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotRootResolution.md)
- [FrameGraphSnapshotSegment](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotSegment.md)
- [FrameGraphSnapshotSegmentKind](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotSegmentKind.md)
- [FrameGraphSnapshotStringifyOptions](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotStringifyOptions.md)
- [FrameGraphSnapshotTextureDescriptor](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotTextureDescriptor.md)
- [FrameGraphSnapshotTextureRegion](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotTextureRegion.md)
- [FrameGraphSnapshotTextureUsageFlag](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotTextureUsageFlag.md)
- [FrameGraphSnapshotTextureView](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotTextureView.md)
- [FrameGraphSnapshotUnavailableFact](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotUnavailableFact.md)
- [FrameGraphSnapshotV1](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotV1.md)
- [FrameGraphSnapshotWriteContents](/zenfg/docs/api/snapshot/root/type-aliases/FrameGraphSnapshotWriteContents.md)
- [JsonPrimitive](/zenfg/docs/api/snapshot/root/type-aliases/JsonPrimitive.md)
- [JsonValue](/zenfg/docs/api/snapshot/root/type-aliases/JsonValue.md)

## Functions

- [decodeFrameGraphSnapshot](/zenfg/docs/api/snapshot/root/functions/decodeFrameGraphSnapshot.md)
- [finalizeFrameGraphSnapshot](/zenfg/docs/api/snapshot/root/functions/finalizeFrameGraphSnapshot.md)
- [parseFrameGraphSnapshot](/zenfg/docs/api/snapshot/root/functions/parseFrameGraphSnapshot.md)
- [stringifyFrameGraphSnapshot](/zenfg/docs/api/snapshot/root/functions/stringifyFrameGraphSnapshot.md)
- [validateFrameGraphSnapshot](/zenfg/docs/api/snapshot/root/functions/validateFrameGraphSnapshot.md)

## References

### FRAME\_GRAPH\_SNAPSHOT\_FORMAT

Re-exports [FRAME_GRAPH_SNAPSHOT_FORMAT](/zenfg/docs/api/snapshot/format/variables/FRAME_GRAPH_SNAPSHOT_FORMAT.md)

***

### FRAME\_GRAPH\_SNAPSHOT\_MAX\_EXTENSION\_DEPTH

Re-exports [FRAME_GRAPH_SNAPSHOT_MAX_EXTENSION_DEPTH](/zenfg/docs/api/snapshot/format/variables/FRAME_GRAPH_SNAPSHOT_MAX_EXTENSION_DEPTH.md)

***

### FRAME\_GRAPH\_SNAPSHOT\_VERSION

Re-exports [FRAME_GRAPH_SNAPSHOT_VERSION](/zenfg/docs/api/snapshot/format/variables/FRAME_GRAPH_SNAPSHOT_VERSION.md)