Skip to content

Main Navigation

简体中文✓English✓

Sidebar Navigation

Introduction

Getting started

Choose your path

@zenfg/webgpu

@zenfg/snapshot

@zenfg/inspector

zenfg

zenfg-snapshot

Concepts

Core concepts

WebGPU concepts

Rust concepts

Guides & examples

Examples and recipes

Inspector workbench

Inspector themes

@zenfg/webgpu usage

zenfg usage

Reference

Snapshot specification

Compatibility & migration

Compatibility

Migrating from 0.1.0

Unified timing and Snapshot 1.2

Migrating to beta.3

Changelog

@zenfg/webgpu upgrades

@zenfg/snapshot upgrades

@zenfg/inspector upgrades

zenfg upgrades

zenfg-snapshot upgrades

API reference (English)

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

BufferAllocationInfo

BufferDesc

BufferHandle

BufferRange

BufferUse

BufferUseOptions

BufferWriteUseOptions

ClearBufferNodeDesc

ClearBufferOperation

CommandEncodeContext

CommandNodeDesc

CompiledFrameAfterSubmitContext

CompiledFrameExecuteOptions

CompiledFrameSubmitContext

CompiledTextureRegion

ComputeEncodeContext

ComputePassNodeDesc

CopyNodeDesc

CopyOperation

CulledNodeReason

ExternalSubmissionContext

ExternalSubmissionNodeDesc

FrameGraphBothExecutionTiming

FrameGraphCompilationAccess

FrameGraphCompilationReport

FrameGraphCompilationRoot

FrameGraphCpuExecutionTiming

FrameGraphCpuTimingReport

FrameGraphErrorCode

FrameGraphErrorOptions

FrameGraphErrorPhase

FrameGraphExecutionSegmentKind

FrameGraphExecutionTiming

FrameGraphGpuExecutionTiming

FrameGraphGpuTimingReport

FrameGraphResourcePoolStats

FrameGraphResourceRange

FrameGraphRootResolution

FrameGraphTimingMode

GraphRootReason

ImportBufferOptions

ImportSwapchainTextureOptions

ImportTextureOptions

NodeKind

NormalizedTextureViewDesc

RenderColorAttachmentDesc

RenderDepthStencilAttachmentDesc

RenderEncodeContext

RenderPassNodeDesc

ResourceAccessMode

ResourceHandle

ResourceKind

ResourceOrigin

ResourcePoolEntryInfo

ResourcePoolEvictionReport

ResourcePoolScope

ResourceUse

SynchronousCallback

TextureAllocationInfo

TextureDesc

TextureHandle

TextureOrigin

TextureSize

TextureUse

TextureViewAccess

TextureViewDesc

TextureViewHandle

TextureViewUse

TransientResourceOptions

UnwrappedResource

WebGpuRenderPassDescriptorExtras

WriteContents

WriteUseOptions

Variables

FRAME_GRAPH_ERROR_CODES

snapshot

Classes

FrameGraphSnapshotValidationError

Type Aliases

CreateFrameGraphSnapshotOptions

FrameGraphSnapshot

Functions

createFrameGraphSnapshot

stringifyFrameGraphSnapshot

Rust API ↗

zenfg 0.2.0

zenfg-snapshot 0.1.1

On this page

Development branch · c5a119d3

Package versions

Development source: @zenfg/webgpu 0.2.0 · @zenfg/snapshot 0.1.1 · @zenfg/inspector 0.2.0 · zenfg 0.2.0 · zenfg-snapshot 0.1.1

Published component releases: @zenfg/webgpu 0.2.0 / @zenfg/snapshot 0.1.1 / @zenfg/inspector 0.2.0 / zenfg 0.2.0 / zenfg-snapshot 0.1.1

Read Markdown · English 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

Classes

Type Aliases

Functions

ZenFG TypeScript API ​

Packages ​

ZenFG TypeScript API

Packages