Skip to content
VesselDSP Docs
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Start Here
Overview
Getting Started
Formats
Supported Formats
Examples
Pro Co Rat Schematic
Guides
Stompbox Layouts
Generated 3D Previews
Controls
Control UI
API Reference
amp/src
Type Aliases
AmpPreviewAppearance
AmpPreviewControlLayout
AmpPreviewGlb
AmpPreviewLayout
AmpPreviewObjectOptions
AmpProfileDeriveOptions
Functions
createAmpPreviewGlb
createAmpPreviewLayout
createAmpPreviewObject3D
createAmpProfileFromDocument
createAmpProfileFromVdsp
References
AmpAppearanceProfile
AmpControlKind
AmpControlPanelProfile
AmpControlProfile
AmpDimensions
AmpProfile
AmpProfileValidation
validateAmpProfile
cabinet/src
Type Aliases
CabinetPreviewAppearance
CabinetPreviewGlb
CabinetPreviewLayout
CabinetPreviewObjectOptions
Functions
createCabinetPreviewGlb
createCabinetPreviewLayout
createCabinetPreviewObject3D
References
CabinetAppearanceProfile
CabinetDimensions
CabinetProfile
CabinetProfileValidation
validateCabinetProfile
control-ui/src
Type Aliases
ConcentricKnobProps
ControlAppearance
ControlAppearanceMap
ControlFrameClassNames
ControlFrameProps
ControlSurfaceClassNames
ControlSurfaceProps
ControlSurfaceRenderItem
ControlSurfaceRenderPlanOptions
ControlUiControlRef
ControlUiTheme
ControlUiThemeProviderProps
DetentedRotarySelectProps
FootswitchButtonProps
GraphicEqSliderProps
JackIndicatorProps
KnobControlProps
LedIndicatorProps
SwitchSelectControlProps
ToggleSwitchControlProps
UseControlStateOptions
UseControlStateResult
Functions
applyControlUiMessage
clampControlPosition
ConcentricKnob
ControlFrame
controlMessageForValue
ControlSurface
ControlUiThemeProvider
controlValueForId
createControlSurfaceRenderPlan
createControlUiState
DetentedRotarySelect
findPanelControl
FootswitchButton
formatControlValue
GraphicEqSlider
JackIndicator
KnobControl
LedIndicator
normalizeSwitchPosition
resolveControlAppearance
snapControlPosition
SwitchSelectControl
themeToCssVariables
ToggleSwitchControl
useControlState
useControlUiTheme
valueForControl
valuePosition
core/src
Type Aliases
AmpAppearanceProfile
AmpControlKind
AmpControlPanelProfile
AmpControlProfile
AmpDimensions
AmpProfile
AmpProfileValidation
AnyCircuitElement
AnyCircuitElementInput
BoardApplicability
BoardEdgeTerminal
BoardFamily
BoardFootprint
BoardFootprintCatalog
BoardFootprintPlacement
BoardHole
BoardKind
BoardNet
BoardNetlist
BoardNetMember
BoardNetRef
BoardPlacedPad
BoardRealization
BoardReview
BoardRoute
BoardSourceCircuitHash
BoardSubtype
Bounds
BuildBom
BuildBomItem
BuildBomRef
BuildBomRefKind
BuildCompleteness
BuildIntent
BuildPartProfile
BuildPartProfileCatalog
BuildScope
CabinetAppearanceProfile
CabinetDimensions
CabinetProfile
CabinetProfileValidation
CanonicalCircuitNetRef
CircuitDocument
CircuitDocumentConversionDiagnostic
CircuitDocumentConversionLossPolicy
CircuitDocumentDevice
CircuitDocumentDeviceKind
CircuitDocumentFileConversionReport
CircuitDocumentFileFormat
CircuitFormat
CircuitJson
CircuitJsonElement
CircuitJsonExport
CircuitJsonExportOptions
CircuitJsonExportTarget
CircuitJsonSchemaValidationIssue
CircuitJsonSchemaValidationResult
CircuitJsonSourceComponent
CircuitJsonSourceNet
CircuitJsonSourcePort
CircuitJsonSourceTrace
Component
ComponentKind
ComponentTerminalRef
Connectivity
ControlApplicabilityPredicate
ControlContext
ControlGroup
ControlGroupMember
ControlInterface
ControlInterfaceAssignmentHint
ControlInterfaceBinding
ControlInterfaceConnector
ControlInterfacePolarity
ControlInterfaceRole
ControlOutput
ControlOutputSwitchMode
ControlRole
ControlState
ControlValue
ConvertCircuitDocumentFileOptions
ConvertCircuitDocumentFileWithReportOptions
CreateComponentArgs
DeviceInterface
DeviceInterfaceAudioBinding
DeviceInterfaceBinding
DeviceInterfaceControl
DeviceInterfaceControlKind
DeviceInterfaceProvenance
DocumentAmpAppearance
DocumentAppearance
DocumentAppearanceLabel
DocumentAppearanceMaterial
DocumentCommand
DocumentMetadata
DocumentSource
DocumentStompboxAppearance
DocumentValidationContext
DocumentValidationRule
EditorCommand
EditorState
ExternalControlAssignmentHint
ExtractedControlGroupMembership
ExtractedDeviceInterface
ExtractedDeviceInterfaceControl
HangingEndpoint
InterchangeSourceFormat
JackAudioRole
JackPort
JackRole
Knob
KnobControlMode
KnobStep
KnobTaper
KnobValue
LedIndicator
LedValue
MechanicalBuildMetadata
MillimeterRect
MovePanelElementOptions
NetlistComponent
NetlistView
NodeId
OffBoardSignalRef
OffBoardWireAttributes
OffBoardWiringConnection
OffBoardWiringCoverage
OffBoardWiringEndpoint
OffBoardWiringEndpointKind
OffBoardWiringHarness
OffBoardWiringHarnessStatus
OffBoardWiringPlan
Panel
PanelColumnOrder
PanelControlKind
PanelControlPlacement
PanelElementBinding
PanelElementPhysicalPlacement
PanelElementPlacement
PanelFace
PanelFaceGeometry
PanelGridIndexing
PanelGridLayout
PanelGridPosition
PanelMessage
PanelPlacementMetadata
PanelRowOrder
ParseCircuitDocumentFileOptions
ParseCircuitDocumentOptions
ParseCircuitJsonDocumentOptions
ParsedQuantity
PinRef
Point
Port
ProfileValidationResult
PropertyObject
PropertyRule
PropertyValue
QuantityRule
Rotation
SerializeCircuitDocumentFileOptions
SerializeInterchangeYamlOptions
SerializeLtspiceAscOptions
SerializeVdspCircuitDocumentOptions
SliderControl
SliderOrientation
SliderRange
SliderValue
SpiceLetter
StringRule
SwitchControl
SwitchKind
SwitchValue
SymbolDef
Terminal
TidyLayoutOptions
ValidateDocumentOptions
ValidationCode
ValidationIssue
ValidationSeverity
VdspBuildDataObject
VdspBuildDataScalar
VdspBuildDataValue
VdspSchemaValidationIssue
VdspSchemaValidationResult
Warning
Wire
WireBodyHit
Variables
ampAppearanceProfileSchema
ampControlKindSchema
ampControlPanelProfileSchema
ampControlProfileSchema
ampProfileSchema
cabinetAppearanceProfileSchema
cabinetProfileSchema
COMPONENT_KINDS
CONTROL_ROLE_VALUES
EMPTY_DOCUMENT
PANEL_PROTOCOL_VERSION
profileDimensionsSchema
vdspFileExtension
VERSION
Functions
applyControlMessage
applyDocumentCommand
applyEditorCommand
buildComponent
buildRenderableWires
canRedo
canUndo
collectPorts
colorForKind
computeComponentBox
computeDocumentBounds
computeLabelTextBoxLayout
convertCircuitDocumentFile
convertCircuitDocumentFileWithReport
createEditorState
defaultControlState
detectCircuitDocumentFileFormat
detectCircuitFormat
extractDeviceInterface
extractPanel
findChainCorners
findHangingEndpoints
findJunctions
findNearestPort
findNearestWireBodyHit
findSnap
findWireChain
getPinNode
getRulesForKind
getSpiceLetter
getSpiceNodeOrder
hasErrors
isKnob
isKnobPositionOnStep
isLed
isParsedQuantity
isPropertyObject
isSlider
isSwitch
isVdspFilename
kindForSpiceLetter
knobStepSize
movePanelElement
nearestKnobStep
orthogonalPath
parseCircuitDocument
parseCircuitDocumentFile
parseCircuitJsonDocument
parseInterchangeYaml
parseLtspiceAsc
parseQuantity
parseSchx
parseSpiceNetlist
parseVdspCircuitDocument
pinKey
pointsToSvg
propertyBooleanValue
propertyNumericValue
propertyQuantityValue
propertyStringValue
propertyValueForSourceAttribute
resetEditorState
resolveConnectivity
serializeCircuitDocumentFile
serializeCircuitJsonDocument
serializeInterchangeYaml
serializeLtspiceAsc
serializeSchx
serializeSpiceNetlist
serializeVdspCircuitDocument
shouldRenderLabelTextBox
snapKnobPosition
symbolFor
tidyDocumentLayout
toNetlistView
validateAmpProfile
validateCabinetProfile
validateCircuitJsonDocument
validateComponent
validateDocument
validateMessage
validateVdspCircuitDocumentSchema
vdspFilenameFromName
viewBoxString
stompbox/src
Type Aliases
ResolvedStompboxAssetPaths
StompboxAppearance
StompboxAppearanceOptions
StompboxAppearancePatchTarget
StompboxAssetFileOptions
StompboxAssetFileReader
StompboxAssetRefs
StompboxAssetResolveOptions
StompboxAudioJackLabelStrategy
StompboxCompiledControlLike
StompboxConcentricDial
StompboxControlStateListener
StompboxControlSurface
StompboxDecalAppearancePatchTarget
StompboxDecalGridPlacement
StompboxDecalInput
StompboxDecalInputCommon
StompboxDecalOptions
StompboxDecalPlacement
StompboxDefaultPartProfileIds
StompboxDiagnostic
StompboxDiagnosticCode
StompboxDrillHole
StompboxDrillHoleMarker
StompboxDrillHoleProfile
StompboxDrillLayout
StompboxDrillTemplate
StompboxDrillTemplateFromVdspOptions
StompboxDrillTemplateHole
StompboxDrillTemplateOptions
StompboxDrillTemplatePage
StompboxDrillTemplateScaleMark
StompboxEnclosureProfile
StompboxEnclosureProfileCatalog
StompboxFaceId
StompboxFootswitchStrategy
StompboxFootswitchTravelAxis
StompboxFromVdspOptions
StompboxGlbAssetValidation
StompboxGlbAssetValidationOptions
StompboxGlbStateTargetRef
StompboxGlbStateTargetRole
StompboxGlbStateTargetSelector
StompboxHardwareProfile
StompboxHardwareProfileAssetValidation
StompboxHardwareProfileAssetValidationOptions
StompboxHardwareProfileDeriveOptions
StompboxHardwareProfileOptions
StompboxImageDecalInput
StompboxKnobGridStrategy
StompboxLabelAppearance
StompboxLayoutOptions
StompboxPartAppearancePatchTarget
StompboxPartGeometry
StompboxPartProfile
StompboxPartProfileCatalog
StompboxPartProvenance
StompboxPartStateTargets
StompboxPartSurface
StompboxPedalState
StompboxPedalStateChange
StompboxPedalStateCommand
StompboxPedalStateListener
StompboxPedalStateStore
StompboxPlacementProvenance
StompboxPoint2
StompboxPoint3
StompboxPreview
StompboxPreviewDecal
StompboxPreviewDecalCommon
StompboxPreviewEnclosure
StompboxPreviewFromVdspOptions
StompboxPreviewGlb
StompboxPreviewGlbFromVdspOptions
StompboxPreviewGlbOptions
StompboxPreviewImageDecal
StompboxPreviewMaterial
StompboxPreviewOptions
StompboxPreviewPart
StompboxPreviewStatePatch
StompboxPreviewStatePatchListener
StompboxPreviewStatePatchTarget
StompboxPreviewSvgDecal
StompboxPreviewSvgGrainOptions
StompboxPreviewSvgViewId
StompboxPreviewSvgViews
StompboxPreviewSvgViewsFromVdspOptions
StompboxPreviewSvgViewsOptions
StompboxPreviewTextDecal
StompboxResolvedAppearance
StompboxResolvedGlbStateTarget
StompboxResolvedPartStateTargets
StompboxRotationDeg
StompboxRuntimeCommand
StompboxRuntimeControlDescriptor
StompboxRuntimeControlKind
StompboxRuntimeControlRoute
StompboxSideHardwareStrategy
StompboxSize2
StompboxSourcePanelControl
StompboxStyleProfile
StompboxStyleProfileFilter
StompboxStyleProfileId
StompboxSvgDecalInput
StompboxTemplateMode
StompboxTextDecalInput
StompboxUnits
StompboxUnsubscribe
Variables
STOMPBOX_DRILL_HOLE_PROFILE_CATALOG
Functions
applyStompboxPedalStateCommand
applyStompboxPreviewInteraction
applyStompboxPreviewStatePatch
createDefaultStompboxPedalState
createDefaultStompboxPedalStateFromVdsp
createStompboxAppearancePatch
createStompboxControlSurface
createStompboxDrillLayout
createStompboxDrillLayoutFromVdsp
createStompboxDrillTemplate
createStompboxDrillTemplateFromVdsp
createStompboxDrillTemplateSvg
createStompboxDrillTemplateSvgFromVdsp
createStompboxFootswitchPressCommand
createStompboxHardwareProfileFromDocument
createStompboxHardwareProfileFromVdsp
createStompboxKnobTurnCommand
createStompboxPanelFromControlSurface
createStompboxPedalStateFromControlSurface
createStompboxPedalStateStore
createStompboxPreview
createStompboxPreviewFromVdsp
createStompboxPreviewGlb
createStompboxPreviewGlbFromVdsp
createStompboxPreviewStatePatch
createStompboxPreviewSvgViews
createStompboxPreviewSvgViewsFromVdsp
createStompboxRuntimeCommand
createStompboxSourcePanelControls
denormalizeStompboxControlValue
getAvailableStompboxStyleProfiles
knobRotationDegForPosition
normalizeStompboxControlValue
resolveStompboxAppearance
resolveStompboxAssetPaths
setStompboxControlValue
setStompboxPedalEnabled
validateStompboxGlbAsset
validateStompboxGlbAssetFromPath
validateStompboxHardwareProfileAssets
visual-effects/src
Type Aliases
ResolvedVesselPreviewEffectPreset
VesselGlitchPass
VesselPreviewCrtBackground
VesselPreviewEffectPipeline
VesselPreviewEffectPreset
VesselScreenGrainPass
Variables
VESSEL_PREVIEW_EFFECT_DEFAULTS
Functions
addToonOutlines
applyMaterialGrain
applyToonMaterials
createGlitchPass
createPreviewEffectPipeline
createScreenGrainPass
resolvePreviewEffectPreset
GitHub
Select theme
Dark
Light
Auto
VesselDSP API
Modules
Section titled “Modules”
amp/src
cabinet/src
control-ui/src
core/src
stompbox/src
visual-effects/src