Main Navigation

Sidebar Navigation

Introduction

Getting started

Choose your path

@zenfg/webgpu

@zenfg/snapshot

@zenfg/inspector

zenfg

zenfg-snapshot

Concepts

Core concepts

Guides & examples

Examples and recipes

Inspector workbench

Inspector themes

Reference

Snapshot specification

Compatibility & migration

Compatibility

Unified timing and Snapshot 1.2

Migrating to beta.3

Changelog

TypeScript API

inspector

root

Classes

FrameGraphInspector

Type Aliases

FrameGraphCaptureRequest

FrameGraphInspectorOptions

FrameGraphSnapshot

FrameGraphSnapshotDecodeResult

FrameGraphSnapshotIssue

Variables

ZENFG_INSPECTOR_QUERY_PARAM

Functions

ensureFrameGraphInspectorStyles

isZenFGInspectorRequested

mountFrameGraphInspector

theme

Interfaces

InspectorTheme

Type Aliases

InspectorThemeVariables

ThemeMode

VisualPalette

Variables

tokyoNightLight

tokyoNightStorm

visualMetrics

visualThemes

snapshot

format

Variables

FRAME_GRAPH_SNAPSHOT_FORMAT

FRAME_GRAPH_SNAPSHOT_MAX_EXTENSION_DEPTH

FRAME_GRAPH_SNAPSHOT_VERSION

LEGACY_CANDIDATE_FRAME_GRAPH_SNAPSHOT_FORMAT

root

Classes

FrameGraphSnapshotValidationError

Type Aliases

FrameGraphSnapshot

FrameGraphSnapshotAccess

FrameGraphSnapshotAccessKind

FrameGraphSnapshotAllocation

FrameGraphSnapshotBufferDescriptor

FrameGraphSnapshotBufferRange

FrameGraphSnapshotBufferUsageFlag

FrameGraphSnapshotCapture

FrameGraphSnapshotCpuTimings

FrameGraphSnapshotDecodeResult

FrameGraphSnapshotDependency

FrameGraphSnapshotDiagnostic

FrameGraphSnapshotEntityId

FrameGraphSnapshotGpuTimings

FrameGraphSnapshotGraph

FrameGraphSnapshotGroup

FrameGraphSnapshotInitialContents

FrameGraphSnapshotIssue

FrameGraphSnapshotMemory

FrameGraphSnapshotMigration

FrameGraphSnapshotNode

FrameGraphSnapshotNodeKind

FrameGraphSnapshotProducer

FrameGraphSnapshotResource

FrameGraphSnapshotResourceKind

FrameGraphSnapshotResourceOrigin

FrameGraphSnapshotResourceRange

FrameGraphSnapshotRoot

FrameGraphSnapshotRootReason

FrameGraphSnapshotRootResolution

FrameGraphSnapshotSegment

FrameGraphSnapshotSegmentKind

FrameGraphSnapshotStringifyOptions

FrameGraphSnapshotTextureDescriptor

FrameGraphSnapshotTextureRegion

FrameGraphSnapshotTextureUsageFlag

FrameGraphSnapshotTextureView

FrameGraphSnapshotUnavailableFact

FrameGraphSnapshotV1

FrameGraphSnapshotWriteContents

JsonPrimitive

JsonValue

Functions

decodeFrameGraphSnapshot

finalizeFrameGraphSnapshot

parseFrameGraphSnapshot

stringifyFrameGraphSnapshot

validateFrameGraphSnapshot

webgpu

root

Enumerations

BufferAccess

TextureAccess

Classes

FrameGraph

FrameGraphError

Interfaces

CompiledFrame

CompiledFrameWithReport

FrameGraphRecorder

FrameGraphRecording

Type Aliases

BufferDesc

BufferHandle

BufferRange

BufferUse

BufferUseOptions

BufferWriteUseOptions

ClearBufferNodeDesc

ClearBufferOperation

CommandEncodeContext

CommandNodeDesc

CompiledFrameAfterSubmitContext

CompiledFrameExecuteOptions

CompiledFrameSubmitContext

CompiledTextureRegion

ComputeEncodeContext

ComputePassNodeDesc

CopyNodeDesc

CopyOperation

CulledNodeReason

ExternalSubmissionContext

ExternalSubmissionNodeDesc

FrameGraphCompilationAccess

FrameGraphCompilationReport

FrameGraphCompilationRoot

FrameGraphCpuTimingReport

FrameGraphErrorCode

FrameGraphErrorOptions

FrameGraphErrorPhase

FrameGraphExecutionSegmentKind

FrameGraphExecutionTiming

FrameGraphGpuTimingReport

FrameGraphResourcePoolStats

FrameGraphResourceRange

FrameGraphRootResolution

FrameGraphTimingMode

GraphRootReason

ImportBufferOptions

ImportSwapchainTextureOptions

ImportTextureOptions

NodeKind

NormalizedTextureViewDesc

RenderColorAttachmentDesc

RenderDepthStencilAttachmentDesc

RenderEncodeContext

RenderPassNodeDesc

ResourceAccessMode

ResourceHandle

ResourceKind

ResourceOrigin

ResourceUse

SynchronousCallback

TextureDesc

TextureHandle

TextureOrigin

TextureSize

TextureUse

TextureViewAccess

TextureViewDesc

TextureViewHandle

TextureViewUse

UnwrappedResource

WriteContents

WriteUseOptions

Variables

FRAME_GRAPH_ERROR_CODES

snapshot

Type Aliases

CreateFrameGraphSnapshotOptions

Functions

createFrameGraphSnapshot

Rust API ↗

zenfg 0.1.0-beta.4

zenfg-snapshot 0.1.0-beta.4

On this page

Development branch · 327c05c7

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

Read Markdown · View source ↗

ZenFG TypeScript API

Packages

inspector
snapshot
webgpu

Edit this page

Pager

Next pageIntroduction

Open source / MIT licensed

root

Classes

Type Aliases

Variables

Functions

theme

Interfaces

Type Aliases

Variables

format

Variables

root

Classes

Type Aliases

Functions

root

Enumerations

Classes

Interfaces

Type Aliases

Variables

snapshot

Type Aliases

Functions

ZenFG TypeScript API ​

Packages ​

ZenFG TypeScript API

Packages