{ "schemaVersion": 1, "kind": "webgpu-os-es-module-catalog", "description": "Machine-readable ES-module catalog generated from repository source. Use each sourceHash to detect drift before relying on a signature. Empty summaries mean the source has no extractable JSDoc; they are reported by summaryCoverage and are never filled with invented prose.", "runtimeLoading": { "sourceMode": "Serve the repository root over HTTP with start_server.py, then use each module's absolute import path.", "compiledMode": "The compact production site loads generated bundles; raw source module URLs are not guaranteed to be deployed." }, "repositories": { "platformDistribution": { "url": "https://github.com/BTSpaniel/particlerealms.engine", "role": "Public browser-ready platform downloads, including compressed .gz bundles.", "sourceOfApiTruth": false }, "masterServer": { "url": "https://github.com/BTSpaniel/particlerealms.engine-master-server", "role": "Separate discovery, admission, encrypted-signaling, TURN, and trusted-node service source.", "gameplayAuthority": false } }, "summaryCoverage": { "modules": { "documented": 1770, "total": 2603, "percent": 68.0 }, "exports": { "documented": 5250, "total": 17364, "percent": 30.2 } }, "modules": [ { "schemaVersion": 1, "title": "adapters/PBDRagdollAgentAdapter", "path": "agi/reference/adapters/PBDRagdollAgentAdapter.md", "source": "agi/adapters/PBDRagdollAgentAdapter.js", "import": "/agi/adapters/PBDRagdollAgentAdapter.js", "sourceHash": "c617ddeda76aa47cbee3e7af4dc72dd8ddde7cc5fce76f545db3c1e36fd3f9d3", "summary": "", "exports": [ { "name": "PBDRagdollAgentAdapter", "kind": "class", "signature": "class PBDRagdollAgentAdapter", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "brain/ExperienceBuffer", "path": "agi/reference/brain/ExperienceBuffer.md", "source": "agi/brain/ExperienceBuffer.js", "import": "/agi/brain/ExperienceBuffer.js", "sourceHash": "63538bf2e35b05177c5527d73d67997316caab4d98969bb6746ef0a2d32ba4e1", "summary": "", "exports": [ { "name": "ExperienceBuffer", "kind": "class", "signature": "class ExperienceBuffer", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "brain/NetworkArchitecture", "path": "agi/reference/brain/NetworkArchitecture.md", "source": "agi/brain/NetworkArchitecture.js", "import": "/agi/brain/NetworkArchitecture.js", "sourceHash": "96d127e43ea3c4d4b717561078bdeecc9efb341e393b25c8214a9da5ad4dd5f4", "summary": "Layer class - represents a single neural network layer", "exports": [ { "name": "Layer", "kind": "class", "signature": "class Layer", "summary": "Layer class - represents a single neural network layer" }, { "name": "NETWORK_ARCHITECTURES", "kind": "constant", "signature": "NETWORK_ARCHITECTURES", "summary": "Network Architecture Definitions Layer configurations and hyperparameters for Policy and Value networks" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "brain/PolicyNetwork", "path": "agi/reference/brain/PolicyNetwork.md", "source": "agi/brain/PolicyNetwork.js", "import": "/agi/brain/PolicyNetwork.js", "sourceHash": "6afeb61b0f881e76c5952c95655bc26cfbcd02670d7dab75859857bb7fa9ec98", "summary": "", "exports": [ { "name": "PolicyNetwork", "kind": "class", "signature": "class PolicyNetwork", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "brain/ValueNetwork", "path": "agi/reference/brain/ValueNetwork.md", "source": "agi/brain/ValueNetwork.js", "import": "/agi/brain/ValueNetwork.js", "sourceHash": "a8768cfbc58ba7acf9656ff451b78b4fac2bf49cdbce4b45e5b6a9dff5b2593c", "summary": "", "exports": [ { "name": "ValueNetwork", "kind": "class", "signature": "class ValueNetwork", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "brain/trainers/PPOTrainer", "path": "agi/reference/brain/trainers/PPOTrainer.md", "source": "agi/brain/trainers/PPOTrainer.js", "import": "/agi/brain/trainers/PPOTrainer.js", "sourceHash": "9ef5331dbd0e566011cba2dcdaeb672138eb9040c461152d6aab61a741a6b88a", "summary": "", "exports": [ { "name": "PPOTrainer", "kind": "class", "signature": "class PPOTrainer", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "config/curriculum", "path": "agi/reference/config/curriculum.md", "source": "agi/config/curriculum.js", "import": "/agi/config/curriculum.js", "sourceHash": "faac029b5a078f894addf4f1810a1e04b028aaa5e37fcaf4da8c70586c1e2893", "summary": "Curriculum Learning Stages Progressive training stages from standing to full locomotion", "exports": [ { "name": "CURRICULUM_STAGES", "kind": "constant", "signature": "CURRICULUM_STAGES", "summary": "Curriculum Learning Stages Progressive training stages from standing to full locomotion" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "config/hyperparameters", "path": "agi/reference/config/hyperparameters.md", "source": "agi/config/hyperparameters.js", "import": "/agi/config/hyperparameters.js", "sourceHash": "a5a8c1d2731a9c858ed889d8bb72b8cbef9838f3cf2c4f68d00cbf685485ead7", "summary": "Neural Network Hyperparameters Configuration for Policy and Value networks, training parameters", "exports": [ { "name": "HYPERPARAMETERS", "kind": "constant", "signature": "HYPERPARAMETERS", "summary": "Neural Network Hyperparameters Configuration for Policy and Value networks, training parameters" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "config/rewards", "path": "agi/reference/config/rewards.md", "source": "agi/config/rewards.js", "import": "/agi/config/rewards.js", "sourceHash": "a54ceb15b1a4b9edba1c462a25c6cf35d0ea99546e3729b6a2bd4704c4eef292", "summary": "Compute reward for current state", "exports": [ { "name": "computeReward", "kind": "function", "signature": "computeReward(state, config = REWARD_WEIGHTS.standing)", "summary": "Compute reward for current state" }, { "name": "REWARD_WEIGHTS", "kind": "constant", "signature": "REWARD_WEIGHTS", "summary": "Reward Function Weights Configurable reward components for different training objectives" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "core/CurriculumManager", "path": "agi/reference/core/CurriculumManager.md", "source": "agi/core/CurriculumManager.js", "import": "/agi/core/CurriculumManager.js", "sourceHash": "4b2fdc7d123b94cdd1d734d3998d70fc2bfa60043fc6c9003ec5d63455d11179", "summary": "", "exports": [ { "name": "CurriculumManager", "kind": "class", "signature": "class CurriculumManager", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "core/MotionMatchingTeacher", "path": "agi/reference/core/MotionMatchingTeacher.md", "source": "agi/core/MotionMatchingTeacher.js", "import": "/agi/core/MotionMatchingTeacher.js", "sourceHash": "8067ac4e7eb42fd195398395e3cd8b35098562e5c8cd79a6a0e1f049ce22fbf7", "summary": "", "exports": [ { "name": "MotionMatchingTeacher", "kind": "class", "signature": "class MotionMatchingTeacher extends MotionMatcher", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "core/MotorController", "path": "agi/reference/core/MotorController.md", "source": "agi/core/MotorController.js", "import": "/agi/core/MotorController.js", "sourceHash": "e92518a41940bd87db2e88b406599fd661679e73cf9d561f45cab80e30dabd03", "summary": "Motor Controller Converts neural network actions into physics impulses", "exports": [ { "name": "MotorController", "kind": "class", "signature": "class MotorController", "summary": "Motor Controller Converts neural network actions into physics impulses" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "core/ObservationBuilder", "path": "agi/reference/core/ObservationBuilder.md", "source": "agi/core/ObservationBuilder.js", "import": "/agi/core/ObservationBuilder.js", "sourceHash": "74c5e77974cdfdec7ae331f82796deafff336adfcae527282cb31a90cf99ab81", "summary": "Observation Builder Converts ragdoll sensor data into neural network input", "exports": [ { "name": "ObservationBuilder", "kind": "class", "signature": "class ObservationBuilder", "summary": "Observation Builder Converts ragdoll sensor data into neural network input" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "core/RagdollController", "path": "agi/reference/core/RagdollController.md", "source": "agi/core/RagdollController.js", "import": "/agi/core/RagdollController.js", "sourceHash": "c248723f6e650dcff7a470393e6c11d4dac0bec1e37d27bc03ba9c8d0c4096f8", "summary": "", "exports": [ { "name": "RagdollController", "kind": "class", "signature": "class RagdollController", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "core/RewardFunction", "path": "agi/reference/core/RewardFunction.md", "source": "agi/core/RewardFunction.js", "import": "/agi/core/RewardFunction.js", "sourceHash": "8f94baf0346ff8e13cb398786fef280535c407b60b10db85aaa1806581f575b6", "summary": "", "exports": [ { "name": "RewardFunction", "kind": "class", "signature": "class RewardFunction", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "index", "path": "agi/reference/index.md", "source": "agi/index.js", "import": "/agi/index.js", "sourceHash": "f20d34de48bbf9d6566a9ffe9b10f489ef732fb3740aea98512226867c7ca502", "summary": "", "exports": [ { "name": "AGI_CORE_FULL", "kind": "re-export", "signature": "AGI_CORE_FULL", "summary": "" }, { "name": "AGI_CORE_VERSION", "kind": "re-export", "signature": "AGI_CORE_VERSION", "summary": "" }, { "name": "AGI_TRAINING_CHANNEL_ID", "kind": "re-export", "signature": "AGI_TRAINING_CHANNEL_ID", "summary": "" }, { "name": "AGI_TRAINING_CONTRACT", "kind": "re-export", "signature": "AGI_TRAINING_CONTRACT", "summary": "" }, { "name": "AGI_TRAINING_ROUTE_ID", "kind": "re-export", "signature": "AGI_TRAINING_ROUTE_ID", "summary": "" }, { "name": "AgiTrainingStateChannel", "kind": "re-export", "signature": "AgiTrainingStateChannel", "summary": "" }, { "name": "BUILD_TAG", "kind": "re-export", "signature": "BUILD_TAG", "summary": "" }, { "name": "BrainVisualizer", "kind": "re-export", "signature": "BrainVisualizer", "summary": "" }, { "name": "ComputeGraph", "kind": "re-export", "signature": "ComputeGraph", "summary": "" }, { "name": "CurriculumManager", "kind": "re-export", "signature": "CurriculumManager", "summary": "" }, { "name": "DebugVisualizer", "kind": "re-export", "signature": "DebugVisualizer", "summary": "" }, { "name": "ExperienceBuffer", "kind": "re-export", "signature": "ExperienceBuffer", "summary": "" }, { "name": "GradientContext", "kind": "re-export", "signature": "GradientContext", "summary": "" }, { "name": "GradientTape", "kind": "re-export", "signature": "GradientTape", "summary": "" }, { "name": "GroundPlane", "kind": "re-export", "signature": "GroundPlane", "summary": "" }, { "name": "InjectionSystem", "kind": "re-export", "signature": "InjectionSystem", "summary": "" }, { "name": "Layer", "kind": "re-export", "signature": "Layer", "summary": "" }, { "name": "LoadingProgress", "kind": "re-export", "signature": "LoadingProgress", "summary": "" }, { "name": "MetricsDisplay", "kind": "re-export", "signature": "MetricsDisplay", "summary": "" }, { "name": "ModelLoader", "kind": "re-export", "signature": "ModelLoader", "summary": "" }, { "name": "MotionMatchingTeacher", "kind": "re-export", "signature": "MotionMatchingTeacher", "summary": "" }, { "name": "MotorController", "kind": "re-export", "signature": "MotorController", "summary": "" }, { "name": "NETWORK_ARCHITECTURES", "kind": "re-export", "signature": "NETWORK_ARCHITECTURES", "summary": "" }, { "name": "NetworkArchitecture", "kind": "re-export", "signature": "NetworkArchitecture", "summary": "" }, { "name": "ObservationBuilder", "kind": "re-export", "signature": "ObservationBuilder", "summary": "" }, { "name": "PBDRagdollAgentAdapter", "kind": "re-export", "signature": "PBDRagdollAgentAdapter", "summary": "" }, { "name": "PPOTrainer", "kind": "re-export", "signature": "PPOTrainer", "summary": "" }, { "name": "ParasiteRig", "kind": "re-export", "signature": "ParasiteRig", "summary": "" }, { "name": "PolicyNetwork", "kind": "re-export", "signature": "PolicyNetwork", "summary": "" }, { "name": "RagdollController", "kind": "re-export", "signature": "RagdollController", "summary": "" }, { "name": "RewardFunction", "kind": "re-export", "signature": "RewardFunction", "summary": "" }, { "name": "SceneRenderer", "kind": "re-export", "signature": "SceneRenderer", "summary": "" }, { "name": "StudioApp", "kind": "re-export", "signature": "StudioApp", "summary": "" }, { "name": "TensorCache", "kind": "re-export", "signature": "TensorCache", "summary": "" }, { "name": "TentacleRenderer", "kind": "re-export", "signature": "TentacleRenderer", "summary": "" }, { "name": "TrackingCamera", "kind": "re-export", "signature": "TrackingCamera", "summary": "" }, { "name": "TrainingScene", "kind": "re-export", "signature": "TrainingScene", "summary": "" }, { "name": "TrainingUI", "kind": "re-export", "signature": "TrainingUI", "summary": "" }, { "name": "ValueNetwork", "kind": "re-export", "signature": "ValueNetwork", "summary": "" }, { "name": "createAgiTrainingStateChannel", "kind": "re-export", "signature": "createAgiTrainingStateChannel", "summary": "" }, { "name": "loadingProgress", "kind": "re-export", "signature": "loadingProgress", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/DeviceProfiler", "path": "agi/reference/llm/DeviceProfiler.md", "source": "agi/llm/DeviceProfiler.js", "import": "/agi/llm/DeviceProfiler.js", "sourceHash": "31c08824be41f7aa80654a5cbfa109250c7ba8d998213935abe7dc176e279945", "summary": "DeviceProfiler.js - WebGPU capability and LLM feasibility profiler. This module is intentionally browser-native and dependency-free. It can use the kernel's shared GPU device when available, or probe navigator.gpu directly for standalone AGI tests.", "exports": [ { "name": "AIDeviceProfiler", "kind": "class", "signature": "class AIDeviceProfiler", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/formats/GGUFParser", "path": "agi/reference/llm/formats/GGUFParser.md", "source": "agi/llm/formats/GGUFParser.js", "import": "/agi/llm/formats/GGUFParser.js", "sourceHash": "a7c01840a7315dcc9cbd906b3edaf8c843ade73612d4a63ce023571d1e49c921", "summary": "", "exports": [ { "name": "GGUFParser", "kind": "class", "signature": "class GGUFParser", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/formats/GGUFTensorReader", "path": "agi/reference/llm/formats/GGUFTensorReader.md", "source": "agi/llm/formats/GGUFTensorReader.js", "import": "/agi/llm/formats/GGUFTensorReader.js", "sourceHash": "bd77c6687c617369f002717fd7bef7429eeebd0a8ba27eca501e9c39e18c258a", "summary": "", "exports": [ { "name": "GGUFTensorReader", "kind": "class", "signature": "class GGUFTensorReader", "summary": "" }, { "name": "bf16ToF32", "kind": "function", "signature": "bf16ToF32(value)", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/formats/LLMPersistenceContracts", "path": "agi/reference/llm/formats/LLMPersistenceContracts.md", "source": "agi/llm/formats/LLMPersistenceContracts.js", "import": "/agi/llm/formats/LLMPersistenceContracts.js", "sourceHash": "6bb1547664180c24ce26d1760ea42eb59574058ad0e089e9452d39492a128b03", "summary": "Accept a legacy bare conversation and return the canonical durable v1 envelope.", "exports": [ { "name": "validateConversationId", "kind": "function", "signature": "validateConversationId(value)", "summary": "" }, { "name": "validateModelId", "kind": "function", "signature": "validateModelId(value)", "summary": "" }, { "name": "prepareModelRegistry", "kind": "function", "signature": "prepareModelRegistry(input)", "summary": "" }, { "name": "prepareModelPackage", "kind": "function", "signature": "prepareModelPackage(input)", "summary": "" }, { "name": "prepareConversation", "kind": "function", "signature": "prepareConversation(input, expectedId = null)", "summary": "Accept a legacy bare conversation and return the canonical durable v1 envelope." }, { "name": "MODEL_REGISTRY_SCHEMA", "kind": "constant", "signature": "MODEL_REGISTRY_SCHEMA", "summary": "" }, { "name": "MODEL_PACKAGE_SCHEMA", "kind": "constant", "signature": "MODEL_PACKAGE_SCHEMA", "summary": "" }, { "name": "CONVERSATION_SCHEMA", "kind": "constant", "signature": "CONVERSATION_SCHEMA", "summary": "" }, { "name": "LLM_SCHEMA_VERSION", "kind": "constant", "signature": "LLM_SCHEMA_VERSION", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/formats/ModelPackageReader", "path": "agi/reference/llm/formats/ModelPackageReader.md", "source": "agi/llm/formats/ModelPackageReader.js", "import": "/agi/llm/formats/ModelPackageReader.js", "sourceHash": "0c36a0a464be2eace294b50d704e66ebf4035dbf64daa8dc84be8601cdd6069d", "summary": "", "exports": [ { "name": "ModelPackageReader", "kind": "class", "signature": "class ModelPackageReader", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/formats/ModelPackageWriter", "path": "agi/reference/llm/formats/ModelPackageWriter.md", "source": "agi/llm/formats/ModelPackageWriter.js", "import": "/agi/llm/formats/ModelPackageWriter.js", "sourceHash": "3e4a12517cf5cb5eeee7b685113e49e0dd850fe8344488e78f2a844c9d8e8a3e", "summary": "", "exports": [ { "name": "ModelPackageWriter", "kind": "class", "signature": "class ModelPackageWriter", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/formats/Quantization", "path": "agi/reference/llm/formats/Quantization.md", "source": "agi/llm/formats/Quantization.js", "import": "/agi/llm/formats/Quantization.js", "sourceHash": "f7a2023a142bedad1e3eef00d91e5578221d7250d8645963db0272be33fc4386", "summary": "", "exports": [ { "name": "quantTypeName", "kind": "function", "signature": "quantTypeName(type)", "summary": "" }, { "name": "ggufFileTypeName", "kind": "function", "signature": "ggufFileTypeName(type)", "summary": "" }, { "name": "inferQuantization", "kind": "function", "signature": "inferQuantization(tensors = [], metadata = {})", "summary": "" }, { "name": "normalizeQuantization", "kind": "function", "signature": "normalizeQuantization(value)", "summary": "" }, { "name": "isSupportedMetadataQuant", "kind": "function", "signature": "isSupportedMetadataQuant(value)", "summary": "" }, { "name": "quantBlockInfo", "kind": "function", "signature": "quantBlockInfo(type)", "summary": "" }, { "name": "tensorElementCount", "kind": "function", "signature": "tensorElementCount(dims = [])", "summary": "" }, { "name": "tensorByteSize", "kind": "function", "signature": "tensorByteSize(type, dims = [])", "summary": "" }, { "name": "GGML_QUANT_TYPES", "kind": "constant", "signature": "GGML_QUANT_TYPES", "summary": "" }, { "name": "SUPPORTED_METADATA_QUANTS", "kind": "constant", "signature": "SUPPORTED_METADATA_QUANTS", "summary": "" }, { "name": "GGUF_FILE_TYPES", "kind": "constant", "signature": "GGUF_FILE_TYPES", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/formats/TensorShardIndex", "path": "agi/reference/llm/formats/TensorShardIndex.md", "source": "agi/llm/formats/TensorShardIndex.js", "import": "/agi/llm/formats/TensorShardIndex.js", "sourceHash": "bf83fd0a109ee8b96bae74d3b80a2ce1c49f01b70e7f7db4503d27b638dda4c2", "summary": "Accept legacy bare indexes and return a canonical, independently cloned v1 document.", "exports": [ { "name": "UnsupportedTensorShardIndexVersionError", "kind": "class", "signature": "class UnsupportedTensorShardIndexVersionError extends Error", "summary": "" }, { "name": "TensorShardIndex", "kind": "class", "signature": "class TensorShardIndex", "summary": "" }, { "name": "prepareTensorShardIndexDocument", "kind": "function", "signature": "prepareTensorShardIndexDocument(input)", "summary": "Accept legacy bare indexes and return a canonical, independently cloned v1 document." }, { "name": "TENSOR_SHARD_INDEX_SCHEMA", "kind": "constant", "signature": "TENSOR_SHARD_INDEX_SCHEMA", "summary": "" }, { "name": "TENSOR_SHARD_INDEX_SCHEMA_VERSION", "kind": "constant", "signature": "TENSOR_SHARD_INDEX_SCHEMA_VERSION", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/index", "path": "agi/reference/llm/index.md", "source": "agi/llm/index.js", "import": "/agi/llm/index.js", "sourceHash": "7a63122268e40a7d5b4c4af344681240db64d95bf9122ad16bc9845ba0d9a007", "summary": "", "exports": [ { "name": "AIDeviceProfiler", "kind": "re-export", "signature": "AIDeviceProfiler", "summary": "" }, { "name": "CONVERSATION_SCHEMA", "kind": "re-export", "signature": "CONVERSATION_SCHEMA", "summary": "" }, { "name": "CpuTensorRunner", "kind": "re-export", "signature": "CpuTensorRunner", "summary": "" }, { "name": "GGUFParser", "kind": "re-export", "signature": "GGUFParser", "summary": "" }, { "name": "GGUFTensorReader", "kind": "re-export", "signature": "GGUFTensorReader", "summary": "" }, { "name": "Gemma4GraphRunner", "kind": "re-export", "signature": "Gemma4GraphRunner", "summary": "" }, { "name": "GenerationLoop", "kind": "re-export", "signature": "GenerationLoop", "summary": "" }, { "name": "GpuPrimitiveRunner", "kind": "re-export", "signature": "GpuPrimitiveRunner", "summary": "" }, { "name": "GraphCompiler", "kind": "re-export", "signature": "GraphCompiler", "summary": "" }, { "name": "InferenceEngine", "kind": "re-export", "signature": "InferenceEngine", "summary": "" }, { "name": "KVCache", "kind": "re-export", "signature": "KVCache", "summary": "" }, { "name": "K_QUANT_LAYOUTS", "kind": "re-export", "signature": "K_QUANT_LAYOUTS", "summary": "" }, { "name": "KernelRegistry", "kind": "re-export", "signature": "KernelRegistry", "summary": "" }, { "name": "LLMRuntime", "kind": "re-export", "signature": "LLMRuntime", "summary": "" }, { "name": "LLMSession", "kind": "re-export", "signature": "LLMSession", "summary": "" }, { "name": "LLM_SCHEMA_VERSION", "kind": "re-export", "signature": "LLM_SCHEMA_VERSION", "summary": "" }, { "name": "LocalGGUFExecutor", "kind": "re-export", "signature": "LocalGGUFExecutor", "summary": "" }, { "name": "MODEL_HANDLE_QUARANTINE_SCHEMA", "kind": "re-export", "signature": "MODEL_HANDLE_QUARANTINE_SCHEMA", "summary": "" }, { "name": "MODEL_HANDLE_RECORD_SCHEMA", "kind": "re-export", "signature": "MODEL_HANDLE_RECORD_SCHEMA", "summary": "" }, { "name": "MODEL_HANDLE_RECORD_VERSION", "kind": "re-export", "signature": "MODEL_HANDLE_RECORD_VERSION", "summary": "" }, { "name": "MODEL_PACKAGE_SCHEMA", "kind": "re-export", "signature": "MODEL_PACKAGE_SCHEMA", "summary": "" }, { "name": "MODEL_REGISTRY_SCHEMA", "kind": "re-export", "signature": "MODEL_REGISTRY_SCHEMA", "summary": "" }, { "name": "ModelCache", "kind": "re-export", "signature": "ModelCache", "summary": "" }, { "name": "ModelHandleStore", "kind": "re-export", "signature": "ModelHandleStore", "summary": "" }, { "name": "ModelHandleStoreError", "kind": "re-export", "signature": "ModelHandleStoreError", "summary": "" }, { "name": "ModelPackageReader", "kind": "re-export", "signature": "ModelPackageReader", "summary": "" }, { "name": "ModelPackageWriter", "kind": "re-export", "signature": "ModelPackageWriter", "summary": "" }, { "name": "ModelRegistry", "kind": "re-export", "signature": "ModelRegistry", "summary": "" }, { "name": "OPFSStore", "kind": "re-export", "signature": "OPFSStore", "summary": "" }, { "name": "PagedAttention", "kind": "re-export", "signature": "PagedAttention", "summary": "" }, { "name": "PrefixBlockCache", "kind": "re-export", "signature": "PrefixBlockCache", "summary": "" }, { "name": "PromptTemplate", "kind": "re-export", "signature": "PromptTemplate", "summary": "" }, { "name": "Q8_0_LAYOUT", "kind": "re-export", "signature": "Q8_0_LAYOUT", "summary": "" }, { "name": "QuantizedMatVecRunner", "kind": "re-export", "signature": "QuantizedMatVecRunner", "summary": "" }, { "name": "Sampler", "kind": "re-export", "signature": "Sampler", "summary": "" }, { "name": "StaticMemoryPlanner", "kind": "re-export", "signature": "StaticMemoryPlanner", "summary": "" }, { "name": "TENSOR_SHARD_INDEX_SCHEMA", "kind": "re-export", "signature": "TENSOR_SHARD_INDEX_SCHEMA", "summary": "" }, { "name": "TENSOR_SHARD_INDEX_SCHEMA_VERSION", "kind": "re-export", "signature": "TENSOR_SHARD_INDEX_SCHEMA_VERSION", "summary": "" }, { "name": "TensorShardIndex", "kind": "re-export", "signature": "TensorShardIndex", "summary": "" }, { "name": "Tokenizer", "kind": "re-export", "signature": "Tokenizer", "summary": "" }, { "name": "ToolBridge", "kind": "re-export", "signature": "ToolBridge", "summary": "" }, { "name": "TransformerExecutor", "kind": "re-export", "signature": "TransformerExecutor", "summary": "" }, { "name": "UnsupportedTensorShardIndexVersionError", "kind": "re-export", "signature": "UnsupportedTensorShardIndexVersionError", "summary": "" }, { "name": "VFSConversationStore", "kind": "re-export", "signature": "VFSConversationStore", "summary": "" }, { "name": "WeightCache", "kind": "re-export", "signature": "WeightCache", "summary": "" }, { "name": "assertShaderCompiled", "kind": "re-export", "signature": "assertShaderCompiled", "summary": "" }, { "name": "checksumBytes", "kind": "re-export", "signature": "checksumBytes", "summary": "" }, { "name": "checksumString", "kind": "re-export", "signature": "checksumString", "summary": "" }, { "name": "createComputePipelineChecked", "kind": "re-export", "signature": "createComputePipelineChecked", "summary": "" }, { "name": "kernelNameForQuant", "kind": "re-export", "signature": "kernelNameForQuant", "summary": "" }, { "name": "prepareConversation", "kind": "re-export", "signature": "prepareConversation", "summary": "" }, { "name": "prepareLastModelRecord", "kind": "re-export", "signature": "prepareLastModelRecord", "summary": "" }, { "name": "prepareModelHandleRecord", "kind": "re-export", "signature": "prepareModelHandleRecord", "summary": "" }, { "name": "prepareModelPackage", "kind": "re-export", "signature": "prepareModelPackage", "summary": "" }, { "name": "prepareModelRegistry", "kind": "re-export", "signature": "prepareModelRegistry", "summary": "" }, { "name": "prepareTensorShardIndexDocument", "kind": "re-export", "signature": "prepareTensorShardIndexDocument", "summary": "" }, { "name": "rowStrideForQuant", "kind": "re-export", "signature": "rowStrideForQuant", "summary": "" }, { "name": "shaderQ4K", "kind": "re-export", "signature": "shaderQ4K", "summary": "" }, { "name": "shaderQ5K", "kind": "re-export", "signature": "shaderQ5K", "summary": "" }, { "name": "shaderQ6K", "kind": "re-export", "signature": "shaderQ6K", "summary": "" }, { "name": "shaderQ80", "kind": "re-export", "signature": "shaderQ80", "summary": "" }, { "name": "validateConversationId", "kind": "re-export", "signature": "validateConversationId", "summary": "" }, { "name": "validateModelId", "kind": "re-export", "signature": "validateModelId", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/inference/CacheGovernor", "path": "agi/reference/llm/inference/CacheGovernor.md", "source": "agi/llm/inference/CacheGovernor.js", "import": "/agi/llm/inference/CacheGovernor.js", "sourceHash": "678bf1b0b84834d9b88952f07e3e69eb481d83f331d7701fbe8b510945f596c0", "summary": "", "exports": [ { "name": "CacheGovernor", "kind": "class", "signature": "class CacheGovernor", "summary": "" }, { "name": "planAdaptivePreload", "kind": "function", "signature": "planAdaptivePreload(tensors = [], options = {})", "summary": "" }, { "name": "adaptiveWeightPriority", "kind": "function", "signature": "adaptiveWeightPriority(tensor)", "summary": "" }, { "name": "adaptiveEvictionScore", "kind": "function", "signature": "adaptiveEvictionScore(name, entry = {}, options = {})", "summary": "" }, { "name": "weightFamily", "kind": "function", "signature": "weightFamily(name)", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/inference/CpuTensorRunner", "path": "agi/reference/llm/inference/CpuTensorRunner.md", "source": "agi/llm/inference/CpuTensorRunner.js", "import": "/agi/llm/inference/CpuTensorRunner.js", "sourceHash": "c2588dc9c5ee2b947451104f28ee92dff1e1f17363ed84f85985ca5cf0fc7166", "summary": "", "exports": [ { "name": "CpuTensorRunner", "kind": "class", "signature": "class CpuTensorRunner", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/inference/Gemma4GraphRunner", "path": "agi/reference/llm/inference/Gemma4GraphRunner.md", "source": "agi/llm/inference/Gemma4GraphRunner.js", "import": "/agi/llm/inference/Gemma4GraphRunner.js", "sourceHash": "b06865d59a227b489cf458884419f550c193fcd4f348c822ea648895665e2a51", "summary": "", "exports": [ { "name": "Gemma4GraphRunner", "kind": "class", "signature": "class Gemma4GraphRunner", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/inference/GenerationLoop", "path": "agi/reference/llm/inference/GenerationLoop.md", "source": "agi/llm/inference/GenerationLoop.js", "import": "/agi/llm/inference/GenerationLoop.js", "sourceHash": "05147a76cb527903174acb5343064fe163d06c7a1c0dfccbc0b2b3baef52aeb7", "summary": "", "exports": [ { "name": "GenerationLoop", "kind": "class", "signature": "class GenerationLoop", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/inference/GpuPrimitiveRunner", "path": "agi/reference/llm/inference/GpuPrimitiveRunner.md", "source": "agi/llm/inference/GpuPrimitiveRunner.js", "import": "/agi/llm/inference/GpuPrimitiveRunner.js", "sourceHash": "afb6ff6ca17b455d5d8111a205bce1064ade992a1c9179bd2cb23a9c15c84c70", "summary": "", "exports": [ { "name": "GpuPrimitiveRunner", "kind": "class", "signature": "class GpuPrimitiveRunner", "summary": "" }, { "name": "blockedTokenKey", "kind": "function", "signature": "blockedTokenKey(ids, vocabSize)", "summary": "" }, { "name": "mapAsyncWithTimeout", "kind": "function", "signature": "mapAsyncWithTimeout(buffer, mode, timeoutMs, message)", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/inference/GpuRuntimeResources", "path": "agi/reference/llm/inference/GpuRuntimeResources.md", "source": "agi/llm/inference/GpuRuntimeResources.js", "import": "/agi/llm/inference/GpuRuntimeResources.js", "sourceHash": "bcf6b65ecef401e35378b047bf1085f9e9e7152a1258c249d1034a42bb911f79", "summary": "", "exports": [ { "name": "GpuParameterArena", "kind": "class", "signature": "class GpuParameterArena", "summary": "" }, { "name": "GpuBindGroupCache", "kind": "class", "signature": "class GpuBindGroupCache", "summary": "" }, { "name": "uniformBinding", "kind": "function", "signature": "uniformBinding(allocation)", "summary": "" }, { "name": "isArenaAllocation", "kind": "function", "signature": "isArenaAllocation(value)", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/inference/GraphCompiler", "path": "agi/reference/llm/inference/GraphCompiler.md", "source": "agi/llm/inference/GraphCompiler.js", "import": "/agi/llm/inference/GraphCompiler.js", "sourceHash": "30fb4ea82efd7f95c5fb61c28ca221010ed258a9d482cc7b5091a4c63b6c605b", "summary": "", "exports": [ { "name": "GraphCompiler", "kind": "class", "signature": "class GraphCompiler", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/inference/InferenceEngine", "path": "agi/reference/llm/inference/InferenceEngine.md", "source": "agi/llm/inference/InferenceEngine.js", "import": "/agi/llm/inference/InferenceEngine.js", "sourceHash": "8398db540595e51abbd5798548e3e7c3943cc41ca607eb35d68f31f838a2d132", "summary": "", "exports": [ { "name": "InferenceEngine", "kind": "class", "signature": "class InferenceEngine", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/inference/KVCache", "path": "agi/reference/llm/inference/KVCache.md", "source": "agi/llm/inference/KVCache.js", "import": "/agi/llm/inference/KVCache.js", "sourceHash": "d9c20edbeb25e42bd6fb81b302286919a2a1aeb217a7be1d1f2d9e71cb4bf385", "summary": "", "exports": [ { "name": "KVCache", "kind": "class", "signature": "class KVCache", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/inference/LocalGGUFExecutor", "path": "agi/reference/llm/inference/LocalGGUFExecutor.md", "source": "agi/llm/inference/LocalGGUFExecutor.js", "import": "/agi/llm/inference/LocalGGUFExecutor.js", "sourceHash": "615988a623002f6b6869c0e6551a9e56efdc8c54722ac5215fc60493544c5711", "summary": "", "exports": [ { "name": "LocalGGUFExecutor", "kind": "class", "signature": "class LocalGGUFExecutor", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/inference/PagedAttention", "path": "agi/reference/llm/inference/PagedAttention.md", "source": "agi/llm/inference/PagedAttention.js", "import": "/agi/llm/inference/PagedAttention.js", "sourceHash": "c941566582c2757e53b4260fdd676a70c898dc183570958ddc69fb3cf546e48b", "summary": "", "exports": [ { "name": "PagedAttention", "kind": "class", "signature": "class PagedAttention", "summary": "" }, { "name": "PrefixBlockCache", "kind": "class", "signature": "class PrefixBlockCache", "summary": "" }, { "name": "blockHash", "kind": "function", "signature": "blockHash(namespace, prefixHash, blockTokens)", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/inference/QuantizedMatVecRunner", "path": "agi/reference/llm/inference/QuantizedMatVecRunner.md", "source": "agi/llm/inference/QuantizedMatVecRunner.js", "import": "/agi/llm/inference/QuantizedMatVecRunner.js", "sourceHash": "dc3596344dda9371cbfe8608dd4ebcfd96438f40595e2e36039a6ccff475c04d", "summary": "", "exports": [ { "name": "QuantizedMatVecRunner", "kind": "class", "signature": "class QuantizedMatVecRunner", "summary": "" }, { "name": "kernelNameForQuant", "kind": "function", "signature": "kernelNameForQuant(quantization)", "summary": "" }, { "name": "batchedKernelNameForQuant", "kind": "function", "signature": "batchedKernelNameForQuant(quantization)", "summary": "" }, { "name": "rowStrideForQuant", "kind": "function", "signature": "rowStrideForQuant(quantization, cols)", "summary": "" }, { "name": "createKQuantParityProbeData", "kind": "function", "signature": "createKQuantParityProbeData(quantization, { rows = SUBGROUP_PROBE_ROWS } = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/inference/StaticMemoryPlanner", "path": "agi/reference/llm/inference/StaticMemoryPlanner.md", "source": "agi/llm/inference/StaticMemoryPlanner.js", "import": "/agi/llm/inference/StaticMemoryPlanner.js", "sourceHash": "263245e37abfd8cce2c8de11df753bff164b998624a21f7ca96fd5a415c1cf72", "summary": "", "exports": [ { "name": "StaticMemoryPlanner", "kind": "class", "signature": "class StaticMemoryPlanner", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/inference/TransformerExecutor", "path": "agi/reference/llm/inference/TransformerExecutor.md", "source": "agi/llm/inference/TransformerExecutor.js", "import": "/agi/llm/inference/TransformerExecutor.js", "sourceHash": "89f26b7091ee7dfa3ee3c7d3ef5f5af81315f19348762f3e7ab355433008539f", "summary": "", "exports": [ { "name": "TransformerExecutor", "kind": "class", "signature": "class TransformerExecutor", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/inference/WeightCache", "path": "agi/reference/llm/inference/WeightCache.md", "source": "agi/llm/inference/WeightCache.js", "import": "/agi/llm/inference/WeightCache.js", "sourceHash": "196c9d86c78264fefad15369fcfa04bab453c289a4c4fbc3c67e6e6a9c28b5fc", "summary": "", "exports": [ { "name": "WeightCache", "kind": "class", "signature": "class WeightCache", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/KernelRegistry", "path": "agi/reference/llm/kernels/KernelRegistry.md", "source": "agi/llm/kernels/KernelRegistry.js", "import": "/agi/llm/kernels/KernelRegistry.js", "sourceHash": "9a5e33335548532e5b6c2cb2513c0086b3cd3f125e336e175b61d8056cd991d0", "summary": "", "exports": [ { "name": "KernelRegistry", "kind": "class", "signature": "class KernelRegistry", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/PipelineUtils", "path": "agi/reference/llm/kernels/PipelineUtils.md", "source": "agi/llm/kernels/PipelineUtils.js", "import": "/agi/llm/kernels/PipelineUtils.js", "sourceHash": "867a34da5e41e5f69215f113d0d1a0490cf4af3b332dcef251f3fc0d7c71c535", "summary": "", "exports": [ { "name": "createComputePipelineChecked", "kind": "function", "signature": "async createComputePipelineChecked(device, module, { label, name = label, entryPoint = 'main' } = {})", "summary": "" }, { "name": "assertShaderCompiled", "kind": "function", "signature": "async assertShaderCompiled(module, name = 'shader')", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/attention_decode", "path": "agi/reference/llm/kernels/shaders/attention_decode.md", "source": "agi/llm/kernels/shaders/attention_decode.js", "import": "/agi/llm/kernels/shaders/attention_decode.js", "sourceHash": "0be9494f3d3038420e5d1ef789b7101d019a2f21c1b32bf7d5c8581665d2280f", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader()", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/attention_decode_legacy", "path": "agi/reference/llm/kernels/shaders/attention_decode_legacy.md", "source": "agi/llm/kernels/shaders/attention_decode_legacy.js", "import": "/agi/llm/kernels/shaders/attention_decode_legacy.js", "sourceHash": "6fd4106a4e62961fe6b2444ca36a061e23487641f8ebdc9082215f704b29f602", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader()", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/attention_prefill_legacy", "path": "agi/reference/llm/kernels/shaders/attention_prefill_legacy.md", "source": "agi/llm/kernels/shaders/attention_prefill_legacy.js", "import": "/agi/llm/kernels/shaders/attention_prefill_legacy.js", "sourceHash": "84b9cc7369771e1ab0840029198d6b86169ad43cac083d2e188e8ab60d5fa88f", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader()", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/attention_prefill_tiled", "path": "agi/reference/llm/kernels/shaders/attention_prefill_tiled.md", "source": "agi/llm/kernels/shaders/attention_prefill_tiled.js", "import": "/agi/llm/kernels/shaders/attention_prefill_tiled.js", "sourceHash": "2bd1338a663e90012322d133cca6b4232f4511cda58df2d065a3c9998fe5de9f", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader()", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/dequant_row_dense", "path": "agi/reference/llm/kernels/shaders/dequant_row_dense.md", "source": "agi/llm/kernels/shaders/dequant_row_dense.js", "import": "/agi/llm/kernels/shaders/dequant_row_dense.js", "sourceHash": "7432a0f5e4b72d8d333dd13088662ffa2d660ffd1abaa6291d6cafbcda77c991", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ format = 'F16' } = {})", "summary": "" }, { "name": "shaderDequantF32", "kind": "function", "signature": "shaderDequantF32(options = {})", "summary": "" }, { "name": "shaderDequantF16", "kind": "function", "signature": "shaderDequantF16(options = {})", "summary": "" }, { "name": "shaderDequantBF16", "kind": "function", "signature": "shaderDequantBF16(options = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/dequant_row_k_quant", "path": "agi/reference/llm/kernels/shaders/dequant_row_k_quant.md", "source": "agi/llm/kernels/shaders/dequant_row_k_quant.js", "import": "/agi/llm/kernels/shaders/dequant_row_k_quant.js", "sourceHash": "f365dd3956e7b7dd8551e01dcff0fe1ed0cbecbd25aa07e1567f9f5b0bcdc310", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ quant = 'Q4_K' } = {})", "summary": "" }, { "name": "shaderDequantQ4K", "kind": "function", "signature": "shaderDequantQ4K(options = {})", "summary": "" }, { "name": "shaderDequantQ5K", "kind": "function", "signature": "shaderDequantQ5K(options = {})", "summary": "" }, { "name": "shaderDequantQ6K", "kind": "function", "signature": "shaderDequantQ6K(options = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/dequant_row_q4_0", "path": "agi/reference/llm/kernels/shaders/dequant_row_q4_0.md", "source": "agi/llm/kernels/shaders/dequant_row_q4_0.js", "import": "/agi/llm/kernels/shaders/dequant_row_q4_0.js", "sourceHash": "bf440db4c3f2eabe87c23e376cda758d114115c9cb0512d0ae27e6d35d3d9546", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader()", "summary": "" }, { "name": "shaderDequantQ40", "kind": "function", "signature": "shaderDequantQ40(options = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/dequant_row_q8_0", "path": "agi/reference/llm/kernels/shaders/dequant_row_q8_0.md", "source": "agi/llm/kernels/shaders/dequant_row_q8_0.js", "import": "/agi/llm/kernels/shaders/dequant_row_q8_0.js", "sourceHash": "c7a53b6f38c2ce8569d5aed7190abb3d3d0a7efe73153fa3fcb253ec9247236a", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader()", "summary": "" }, { "name": "shaderDequantQ80", "kind": "function", "signature": "shaderDequantQ80(options = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/embedding_row_gather", "path": "agi/reference/llm/kernels/shaders/embedding_row_gather.md", "source": "agi/llm/kernels/shaders/embedding_row_gather.js", "import": "/agi/llm/kernels/shaders/embedding_row_gather.js", "sourceHash": "57a19c1055f6c8ef7d5dc919dc2b3fb1e0e754da8c2d54dd248c46a693f9005b", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader()", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/matmul_k_quant", "path": "agi/reference/llm/kernels/shaders/matmul_k_quant.md", "source": "agi/llm/kernels/shaders/matmul_k_quant.js", "import": "/agi/llm/kernels/shaders/matmul_k_quant.js", "sourceHash": "6f5cb344061d162f343a57b251fe92f0addfe5f23362e42b31a92d79feb2f643", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ quant = 'Q4_K', workgroupSize = WORKGROUP_SIZE } = {})", "summary": "" }, { "name": "shaderMatMulQ4K", "kind": "function", "signature": "shaderMatMulQ4K(options = {})", "summary": "" }, { "name": "shaderMatMulQ5K", "kind": "function", "signature": "shaderMatMulQ5K(options = {})", "summary": "" }, { "name": "shaderMatMulQ6K", "kind": "function", "signature": "shaderMatMulQ6K(options = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/matmul_q4", "path": "agi/reference/llm/kernels/shaders/matmul_q4.md", "source": "agi/llm/kernels/shaders/matmul_q4.js", "import": "/agi/llm/kernels/shaders/matmul_q4.js", "sourceHash": "bf5931cdb4e80ca432641b4d1b61bd89cb410e6a4f2b98fdc0df8c79c0f48908", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader()", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/matmul_q4_0", "path": "agi/reference/llm/kernels/shaders/matmul_q4_0.md", "source": "agi/llm/kernels/shaders/matmul_q4_0.js", "import": "/agi/llm/kernels/shaders/matmul_q4_0.js", "sourceHash": "547c12a0394481647058fd962907e7255df191670c3d36bb2dabaa360d77c927", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ workgroupSize = WORKGROUP_SIZE } = {})", "summary": "" }, { "name": "shaderMatMulQ40", "kind": "function", "signature": "shaderMatMulQ40(options = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/matvec_dense", "path": "agi/reference/llm/kernels/shaders/matvec_dense.md", "source": "agi/llm/kernels/shaders/matvec_dense.js", "import": "/agi/llm/kernels/shaders/matvec_dense.js", "sourceHash": "6a4151e047b9ad87008971b3e529a76da594e2ddecd27eda26969f798370100f", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ format = 'F32', workgroupSize = WORKGROUP_SIZE } = {})", "summary": "" }, { "name": "shaderF32", "kind": "function", "signature": "shaderF32(options = {})", "summary": "" }, { "name": "shaderF16", "kind": "function", "signature": "shaderF16(options = {})", "summary": "" }, { "name": "shaderBF16", "kind": "function", "signature": "shaderBF16(options = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/matvec_k_quant", "path": "agi/reference/llm/kernels/shaders/matvec_k_quant.md", "source": "agi/llm/kernels/shaders/matvec_k_quant.js", "import": "/agi/llm/kernels/shaders/matvec_k_quant.js", "sourceHash": "e69ee211a39f66e61461fc9d4638427b2d0425e9208c50256ede0bc22edd36dd", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ quant = 'Q4_K', workgroupSize = WORKGROUP_SIZE, useSubgroups = false } = {})", "summary": "" }, { "name": "shaderQ4K", "kind": "function", "signature": "shaderQ4K(options = {})", "summary": "" }, { "name": "shaderQ5K", "kind": "function", "signature": "shaderQ5K(options = {})", "summary": "" }, { "name": "shaderQ6K", "kind": "function", "signature": "shaderQ6K(options = {})", "summary": "" }, { "name": "K_QUANT_LAYOUTS", "kind": "constant", "signature": "K_QUANT_LAYOUTS", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/matvec_q4_0", "path": "agi/reference/llm/kernels/shaders/matvec_q4_0.md", "source": "agi/llm/kernels/shaders/matvec_q4_0.js", "import": "/agi/llm/kernels/shaders/matvec_q4_0.js", "sourceHash": "e97dd089f8c186dd3ae4361c757a43e72d31b1716b5257eede66d3347fa660bd", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ workgroupSize = WORKGROUP_SIZE } = {})", "summary": "" }, { "name": "shaderQ40", "kind": "function", "signature": "shaderQ40(options = {})", "summary": "" }, { "name": "Q4_0_LAYOUT", "kind": "constant", "signature": "Q4_0_LAYOUT", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/matvec_q8_0", "path": "agi/reference/llm/kernels/shaders/matvec_q8_0.md", "source": "agi/llm/kernels/shaders/matvec_q8_0.js", "import": "/agi/llm/kernels/shaders/matvec_q8_0.js", "sourceHash": "eed60c3ea0ab2f3873ff1fee33847d5f06117df09ffa20fb6cc8374fc3dc350f", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ workgroupSize = WORKGROUP_SIZE } = {})", "summary": "" }, { "name": "shaderQ80", "kind": "function", "signature": "shaderQ80(options = {})", "summary": "" }, { "name": "Q8_0_LAYOUT", "kind": "constant", "signature": "Q8_0_LAYOUT", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/rmsnorm_fused", "path": "agi/reference/llm/kernels/shaders/rmsnorm_fused.md", "source": "agi/llm/kernels/shaders/rmsnorm_fused.js", "import": "/agi/llm/kernels/shaders/rmsnorm_fused.js", "sourceHash": "74586ffb56cf3fa59378e75eb7281c427bb34fd60dced4298336ca65b6d241c4", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ hiddenSize = 1536, epsilon = '0.000001', workgroupSize = 256 } = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/rmsnorm_residual_fused", "path": "agi/reference/llm/kernels/shaders/rmsnorm_residual_fused.md", "source": "agi/llm/kernels/shaders/rmsnorm_residual_fused.js", "import": "/agi/llm/kernels/shaders/rmsnorm_residual_fused.js", "sourceHash": "1f5766acb0c1e2059787778865605e88764f3fe2d927c196194bec180ed1c997", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ hiddenSize = 1536, epsilon = '0.000001', workgroupSize = 256 } = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/rope_batch", "path": "agi/reference/llm/kernels/shaders/rope_batch.md", "source": "agi/llm/kernels/shaders/rope_batch.js", "import": "/agi/llm/kernels/shaders/rope_batch.js", "sourceHash": "20eea19d8f78862bb94d7fe482a80f789b660eafbddbb410a76a51a942ba17c8", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ theta = '10000.0' } = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/rope_fused", "path": "agi/reference/llm/kernels/shaders/rope_fused.md", "source": "agi/llm/kernels/shaders/rope_fused.js", "import": "/agi/llm/kernels/shaders/rope_fused.js", "sourceHash": "17235f8e330980030c2a833e5b794716589e9c5e3685a5a0036a6de59b9bc1c9", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ theta = '10000.0' } = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/rope_kv_append", "path": "agi/reference/llm/kernels/shaders/rope_kv_append.md", "source": "agi/llm/kernels/shaders/rope_kv_append.js", "import": "/agi/llm/kernels/shaders/rope_kv_append.js", "sourceHash": "933d3683015dab6cbd815f769f0af56c038d4ddaf5a1ff140eb77a4dc2a76f4a", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ theta = '10000.0' } = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/rope_table", "path": "agi/reference/llm/kernels/shaders/rope_table.md", "source": "agi/llm/kernels/shaders/rope_table.js", "import": "/agi/llm/kernels/shaders/rope_table.js", "sourceHash": "fbba2d1a3dc39889670e58f0d3a59112f3c1cd06749f3c4ed1ba1c22efd023f1", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader()", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/sampling_topk_candidates", "path": "agi/reference/llm/kernels/shaders/sampling_topk_candidates.md", "source": "agi/llm/kernels/shaders/sampling_topk_candidates.js", "import": "/agi/llm/kernels/shaders/sampling_topk_candidates.js", "sourceHash": "da73f52b37c5cb358503cc4a1113fae24497da73fa41fe6f1eda2f47dd5343e1", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader()", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/sampling_topk_reduce", "path": "agi/reference/llm/kernels/shaders/sampling_topk_reduce.md", "source": "agi/llm/kernels/shaders/sampling_topk_reduce.js", "import": "/agi/llm/kernels/shaders/sampling_topk_reduce.js", "sourceHash": "7fc54814db3fb73dfeaae4f84d31d0ec89cedd658d28012073707551b7bac905", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader()", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/sampling_topk_topp", "path": "agi/reference/llm/kernels/shaders/sampling_topk_topp.md", "source": "agi/llm/kernels/shaders/sampling_topk_topp.js", "import": "/agi/llm/kernels/shaders/sampling_topk_topp.js", "sourceHash": "78523733d5de1973008e6076f8030d5a3b6fec799ec66c63b9b574fe765b92e6", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader()", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/sampling_topk_topp_legacy", "path": "agi/reference/llm/kernels/shaders/sampling_topk_topp_legacy.md", "source": "agi/llm/kernels/shaders/sampling_topk_topp_legacy.js", "import": "/agi/llm/kernels/shaders/sampling_topk_topp_legacy.js", "sourceHash": "2928af2857e53545e737df56ff73dae832500fa94221d2bb041f083bf94a0dd8", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader()", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/swiglu_fused", "path": "agi/reference/llm/kernels/shaders/swiglu_fused.md", "source": "agi/llm/kernels/shaders/swiglu_fused.js", "import": "/agi/llm/kernels/shaders/swiglu_fused.js", "sourceHash": "4a73d9ed716df74caa90480a22d65a8e9f9eb3b75ac4d140e44c7331b993dc07", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ activation = 'gelu_pytorch_tanh' } = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/tied_embedding_logits", "path": "agi/reference/llm/kernels/shaders/tied_embedding_logits.md", "source": "agi/llm/kernels/shaders/tied_embedding_logits.js", "import": "/agi/llm/kernels/shaders/tied_embedding_logits.js", "sourceHash": "dc498a6e969dbbc616cec0e077793dae57c25bdba66946bf3bc4d230ddd454c7", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ workgroupSize = 128 } = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/kernels/shaders/vector_ops", "path": "agi/reference/llm/kernels/shaders/vector_ops.md", "source": "agi/llm/kernels/shaders/vector_ops.js", "import": "/agi/llm/kernels/shaders/vector_ops.js", "sourceHash": "5ba610453422e04d830ce916cd74d91b328c7539d3e55f406a5a68e547f2a376", "summary": "", "exports": [ { "name": "shader", "kind": "function", "signature": "shader({ op = 'add' } = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/runtime/LLMRuntime", "path": "agi/reference/llm/runtime/LLMRuntime.md", "source": "agi/llm/runtime/LLMRuntime.js", "import": "/agi/llm/runtime/LLMRuntime.js", "sourceHash": "3ac2e9e534240f3d7d807becc5b3704433d2c207259b45ce1297d62a6a9160a1", "summary": "", "exports": [ { "name": "LLMRuntime", "kind": "class", "signature": "class LLMRuntime", "summary": "" }, { "name": "normalizeLocalRuntimeResourceUsage", "kind": "function", "signature": "normalizeLocalRuntimeResourceUsage(before, after)", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/runtime/LLMSession", "path": "agi/reference/llm/runtime/LLMSession.md", "source": "agi/llm/runtime/LLMSession.js", "import": "/agi/llm/runtime/LLMSession.js", "sourceHash": "a589715cef48e22304b5327132e2dbecf7ed9fef2eb3e0217b595fcfe1b51310", "summary": "", "exports": [ { "name": "LLMSession", "kind": "class", "signature": "class LLMSession", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/runtime/LogFormat", "path": "agi/reference/llm/runtime/LogFormat.md", "source": "agi/llm/runtime/LogFormat.js", "import": "/agi/llm/runtime/LogFormat.js", "sourceHash": "820e6a6e3aa5a9535c690613776ddcb3fec7f20dae1115ebaf2fb13e88057f1a", "summary": "", "exports": [ { "name": "logRuntimeEvent", "kind": "function", "signature": "logRuntimeEvent(event, data = {}, options = {})", "summary": "" }, { "name": "compactLogLine", "kind": "function", "signature": "compactLogLine(data)", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/runtime/ModelRegistry", "path": "agi/reference/llm/runtime/ModelRegistry.md", "source": "agi/llm/runtime/ModelRegistry.js", "import": "/agi/llm/runtime/ModelRegistry.js", "sourceHash": "9c248d6bd650fc067d502d4283e2abe039a4c8941e8ad28e064728ffc35167fa", "summary": "", "exports": [ { "name": "ModelRegistry", "kind": "class", "signature": "class ModelRegistry", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/runtime/PromptTemplate", "path": "agi/reference/llm/runtime/PromptTemplate.md", "source": "agi/llm/runtime/PromptTemplate.js", "import": "/agi/llm/runtime/PromptTemplate.js", "sourceHash": "2f159e1f9e527baab2001e447b934eb619724f46e9500d7175e1b6cf4b214557", "summary": "", "exports": [ { "name": "PromptTemplate", "kind": "class", "signature": "class PromptTemplate", "summary": "" }, { "name": "GEMMA4_SPECIAL_TOKENS", "kind": "constant", "signature": "GEMMA4_SPECIAL_TOKENS", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/runtime/RuntimePerformanceMonitor", "path": "agi/reference/llm/runtime/RuntimePerformanceMonitor.md", "source": "agi/llm/runtime/RuntimePerformanceMonitor.js", "import": "/agi/llm/runtime/RuntimePerformanceMonitor.js", "sourceHash": "e689a583853ad1636940b5e3387cc35ae022450d76cea1f9d590b175af7de5a9", "summary": "", "exports": [ { "name": "RuntimePerformanceMonitor", "kind": "class", "signature": "class RuntimePerformanceMonitor", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/runtime/Sampler", "path": "agi/reference/llm/runtime/Sampler.md", "source": "agi/llm/runtime/Sampler.js", "import": "/agi/llm/runtime/Sampler.js", "sourceHash": "8e51d5faea4a77bd54d89efcbb191ef8d0f848def16e5a06986a79d2f3f2cfce", "summary": "", "exports": [ { "name": "Sampler", "kind": "class", "signature": "class Sampler", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/runtime/Tokenizer", "path": "agi/reference/llm/runtime/Tokenizer.md", "source": "agi/llm/runtime/Tokenizer.js", "import": "/agi/llm/runtime/Tokenizer.js", "sourceHash": "609fa36ca7371a78ab083580a8f7abbb72e3760cbffd6c269983fe6df7bca22c", "summary": "", "exports": [ { "name": "Tokenizer", "kind": "class", "signature": "class Tokenizer", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/runtime/TokenizerWorkerClient", "path": "agi/reference/llm/runtime/TokenizerWorkerClient.md", "source": "agi/llm/runtime/TokenizerWorkerClient.js", "import": "/agi/llm/runtime/TokenizerWorkerClient.js", "sourceHash": "c39ec40134c451df5a47c9cd7d268ba56a0ed225c5e8fe09c39082644ee2d930", "summary": "", "exports": [ { "name": "TokenizerWorkerClient", "kind": "class", "signature": "class TokenizerWorkerClient", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/runtime/ToolBridge", "path": "agi/reference/llm/runtime/ToolBridge.md", "source": "agi/llm/runtime/ToolBridge.js", "import": "/agi/llm/runtime/ToolBridge.js", "sourceHash": "8fc3a009d82b829a6e0cb140402c0dbf639db62c05914d68f28971618fa29105", "summary": "", "exports": [ { "name": "ToolBridge", "kind": "class", "signature": "class ToolBridge", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/storage/AtomicJSON", "path": "agi/reference/llm/storage/AtomicJSON.md", "source": "agi/llm/storage/AtomicJSON.js", "import": "/agi/llm/storage/AtomicJSON.js", "sourceHash": "29990a9482059b74d5fa6518e9f656deb9453857d478e78f4a71f8ccd07ba685", "summary": "Publish JSON through a verified staging file while retaining the previous revision until the replacement move succeeds.", "exports": [ { "name": "replaceJSONCopyOnWrite", "kind": "function", "signature": "async replaceJSONCopyOnWrite(store, path, value, { validate = null, label = 'JSON record' } = {})", "summary": "Publish JSON through a verified staging file while retaining the previous revision until the replacement move succeeds." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/storage/Checksum", "path": "agi/reference/llm/storage/Checksum.md", "source": "agi/llm/storage/Checksum.js", "import": "/agi/llm/storage/Checksum.js", "sourceHash": "06867b19c75e6c53f4c04fce2a8d2722ee576925a6a19000d9510d6ad6be3f59", "summary": "", "exports": [ { "name": "checksumBytes", "kind": "function", "signature": "async checksumBytes(bytes, algorithm = 'SHA-256')", "summary": "" }, { "name": "checksumString", "kind": "function", "signature": "async checksumString(text, algorithm = 'SHA-256')", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/storage/ModelCache", "path": "agi/reference/llm/storage/ModelCache.md", "source": "agi/llm/storage/ModelCache.js", "import": "/agi/llm/storage/ModelCache.js", "sourceHash": "61ef650481657d194c49bd4d85b49717c67893238b22f837de8b311892c1d420", "summary": "", "exports": [ { "name": "ModelCache", "kind": "class", "signature": "class ModelCache", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/storage/ModelHandleStore", "path": "agi/reference/llm/storage/ModelHandleStore.md", "source": "agi/llm/storage/ModelHandleStore.js", "import": "/agi/llm/storage/ModelHandleStore.js", "sourceHash": "1ac899619e21fe46122a9f035b0e75e0416b01dacc5f4bdb23d0c8cf82bd26c0", "summary": "", "exports": [ { "name": "ModelHandleStoreError", "kind": "class", "signature": "class ModelHandleStoreError extends Error", "summary": "" }, { "name": "ModelHandleStore", "kind": "class", "signature": "class ModelHandleStore", "summary": "" }, { "name": "prepareModelHandleRecord", "kind": "function", "signature": "prepareModelHandleRecord(value, expectedModelId = null)", "summary": "" }, { "name": "prepareLastModelRecord", "kind": "function", "signature": "prepareLastModelRecord(value)", "summary": "" }, { "name": "isFileSystemHandle", "kind": "function", "signature": "isFileSystemHandle(value)", "summary": "" }, { "name": "queryHandlePermission", "kind": "function", "signature": "async queryHandlePermission(handle)", "summary": "" }, { "name": "requestHandlePermission", "kind": "function", "signature": "async requestHandlePermission(handle)", "summary": "" }, { "name": "MODEL_HANDLE_RECORD_SCHEMA", "kind": "constant", "signature": "MODEL_HANDLE_RECORD_SCHEMA", "summary": "" }, { "name": "MODEL_HANDLE_RECORD_VERSION", "kind": "constant", "signature": "MODEL_HANDLE_RECORD_VERSION", "summary": "" }, { "name": "MODEL_HANDLE_QUARANTINE_SCHEMA", "kind": "constant", "signature": "MODEL_HANDLE_QUARANTINE_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/storage/OPFSStore", "path": "agi/reference/llm/storage/OPFSStore.md", "source": "agi/llm/storage/OPFSStore.js", "import": "/agi/llm/storage/OPFSStore.js", "sourceHash": "59bfc3241bd863dd7c1cb58aa9480cc22620a004d9526192f0bf9c249761403b", "summary": "", "exports": [ { "name": "OPFSStore", "kind": "class", "signature": "class OPFSStore", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/storage/VFSConversationStore", "path": "agi/reference/llm/storage/VFSConversationStore.md", "source": "agi/llm/storage/VFSConversationStore.js", "import": "/agi/llm/storage/VFSConversationStore.js", "sourceHash": "db4e21ded540c16a1f9fca1007fb19c9a8ec726bafb03074d230f91ba64c8a47", "summary": "", "exports": [ { "name": "VFSConversationStore", "kind": "class", "signature": "class VFSConversationStore", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/workers/LLMLoadPlannerWorker", "path": "agi/reference/llm/workers/LLMLoadPlannerWorker.md", "source": "agi/llm/workers/LLMLoadPlannerWorker.js", "import": "/agi/llm/workers/LLMLoadPlannerWorker.js", "sourceHash": "b62dac9e7b377ca82e5c3176bde34aedf13eae2fa75c5d9b8b8e346dd17217b5", "summary": "", "exports": [], "subsystem": "agi" }, { "schemaVersion": 1, "title": "llm/workers/LLMTokenizerWorker", "path": "agi/reference/llm/workers/LLMTokenizerWorker.md", "source": "agi/llm/workers/LLMTokenizerWorker.js", "import": "/agi/llm/workers/LLMTokenizerWorker.js", "sourceHash": "769ae066cd2b0d1f52841f87b4094b164190165e88dba83d82d0546f8fed9d25", "summary": "", "exports": [], "subsystem": "agi" }, { "schemaVersion": 1, "title": "loader/ModelLoader", "path": "agi/reference/loader/ModelLoader.md", "source": "agi/loader/ModelLoader.js", "import": "/agi/loader/ModelLoader.js", "sourceHash": "6e3006b4ce7d497edf04a0fa47e99860b44bc97a2bd2b802477c1e06f521d40a", "summary": "", "exports": [ { "name": "ModelLoader", "kind": "class", "signature": "class ModelLoader", "summary": "" }, { "name": "modelLoaderVertexDedupHash32", "kind": "function", "signature": "modelLoaderVertexDedupHash32(posBits, pOff, uvBits = null, uOff = 0)", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "network/TrainingStateChannel", "path": "agi/reference/network/TrainingStateChannel.md", "source": "agi/network/TrainingStateChannel.js", "import": "/agi/network/TrainingStateChannel.js", "sourceHash": "3bfd7433f6e110a712aec26fdaab4b2fa1bc52d841d7372ea1027c06054fcb9c", "summary": "Bind AGI Studio telemetry to the standard State Channel stack. The training runtime is authoritative; same-origin tabs need no setup, and callers hosted inside WebGPU OS may pass NetworkDriver to publish over mesh.", "exports": [ { "name": "AgiTrainingStateChannel", "kind": "class", "signature": "class AgiTrainingStateChannel", "summary": "Bind AGI Studio telemetry to the standard State Channel stack. The training runtime is authoritative; same-origin tabs need no setup, and callers hosted inside WebGPU OS may pass NetworkDriver to publish over mesh." }, { "name": "createAgiTrainingStateChannel", "kind": "function", "signature": "createAgiTrainingStateChannel(options = {})", "summary": "" }, { "name": "AGI_TRAINING_CHANNEL_ID", "kind": "constant", "signature": "AGI_TRAINING_CHANNEL_ID", "summary": "" }, { "name": "AGI_TRAINING_ROUTE_ID", "kind": "constant", "signature": "AGI_TRAINING_ROUTE_ID", "summary": "" }, { "name": "AGI_TRAINING_CONTRACT", "kind": "constant", "signature": "AGI_TRAINING_CONTRACT", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/articulatory/BreathReservoirState", "path": "agi/reference/particle_voice/articulatory/BreathReservoirState.md", "source": "agi/particle_voice/articulatory/BreathReservoirState.js", "import": "/agi/particle_voice/articulatory/BreathReservoirState.js", "sourceHash": "5d29378ba659dc894212c40bace8aca69114befc9e97127e251717dec025df5f", "summary": "BreathReservoirState.js — Phase 2 Voice Box state schema (`v0`). \"Lung pressure, compliance, target subglottal pressure\" per `ARCHITECTURE.md` §4 — the JS-side state container wrapping `nn/kernels/articulatory/breath_reservoir.js`'s per-instance recurrence (`pressure[n] = pressure[n-1] + (target[n] - pressure[n-1]) * lagRate`, proven against `risk/BreathReservoir.js` (R6A)). This module owns the `lagRate` derivation from `compliance`/`sampleRate` (the caller-computed value that kernel's docstring says it expects pre-computed, not recomputed in-shader) and the timestamped state container the kernel's `initial_pressure`/`pressure_out` buffers round-trip through across chunks — it does not itself dispatch the kernel (that is `ParticleTract.js`'s job once a real model exists to drive it).", "exports": [ { "name": "lagRateFromCompliance", "kind": "function", "signature": "lagRateFromCompliance(compliance, sampleRate)", "summary": "`lagRate = 1 - exp(-1/(compliance*sampleRate))` — matches `risk/BreathReservoir.js` (R6A)'s proven formula exactly; `breath_reservoir.js`'s own docstring requires this be computed by the caller, not the kernel." }, { "name": "createBreathReservoirState", "kind": "function", "signature": "createBreathReservoirState({ sampleIndex, pressure, compliance, targetSubglottalPressure })", "summary": "" }, { "name": "stepBreathReservoirState", "kind": "function", "signature": "stepBreathReservoirState(state, sampleRate)", "summary": "Advance one `BreathReservoirState` by one sample using the exact same recurrence `breath_reservoir.js`/`risk/BreathReservoir.js` implement — the CPU-side single-sample equivalent, useful for tests and for any non-GPU fallback path, not a replacement for the GPU kernel's chunked dispatch." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/articulatory/FormantSolver", "path": "agi/reference/particle_voice/articulatory/FormantSolver.md", "source": "agi/particle_voice/articulatory/FormantSolver.js", "import": "/agi/particle_voice/articulatory/FormantSolver.js", "sourceHash": "b8dc73ed6ea31c7ecbca2bf1e03f0f79e8c2d19e55bbfc61e3190aac2f2651d9", "summary": "FormantSolver.js — Phase 3 ParticleVoice articulatory calibration. Measures the resonances a Kelly-Lochbaum area profile actually produces, and inverts that: given target formants, searches for an area profile that hits them. ## Why this exists Vowel identity in speech is carried almost entirely by **F1 and F2**. An area profile invented from articulatory adjectives (\"high\", \"back\", \"rounded\") produces *some* formants, but nothing forces them to be the RIGHT ones — and if they are wrong, every vowel collapses toward a neutral timbre and the speech is unintelligible no matter how clean the pipeline is. That was the state before this module: `ArticulationHead`'s height/backness → area mapping was plausible but uncalibrated. Defining vowels by their measured formant targets and SOLVING for the geometry inverts the dependency: the targets are citable data (Peterson & Barney 1952 / Hillenbrand et al. 1995 male averages, whose vowel set maps exactly onto `spec/PhonemeSet-v0.md`'s ten monophthongs), and the geometry becomes a derived quantity that stays correct if the section count or sample rate changes. ## The response is measured with the SAME recurrence the GPU runs `impulseResponse()` reimplements `tract_waveguide.js`'s scattering recurrence on the CPU rather than using an analytic transfer function. That is deliberate: an analytic formula would be a second model that could disagree with the kernel, and then a \"calibrated\" vowel would not actually be calibrated for the thing doing the synthesis. In particular this omits the lip first-difference, matching `ParticleTract`'s `radiation_difference = 0` (its source is already a flow derivative).", "exports": [ { "name": "impulseResponse", "kind": "function", "signature": "impulseResponse(areas, { glottalReflection, lipReflection, responseLength, wallLoss = 1 })", "summary": "Impulse response of the lossless KL chain, mirroring `tract_waveguide.js`'s recurrence (and, like `ParticleTract`, WITHOUT the lip first difference)." }, { "name": "findFormants", "kind": "function", "signature": "findFormants(areas, sampleRate, options = {})", "summary": "Resonance frequencies of an area profile, lowest first." }, { "name": "profileFromParams", "kind": "function", "signature": "profileFromParams(params, numSections)", "summary": "Build the profile this solver searches over. `constrictionWidth` exists because a single control point is not enough for high front vowels. `shapedAreaProfile` interpolates LINEARLY between control points, so one narrow point produces a smooth V — a tract that tapers and re-widens with no distinct cavities. /i/ needs the opposite: a genuinely SHORT front cavity (F2 = 2290 Hz implies c/(4*F2) ~ 3.7 cm) sharply separated from a long back cavity. Giving the constriction a WIDTH creates that two-cavity structure, and with it F2 values a single point cannot reach (an earlier 3-point version topped out at 1889 Hz against IY's 2290 Hz target, 333 cents low, which made IY and IH nearly identical in F2). A width of 0 degenerates to the original 3-point shape, so the parametrisation strictly extends the old one rather than replacing it." }, { "name": "fitVowelAreas", "kind": "function", "signature": "fitVowelAreas(target, numSections, sampleRate, options = {})", "summary": "Search for an area profile whose first two resonances match `target`. Error is measured in the LOG-frequency domain, because formant perception is roughly logarithmic: being 100 Hz off matters far more at F1 = 270 than at F2 = 2290, and a linear error would happily sacrifice F1 accuracy to shave a little off F2. Exhaustive over a coarse grid, then a local refinement pass. Exhaustive rather than gradient-based on purpose: the map from geometry to formants is non-monotonic (moving a constriction can swap which cavity dominates F2), so a descent method lands in whichever basin it started in." }, { "name": "fitTargets", "kind": "function", "signature": "fitTargets(targets, numSections, sampleRate, options = {})", "summary": "Fit every entry in a formant-target table. Slow (a full grid per entry) — intended for a calibration tool/test, not a hot path." }, { "name": "fitAllVowels", "kind": "function", "signature": "fitAllVowels(numSections, sampleRate, options = {})", "summary": "" }, { "name": "fitAllApproximants", "kind": "function", "signature": "fitAllApproximants(numSections, sampleRate, options = {})", "summary": "" }, { "name": "tractLengthFor", "kind": "function", "signature": "tractLengthFor(numSections, sampleRate)", "summary": "The tract length a section count represents, for reporting alongside a fit." }, { "name": "VOWEL_FORMANTS", "kind": "constant", "signature": "VOWEL_FORMANTS", "summary": "Peterson & Barney (1952) male averages, Hz. Their vowel set — heed, hid, head, had, hod, hawed, hood, who'd, hud, heard — is exactly this project's ten monophthongs, so no mapping or interpolation is needed. F3 is carried for `ER` only, where the unusually LOW F3 is the defining rhotic cue; for the others F1/F2 determine identity." }, { "name": "VOWEL_AREA_PARAMS", "kind": "constant", "signature": "VOWEL_AREA_PARAMS", "summary": "The solved geometry for each vowel, produced by `fitAllVowels()` and baked here so the runtime does not pay for the search (a full grid per vowel takes tens of seconds). `tests/particle-voice/vowel-formants.html` re-verifies this table against the targets cheaply on every run, so it cannot silently go stale if the section count or sample rate changes — the check fails and the table is re-fitted. Fitted at **32 sections / 64 kHz, two constrictions, wall loss included**. Measured F1/F2 vs target, worst case **21 cents** across all ten: IY 270/2291 IH 390/1989 EH 530/1844 AE 661/1724 AH 640/1190 ER 490/1350 AA 730/1090 AO 569/850 UH 438/1019 UW 300/867 Three structural changes got here, none of them tuning: 1. **Doubling the resolution** (16 -> 32 sections, via 32 -> 64 kHz) made a short front cavity representable, which is what front vowels need. IY's F2 went 1926 -> 2211 Hz on its own. 2. **A second constriction** fixed the back rounded vowels, which a single narrowing simply could not reach: AO's F2 was 1130 Hz against an 840 Hz target (513 cents) and no better solution existed anywhere in the search space, because a low F2 requires a long back cavity AND lip rounding acting together. Worst error 513 -> 60 cents. 3. **Including WALL LOSS in the calibration**, which improved it again (60 -> 21 cents). That is not a coincidence: loss gives the formants realistic bandwidth, and damped peaks are better separated and more reliably located than the near-singular peaks of a lossless tube. It also means the fit is now against the same damped tube that renders. Every area respects `MIN_VOWEL_AREA_CM2`, so no vowel is realised with a constriction tight enough to whistle or hiss." }, { "name": "APPROXIMANT_FORMANTS", "kind": "constant", "signature": "APPROXIMANT_FORMANTS", "summary": "Formant targets for the four approximants, Hz. These are consonants only in their distribution — acoustically /w j r l/ are \"vowel-like consonants\" (semivowels), and a generic `MANNER_AREA` constriction cannot produce any of them. That is why they were inaudible as themselves: a single 0.85 cm^2 narrowing at a place position yields something vowel-shaped and roughly neutral, so /r/, /l/, /w/ and /y/ all collapsed into the same glide. Treating them like vowels — targets first, geometry solved — is the only way they become distinct. Values from the acoustic-phonetics literature (Espy-Wilson's prevocalic measurements; the Delaware ASEL synthesis tables): /w/ 250/750 — an \"extreme /u/\": lower F1 and F2 than the vowel /r/ 350/1000 — F1/F2 like a central rounded vowel... /l/ 400/1075 — ...nearly the same F1/F2 as /r/ /y/ 300/2450 — an \"extreme /i/\" Note the F1/F2 values for /r/ and /l/ are nearly identical. **F3 is what separates them**, almost entirely: /r/'s F3 falls below 2000 Hz (often close to F2, which is its single most salient property), while /l/'s sits at or above 2500 Hz. `f3` is carried here for that reason, and `f3Weight` marks where matching it actually matters — for /r/ and /l/ an F3 error is not a refinement, it is the difference between the two phonemes." }, { "name": "APPROXIMANT_AREA_PARAMS", "kind": "constant", "signature": "APPROXIMANT_AREA_PARAMS", "summary": "Solved approximant geometry, same provenance and staleness guard as `VOWEL_AREA_PARAMS`. Fitted at 32 sections / 64 kHz, with the second constriction AND wall loss (both must match `DEFAULT_TRACT_CONFIG`, or this calibrates a different tube than the one that renders). Measured F1/F2/F3 against target: W 249/852/2113 (250/750/2500) R 337/1137/1845 (350/1000/1500) L 398/1075/2556 (400/1075/2550) Y 299/2402/2688 (300/2450/2600) L is near-exact on all three and Y is within 50 Hz on F1/F2. The decisive property holds: **R's F3 sits at 1845 Hz and L's at 2556 Hz**, a 711 Hz separation, so the one cue that distinguishes /r/ from /l/ genuinely exists. Before calibration both were a generic manner constriction with NO F3 contrast at all — literally the same sound, which is why the user could hear neither. The second constriction is what made this reachable. With a single one, R's F3 was 2166 Hz (not rhotic at all), W's F2 was 1091 against 750, and Y's F2 was 1541 against 2450. R's F3 is still ~345 Hz above target, the remaining gap being the sublingual cavity that a 1-D area function cannot represent at all." }, { "name": "MIN_VOWEL_AREA_CM2", "kind": "constant", "signature": "MIN_VOWEL_AREA_CM2", "summary": "Smallest cross-section, in cm^2, a VOWEL is allowed anywhere in the tract. Without this the search is free to buy formant accuracy with impossible geometry: an unconstrained fit put AA's constriction at 0.15 cm^2, which is TIGHTER than `ArticulationHead`'s fricative constant (0.14). Two things are wrong with that. Physically, a channel that narrow generates turbulence at speech airflow rates — it would be a fricative, not a vowel, and a vowel that hisses is not the vowel you asked for. Numerically, the extreme area ratio drives junction reflection coefficients toward +-1, giving absurdly high-Q resonances that ring. 0.35 cm^2 sits just above the turbulence onset region while still allowing the tight constrictions high vowels genuinely need (measured vowel minima run from ~0.3 cm^2 for /i/ upward)." }, { "name": "DEFAULT_SOLVER_OPTIONS", "kind": "constant", "signature": "DEFAULT_SOLVER_OPTIONS", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/articulatory/NeuralPhysiologyState", "path": "agi/reference/particle_voice/articulatory/NeuralPhysiologyState.md", "source": "agi/particle_voice/articulatory/NeuralPhysiologyState.js", "import": "/agi/particle_voice/articulatory/NeuralPhysiologyState.js", "sourceHash": "e759a67f60b7e17ad72176a031511d060010bc247e22176a052bfdcf2f393c76", "summary": "NeuralPhysiologyState.js — Phase 2 Voice Box state schema (`v0`). The model's predicted per-frame physiology state, per `ARCHITECTURE.md` §4: four control heads plus an uncertainty head, version `0x00010000`. This is a `v0` working definition of each head's field set — the heads themselves are named and required by the plan, but their exact field composition was not otherwise specified anywhere in the frozen `spec/` documents, so the fields chosen here are deliberately the smallest set that maps DIRECTLY onto an already-built, already-tested GPU kernel's input parameters (not invented ahead of a consumer): - `RespiratoryDriveHead.targetSubglottalPressure` → drives `BreathReservoirState`/`nn/kernels/articulatory/breath_reservoir.js`. - `GlottalStateHead` (`t0Samples`/`teSamples`/`tpSamples`/`taSamples`/ `ee`) → the exact parameter names `nn/kernels/articulatory/glottal_lf.js` takes per instance. - `TractGestureHead.areas` → the area profile `nn/kernels/articulatory/tract_transfer.js`/`tract_waveguide.js` consume. - `ArticulationEventHead` (`constrictionIndex`/`constrictionAmplitude`/ `nasalCoupling`) → drives `constriction_noise.js`/`nasal_junction.js` injection points (the actual multi-port coupling math those two kernels' docstrings still flag as deferred — this head only carries the control values, not a coupling implementation). - `UncertaintyHead.confidence` → a single scalar per-frame confidence, the minimal representation until a real model exists to justify a richer (e.g. per-head covariance) shape. Like every other `v0` document in this project, this field set may still change before a `v1` freeze — it is not a claim that these are the final head shapes, only that they are usable today and traceable to real kernel inputs rather than speculative. Per `ARCHITECTURE.md` §4's timestamping rule, every state object here carries the absolute sample counter it was produced at (`sampleIndex`), never a chunk-relative index.", "exports": [ { "name": "createNeuralPhysiologyState", "kind": "function", "signature": "createNeuralPhysiologyState({ sampleIndex, respiratoryDrive, glottalState, tractGesture, articulationEvent = null, uncertainty = { confidence: 1 }, })", "summary": "" }, { "name": "validateRespiratoryDriveHead", "kind": "function", "signature": "validateRespiratoryDriveHead(head)", "summary": "" }, { "name": "validateGlottalStateHead", "kind": "function", "signature": "validateGlottalStateHead(head)", "summary": "" }, { "name": "validateTractGestureHead", "kind": "function", "signature": "validateTractGestureHead(head)", "summary": "" }, { "name": "validateArticulationEventHead", "kind": "function", "signature": "validateArticulationEventHead(head)", "summary": "" }, { "name": "validateUncertaintyHead", "kind": "function", "signature": "validateUncertaintyHead(head)", "summary": "" }, { "name": "NEURAL_PHYSIOLOGY_STATE_VERSION", "kind": "constant", "signature": "NEURAL_PHYSIOLOGY_STATE_VERSION", "summary": "NeuralPhysiologyState.js — Phase 2 Voice Box state schema (`v0`). The model's predicted per-frame physiology state, per `ARCHITECTURE.md` §4: four control heads plus an uncertainty head, version `0x00010000`. This is a `v0` working definition of each head's field set — the heads themselves are named and required by the plan, but their exact field composition was not otherwise specified anywhere in the frozen `spec/` documents, so the fields chosen here are deliberately the smallest set that maps DIRECTLY onto an already-built, already-tested GPU kernel's input parameters (not invented ahead of a consumer): - `RespiratoryDriveHead.targetSubglottalPressure` → drives `BreathReservoirState`/`nn/kernels/articulatory/breath_reservoir.js`. - `GlottalStateHead` (`t0Samples`/`teSamples`/`tpSamples`/`taSamples`/ `ee`) → the exact parameter names `nn/kernels/articulatory/glottal_lf.js` takes per instance. - `TractGestureHead.areas` → the area profile `nn/kernels/articulatory/tract_transfer.js`/`tract_waveguide.js` consume. - `ArticulationEventHead` (`constrictionIndex`/`constrictionAmplitude`/ `nasalCoupling`) → drives `constriction_noise.js`/`nasal_junction.js` injection points (the actual multi-port coupling math those two kernels' docstrings still flag as deferred — this head only carries the control values, not a coupling implementation). - `UncertaintyHead.confidence` → a single scalar per-frame confidence, the minimal representation until a real model exists to justify a richer (e.g. per-head covariance) shape. Like every other `v0` document in this project, this field set may still change before a `v1` freeze — it is not a claim that these are the final head shapes, only that they are usable today and traceable to real kernel inputs rather than speculative. Per `ARCHITECTURE.md` §4's timestamping rule, every state object here carries the absolute sample counter it was produced at (`sampleIndex`), never a chunk-relative index." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/articulatory/ParticleTract", "path": "agi/reference/particle_voice/articulatory/ParticleTract.md", "source": "agi/particle_voice/articulatory/ParticleTract.js", "import": "/agi/particle_voice/articulatory/ParticleTract.js", "sourceHash": "a294f6f6db8a6fbe43ad637c6ee1e5575dd74b882281b1c96b833704f6c93497", "summary": "ParticleTract.js — Phase 2 ParticleVoice Voice Box orchestrator. The GPU-resident articulatory synthesizer: composes the already-verified Phase 2 articulatory kernels into audible speech, one fixed-size chunk at a time, with all cross-chunk state persisted ON THE GPU (no CPU round trip mid-pipeline). This is the production counterpart of R6's pure-CPU `risk/VoiceBoxWaveguideProbe.js`, and deliberately reproduces the same four controllable behaviors that probe proved: stable vowels, nasal coupling, closure/release/frication, and pitch sweeps. Signal graph per chunk (7 GPU passes + 4 state copies, ONE submit): glottal_lf ────────────────► voicing ──┐ ├─ signal_add ─► source_flow ─┐ constriction_noise(asp seed) ─► asp ────┘ │ ▼ constriction_noise(fric seed) ─► frication ──────► tract_waveguide (oral) │ │ radiated ◄─────────┘ └──► nasal_tap │ │ │ nasal_junction ◄────┘ │ │ └── signal_add ◄── radiated │ ▼ final PCM Design decisions worth knowing: - **Frication is injected at the constriction, not the glottis.** The frication noise buffer goes to `tract_waveguide.js`'s `constriction_noise` input and is added to the right-going wave at `constrictionIndex`, so only the cavity in FRONT of the constriction filters it. Mixing it into `source_flow` instead would make every fricative sound like a whisper. Aspiration, which really is glottal, IS mixed into `source_flow`. - **No `lip_radiation` pass.** `tract_waveguide.js` already applies the `outputRaw - prevOutputRaw` radiation first-difference internally (exactly as R6's `step()` does). Running `lip_radiation.js` on its output would differentiate twice and produce a thin, bass-less buzz. That kernel exists for callers holding an undifferentiated signal. - **Fixed `chunkSamples`.** `tract_waveguide.js`/`nasal_junction.js` pack their radiated signal and persisted state into one buffer whose internal offsets depend on `num_samples`, so a varying chunk size would move every offset and invalidate the pre-built bind groups. A fixed chunk size is also what a real-time audio bridge wants anyway (`streaming/VoiceChunker.js` schedules in fixed frame buckets), so it is required here rather than worked around. - **Reflection coefficients are computed CPU-side** each chunk via `risk/KellyLochbaumWaveguide.js`'s proven `reflectionCoefficients`, matching `tract_waveguide.js`'s stated contract. Changing `areas` between chunks is how closure/release is articulated. **Visualization is optional and structurally incapable of changing the PCM.** `ARCHITECTURE.md` §4 requires visualization to be \"bit-identically disable-able without changing rendered PCM\". Here that is not a runtime convention but a structural property: when `visualFramesPerChunk` is 0 (the default) the visualization buffers, pipeline and dispatches are never created at all, and when it is enabled every visualization buffer is WRITE-ONLY from the acoustic path's perspective — the field is copied OUT of `tract_waveguide`/`nasal_junction`'s already-final packed outputs, and nothing in the visualization path is ever read back into the acoustic path. `visual_state_decimate.js` makes the same guarantee at kernel level (it has no read_write access to anything the acoustic path reads). Known limitations, stated honestly rather than papered over: - `constrictionIndex` and `nasalCoupling` are DISPATCH-WIDE (they live in the kernels' uniform structs, not per-instance storage arrays), so all instances of one `ParticleTract` share them. Per-instance variation would require promoting both to storage buffers. They are therefore top-level controls here, not per-instance ones, so the API does not imply a capability that does not exist. - The nasal tap is a read-only observation of the oral tract, not a rigorous 3-port scattering junction — the oral tract is not loaded by the nasal branch. This matches R6 exactly and is noted in `tract_waveguide.js`'s docstring too. - The visualization field carries the THREE per-sample solver signals the kernels actually expose (oral radiated, nasal tap, nasal radiated), not one channel per tube section. `ARCHITECTURE.md` §4 describes the richer per-section field, but `tract_waveguide.js` does not emit a `[section, sample]` field — only its radiated signal, final state and the single tapped section. Adding one would mean a `numSections * chunkSamples` output block (~512 KB per chunk at 32 sections / 1024 samples) allocated whether or not visualization is on. That is a deliberate follow-up, not an oversight; the three channels here are enough to drive a ribbon/heatmap of what the solver is actually radiating.", "exports": [ { "name": "ParticleTract", "kind": "class", "signature": "class ParticleTract", "summary": "" }, { "name": "sectionsForLength", "kind": "function", "signature": "sectionsForLength(lengthM, sampleRate, speedOfSound = SPEED_OF_SOUND_M_PER_S)", "summary": "" }, { "name": "lengthForSections", "kind": "function", "signature": "lengthForSections(numSections, sampleRate, speedOfSound = SPEED_OF_SOUND_M_PER_S)", "summary": "" }, { "name": "createParticleTract", "kind": "function", "signature": "createParticleTract(device, options)", "summary": "" }, { "name": "SPEED_OF_SOUND_M_PER_S", "kind": "constant", "signature": "SPEED_OF_SOUND_M_PER_S", "summary": "Boundary coefficients are R6's proven values. The SECTION COUNTS are not — they are derived from physics, and R6's were wrong. ## Section count is not a free parameter: it sets the tract LENGTH In this waveguide a wave advances one section per sample (`right[i] -> right[i+1]`), so each section is one sample of travel: sectionLength = c / sampleRate tractLength = numSections * c / sampleRate The count is therefore *determined* by the sample rate and the length you want. At 32 kHz with c = 340 m/s a section is 1.06 cm, so a 17.5 cm adult vocal tract needs **16 sections**, not 32. R6 used 32 sections at 32 kHz, which models a **34 cm** tube — twice human length. Nothing errors: the model is a perfectly valid tube, just the wrong one. Since a quarter-wave resonator's formants are `(2k-1)*c/(4L)`, doubling L puts EVERY formant an octave too low — F1 at ~260 Hz instead of ~500 Hz. That is not a subtle detune; it moves the formants out of the range speech sounds occupy, which is audible as muffled, \"underwater\", vowel-less noise no matter how clean the rest of the pipeline is. It was measured directly (F1 261 Hz, implied length 32.6 cm) by the uniform-tube calibration check in `tests/particle-voice/voicebox-audio.html`, which now guards it. Note the literature's 2x trap: a HALF-sample-delay Kelly-Lochbaum variant has `sectionLength = c/(2*sampleRate)`, for which 32 sections at 32 kHz WOULD be right (that is why published models quote e.g. 44 segments at 44.1 kHz). This implementation is the full-sample form, so the full-sample relation applies. The calibration test asserts the resulting length empirically rather than trusting either convention." }, { "name": "ADULT_TRACT_LENGTH_M", "kind": "constant", "signature": "ADULT_TRACT_LENGTH_M", "summary": "" }, { "name": "ADULT_NASAL_LENGTH_M", "kind": "constant", "signature": "ADULT_NASAL_LENGTH_M", "summary": "" }, { "name": "DEFAULT_TRACT_CONFIG", "kind": "constant", "signature": "DEFAULT_TRACT_CONFIG", "summary": "" }, { "name": "VISUAL_CHANNELS", "kind": "constant", "signature": "VISUAL_CHANNELS", "summary": "The per-sample solver signals the visualization field carries, in channel order. Exported so a renderer indexes channels by name instead of hard-coding 0/1/2." }, { "name": "DEFAULT_LF_SHAPE", "kind": "constant", "signature": "DEFAULT_LF_SHAPE", "summary": "LF shape defaults. `openQuotient` matches R6's `createGlottalSource({ openQuotient: 0.6 })`; the other two are LF-specific ratios with no R6 equivalent (R6 used the raised-cosine \"LF-lite\" shape that has no Tp/Ta at all)." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/articulatory/PhysiologyFeedbackState", "path": "agi/reference/particle_voice/articulatory/PhysiologyFeedbackState.md", "source": "agi/particle_voice/articulatory/PhysiologyFeedbackState.js", "import": "/agi/particle_voice/articulatory/PhysiologyFeedbackState.js", "sourceHash": "adbb8adf62de04bc7038811cd5b7a79a24d3aeef734d1dd099757c1e254922ff", "summary": "PhysiologyFeedbackState.js — Phase 2 Voice Box state schema (`v0`). `ARCHITECTURE.md` §4's `PhysiologyFeedbackState`: \"a reduced/decimated feedback signal from the acoustic solve back toward the model\". The JS-side timestamped container for one `nn/kernels/articulatory/physiology_feedback_reduce.js` dispatch's output — per-instance (mean, RMS) pairs, one pair per fixed-size frame — distinct from `TractStateSnapshot.js`'s multi-channel visualization field (`visual_state_decimate.js`'s output): this shape is what the model's control loop reads back, not what a rig/visual system reads. Every consumer of this state should treat it as internal-physiology feedback, not a real acoustic measurement — matching `spec/ActivityContract-v0.md` §8's `GeneratedPhysiologyEnergy` / `RenderedOutputEnergy` / `ObservedInputEnergy` three-domain separation (this is `GeneratedPhysiologyEnergy`'s reduced form, never to be confused with a microphone-observed or rendered-PCM-measured energy value).", "exports": [ { "name": "createPhysiologyFeedbackState", "kind": "function", "signature": "createPhysiologyFeedbackState({ sampleIndex, numFrames, mean, rms })", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/articulatory/TractStateSnapshot", "path": "agi/reference/particle_voice/articulatory/TractStateSnapshot.md", "source": "agi/particle_voice/articulatory/TractStateSnapshot.js", "import": "/agi/particle_voice/articulatory/TractStateSnapshot.js", "sourceHash": "10ed0ac0a50c92dc1214e3d28ce96a141d247a7ad534c1cf41922b5618cb408d", "summary": "TractStateSnapshot.js — Phase 2 Voice Box state schema (`v0`). `ARCHITECTURE.md` §4's `TractStateSnapshot`: \"low-rate timestamped state for rigs/visualization, decimated from the per-sample waveguide state\". The JS-side timestamped container for one `nn/kernels/articulatory/visual_state_decimate.js` dispatch's output — a `[channel, frame]` box-averaged field (one channel per tube section, per that kernel's docstring), NOT the model-feedback (mean, RMS) shape `PhysiologyFeedbackState.js` wraps (`physiology_feedback_reduce.js`'s output) — the two are read by different consumers (a rig/visual system here, the model's control loop there) and were kept as separate kernels for exactly this reason (see `visual_state_decimate.js`'s own docstring). Per `ARCHITECTURE.md` §4's requirement that visualization \"must be bit-identically disable-able without changing rendered PCM\", this container holds ONLY derived/decimated data for display — nothing here is ever read back into the acoustic path, matching `visual_state_decimate.js`'s structural read-only guarantee.", "exports": [ { "name": "createTractStateSnapshot", "kind": "function", "signature": "createTractStateSnapshot({ sampleIndex, numChannels, numFrames, field })", "summary": "" }, { "name": "channelSeries", "kind": "function", "signature": "channelSeries(snapshot, channel)", "summary": "Reads channel `channel`'s decimated time series out of a snapshot's flat `[channel, frame]` field — matches `visual_state_decimate.js`'s `(inst*num_channels+ch)*num_frames+frame` packing (single-instance view; the caller selects `channel`/`instance` slicing upstream of this helper)." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/articulatory/VoiceAnatomyProfile", "path": "agi/reference/particle_voice/articulatory/VoiceAnatomyProfile.md", "source": "agi/particle_voice/articulatory/VoiceAnatomyProfile.js", "import": "/agi/particle_voice/articulatory/VoiceAnatomyProfile.js", "sourceHash": "0bcf2ed0d4d2dbd00062ed90e14f1598429d046845c4ec3d16f83c27662cb386", "summary": "VoiceAnatomyProfile.js — Phase 2 Voice Box state schema (`v0`). `ARCHITECTURE.md` §4's `CharacterAnatomyState`: \"persistent per-character morphology (equivalent role to `PRVC-v0`'s `formantScale`/pitch-range calibration, but for non-cloned/authored characters rather than captured voices)\". This is the STATIC per-voice data that stays constant across frames — the rest-position oral tube area profile, optional nasal branch area profile, and the three boundary reflection coefficients `nn/kernels/articulatory/tract_waveguide.js`/`nasal_junction.js` require (`glottalReflection`/`lipReflection`/`nostrilReflection`, all magnitude `< 1` for BIBO stability per `risk/KellyLochbaumWaveguide.js` (R6)) — as distinct from `NeuralPhysiologyState`'s `TractGestureHead`, which is the per-FRAME predicted deviation/gesture applied on top of this rest profile, not a replacement for it. `risk/VoiceBoxWaveguideProbe.js` (R6/R6A) already proved out `NUM_SECTIONS = 32`/`NASAL_SECTIONS = 16`, `GLOTTAL_REFLECTION = 0.85`, `LIP_REFLECTION = -0.9`, `NOSTRIL_REFLECTION = -0.85` as one working anatomy — `defaultVoiceAnatomyProfile()` below reuses those exact proven values as the default rather than inventing new ones.", "exports": [ { "name": "createVoiceAnatomyProfile", "kind": "function", "signature": "createVoiceAnatomyProfile({ oralAreas, nasalAreas = null, glottalReflection = DEFAULT_GLOTTAL_REFLECTION, lipReflection = DEFAULT_LIP_REFLECTION, nostrilReflection = DEFAULT_NOSTRIL_REFLECTION, formantScale = 1, pitchRangeHz = { min: 80, max: 400 }, } = {})", "summary": "" }, { "name": "defaultVoiceAnatomyProfile", "kind": "function", "signature": "defaultVoiceAnatomyProfile()", "summary": "The R6/R6A-proven default anatomy (uniform tube, no nasal coupling) — a reasonable starting profile for an authored (non-cloned) character, not a claim of acoustic realism." }, { "name": "DEFAULT_NUM_ORAL_SECTIONS", "kind": "constant", "signature": "DEFAULT_NUM_ORAL_SECTIONS", "summary": "VoiceAnatomyProfile.js — Phase 2 Voice Box state schema (`v0`). `ARCHITECTURE.md` §4's `CharacterAnatomyState`: \"persistent per-character morphology (equivalent role to `PRVC-v0`'s `formantScale`/pitch-range calibration, but for non-cloned/authored characters rather than captured voices)\". This is the STATIC per-voice data that stays constant across frames — the rest-position oral tube area profile, optional nasal branch area profile, and the three boundary reflection coefficients `nn/kernels/articulatory/tract_waveguide.js`/`nasal_junction.js` require (`glottalReflection`/`lipReflection`/`nostrilReflection`, all magnitude `< 1` for BIBO stability per `risk/KellyLochbaumWaveguide.js` (R6)) — as distinct from `NeuralPhysiologyState`'s `TractGestureHead`, which is the per-FRAME predicted deviation/gesture applied on top of this rest profile, not a replacement for it. `risk/VoiceBoxWaveguideProbe.js` (R6/R6A) already proved out `NUM_SECTIONS = 32`/`NASAL_SECTIONS = 16`, `GLOTTAL_REFLECTION = 0.85`, `LIP_REFLECTION = -0.9`, `NOSTRIL_REFLECTION = -0.85` as one working anatomy — `defaultVoiceAnatomyProfile()` below reuses those exact proven values as the default rather than inventing new ones." }, { "name": "DEFAULT_NUM_NASAL_SECTIONS", "kind": "constant", "signature": "DEFAULT_NUM_NASAL_SECTIONS", "summary": "" }, { "name": "DEFAULT_GLOTTAL_REFLECTION", "kind": "constant", "signature": "DEFAULT_GLOTTAL_REFLECTION", "summary": "" }, { "name": "DEFAULT_LIP_REFLECTION", "kind": "constant", "signature": "DEFAULT_LIP_REFLECTION", "summary": "" }, { "name": "DEFAULT_NOSTRIL_REFLECTION", "kind": "constant", "signature": "DEFAULT_NOSTRIL_REFLECTION", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/articulatory/WaveguideAcousticState", "path": "agi/reference/particle_voice/articulatory/WaveguideAcousticState.md", "source": "agi/particle_voice/articulatory/WaveguideAcousticState.js", "import": "/agi/particle_voice/articulatory/WaveguideAcousticState.js", "sourceHash": "448316a5a8989253150f963573bbfa72eada9c9598dc53a4baa42e5768d48772", "summary": "WaveguideAcousticState.js — Phase 2 Voice Box state schema (`v0`). \"The R6 `KellyLochbaumWaveguide.js` tract's per-sample output (radiated signal + nasal tap)\" per `ARCHITECTURE.md` §4 — the JS-side timestamped container for one dispatched chunk's worth of `nn/kernels/articulatory/tract_waveguide.js` (`radiated`, plus the persisted `finalRight`/`finalLeft`/`finalPrevOutput` continuation state that kernel's packed output layout produces) and, optionally, a coupled `nn/kernels/articulatory/nasal_junction.js` chunk's own radiated output. This container does not itself dispatch either kernel or compute `nasalTapSignal` (`tract_waveguide.js`'s own docstring notes the nasal tap read-out is still deferred there) — it only fixes the shape a caller that DOES dispatch those kernels should hand back, so downstream consumers (the audio bridge, `physiology_feedback_reduce.js`, `visual_state_decimate.js`) have one stable state shape to depend on regardless of which kernel(s) produced it.", "exports": [ { "name": "createWaveguideAcousticState", "kind": "function", "signature": "createWaveguideAcousticState({ sampleIndex, numSamples, radiated, finalRight, finalLeft, finalPrevOutput, nasalRadiated = null })", "summary": "" }, { "name": "nextChunkInitialState", "kind": "function", "signature": "nextChunkInitialState(previousState)", "summary": "Builds the next chunk's initial-state inputs (`tract_waveguide.js`'s `initial_right`/`initial_left`/`initial_prev_output` bindings) from a previous chunk's `WaveguideAcousticState` — the exact cross-chunk continuity `tests/particle-voice/phase2-dsp.html`'s `tract_waveguide` test verifies at the kernel level." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/frontend/G2PModel", "path": "agi/reference/particle_voice/frontend/G2PModel.md", "source": "agi/particle_voice/frontend/G2PModel.js", "import": "/agi/particle_voice/frontend/G2PModel.js", "sourceHash": "c7cc69895f4d227ad78224baa6ece1a568c91edad1c547a17b2b00763ea9673e", "summary": "G2PModel.js — Phase 3 ParticleVoice text frontend. Grapheme-to-phoneme fallback for words `PronunciationLexicon.js` does not cover, plus `textToPhonemeSequence()` — the deterministic lowering `spec/VoicePlan-v0.md` §4 describes, which turns raw text into the `{ phonemeIds, stress, punctuationContext }` triple the model consumes. ## It is rules, not a network — deliberately The plan calls for a \"minimal `G2PModel.js`\" in Phase 3, and this is a **deterministic, context-sensitive letter-to-sound rule set**, not a trained model. That is the honest choice at this stage: a neural G2P needs a pronunciation corpus to train against, and this project vendors no external data (CMUdict included). Rules give reproducible output today, and the class boundary here is what a learned model would later slot into without touching callers. The name matches the plan's; the implementation does not pretend to be learned. ## Accuracy expectations, stated plainly English orthography is not a function of spelling alone, so a rule set of this size gets the regular cases right and a meaningful minority wrong (`read` has two pronunciations; `bread` breaks the `ea → IY` rule; stress placement in long words is genuinely lexical). That is exactly why `PronunciationLexicon.js` exists and is consulted FIRST — every word whose spelling actively lies belongs there. G2P's job is to make unseen words (character names, invented words, rare vocabulary) pronounceable and stable, not to be a dictionary. ## Rule format Each rule is `[leftContext, target, rightContext, phonemes]`, tried in order at each position, first match winning. Rules are authored longest-target-first per letter so digraphs beat single letters. The context pattern language is deliberately tiny — three metacharacters, no regex — so a rule's behaviour is obvious by inspection: `#` word boundary (start of a left context, end of a right context) `C` exactly one consonant letter `V` exactly one vowel letter anything else, a literal letter Stress is assigned afterwards by syllable heuristic (see `assignStressHeuristic`), because stress is a property of the whole word, not of any single grapheme.", "exports": [ { "name": "G2PModel", "kind": "class", "signature": "class G2PModel", "summary": "" }, { "name": "graphemesToPhonemeSymbols", "kind": "function", "signature": "graphemesToPhonemeSymbols(word)", "summary": "Apply the rule set to a spelling." }, { "name": "assignStressHeuristic", "kind": "function", "signature": "assignStressHeuristic(word, symbols)", "summary": "Place a single primary stress by syllable heuristic. Documented as a heuristic because English stress is genuinely lexical — the lexicon is the place to be exact. - Suffixes `-tion/-sion/-cial/-tial/-cian` pull stress onto the syllable immediately before them (na-TION-al → \"NA-tion\", in-for-MA-tion). - `-ity/-ety/-ify/-ogy/-omy` pull stress two syllables back. - Otherwise stress the first syllable, unless the word opens with a normally-unstressed prefix and has more than one syllable, in which case stress the second." }, { "name": "graphemesToPhonemes", "kind": "function", "signature": "graphemesToPhonemes(word)", "summary": "" }, { "name": "textToPhonemeSequence", "kind": "function", "signature": "textToPhonemeSequence(normalized, { g2p = new G2PModel()", "summary": "Deterministic lowering of normalized text into `spec/VoicePlan-v0.md` §4's `PhonemeSequence`. All three arrays are the same length, one entry per phoneme instance including structural tokens, exactly as that spec requires. Structural insertion follows `spec/PhonemeSet-v0.md` §4's Effect column: a phrase's `structural` token (`SP` for comma-level, `SIL` for terminals) is appended after its words, and a paragraph boundary additionally emits `BREATH` before its `SIL` (§4: \"longer SIL, breath event likely\")." }, { "name": "createG2PModel", "kind": "function", "signature": "createG2PModel(options)", "summary": "" }, { "name": "LTS_RULES", "kind": "constant", "signature": "LTS_RULES", "summary": "Letter-to-sound rules, grouped by first letter of `target`. Order within a group IS the priority order." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/frontend/PhonemeSet", "path": "agi/reference/particle_voice/frontend/PhonemeSet.md", "source": "agi/particle_voice/frontend/PhonemeSet.js", "import": "/agi/particle_voice/frontend/PhonemeSet.js", "sourceHash": "7d7c3c56c4e63354c33e516a24aa3efded914b60af82ec5adeac4e5c9c1dd821", "summary": "PhonemeSet.js — Phase 3 ParticleVoice text frontend. The executable form of `spec/PhonemeSet-v0.md`: the English phoneme inventory, its per-entry articulatory feature vectors, the stress scale, and the punctuation-context tags. This module is the SINGLE SOURCE OF TRUTH every other Phase 3 component reads — `PronunciationLexicon.js` validates against it, `G2PModel.js` targets it, `PhonemeEncoder.js` sizes its embedding table from `PHONEME_COUNT`, and `ArticulationHead.js` consumes the feature vectors to bias `NeuralPhysiologyState`. ## Corrections to `spec/PhonemeSet-v0.md` Encoding the spec surfaced four places where its §1 tables (the actual data) disagree with its §1 summary line or its §2 enum declarations. The tables are treated as normative and the spec has been corrected to match; each is recorded here because a reader comparing the two must know which way the discrepancy was resolved. 1. **Inventory size.** §1 claimed \"24 vowel symbols + 24 consonant symbols + 3 structural tokens = 51\" and `u8` IDs `0..50`. The tables actually list **10 monophthongs + 5 diphthongs = 15 vowels**, so the real total is **42** entries, IDs `0..41`. \"24 vowel symbols\" appears to be an accidental duplication of the consonant count. This matters concretely: it sets `PhonemeEncoder.js`'s embedding table size and the legal `phonemeIds` range in `spec/VoicePlan-v0.md` §4, both of which were also stated as 51/`0..50` and are now corrected. 2. **Vowel height values.** §2 declares `height: low | mid | high`, but §1's table also uses `low-mid` (`AO`) and `high-mid` (`UH`). All five values are kept (see `HEIGHT`); the narrower §2 enum was the error. 3. **`ER`'s rounded column** contains `rhotic`, which is not a rounded-ness value at all. Modeled here as `rounded: false` plus a separate `rhotic: true` flag, since rhoticity is an independent articulatory property (it shapes the area profile rather than the lip aperture). 4. **`W`'s place** is `bilabial-velar` in §1's table, which is not one of §2's `place` values. Modeled as `place: 'bilabial'` with `secondaryPlace: 'velar'`, preserving the information without inventing an enum member the spec does not define. Structural tokens (`SIL`/`SP`/`BREATH`) carry `place: null`, `manner: null`, `voiced: false` and are identified by `category === 'structural'` — deliberately NOT given invented enum values, since §2's `place`/`manner` enums describe articulated speech sounds only.", "exports": [ { "name": "phonemeIdOf", "kind": "function", "signature": "phonemeIdOf(symbol)", "summary": "" }, { "name": "hasPhoneme", "kind": "function", "signature": "hasPhoneme(symbol)", "summary": "" }, { "name": "phonemeAt", "kind": "function", "signature": "phonemeAt(id)", "summary": "" }, { "name": "phonemeBySymbol", "kind": "function", "signature": "phonemeBySymbol(symbol)", "summary": "" }, { "name": "diphthongTargetIds", "kind": "function", "signature": "diphthongTargetIds(id)", "summary": "" }, { "name": "constrictionPositionOf", "kind": "function", "signature": "constrictionPositionOf(id)", "summary": "" }, { "name": "isValidStress", "kind": "function", "signature": "isValidStress(stress)", "summary": "" }, { "name": "isValidPunctuationContext", "kind": "function", "signature": "isValidPunctuationContext(tag)", "summary": "" }, { "name": "isVowel", "kind": "function", "signature": "isVowel(id)", "summary": "" }, { "name": "isConsonant", "kind": "function", "signature": "isConsonant(id)", "summary": "" }, { "name": "isStructural", "kind": "function", "signature": "isStructural(id)", "summary": "" }, { "name": "isVoiced", "kind": "function", "signature": "isVoiced(id)", "summary": "" }, { "name": "isDiphthong", "kind": "function", "signature": "isDiphthong(id)", "summary": "" }, { "name": "STRESS", "kind": "constant", "signature": "STRESS", "summary": "§3: per-vowel-instance stress, separate from the phoneme symbol." }, { "name": "PUNCTUATION_CONTEXT", "kind": "constant", "signature": "PUNCTUATION_CONTEXT", "summary": "§4: punctuation-context tag ids, emitted per phoneme by `TextNormalizer.js`." }, { "name": "PLACE", "kind": "constant", "signature": "PLACE", "summary": "" }, { "name": "MANNER", "kind": "constant", "signature": "MANNER", "summary": "" }, { "name": "HEIGHT", "kind": "constant", "signature": "HEIGHT", "summary": "Includes §1's `low-mid`/`high-mid`, which §2's three-value enum omitted (correction 2)." }, { "name": "BACKNESS", "kind": "constant", "signature": "BACKNESS", "summary": "" }, { "name": "PLACE_POSITION", "kind": "constant", "signature": "PLACE_POSITION", "summary": "§2: place → normalized position (0 = glottis, 1 = lips) of the narrowest point, fed to `shapedAreaProfile`'s control points. Provisional estimates per the spec's own §6 — NOT measured against vocal-tract MRI data." }, { "name": "PHONEMES", "kind": "constant", "signature": "PHONEMES", "summary": "The inventory, in `spec/PhonemeSet-v0.md` §1 table order. **Array index IS the `u8` phoneme id** — appending is safe, reordering is a breaking change to every trained embedding table." }, { "name": "PHONEME_COUNT", "kind": "constant", "signature": "PHONEME_COUNT", "summary": "42 — sizes `PhonemeEncoder.js`'s embedding table. See correction 1." }, { "name": "MAX_PHONEME_ID", "kind": "constant", "signature": "MAX_PHONEME_ID", "summary": "Highest legal `u8` phoneme id (41)." }, { "name": "STRUCTURAL_SYMBOLS", "kind": "constant", "signature": "STRUCTURAL_SYMBOLS", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/frontend/PronunciationLexicon", "path": "agi/reference/particle_voice/frontend/PronunciationLexicon.md", "source": "agi/particle_voice/frontend/PronunciationLexicon.js", "import": "/agi/particle_voice/frontend/PronunciationLexicon.js", "sourceHash": "b99b1bb0da549f99d195ede8f5a035789cc49a13f03e37ebe170c254bfcd4276", "summary": "PronunciationLexicon.js — Phase 3 ParticleVoice text frontend. Word → phoneme-sequence dictionary, checked entry-by-entry against `PhonemeSet.js` at construction time. Sits between `TextNormalizer.js` and `G2PModel.js`: a lexicon hit is authoritative, and only words with no entry fall through to G2P's letter-to-sound rules. ## ⚠ Stress digits are the INVERSE of CMUdict Pronunciation strings use CMUdict's familiar `SYMBOL+digit` shape (`HH AH L OW2`), but the digit follows `spec/PhonemeSet-v0.md` §3: **0 = unstressed, 1 = SECONDARY, 2 = PRIMARY** CMUdict is the other way round (`1` = primary, `2` = secondary). Copying CMUdict strings verbatim would therefore silently swap primary and secondary stress on every polysyllabic word — audible as wrong prosody, not as an error. This module cannot detect that mistake for you, so the convention is stated here, in `spec/PhonemeSet-v0.md` §3, and enforced by `MAX_STRESS`-range validation only. ## Authoring rules (validated, not merely documented) - Every symbol must exist in `PhonemeSet.js`. A typo throws at construction, naming the word — never at synthesis time. - A stress digit is legal ONLY on a vowel. Spec §3 defines stress as a per-vowel-instance property, so `S2` is rejected outright rather than quietly ignored. - Omitting the digit on a vowel means unstressed (0). This keeps reduced function words (`the` = `DH AH`) readable. - **At most one** primary stress per word. Not *exactly* one: genuinely reduced function words (`the`, `a`, `of`) carry no stress at all, and forcing a primary onto them would produce robotically over-stressed speech. ## Scope `CORE_LEXICON` is a deliberately curated core, NOT a full dictionary. It covers high-frequency function/content words plus — the reason a lexicon exists at all — words whose spelling actively lies about their pronunciation (`one`, `through`, `women`, `said`, `colonel`, `choir`, `island`), which any letter-to-sound rule set gets wrong. CMUdict is not vendored: this project takes no external data dependencies, and the long tail is `G2PModel.js`'s job. Callers add domain vocabulary (character names, place names) via `add()`/`addAll()`.", "exports": [ { "name": "PronunciationLexicon", "kind": "class", "signature": "class PronunciationLexicon", "summary": "" }, { "name": "parsePronunciation", "kind": "function", "signature": "parsePronunciation(pronunciation, wordLabel = '')", "summary": "Parse one `SYMBOL+digit` pronunciation string." }, { "name": "createPronunciationLexicon", "kind": "function", "signature": "createPronunciationLexicon(options)", "summary": "" }, { "name": "MAX_STRESS", "kind": "constant", "signature": "MAX_STRESS", "summary": "" }, { "name": "LETTER_NAMES", "kind": "constant", "signature": "LETTER_NAMES", "summary": "Spoken letter names, for spelling out initialisms. `TextNormalizer.js` flags all-caps tokens with `wasAllCaps` but deliberately does not decide whether they are words or initialisms; `spellOut()` here is the mechanism for the latter." }, { "name": "CORE_LEXICON", "kind": "constant", "signature": "CORE_LEXICON", "summary": "Curated core lexicon. Stress digits: 2 = PRIMARY (see the warning above). Grouped by why each entry is here." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/frontend/TextNormalizer", "path": "agi/reference/particle_voice/frontend/TextNormalizer.md", "source": "agi/particle_voice/frontend/TextNormalizer.js", "import": "/agi/particle_voice/frontend/TextNormalizer.js", "sourceHash": "ddc390177f2ebb15055b52bc90e4b1f6bebf549283dafb49299720ab4ab60cbc", "summary": "TextNormalizer.js — Phase 3 ParticleVoice text frontend. Turns raw author/LLM text into speakable words plus the per-phrase punctuation-context tags `spec/PhonemeSet-v0.md` §4 defines, ready for `PronunciationLexicon.js`/`G2PModel.js` to lower into phoneme ids. Output shape (`normalizeText`): { raw: string, phrases: [{ words: [{ text, wasAllCaps }], boundary: PUNCTUATION_CONTEXT id, // §4 tag for THIS phrase's end structural: 'SP' | 'SIL' | null, // token to insert at the boundary breathLikely: boolean, // §4: paragraph breaks only }] } One tag per phrase (not per phoneme): `spec/VoicePlan-v0.md` §4's per-phoneme `punctuationContext` array is produced downstream by repeating a phrase's tag across the phonemes its words expand into, which is exactly what that spec means by \"repeats within a phrase, changes at boundaries\". ## Ordering matters Abbreviation expansion and decimal-point protection run BEFORE phrase splitting, because both consume `.` characters that would otherwise be mistaken for sentence terminators — `Dr. Smith` is one phrase, not two, and `3.14` is one number, not `3` then `14`. Getting this order wrong is the classic text-frontend bug, so it is enforced by construction here rather than left to a later cleanup pass. ## Deliberate non-guesses Two things this module refuses to infer, because guessing wrong is worse than not trying: - **Years.** `1999` could be a year (\"nineteen ninety nine\") or a quantity (\"one thousand nine hundred ninety nine\"), and `1500 dollars` proves the quantity reading is often right. Bare integers are ALWAYS read as cardinals; `expandYear()` is exported for callers that actually know the context (e.g. a date field), rather than being applied by a heuristic that would silently corrupt prices and counts. - **Acronym pronunciation.** `NASA` is said as a word, `USA` letter by letter, and nothing in the surface form distinguishes them. All-caps tokens are passed through with `wasAllCaps: true` so `PronunciationLexicon.js` gets first refusal and `G2PModel.js` can fall back to spelling out — the decision belongs where the pronunciation knowledge lives, not here. Dates and clock times are likewise out of scope for `v0` (both are format-ambiguous: `3/4` is a date in one locale and a fraction in another). They are documented as unhandled rather than half-handled.", "exports": [ { "name": "expandCardinal", "kind": "function", "signature": "expandCardinal(n)", "summary": "" }, { "name": "expandOrdinal", "kind": "function", "signature": "expandOrdinal(n)", "summary": "" }, { "name": "expandDigits", "kind": "function", "signature": "expandDigits(digits)", "summary": "" }, { "name": "expandYear", "kind": "function", "signature": "expandYear(year)", "summary": "Read a 4-digit year the way speech does. NOT applied automatically — see this module's \"deliberate non-guesses\" note; callers that know a number is a year opt in explicitly." }, { "name": "normalizeCharacters", "kind": "function", "signature": "normalizeCharacters(raw)", "summary": "Unicode/typography normalization: NFKC, curly quotes and dashes to ASCII, whitespace collapsed (paragraph breaks preserved as `\\n\\n`)." }, { "name": "normalizeText", "kind": "function", "signature": "normalizeText(raw)", "summary": "" }, { "name": "flattenWords", "kind": "function", "signature": "flattenWords(normalized)", "summary": "" }, { "name": "MAX_CARDINAL", "kind": "constant", "signature": "MAX_CARDINAL", "summary": "" }, { "name": "ABBREVIATIONS", "kind": "constant", "signature": "ABBREVIATIONS", "summary": "Expanded before phrase splitting, so their trailing `.` never reads as a sentence end. Keys are matched case-insensitively without the period." }, { "name": "SYMBOL_WORDS", "kind": "constant", "signature": "SYMBOL_WORDS", "summary": "Standalone symbol → word. Applied per token, so `&` between words works but `AT&T` is left to the lexicon." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/lab/ManualArticulator", "path": "agi/reference/particle_voice/lab/ManualArticulator.md", "source": "agi/particle_voice/lab/ManualArticulator.js", "import": "/agi/particle_voice/lab/ManualArticulator.js", "sourceHash": "e2aa28a20c38cb338c70ec14130e5c7f5142eddc816eb2df922d5bed3b07c73c", "summary": "ManualArticulator.js — Phase 3 ParticleVoice lab. Turns direct articulator controls (the Voice Box demo's sliders) into the SAME physiology-stream shape `ArticulationHead.predict()` produces, so `ParticleVoiceModel.renderPhysiology()` accepts it unchanged. ## Why this is a module and not inline demo code The plan requires the live demo to have \"manual articulator mode + neural mode; same `VisualAirflowState`\". If manual mode built its own control path — or worse, called `ParticleTract` directly — the two modes would diverge: different smoothing, different validation, a different visualization source. By emitting the identical stream shape, manual mode goes through exactly the same `renderPhysiology()` → `ParticleTract` → `SafetyLimiter` path, and the visualization comes from the same solver snapshots. That makes \"same VisualAirflowState\" structural rather than a promise, and it means this logic is testable headlessly instead of only by clicking. ## Controls Deliberately the physical knobs, not phonemes — the point of manual mode is to drive the tract directly: - `f0Hz`, `voiced` — glottal source - `constrictionPosition` (0 = glottis, 1 = lips) and `constrictionArea` — one moving constriction, the single most expressive articulator - `pharynxArea`, `lipArea` — the tube's two ends - `nasalCoupling` — velum - `fricationAmplitude` — turbulence at the constriction - `pressure` — subglottal drive A held pose is rendered as a constant stream; `interpolatePoses()` produces a glide between two poses, which is how the demo can sweep a diphthong or a closure/release gesture without hand-authoring every frame.", "exports": [ { "name": "ManualArticulator", "kind": "class", "signature": "class ManualArticulator", "summary": "" }, { "name": "normalizePose", "kind": "function", "signature": "normalizePose(pose = {})", "summary": "Validate and clamp a partial pose into a complete one." }, { "name": "interpolatePoses", "kind": "function", "signature": "interpolatePoses(a, b, t)", "summary": "Linear blend between two poses; `voiced` switches at the midpoint since it is boolean." }, { "name": "poseAreaProfile", "kind": "function", "signature": "poseAreaProfile(pose, numSections)", "summary": "Area profile for one pose, using the same 3-control-point `shapedAreaProfile` shape `ArticulationHead` uses for vowels." }, { "name": "createManualArticulator", "kind": "function", "signature": "createManualArticulator(options)", "summary": "" }, { "name": "DEFAULT_POSE", "kind": "constant", "signature": "DEFAULT_POSE", "summary": "" }, { "name": "POSE_CONTROLS", "kind": "constant", "signature": "POSE_CONTROLS", "summary": "Slider metadata for the demo UI, kept beside the pose it describes so the two cannot drift apart." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/lab/TractSagittalView", "path": "agi/reference/particle_voice/lab/TractSagittalView.md", "source": "agi/particle_voice/lab/TractSagittalView.js", "import": "/agi/particle_voice/lab/TractSagittalView.js", "sourceHash": "942497f48f9c80bea8834b00e8d7d25aed300f421077e4fd8efcb6f4a1605cb4", "summary": "TractSagittalView.js — mid-sagittal renderer for the vocal tract area function. Draws what the solver is actually doing, as an anatomical cross-section: the pharynx rising from the glottis, the bend behind the tongue, the oral cavity, the teeth and the lips. The tract's `areas` array IS the picture — section `i` is a slice of tube, and its cross-sectional area is the gap between the tongue surface and the roof of the mouth at that point. ## Why a sagittal view rather than a plot of the numbers A line plot of 32 areas is readable but not *diagnosable*: it does not tell you whether a shape is a plausible mouth. Errors in this project have repeatedly been of exactly that kind — a tract twice the correct length, a \"stop\" whose closure never closed, a constriction so tight it would whistle. All of those are obvious at a glance in an anatomical view and invisible in a spectrum. ## Geometry The centreline follows an arc, matching how the real tract bends ~90 degrees behind the tongue: the glottis end points up, the lip end points forward. Each section is drawn radially across that arc, with the OUTER boundary fixed (the rigid palate, teeth and rear pharyngeal wall) and the INNER boundary displaced by the section's diameter (the tongue and jaw, which are what move). Diameter, not area, sets the drawn width: a tube's diameter goes as the SQUARE ROOT of its area, so plotting area directly would exaggerate open sections and make near-closures look tighter than they are.", "exports": [ { "name": "TractSagittalView", "kind": "class", "signature": "class TractSagittalView", "summary": "Renders one frame of tract geometry. Stateless by design: it takes the geometry and draws it, so the same view can be driven by `ArticulationHead`'s per-frame stream, by `ManualArticulator`'s live sliders, or by a single static profile from `FormantSolver`, with no notion of playback inside it." }, { "name": "diameterForArea", "kind": "function", "signature": "diameterForArea(areaCm2)", "summary": "" }, { "name": "LANDMARKS", "kind": "constant", "signature": "LANDMARKS", "summary": "Anatomical landmarks as a fraction of tract length from the glottis, used only for labels and the teeth marker." }, { "name": "DEFAULT_VIEW_OPTIONS", "kind": "constant", "signature": "DEFAULT_VIEW_OPTIONS", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/model/ArticulationHead", "path": "agi/reference/particle_voice/model/ArticulationHead.md", "source": "agi/particle_voice/model/ArticulationHead.js", "import": "/agi/particle_voice/model/ArticulationHead.js", "sourceHash": "2edfa30adfbaba9b6e993d08a1381f7a4bf43d21cc13de20b14dc0fcb9442b33", "summary": "ArticulationHead.js — Phase 3 ParticleVoice model. Per-frame streams → `NeuralPhysiologyState` (`articulatory/NeuralPhysiologyState.js`): the four control heads plus uncertainty that `ParticleTract` actually consumes. This is where `spec/PhonemeSet-v0.md` §2's articulatory feature vectors finally reach the vocal tract — place becomes a constriction position, manner becomes a constriction degree, height/backness/rounded become a vowel area profile. ## Rule-based, mapping features to geometry Like `ProsodyPlanner`, this is a deterministic feature→geometry mapping, not a trained head. `spec/PhonemeSet-v0.md` §6 already flags its place-position percentages as \"provisional estimates ... not measured against real vocal-tract MRI data\", and the vowel profiles here are the same kind of estimate: a 3-control-point `shapedAreaProfile` whose constriction position comes from backness, constriction area from height, and lip area from rounding. They are ordered correctly (high vowels narrower than low, front constrictions further forward than back) and produce distinguishable formants — verified in Phase 2 to be what makes a vowel a vowel rather than a buzz — but they are not fitted to measured data. ## Two constraints that are NOT stylistic 1. **`ee` must be strictly positive, even when unvoiced.** It is tempting to set the glottal excitation to 0 on a voiceless frame. That breaks `glottal_lf.js`: its Newton solve for `alpha` computes `areaPrime = (-ee / sin(wg*te)) * (...)`, so `ee = 0` makes the derivative exactly 0 and the update `alpha -= (area - target) / 0` evaluates to **NaN**, which then propagates through the whole waveguide. `NeuralPhysiologyState`'s own validator independently requires `ee > 0`. Voiceless frames therefore use a small positive `UNVOICED_EE` — inaudible, but numerically safe. 2. **Areas are SMOOTHED across frames, per-manner.** Snapping the area profile to a new target at a phoneme boundary is a step change in the waveguide's reflection coefficients, which radiates as a click — the precise artifact Phase 2's exit gate spent effort eliminating. Each manner gets its own time constant because the right smoothing speed is phonetically real, not a tuning knob: a stop's closure and release ARE fast (smearing them destroys the plosive), while a vowel-to-vowel transition is genuinely slow. A single global constant would either smear plosives or click on vowels. ## Output shape `predict()` returns COMPACT typed arrays (one row per frame), not an array of frozen `NeuralPhysiologyState` objects: a few seconds of speech is hundreds of frames, and materializing hundreds of frozen nested objects per utterance would be wasteful when the consumer reads them once, in order. `physiologyStateAt(result, frame)` builds the real validated schema object on demand, so the schema is genuinely exercised (and validated) rather than bypassed.", "exports": [ { "name": "ArticulationHead", "kind": "class", "signature": "class ArticulationHead", "summary": "" }, { "name": "physiologyStateAt", "kind": "function", "signature": "physiologyStateAt(result, frame, { glottalReflection, lipReflection } = {})", "summary": "Materialize one frame of a `predict()` result as a validated `NeuralPhysiologyState`. Built on demand rather than eagerly — see the header's \"output shape\" note — so the schema and its validators are genuinely exercised without allocating hundreds of frozen objects per utterance." }, { "name": "createArticulationHead", "kind": "function", "signature": "createArticulationHead(config)", "summary": "" }, { "name": "UNVOICED_EE", "kind": "constant", "signature": "UNVOICED_EE", "summary": "Small but strictly positive glottal excitation for voiceless frames. See constraint 1 in the header: 0 would make `glottal_lf.js`'s Newton solve produce NaN." }, { "name": "BACKNESS_POSITION", "kind": "constant", "signature": "BACKNESS_POSITION", "summary": "Fallback constriction position (0 = glottis, 1 = lips) by vowel backness, and cross-section by height. These are NO LONGER the primary path for the ten monophthongs — see `vowelProfile()`. They were an articulatory-adjective mapping (\"front vowels constrict further forward\", \"high vowels constrict more tightly\") that is directionally right but produces whatever formants it happens to produce. Since vowel identity is carried almost entirely by F1/F2, \"plausible geometry\" is not good enough: uncalibrated profiles pull every vowel toward a neutral timbre, which is heard as speech-like noise with no decipherable vowels. Retained only as the fallback for any vowel with no entry in `VOWEL_AREA_PARAMS`, so adding a phoneme to `PhonemeSet` cannot crash synthesis before it has been calibrated." }, { "name": "HEIGHT_AREA", "kind": "constant", "signature": "HEIGHT_AREA", "summary": "" }, { "name": "MANNER_WIDTH", "kind": "constant", "signature": "MANNER_WIDTH", "summary": "Constriction LENGTH by manner, as a fraction of tract length. A constriction specified as a single control point does not survive `shapedAreaProfile`'s linear interpolation: the profile tapers to the target only exactly AT that point, and since the point rarely lands on a section centre, the realised minimum is far wider than requested. Measured, a stop asking for 0.02 cm^2 actually reached **0.138** — nearly 7x too open. That is not a cosmetic error: a stop whose closure never closes produces neither the silence nor the release burst that identify it, and stops are six of the most frequent consonants in English. The effect got worse when the section count was corrected from 32 to 16, because coarser sections smear a point further. Giving the constriction a length makes it span whole sections, so it genuinely reaches the target area. The values are anatomical: a stop's occlusion covers roughly 1.5-2 cm of the tract, a fricative channel is comparable, and an approximant's narrowing is longer and gentler. At 17 cm / 16 sections one section is 1.06 cm, so 0.10 (1.7 cm) is about 1.6 sections — enough to hold the target rather than merely touch it." }, { "name": "MANNER_AREA", "kind": "constant", "signature": "MANNER_AREA", "summary": "Constriction cross-section by consonant manner — the \"degree\" half of spec §2's place/manner pair." }, { "name": "VOICING_TIME_MS", "kind": "constant", "signature": "VOICING_TIME_MS", "summary": "Smoothing time constant for the glottal excitation amplitude. `ee` switches between `voicedEe` (1.0) and `UNVOICED_EE` (1e-3) — a factor of a THOUSAND, i.e. a 60 dB step. Applied instantaneously that is a hard click at every voicing transition, and an English sentence has one at every voiceless consonant; several per second turns into a sputter that swamps the speech. Real vocal folds cannot change amplitude discontinuously either, so smoothing here is physical as well as necessary. ~18 ms is fast enough to keep a voiceless stop sounding unvoiced (its closure alone is ~25 ms) while removing the step." }, { "name": "GESTURE_TIME_MS", "kind": "constant", "signature": "GESTURE_TIME_MS", "summary": "Area-smoothing time constants in ms, by manner — the speed of the ARTICULATOR, nothing else. ## These were far too slow, and every stop in every utterance was a glide The previous values (stop 25 ms, vowel 50 ms) were justified by the claim that \"a stop at 25 ms still reaches ~94% of its closure within a typical 70 ms stop, so the plosive is preserved\". That reasoning is wrong, and wrong in a way worth recording: it measures the PERCENTAGE OF DISTANCE travelled, but what decides whether a stop is a stop is the ABSOLUTE area reached. Going 94% of the way from a vowel's ~3.0 cm^2 to a 0.02 cm^2 closure leaves **0.18 cm^2** — which is not a closure at all, it is a narrow approximant. So the tract never actually blocked, no stop ever produced silence or a release burst, and all six English stops came out as vowel-like glides. Perceptually the whole utterance collapses toward a string of semivowels, which is exactly the reported \"yeah yeah yeah\". For a target near zero, percentage-of-distance and absolute-value diverge arbitrarily far. This is the same relative-versus-absolute confusion that produced the earlier bad thresholds in this project. ## Why they can now be as fast as the phonetics actually requires These constants USED to be doing two jobs: modelling articulator inertia AND preventing the per-chunk reflection-coefficient step from clicking. The second job is gone — `tract_waveguide.js` now interpolates `junction_k` per sample, so geometry is continuous no matter how fast the frame targets move. That frees these to be purely phonetic. O'Connor et al. (1957) found listeners hear a formant transition as a STOP below ~50 ms and as a SEMIVOWEL above it, so a stop's gesture must complete well inside 50 ms. At the 10 ms frame interval, tau = 8 ms gives alpha 0.71, reaching 0.026 cm^2 (a real closure) within 50 ms. Approximants stay slower: the same literature has /w j r l/ holding their formant loci for 30-50 ms, i.e. genuinely gliding rather than snapping." }, { "name": "RELEASE_AREA_CM2", "kind": "constant", "signature": "RELEASE_AREA_CM2", "summary": "Stop RELEASE BURST. A plosive is two acoustic events, not one: a silent closure, then a sharp transient when the occlusion opens and the pressure built up behind it escapes. Only the closure was being modelled, so stops had the right silence and then simply faded back into the next vowel. The burst is a primary place cue — much of what distinguishes /p/ from /t/ from /k/ lives in its spectrum — so without it stops are detectable but not identifiable. Pink Trombone models the same thing, adding a transient whenever a diameter goes from zero to positive; this is the equivalent, expressed through the turbulence channel that already exists rather than as a new kernel input, since a burst IS a brief broadband excitation at the constriction. Detection uses the SMOOTHED area, not the phoneme label: what matters is that the tract actually opened, which is the same reason the closure test asserts realised rather than target geometry. `RELEASE_AREA_CM2` is the threshold below which the tract counts as closed, matching the closure the test requires." }, { "name": "BURST_AMPLITUDE", "kind": "constant", "signature": "BURST_AMPLITUDE", "summary": "" }, { "name": "BURST_TIME_MS", "kind": "constant", "signature": "BURST_TIME_MS", "summary": "Burst decay. ~8 ms puts the transient plus its aspiration in the 10-30 ms range measured for real plosive releases." }, { "name": "FRICATION_PLACE_GAIN", "kind": "constant", "signature": "FRICATION_PLACE_GAIN", "summary": "" }, { "name": "VOICED_FRICATION_GAIN", "kind": "constant", "signature": "VOICED_FRICATION_GAIN", "summary": "" }, { "name": "DEFAULT_ARTICULATION_CONFIG", "kind": "constant", "signature": "DEFAULT_ARTICULATION_CONFIG", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/model/LengthRegulator", "path": "agi/reference/particle_voice/model/LengthRegulator.md", "source": "agi/particle_voice/model/LengthRegulator.js", "import": "/agi/particle_voice/model/LengthRegulator.js", "sourceHash": "4f465197f6c3f3eddb6be39697fe9937780b792ac89bdaeb6d868bcdd46292e9", "summary": "LengthRegulator.js — Phase 3 ParticleVoice model. Expands per-PHONEME encoder features and prosody into per-FRAME streams, and — because `spec/VoicePlan-v0.md` §5 explicitly assigns it here — handles resampling between the 100 Hz plan frame rate and whatever rate the consumer runs at (the Activity path is 8 ms/frame = 125 Hz, `ActivityContract-v0` §1; the two \"are not required to be equal; any resampling between them is `LengthRegulator.js`'s job, not assumed away here\"). ## F0 is interpolated, features are held These two streams are expanded differently, on purpose: - **F0 is linearly interpolated** between phoneme centres. Holding one value per phoneme would produce a pitch STAIRCASE, and a discontinuous F0 is audible as a click or a warble at every phoneme boundary — the exact artifact the Phase 2 exit gate spent effort eliminating from the waveguide. Interpolating between centres (not edges) means each phoneme's nominal pitch is actually reached at its midpoint. - **Feature vectors are HELD** across a phoneme's frames, not interpolated. They are a learned representation, and blending two phonemes' embeddings produces a vector that means neither. Holding is the standard FastSpeech-style length regulation and is what the downstream `ArticulationHead` expects. - **The voiced flag is held** — it is boolean; interpolating it would invent half-voiced frames that no source model can honour. ## Where it runs CPU-side. The encoder's features are produced on GPU, so using them here costs a readback — but the consumer (`ArticulationHead` → `ParticleTract`) needs per-chunk control values in JS anyway (`areas`, `f0Hz`), so the readback is not avoided by moving this to GPU, only relocated. A GPU `length_regulate` gather kernel is a straightforward follow-up IF profiling later shows the feature upload dominating; the condition that would justify it is stated so the decision is revisitable rather than forgotten.", "exports": [ { "name": "LengthRegulator", "kind": "class", "signature": "class LengthRegulator", "summary": "" }, { "name": "regulateLength", "kind": "function", "signature": "regulateLength({ durationFrames, f0Hz, voiced, features = null, featureDim = 0, maxFrames = 1 << 20 })", "summary": "Expand per-phoneme streams to per-frame streams. durationFrames: ArrayLike, f0Hz: ArrayLike, voiced: ArrayLike, features?: ArrayLike, featureDim?: number, maxFrames?: number, }} input" }, { "name": "resampleFrames", "kind": "function", "signature": "resampleFrames(regulated, fromRateHz, toRateHz, featureDim = 0)", "summary": "Resample per-frame streams from one frame rate to another — the job `spec/VoicePlan-v0.md` §5 assigns to this module for crossing between the 100 Hz plan rate and the 125 Hz Activity rate. F0 is linearly interpolated (it is continuous); voicing and the phoneme index use NEAREST-neighbour, because both are categorical and interpolating them would invent values that do not exist (a half-voiced frame, or a fractional phoneme id)." }, { "name": "createLengthRegulator", "kind": "function", "signature": "createLengthRegulator(options)", "summary": "" }, { "name": "ACTIVITY_FRAME_RATE_HZ", "kind": "constant", "signature": "ACTIVITY_FRAME_RATE_HZ", "summary": "LengthRegulator.js — Phase 3 ParticleVoice model. Expands per-PHONEME encoder features and prosody into per-FRAME streams, and — because `spec/VoicePlan-v0.md` §5 explicitly assigns it here — handles resampling between the 100 Hz plan frame rate and whatever rate the consumer runs at (the Activity path is 8 ms/frame = 125 Hz, `ActivityContract-v0` §1; the two \"are not required to be equal; any resampling between them is `LengthRegulator.js`'s job, not assumed away here\"). ## F0 is interpolated, features are held These two streams are expanded differently, on purpose: - **F0 is linearly interpolated** between phoneme centres. Holding one value per phoneme would produce a pitch STAIRCASE, and a discontinuous F0 is audible as a click or a warble at every phoneme boundary — the exact artifact the Phase 2 exit gate spent effort eliminating from the waveguide. Interpolating between centres (not edges) means each phoneme's nominal pitch is actually reached at its midpoint. - **Feature vectors are HELD** across a phoneme's frames, not interpolated. They are a learned representation, and blending two phonemes' embeddings produces a vector that means neither. Holding is the standard FastSpeech-style length regulation and is what the downstream `ArticulationHead` expects. - **The voiced flag is held** — it is boolean; interpolating it would invent half-voiced frames that no source model can honour. ## Where it runs CPU-side. The encoder's features are produced on GPU, so using them here costs a readback — but the consumer (`ArticulationHead` → `ParticleTract`) needs per-chunk control values in JS anyway (`areas`, `f0Hz`), so the readback is not avoided by moving this to GPU, only relocated. A GPU `length_regulate` gather kernel is a straightforward follow-up IF profiling later shows the feature upload dominating; the condition that would justify it is stated so the decision is revisitable rather than forgotten." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/model/ParticleVoiceModel", "path": "agi/reference/particle_voice/model/ParticleVoiceModel.md", "source": "agi/particle_voice/model/ParticleVoiceModel.js", "import": "/agi/particle_voice/model/ParticleVoiceModel.js", "sourceHash": "ceb7f417da825d08ede6d7eac2c998966dbd1eeb172cec46060c9a7f533a9bce", "summary": "ParticleVoiceModel.js — Phase 3 ParticleVoice model. Wires the whole Phase 3 path into one call: **text → PCM**. TextNormalizer → G2P/lexicon → PhonemeSequence → PhonemeEncoder (GPU, optional) → ProsodyPlanner → LengthRegulator → ArticulationHead → NeuralPhysiologyState stream → ParticleTract (GPU acoustic solver) → SafetyLimiter → PCM ## Why there is no separate `SourceVocoder` in Phase 3 The plan lists \"`SourceVocoder.js` basic harmonic + noise + waveguide output\". In Phase 3 that IS `ParticleTract`: it already runs `glottal_lf` (harmonic source), two `constriction_noise` streams (aspiration at the glottis, frication at the constriction) and the Kelly-Lochbaum waveguide, with lip radiation applied internally. Adding a `SourceVocoder` wrapper that only forwarded to it would be a layer with no content. Phase 4's full source-filter Fourier vocoder (bounded spectral residual, MPD/MRD refinement, IFFT + WOLA) is where that module earns its own file — and the seam for it is `renderPhysiology()`, which is already separate from the text frontend. ## Frame rate vs chunk rate: the decimation that matters `ArticulationHead` emits physiology at the 100 Hz plan frame rate (10 ms), but `ParticleTract.renderChunk()` accepts **one control set per chunk** — one area profile, one f0, one constriction index. At 32 kHz with 1024-sample chunks a chunk is 32 ms, so roughly 3 physiology frames fall inside each one. Something has to reduce them, and the choice is audible: - **Areas are AVERAGED** across the frames in a chunk. Picking one frame (say the first) would throw away the smoothing `ArticulationHead` deliberately applied and reintroduce exactly the reflection-coefficient step it exists to prevent. - **F0 is averaged** for the same reason: a chunk-rate pitch staircase is audible as a warble. - **Constriction index is taken by MAJORITY**, not averaged — it is a position index, and the mean of \"junction 20\" and \"junction 6\" is junction 13, a place no phoneme asked for. - **Voicing/amplitudes are averaged**, which naturally cross-fades a voiced→voiceless transition across the chunk rather than switching hard. This decimation is the one place a Phase 3 discontinuity could still enter, so it is concentrated in `_decimateChunk()` and tested directly. ## Breath reservoir `BreathReservoirState`'s one-pole lag is applied CPU-side per chunk to turn `ArticulationHead`'s target subglottal pressure into an actual pressure with inertia, and that pressure scales the glottal excitation. This uses the same `lagRateFromCompliance` formula the GPU `breath_reservoir` kernel expects pre-computed, so the two agree; running it here rather than on GPU avoids a readback for a single scalar per chunk. Documented as a deliberate simplification: a per-SAMPLE reservoir would need the kernel.", "exports": [ { "name": "ParticleVoiceModel", "kind": "class", "signature": "class ParticleVoiceModel", "summary": "" }, { "name": "DEFAULT_VOICE_MODEL_CONFIG", "kind": "constant", "signature": "DEFAULT_VOICE_MODEL_CONFIG", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/model/PhonemeEncoder", "path": "agi/reference/particle_voice/model/PhonemeEncoder.md", "source": "agi/particle_voice/model/PhonemeEncoder.js", "import": "/agi/particle_voice/model/PhonemeEncoder.js", "sourceHash": "4099b66bf7b0331dc1686681d7fde3502c56c671ba3c4b6ef25e49571d91a74e", "summary": "PhonemeEncoder.js — Phase 3 ParticleVoice model. Phoneme ids → contextual per-token feature vectors, entirely on GPU: a `PHONEME_COUNT`-row embedding table followed by two Conv1D blocks, each with SiLU, and a final RMSNorm. This is the first Phase 3 component that runs the Phase 1 ParticleNN kernels in composition. Pipeline (7 dispatches, ONE submit per `encode()`): ids [T] → embedding_f16 → [T, D] sequence-major → transpose_2d → [D, T] channel-major (see \"layout\" below) → conv1d_w8a16 → [H, T] → silu_f16 → [H, T] → conv1d_w8a16 → [O, T] → silu_f16 → [O, T] → transpose_2d → [T, O] sequence-major → rmsnorm_f16 → [T, O] per-token normalization ## Layout: why two transposes are load-bearing The Phase 1 kernels disagree about which axis is major, and each is right for itself: `embedding_f16` gathers rows so it emits **sequence-major** `[numIds, embedDim]`; `conv1d_w8a16` slides a kernel along time so it reads **channel-major** `[inChannels, seqLen]`; `rmsnorm_f16` normalizes rows, so per-token normalization needs sequence-major again. Composing them without the axis swaps would not error — it would silently convolve across the feature axis and produce scrambled activations. `core/transpose_2d.js` was added for exactly this, and the two transposes here are the minimum: SiLU is elementwise and therefore layout-agnostic, so both convolutions run back-to-back in channel-major before a single swap back for the norm. ## Weights are placeholders, and this file says so No Phase 3 training exists yet, so `createDeterministicEncoderWeights()` produces **seeded pseudorandom INT8 weights**. They make the pipeline runnable, shape-correct and reproducible end-to-end; they do NOT make it meaningful. The encoder's output is a deterministic function of its input, which is what Phase 3's downstream components need in order to be built and tested — but nothing here has learned anything about phonetics. Real weights arrive with training; the `weights` argument is the seam. ## Quantization Conv weights are INT8 with a per-output-channel scale, matching `conv1d_w8a16.js`'s packed layout exactly (4 int8 per `u32`, flattened `(inCh, tap)` index, `inChannels * kernelWidth` a multiple of 4 — validated in the constructor rather than left to fail as garbage output).", "exports": [ { "name": "PhonemeEncoder", "kind": "class", "signature": "class PhonemeEncoder", "summary": "" }, { "name": "packInt8Weights", "kind": "function", "signature": "packInt8Weights(weights, outChannels, kTotal)", "summary": "Pack int8 weights into `u32`s, 4 per word, matching `conv1d_w8a16.js`'s documented `(inCh, tap)` flattening." }, { "name": "createDeterministicEncoderWeights", "kind": "function", "signature": "createDeterministicEncoderWeights(config = {}, seed = 1337)", "summary": "Build a complete, reproducible placeholder weight set. See the header: this is scaffolding so the pipeline can be exercised, not a trained model." }, { "name": "createPhonemeEncoder", "kind": "function", "signature": "createPhonemeEncoder(device, options)", "summary": "" }, { "name": "DEFAULT_ENCODER_CONFIG", "kind": "constant", "signature": "DEFAULT_ENCODER_CONFIG", "summary": "Small by design: Phase 3 is a \"tiny deterministic single-speaker model\", not a production encoder." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/model/ProsodyPlanner", "path": "agi/reference/particle_voice/model/ProsodyPlanner.md", "source": "agi/particle_voice/model/ProsodyPlanner.js", "import": "/agi/particle_voice/model/ProsodyPlanner.js", "sourceHash": "b8bf23fcb2a94a29ff26b3a723154cddbc038f94fe2335238c0fd17afc2ba9e0", "summary": "ProsodyPlanner.js — Phase 3 ParticleVoice model. Predicts per-phoneme **duration**, **F0** and a **voiced flag** from a `PhonemeSequence` (`spec/VoicePlan-v0.md` §4), at the plan frame rate of 100 Hz / 10 ms per frame that spec fixes. ## Rule-based, and the plan says \"minimal\" This is a deterministic rule model, not a trained one: durations come from per-manner base values scaled by stress and boundary position, and F0 from a declination line with stress excursions and a terminal contour selected by punctuation context. Phase 3's goal is \"a tiny deterministic single-speaker model\", and a learned duration/F0 predictor needs aligned speech data this project does not have. The numbers below are therefore **plausible phonetics, not measured values** — they are ordered correctly relative to each other (stops shorter than fricatives, diphthongs longer than monophthongs, stressed longer than unstressed), which is what makes speech intelligible, but they are not fitted to any corpus. `plan()` takes an optional `overrides` bag so a caller can retune without editing this file, and the class boundary is where a learned predictor slots in. ## What it deliberately does not do - **No per-phoneme F0 contour inside a phoneme.** One target per phoneme; smoothing into a continuous per-frame curve is `LengthRegulator.js`'s job, because that is where frame counts exist. Emitting a flat value per phoneme here and interpolating there avoids the audible pitch STEP that a naive per-phoneme hold would produce. - **No accent/emotion conditioning.** `spec/VoicePlan-v0.md` §3's factorized conditioning channels exist, but wiring them is Phase 4+; pretending to condition on them now would be fake.", "exports": [ { "name": "ProsodyPlanner", "kind": "class", "signature": "class ProsodyPlanner", "summary": "" }, { "name": "createProsodyPlanner", "kind": "function", "signature": "createProsodyPlanner(config)", "summary": "" }, { "name": "PLAN_FRAME_RATE_HZ", "kind": "constant", "signature": "PLAN_FRAME_RATE_HZ", "summary": "`spec/VoicePlan-v0.md` §5: the plan frame rate is 100 Hz (10 ms/frame)." }, { "name": "PLAN_FRAME_MS", "kind": "constant", "signature": "PLAN_FRAME_MS", "summary": "" }, { "name": "BASE_DURATION_MS", "kind": "constant", "signature": "BASE_DURATION_MS", "summary": "Base durations in MILLISECONDS by articulatory manner. Relative ordering is the part that matters (see header); absolute values are plausible defaults." }, { "name": "STRUCTURAL_DURATION_MS", "kind": "constant", "signature": "STRUCTURAL_DURATION_MS", "summary": "Structural-token durations, keyed by the punctuation context they sit at (spec §4's Effect column: comma-level is a short pause, terminals are full silences, a paragraph is longer still)." }, { "name": "DEFAULT_PROSODY_CONFIG", "kind": "constant", "signature": "DEFAULT_PROSODY_CONFIG", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/autodiff/BackwardGraphCompiler", "path": "agi/reference/particle_voice/nn/autodiff/BackwardGraphCompiler.md", "source": "agi/particle_voice/nn/autodiff/BackwardGraphCompiler.js", "import": "/agi/particle_voice/nn/autodiff/BackwardGraphCompiler.js", "sourceHash": "40bed4344aa1afa39a03635f1d31fe032444fde0eb6ab8f48b1392eb864ae7aa", "summary": "BackwardGraphCompiler.js — Phase 1 ParticleNN autodiff STUB. **Not wired into anything until Phase 11.** Walks a `ParticleTape`'s recorded forward ops in reverse and builds a `GradientGraph` node per op that has a registered `BackwardRuleRegistry` rule (ops without one are skipped, not silently faked with an identity/zero gradient). Refuses to compile anything if the registry is completely empty — the honest current state (no backward rules exist yet for any real kernel) rather than returning a plausible-looking but meaningless empty graph.", "exports": [ { "name": "BackwardGraphCompiler", "kind": "class", "signature": "class BackwardGraphCompiler", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/autodiff/BackwardRuleRegistry", "path": "agi/reference/particle_voice/nn/autodiff/BackwardRuleRegistry.md", "source": "agi/particle_voice/nn/autodiff/BackwardRuleRegistry.js", "import": "/agi/particle_voice/nn/autodiff/BackwardRuleRegistry.js", "sourceHash": "7fa8f347e083d9a344b32aba41790913e04fb201aa05fb4396630fe8792f0d2d", "summary": "BackwardRuleRegistry.js — Phase 1 ParticleNN autodiff STUB. **Not wired into anything until Phase 11.** Maps a forward op name (from `KernelRegistry.js`'s allowlist, e.g. `matmul_w8a16`) to a backward rule: a function that, given the recorded forward op's inputs/outputs/params plus the gradient(s) flowing into its outputs, produces the gradient(s) with respect to its inputs. No rules are registered for any real kernel yet — that is genuinely Phase 11 work (differentiating through INT8 quantization and FP16 rounding correctly is a real design problem, not something to hand-wave here) — this file only fixes the registry shape.", "exports": [ { "name": "BackwardRuleRegistry", "kind": "class", "signature": "class BackwardRuleRegistry", "summary": "BackwardRuleRegistry.js — Phase 1 ParticleNN autodiff STUB. **Not wired into anything until Phase 11.** Maps a forward op name (from `KernelRegistry.js`'s allowlist, e.g. `matmul_w8a16`) to a backward rule: a function that, given the recorded forward op's inputs/outputs/params plus the gradient(s) flowing into its outputs, produces the gradient(s) with respect to its inputs. No rules are registered for any real kernel yet — that is genuinely Phase 11 work (differentiating through INT8 quantization and FP16 rounding correctly is a real design problem, not something to hand-wave here) — this file only fixes the registry shape." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/autodiff/GradientGraph", "path": "agi/reference/particle_voice/nn/autodiff/GradientGraph.md", "source": "agi/particle_voice/nn/autodiff/GradientGraph.js", "import": "/agi/particle_voice/nn/autodiff/GradientGraph.js", "sourceHash": "b2f0dd7bb7f7cf81a7edeedc69afc2719015be50a7c93af47f523ec6cde48882", "summary": "GradientGraph.js — Phase 1 ParticleNN autodiff STUB. **Not wired into anything until Phase 11.** The backward-pass analogue of `ParticleGraph.js`: nodes are backward-rule applications rather than forward kernels, gradient-tensor names rather than activation-tensor names. Reuses `ParticleGraph`'s DAG/topological-sort machinery directly (a gradient graph's dependency structure is a plain DAG exactly like a forward graph's — no different algorithm is needed) rather than duplicating it, and adds `accumulate()` for the one thing a gradient graph needs that a forward graph never does: multiple edges producing a gradient for the *same* tensor must sum, not overwrite (a tensor used as input to two or more forward ops receives a gradient contribution from each one).", "exports": [ { "name": "GradientGraph", "kind": "class", "signature": "class GradientGraph extends ParticleGraph", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/autodiff/ParticleTape", "path": "agi/reference/particle_voice/nn/autodiff/ParticleTape.md", "source": "agi/particle_voice/nn/autodiff/ParticleTape.js", "import": "/agi/particle_voice/nn/autodiff/ParticleTape.js", "sourceHash": "3efdfbe05c920def939bd97d89c68c81aed888637fded444b3929087e226a713", "summary": "ParticleTape.js — Phase 1 ParticleNN autodiff STUB. **Not wired into anything until Phase 11** (browser training), per the plan's explicit phasing. This establishes the recording-tape contract a future forward pass will write to and `BackwardGraphCompiler.js` will read from — it is NOT exercised by any real training loop yet (R7's training spike used its own hand-wired `TinyAutodiff.js`, deliberately separate from this production module). Records forward-pass operations (op name, input tensor names, output tensor names, and any params the backward rule will need) in execution order, reverse-mode style.", "exports": [ { "name": "ParticleTape", "kind": "class", "signature": "class ParticleTape", "summary": "ParticleTape.js — Phase 1 ParticleNN autodiff STUB. **Not wired into anything until Phase 11** (browser training), per the plan's explicit phasing. This establishes the recording-tape contract a future forward pass will write to and `BackwardGraphCompiler.js` will read from — it is NOT exercised by any real training loop yet (R7's training spike used its own hand-wired `TinyAutodiff.js`, deliberately separate from this production module). Records forward-pass operations (op name, input tensor names, output tensor names, and any params the backward rule will need) in execution order, reverse-mode style." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/core/ParticleGraph", "path": "agi/reference/particle_voice/nn/core/ParticleGraph.md", "source": "agi/particle_voice/nn/core/ParticleGraph.js", "import": "/agi/particle_voice/nn/core/ParticleGraph.js", "sourceHash": "15daeedd19bebde7375ffc386b807991182723149294f0651afc2f55a664f748", "summary": "ParticleGraph.js — Phase 1 ParticleNN core. The uncompiled neural compute graph a model author builds: named nodes with an `op` (must be in `PRNN-v0.md` §3's operator allowlist) and named input/output tensor slots. `PRNNCompiler.js` (Phase 2+) lowers a `ParticleGraph` into a `PRNN-v0` §8 execution plan / `ParticleProgram`; this file only builds and validates the DAG itself (topological sort, cycle/dangling-reference detection) — it does not compile or dispatch anything.", "exports": [ { "name": "ParticleGraph", "kind": "class", "signature": "class ParticleGraph", "summary": "ParticleGraph.js — Phase 1 ParticleNN core. The uncompiled neural compute graph a model author builds: named nodes with an `op` (must be in `PRNN-v0.md` §3's operator allowlist) and named input/output tensor slots. `PRNNCompiler.js` (Phase 2+) lowers a `ParticleGraph` into a `PRNN-v0` §8 execution plan / `ParticleProgram`; this file only builds and validates the DAG itself (topological sort, cycle/dangling-reference detection) — it does not compile or dispatch anything." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/core/ParticleKernel", "path": "agi/reference/particle_voice/nn/core/ParticleKernel.md", "source": "agi/particle_voice/nn/core/ParticleKernel.js", "import": "/agi/particle_voice/nn/core/ParticleKernel.js", "sourceHash": "123b27d02c1efe426eafe37c3146f0102efc32d503fa815d16b80bb7c72ba380", "summary": "ParticleKernel.js — Phase 1 ParticleNN core. Kernel specialization: resolves a `KernelRegistry` entry + concrete params (`useShaderF16`, kernel-specific options like `eps`) into one ready-to-compile unit — WGSL source, entry point, workgroup size, and the explicit bind-group-layout entries `PipelineCache.js`/`KernelValidation.js` proved necessary for `f16` kernels (`DeviceContract-v0.md` §8).", "exports": [ { "name": "ParticleKernel", "kind": "class", "signature": "class ParticleKernel", "summary": "ParticleKernel.js — Phase 1 ParticleNN core. Kernel specialization: resolves a `KernelRegistry` entry + concrete params (`useShaderF16`, kernel-specific options like `eps`) into one ready-to-compile unit — WGSL source, entry point, workgroup size, and the explicit bind-group-layout entries `PipelineCache.js`/`KernelValidation.js` proved necessary for `f16` kernels (`DeviceContract-v0.md` §8)." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/core/ParticleModel", "path": "agi/reference/particle_voice/nn/core/ParticleModel.md", "source": "agi/particle_voice/nn/core/ParticleModel.js", "import": "/agi/particle_voice/nn/core/ParticleModel.js", "sourceHash": "3438a4ebf315d89dc8c95d3a698408c0f95b777d17cfec0682e88738769e8fd2", "summary": "ParticleModel.js — Phase 1 ParticleNN core. A loaded model container: a compiled `ParticleProgram` plus its weight memory (`WeightPageStore`/`WeightBindWindow`/`WeightPageUploader`) and `.prnn` header metadata, as one object. Deliberately thin scaffolding at Phase 1 — no real model exists yet (`PRNNReader.js`/`PRNNCompiler.js` that would actually produce one of these from a `.prnn` file are Phase 2+ work); this fixes the shape that loader will hand to callers.", "exports": [ { "name": "ParticleModel", "kind": "class", "signature": "class ParticleModel", "summary": "ParticleModel.js — Phase 1 ParticleNN core. A loaded model container: a compiled `ParticleProgram` plus its weight memory (`WeightPageStore`/`WeightBindWindow`/`WeightPageUploader`) and `.prnn` header metadata, as one object. Deliberately thin scaffolding at Phase 1 — no real model exists yet (`PRNNReader.js`/`PRNNCompiler.js` that would actually produce one of these from a `.prnn` file are Phase 2+ work); this fixes the shape that loader will hand to callers." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/core/ParticleProgram", "path": "agi/reference/particle_voice/nn/core/ParticleProgram.md", "source": "agi/particle_voice/nn/core/ParticleProgram.js", "import": "/agi/particle_voice/nn/core/ParticleProgram.js", "sourceHash": "1a366f9296f31cdb985fd020356bda7fa5df1bcd347f893666ee22728b91a4ec", "summary": "ParticleProgram.js — Phase 1 ParticleNN core. A compiled dispatch sequence: `ParticleGraph`'s topological order lowered into an ordered list of `{ nodeId, kernel: ParticleKernel, inputs, outputs }` steps, one `ParticleKernel` per graph node. `compileAll()` builds every step's GPU pipeline via a shared `PipelineCache` up front (so first dispatch has no compile-stall); actually running the steps each frame is `NeuralExecutor.js`'s job, not this file's.", "exports": [ { "name": "ParticleProgram", "kind": "class", "signature": "class ParticleProgram", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/core/ParticleTensor", "path": "agi/reference/particle_voice/nn/core/ParticleTensor.md", "source": "agi/particle_voice/nn/core/ParticleTensor.js", "import": "/agi/particle_voice/nn/core/ParticleTensor.js", "sourceHash": "14e6b39b5d77438d5628526ab3343ff90b8e96eb1d8e891e8c4427beb4586214", "summary": "ParticleTensor.js — Phase 1 ParticleNN core. GPU-resident tensor with explicit shape/strides/dtype/quant metadata. Mirrors `agi/tensor/Tensor.js`'s ownership/readback/dispose conventions (reference only, not imported at runtime — the plan requires ParticleNN to stay decoupled from the LLM runtime) but adds the metadata ParticleVoice actually needs: multiple dtypes (`f32`/`f16`/`i8`/`u32`) and optional per-block INT8 quantization scale/zero data alongside the raw buffer.", "exports": [ { "name": "ParticleTensor", "kind": "class", "signature": "class ParticleTensor", "summary": "`quant`, when present, describes INT8 block quantization for `dtype: 'i8'` tensors: `{ scheme: 'int8-block', blockSize: u32, scales: Float32Array }` — one scale per `ceil(elementCount / blockSize)` block, dequantized as `value = i8Value * scales[blockIndex]` (zero-point-free, symmetric quantization; PRNN-v0's `dequant_int8` kernel implements this exact scheme — see `nn/kernels/quantization/dequant_int8.js`)." }, { "name": "contiguousStrides", "kind": "function", "signature": "contiguousStrides(shape)", "summary": "Row-major contiguous strides for `shape` (element units, not bytes)." }, { "name": "tensorElementCount", "kind": "function", "signature": "tensorElementCount(shape)", "summary": "" }, { "name": "wrapReadbackBuffer", "kind": "function", "signature": "wrapReadbackBuffer(dtype, arrayBuffer, size)", "summary": "Wrap a raw readback `ArrayBuffer` in the correct typed-array view for `dtype`. Shared by `ParticleTensor` and `ParticleTensorView` so readback interpretation lives in exactly one place." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/core/ParticleTensorView", "path": "agi/reference/particle_voice/nn/core/ParticleTensorView.md", "source": "agi/particle_voice/nn/core/ParticleTensorView.js", "import": "/agi/particle_voice/nn/core/ParticleTensorView.js", "sourceHash": "16aa70b107f4a6b95b991ae206e4ff7d211c06dc2e2fb245883abef6bc2e4123", "summary": "ParticleTensorView.js — Phase 1 ParticleNN core. A zero-copy view over a parent `ParticleTensor`'s GPU buffer: a different logical shape/strides/byte-offset into the SAME underlying buffer, with no `device.queue` copy and no new buffer allocation. Used for things like binding a single weight page's sub-range, or reading one layer's slice out of a stacked activation tensor, without a `copyBufferToBuffer` pass.", "exports": [ { "name": "ParticleTensorView", "kind": "class", "signature": "class ParticleTensorView", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/KernelRegistry", "path": "agi/reference/particle_voice/nn/kernels/KernelRegistry.md", "source": "agi/particle_voice/nn/kernels/KernelRegistry.js", "import": "/agi/particle_voice/nn/kernels/KernelRegistry.js", "sourceHash": "ebc1640bea74a31e76572d90ddf48518bd63f7c87855d72d61f41663d9534d19", "summary": "KernelRegistry.js — Phase 1 ParticleNN kernel infrastructure. Maps kernel name -> `shader(params)` generator, mirroring `agi/llm/kernels/KernelRegistry.js`'s design (reference only, not imported — same LLM-runtime-decoupling rule as `PipelineUtils.js`). Each generator here also declares `inputCount` (how many read-only storage bindings it expects before the single read_write output binding) so `createShaderModule`'s caller can build the matching explicit bind-group layout required for `useShaderF16` kernels (see `DeviceContract-v0.md` §8 / `KernelValidation.js`'s `createExplicitLayoutPipeline`) without re-deriving each kernel's binding count by hand.", "exports": [ { "name": "KernelRegistry", "kind": "class", "signature": "class KernelRegistry", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/ShaderComposer", "path": "agi/reference/particle_voice/nn/kernels/ShaderComposer.md", "source": "agi/particle_voice/nn/kernels/ShaderComposer.js", "import": "/agi/particle_voice/nn/kernels/ShaderComposer.js", "sourceHash": "18282638eea21ae5e09e66e8c5d20c355144e57389352457ac632a0606ebc938", "summary": "ShaderComposer.js — Phase 1 ParticleNN kernel infrastructure. WGSL chunk composition with dependency resolution: register named chunks (each optionally depending on other chunks), then compose an ordered, deduplicated concatenation for a kernel body — so e.g. `int8_pack`'s `unpack_int8` is emitted exactly once even if two requested chunks both depend on it, and always appears before any chunk/body that calls it.", "exports": [ { "name": "ShaderComposer", "kind": "class", "signature": "class ShaderComposer", "summary": "ShaderComposer.js — Phase 1 ParticleNN kernel infrastructure. WGSL chunk composition with dependency resolution: register named chunks (each optionally depending on other chunks), then compose an ordered, deduplicated concatenation for a kernel body — so e.g. `int8_pack`'s `unpack_int8` is emitted exactly once even if two requested chunks both depend on it, and always appears before any chunk/body that calls it." }, { "name": "createDefaultShaderComposer", "kind": "function", "signature": "async createDefaultShaderComposer()", "summary": "Pre-registers the Phase 1 WGSL chunk set (`math_common`, `int8_pack`, `complex_math`) so a kernel generator can immediately `compose(['math_common', 'int8_pack'], body)` without registering each chunk itself. `f16_utils.js` has no WGSL fragment (it is a host-side-only JS<->f16 bit-conversion utility, per its own module doc) so it is not registered here." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/ShaderDiagnosticFormatter", "path": "agi/reference/particle_voice/nn/kernels/ShaderDiagnosticFormatter.md", "source": "agi/particle_voice/nn/kernels/ShaderDiagnosticFormatter.js", "import": "/agi/particle_voice/nn/kernels/ShaderDiagnosticFormatter.js", "sourceHash": "13b19634b694ecc98fc536dbfc72af1111e262398f0de662600f6dfe3b3897d7", "summary": "ShaderDiagnosticFormatter.js — Phase 1 ParticleNN kernel infrastructure. Formats `GPUCompilationMessage[]` (from `module.getCompilationInfo()`) into human-readable diagnostics, optionally resolving each message's line number through a `WGSLSourceMap` to name which chunk it came from — a strict superset of `PipelineUtils.js`'s `assertShaderCompiled` error text (which only reports line:col + message, no chunk attribution).", "exports": [ { "name": "formatCompilationMessages", "kind": "function", "signature": "formatCompilationMessages(messages, { sourceMap = null } = {})", "summary": "" }, { "name": "formatDiagnosticReport", "kind": "function", "signature": "formatDiagnosticReport(kernelName, messages, options = {})", "summary": "" }, { "name": "formatErrorsOnly", "kind": "function", "signature": "formatErrorsOnly(kernelName, messages, options = {})", "summary": "Only the `type === 'error'` messages, formatted — the subset that should fail a build/test, distinct from warnings/info the caller may want to log but not fail on." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/WGSLSourceMap", "path": "agi/reference/particle_voice/nn/kernels/WGSLSourceMap.md", "source": "agi/particle_voice/nn/kernels/WGSLSourceMap.js", "import": "/agi/particle_voice/nn/kernels/WGSLSourceMap.js", "sourceHash": "e73066c5debd3b3a0c2c309f7adf24988d31a1fffbce8254d3876f6b1e85074b", "summary": "WGSLSourceMap.js — Phase 1 ParticleNN kernel infrastructure. Generated-WGSL-line -> originating-chunk mapping. Kernels compose WGSL from named chunks (`ShaderComposer.js`) plus their own body; when the GPU compiler reports an error at line N, this turns that bare line number back into \"which named chunk (or the kernel's own body) that line came from\" — the JS source itself isn't line-mapped (these are template literals, not a separate compilation step), but chunk attribution is usually enough to know where to look.", "exports": [ { "name": "WGSLSourceMap", "kind": "class", "signature": "class WGSLSourceMap", "summary": "WGSLSourceMap.js — Phase 1 ParticleNN kernel infrastructure. Generated-WGSL-line -> originating-chunk mapping. Kernels compose WGSL from named chunks (`ShaderComposer.js`) plus their own body; when the GPU compiler reports an error at line N, this turns that bare line number back into \"which named chunk (or the kernel's own body) that line came from\" — the JS source itself isn't line-mapped (these are template literals, not a separate compilation step), but chunk attribution is usually enough to know where to look." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/WgslPreprocessor", "path": "agi/reference/particle_voice/nn/kernels/WgslPreprocessor.md", "source": "agi/particle_voice/nn/kernels/WgslPreprocessor.js", "import": "/agi/particle_voice/nn/kernels/WgslPreprocessor.js", "sourceHash": "694bb73ac6f6ee88cdad7dd6c31ebc171c47fa01a199061b9045dcdd18837c3b", "summary": "WgslPreprocessor.js — Phase 1 ParticleNN kernel infrastructure. Tagged template `wgsl\\`...\\`` supporting `#if`/`#else`/`#endif` and `#for`/`#endfor` directives, evaluated at kernel-generation time (trusted JS call sites only — this is code generation for the kernel author, not a user-input template engine, so a plain `Function` eval for `#if` expressions is an acceptable, deliberate choice here). Directive syntax (each directive must be alone on its own line): #if // evaluated with no closure — pre-interpolate #else // values via `${...}` before the directive #endif // line if the condition depends on a variable #for in .. // half-open range, start/end integers #endfor // body may reference `#{name}` (a // literal placeholder distinct from // `${}`, since `${}` is already // resolved by template-literal // substitution before this runs)", "exports": [ { "name": "preprocessWgsl", "kind": "function", "signature": "preprocessWgsl(source)", "summary": "Process `#if`/`#else`/`#endif` and `#for`/`#endfor` directives in a flat WGSL source string, line by line." }, { "name": "wgsl", "kind": "function", "signature": "wgsl(strings, ...values)", "summary": "Tagged template: joins `strings`/`values` per normal template-literal semantics, then runs `preprocessWgsl` over the result." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/activation/silu_f16", "path": "agi/reference/particle_voice/nn/kernels/activation/silu_f16.md", "source": "agi/particle_voice/nn/kernels/activation/silu_f16.js", "import": "/agi/particle_voice/nn/kernels/activation/silu_f16.js", "sourceHash": "deb9b2192f65324386089c61c6330950cf7bbbe36a8bd92b801606b719a9fc2c", "summary": "activation/silu_f16.js — Phase 1 ParticleNN kernel. Elementwise SiLU (`x * sigmoid(x)`), composed from `chunks/math_common.js`'s `siluScalar` rather than re-deriving the sigmoid inline.", "exports": [ { "name": "siluF16Shader", "kind": "function", "signature": "siluF16Shader({ useShaderF16 = false } = {})", "summary": "" }, { "name": "SILU_F16_ENTRY_POINT", "kind": "constant", "signature": "SILU_F16_ENTRY_POINT", "summary": "" }, { "name": "SILU_F16_WORKGROUP_SIZE", "kind": "constant", "signature": "SILU_F16_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/articulatory/breath_reservoir", "path": "agi/reference/particle_voice/nn/kernels/articulatory/breath_reservoir.md", "source": "agi/particle_voice/nn/kernels/articulatory/breath_reservoir.js", "import": "/agi/particle_voice/nn/kernels/articulatory/breath_reservoir.js", "sourceHash": "05c936a99ba1cc87307bce066c86376211bc53e62c2814b417ebdaf9f2d7588b", "summary": "breath_reservoir.js — Phase 2 ParticleNN articulatory kernel. First-order lag filter: `pressure[n] = pressure[n-1] + (target[n] - pressure[n-1]) * lag_rate`, matching `risk/BreathReservoir.js` (R6A)'s proven recurrence exactly (`lag_rate = 1 - exp(-1/(compliance*sampleRate))` is computed by the caller and passed in, not recomputed here). A first-order IIR recurrence is inherently sequential in time, but each of up to N simultaneous voice/capsule *instances* is fully independent — `workgroup_id.x` selects the instance, and a single thread per workgroup walks that instance's whole chunk sequentially (cheap: a chunk is a few hundred samples, and GPU dispatch overhead dominates at that size anyway, so there is nothing to gain from parallelizing within one instance's strictly-sequential recurrence).", "exports": [ { "name": "breathReservoirShader", "kind": "function", "signature": "breathReservoirShader()", "summary": "" }, { "name": "BREATH_RESERVOIR_ENTRY_POINT", "kind": "constant", "signature": "BREATH_RESERVOIR_ENTRY_POINT", "summary": "breath_reservoir.js — Phase 2 ParticleNN articulatory kernel. First-order lag filter: `pressure[n] = pressure[n-1] + (target[n] - pressure[n-1]) * lag_rate`, matching `risk/BreathReservoir.js` (R6A)'s proven recurrence exactly (`lag_rate = 1 - exp(-1/(compliance*sampleRate))` is computed by the caller and passed in, not recomputed here). A first-order IIR recurrence is inherently sequential in time, but each of up to N simultaneous voice/capsule *instances* is fully independent — `workgroup_id.x` selects the instance, and a single thread per workgroup walks that instance's whole chunk sequentially (cheap: a chunk is a few hundred samples, and GPU dispatch overhead dominates at that size anyway, so there is nothing to gain from parallelizing within one instance's strictly-sequential recurrence)." }, { "name": "BREATH_RESERVOIR_WORKGROUP_SIZE", "kind": "constant", "signature": "BREATH_RESERVOIR_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/articulatory/constriction_noise", "path": "agi/reference/particle_voice/nn/kernels/articulatory/constriction_noise.md", "source": "agi/particle_voice/nn/kernels/articulatory/constriction_noise.js", "import": "/agi/particle_voice/nn/kernels/articulatory/constriction_noise.js", "sourceHash": "ef910ca35007fa674e4288bc74ad062b4fb9b6d3606345153ed74d567a4a72e7", "summary": "constriction_noise.js — Phase 2 ParticleNN articulatory kernel. Turbulence/frication noise generator for a chosen internal tract junction (fricatives, plosive bursts) — deliberately a SEPARATE kernel from `speech/noise_source.js` rather than reusing it directly, because the two have genuinely different shapes: `noise_source.js` generates one flat, constant-amplitude signal for the whole dispatch (aspiration noise mixed at the glottis, `risk/GlottalSource.js` (R6)'s `aspirationLevel`), while frication noise needs a per-sample, per-instance TIME-VARYING amplitude envelope (driven by how tightly a constriction is formed, which changes continuously as an articulator moves) and per-instance start index/seed so N simultaneous voices/characters never share correlated turbulence. Sharing the same underlying hash rather than inventing a second one is still correct reuse: `noise_at()` below is the identical two-round Murmur-style avalanche hash as `noise_source.js`/ `risk/GlottalSource.js`'s `noiseAt` (same technique as `StreamingContinuitySource.js`), just applied per-instance with an amplitude that varies per output sample instead of being a single dispatch-wide uniform scalar. `tract_waveguide.js` does not (yet) consume this kernel's output at a `constrictionIndex` internally (its own docstring flags that as deferred, matching R6's `step()`'s own `constrictionIndex`/ `constrictionNoiseSample` option) — this kernel only produces the turbulence signal; injecting it into a specific internal tract junction is a `ParticleTract` orchestration concern for a later phase, once the model that decides the constriction's time-varying amplitude envelope exists. Three spectral shapes are supported: - `direct` `noise_at()` (flat/white-ish), the default reference; - `lowpass` block-interpolated `noise_at()` for glottal aspiration, giving the noise a predominantly low-frequency, breathy character rather than a hissy fricative one; - `derivative` first-differenced `noise_at()` (blue, +6 dB/octave) for oral frication and plosive bursts, where the high-frequency emphasis makes consonants like /s/ and /t/ pop without changing the vowel source.", "exports": [ { "name": "constrictionNoiseShader", "kind": "function", "signature": "constrictionNoiseShader({ spectralShape = 'direct', lowpassHold = 32 } = {})", "summary": "" }, { "name": "CONSTRICTION_NOISE_ENTRY_POINT", "kind": "constant", "signature": "CONSTRICTION_NOISE_ENTRY_POINT", "summary": "constriction_noise.js — Phase 2 ParticleNN articulatory kernel. Turbulence/frication noise generator for a chosen internal tract junction (fricatives, plosive bursts) — deliberately a SEPARATE kernel from `speech/noise_source.js` rather than reusing it directly, because the two have genuinely different shapes: `noise_source.js` generates one flat, constant-amplitude signal for the whole dispatch (aspiration noise mixed at the glottis, `risk/GlottalSource.js` (R6)'s `aspirationLevel`), while frication noise needs a per-sample, per-instance TIME-VARYING amplitude envelope (driven by how tightly a constriction is formed, which changes continuously as an articulator moves) and per-instance start index/seed so N simultaneous voices/characters never share correlated turbulence. Sharing the same underlying hash rather than inventing a second one is still correct reuse: `noise_at()` below is the identical two-round Murmur-style avalanche hash as `noise_source.js`/ `risk/GlottalSource.js`'s `noiseAt` (same technique as `StreamingContinuitySource.js`), just applied per-instance with an amplitude that varies per output sample instead of being a single dispatch-wide uniform scalar. `tract_waveguide.js` does not (yet) consume this kernel's output at a `constrictionIndex` internally (its own docstring flags that as deferred, matching R6's `step()`'s own `constrictionIndex`/ `constrictionNoiseSample` option) — this kernel only produces the turbulence signal; injecting it into a specific internal tract junction is a `ParticleTract` orchestration concern for a later phase, once the model that decides the constriction's time-varying amplitude envelope exists. Three spectral shapes are supported: - `direct` `noise_at()` (flat/white-ish), the default reference; - `lowpass` block-interpolated `noise_at()` for glottal aspiration, giving the noise a predominantly low-frequency, breathy character rather than a hissy fricative one; - `derivative` first-differenced `noise_at()` (blue, +6 dB/octave) for oral frication and plosive bursts, where the high-frequency emphasis makes consonants like /s/ and /t/ pop without changing the vowel source." }, { "name": "CONSTRICTION_NOISE_WORKGROUP_SIZE", "kind": "constant", "signature": "CONSTRICTION_NOISE_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/articulatory/glottal_lf", "path": "agi/reference/particle_voice/nn/kernels/articulatory/glottal_lf.md", "source": "agi/particle_voice/nn/kernels/articulatory/glottal_lf.js", "import": "/agi/particle_voice/nn/kernels/articulatory/glottal_lf.js", "sourceHash": "1310ff7266290c426809da09eb2155d5b5b5f8cad49461cf445230069c1aca8c", "summary": "glottal_lf.js — Phase 2 ParticleNN articulatory kernel. The full Liljencrants-Fant (LF) glottal flow DERIVATIVE model, replacing `speech/harmonic_source.js`'s raised-cosine \"LF-lite\" stand-in (`risk/GlottalSource.js` (R6)'s own docstring calls that shape a deliberate simplification and names `articulatory/glottal_lf.js` as the real implementation it stands in for). Per period, given control instants Te (glottal closure / main excitation, 0 < Te < T0), Tp (peak-flow instant, 0 < Tp < Te), Ta (return-phase time constant), and Ee (excitation strength), the classic two-segment LF waveform is: E(t) = E0 * exp(alpha*t) * sin(wg*t) 0<=t 0` is just the previous element of the *same* input buffer (already fully computed, no accumulation), and only `n = 0` needs externally-supplied state (`prev_last_sample`, the previous chunk's final raw sample) — so every output sample can be computed independently with no sequential loop at all.", "exports": [ { "name": "lipRadiationShader", "kind": "function", "signature": "lipRadiationShader()", "summary": "" }, { "name": "LIP_RADIATION_ENTRY_POINT", "kind": "constant", "signature": "LIP_RADIATION_ENTRY_POINT", "summary": "lip_radiation.js — Phase 2 ParticleNN articulatory kernel. Idealized lip-radiation filter: a first difference, `radiated[n] = raw[n] - raw[n-1]`, matching `risk/KellyLochbaumWaveguide.js` (R6)'s `step()` exactly (`radiated = outputRaw - prevOutputRaw`) — the differentiating characteristic of radiation from an open end. Despite being defined via a one-sample recurrence, this is embarrassingly parallel: `raw[n-1]` for `n > 0` is just the previous element of the *same* input buffer (already fully computed, no accumulation), and only `n = 0` needs externally-supplied state (`prev_last_sample`, the previous chunk's final raw sample) — so every output sample can be computed independently with no sequential loop at all." }, { "name": "LIP_RADIATION_WORKGROUP_SIZE", "kind": "constant", "signature": "LIP_RADIATION_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/articulatory/nasal_junction", "path": "agi/reference/particle_voice/nn/kernels/articulatory/nasal_junction.md", "source": "agi/particle_voice/nn/kernels/articulatory/nasal_junction.js", "import": "/agi/particle_voice/nn/kernels/articulatory/nasal_junction.js", "sourceHash": "734baaf1aa299d5c3bd78778865ce973467b8a232da59f37376895aff24d4d59", "summary": "nasal_junction.js — Phase 2 ParticleNN articulatory kernel. Production nasal branch: a second, independent Kelly-Lochbaum tube chain generalizing risk/KellyLochbaumWaveguide.js (R6)'s proven createNasalBranch().step() to run a whole sample chunk times N instances on GPU, using the exact same one-thread-per-section / double-buffered-workgroup-memory / sequential-workgroupBarrier-per-sample structure as tract_waveguide.js (see that file's docstring for the full parallelization rationale, not repeated here). Differences from tract_waveguide.js's oral tract, matching R6's createNasalBranch() exactly: - The near end has no reflection term at all: nextRight[0] = inputFlow (R6's oral tract instead does sourceFlow + glottalReflection * left[0]) — the nasal branch is driven directly by a coupled fraction of an oral-tract tap signal, not its own glottal source. - The far end uses a single nostrilReflection coefficient (R6's lipReflection equivalent). `radiation_difference` selects whether the first-difference radiation filter is applied: 1.0 for R6's flow-domain parity path, 0.0 for ParticleTract's LF-derivative-domain production path. This kernel does not itself compute the oral-tract tap signal fed into inputFlow — that is tract_waveguide.js's nasal_tap output block, and inputFlow is an ordinary per-instance per-sample input buffer here, matching every other Phase 2 kernel's convention of not silently reaching into another kernel's state. input_gain is the velum/nasal COUPLING fraction. R6's createNasalBranch() has no such parameter because its caller pre-multiplied the tap signal (nasalCoupling * nasalTapSignal) before calling step(). On GPU that would force either a whole extra scaling kernel or a CPU round-trip in the middle of an otherwise GPU-resident chunk, so the scalar lives here instead — exactly where this file's own docstring already says the branch is \"driven by a coupled fraction of an oral-tract tap signal\". input_gain = 1.0 reproduces R6's step() bit-for-bit, which is what the parity test in phase2-dsp.html pins.", "exports": [ { "name": "nasalJunctionOutputLayout", "kind": "function", "signature": "nasalJunctionOutputLayout(numSections, numSamples, numInstances)", "summary": "Shared flat-output-buffer layout — mirrors tractWaveguideOutputLayout() exactly (same three persisted-state pieces plus the radiated signal), kept as its own function per kernel so a future layout change to one tract type can never silently affect the other." }, { "name": "nasalJunctionShader", "kind": "function", "signature": "nasalJunctionShader()", "summary": "" }, { "name": "NASAL_JUNCTION_MAX_SECTIONS", "kind": "constant", "signature": "NASAL_JUNCTION_MAX_SECTIONS", "summary": "nasal_junction.js — Phase 2 ParticleNN articulatory kernel. Production nasal branch: a second, independent Kelly-Lochbaum tube chain generalizing risk/KellyLochbaumWaveguide.js (R6)'s proven createNasalBranch().step() to run a whole sample chunk times N instances on GPU, using the exact same one-thread-per-section / double-buffered-workgroup-memory / sequential-workgroupBarrier-per-sample structure as tract_waveguide.js (see that file's docstring for the full parallelization rationale, not repeated here). Differences from tract_waveguide.js's oral tract, matching R6's createNasalBranch() exactly: - The near end has no reflection term at all: nextRight[0] = inputFlow (R6's oral tract instead does sourceFlow + glottalReflection * left[0]) — the nasal branch is driven directly by a coupled fraction of an oral-tract tap signal, not its own glottal source. - The far end uses a single nostrilReflection coefficient (R6's lipReflection equivalent). `radiation_difference` selects whether the first-difference radiation filter is applied: 1.0 for R6's flow-domain parity path, 0.0 for ParticleTract's LF-derivative-domain production path. This kernel does not itself compute the oral-tract tap signal fed into inputFlow — that is tract_waveguide.js's nasal_tap output block, and inputFlow is an ordinary per-instance per-sample input buffer here, matching every other Phase 2 kernel's convention of not silently reaching into another kernel's state. input_gain is the velum/nasal COUPLING fraction. R6's createNasalBranch() has no such parameter because its caller pre-multiplied the tap signal (nasalCoupling * nasalTapSignal) before calling step(). On GPU that would force either a whole extra scaling kernel or a CPU round-trip in the middle of an otherwise GPU-resident chunk, so the scalar lives here instead — exactly where this file's own docstring already says the branch is \"driven by a coupled fraction of an oral-tract tap signal\". input_gain = 1.0 reproduces R6's step() bit-for-bit, which is what the parity test in phase2-dsp.html pins." }, { "name": "NASAL_JUNCTION_ENTRY_POINT", "kind": "constant", "signature": "NASAL_JUNCTION_ENTRY_POINT", "summary": "" }, { "name": "NASAL_JUNCTION_WORKGROUP_SIZE", "kind": "constant", "signature": "NASAL_JUNCTION_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/articulatory/physiology_feedback_reduce", "path": "agi/reference/particle_voice/nn/kernels/articulatory/physiology_feedback_reduce.md", "source": "agi/particle_voice/nn/kernels/articulatory/physiology_feedback_reduce.js", "import": "/agi/particle_voice/nn/kernels/articulatory/physiology_feedback_reduce.js", "sourceHash": "19003236581791c2a69dadf65ea6522e6b74738663abdc10aec1fc76f5f0b08c", "summary": "physiology_feedback_reduce.js — Phase 2 ParticleNN articulatory kernel. Reduces a high-rate (32 kHz per `ARCHITECTURE.md` §3) per-sample waveguide/tract signal (e.g. `tract_waveguide.js`'s radiated output, or a raw right/left traveling-wave channel) down to one (mean, RMS) pair per fixed-size frame — the `PhysiologyFeedbackState` `ARCHITECTURE.md` §4 names as \"a reduced/decimated feedback signal from the acoustic solve back toward the model\", so the model's control-rate loop (100 Hz per `ARCHITECTURE.md` §3) can see a compact summary of what the acoustic solver actually produced last frame without reading back and processing the full high-rate PCM itself. `samples_per_frame` is expected to be one of the plan's fixed legal chunk buckets (first 12/16/24 frames, steady 32/48/64 frames at the activity frame size, or a caller-chosen block size for this specific feedback path) — this kernel does not itself enforce bucket membership, it just requires `num_samples == num_frames * samples_per_frame` exactly (no partial trailing frame), matching every other Phase 2 kernel's expectation that framing/bucketing is decided by the caller (`stft.js`/`overlap_add.js` take the same stance). One thread per (instance, frame) pair does its own small sequential reduction over `samples_per_frame` samples — deliberately not a parallel-reduction tree, since typical frame sizes here (tens to a few hundred samples) are small enough that per-thread sequential summation is simpler and cheaper than the synchronization a tree reduction would need, the same reasoning `breath_reservoir.js`'s per-instance single-thread recurrence gives for its own necessarily-sequential loop (this kernel's reduction isn't sequential for correctness, just small enough that a loop is the pragmatic choice).", "exports": [ { "name": "physiologyFeedbackReduceOutputLayout", "kind": "function", "signature": "physiologyFeedbackReduceOutputLayout(numFrames, numInstances)", "summary": "Packed-output layout: [mean block (num_instances*num_frames)] then [rms block (num_instances*num_frames)] — kept as its own function so the WGSL offsets and any JS-side reader stay in lockstep, matching `tractWaveguideOutputLayout()`'s precedent." }, { "name": "physiologyFeedbackReduceShader", "kind": "function", "signature": "physiologyFeedbackReduceShader()", "summary": "" }, { "name": "PHYSIOLOGY_FEEDBACK_REDUCE_ENTRY_POINT", "kind": "constant", "signature": "PHYSIOLOGY_FEEDBACK_REDUCE_ENTRY_POINT", "summary": "physiology_feedback_reduce.js — Phase 2 ParticleNN articulatory kernel. Reduces a high-rate (32 kHz per `ARCHITECTURE.md` §3) per-sample waveguide/tract signal (e.g. `tract_waveguide.js`'s radiated output, or a raw right/left traveling-wave channel) down to one (mean, RMS) pair per fixed-size frame — the `PhysiologyFeedbackState` `ARCHITECTURE.md` §4 names as \"a reduced/decimated feedback signal from the acoustic solve back toward the model\", so the model's control-rate loop (100 Hz per `ARCHITECTURE.md` §3) can see a compact summary of what the acoustic solver actually produced last frame without reading back and processing the full high-rate PCM itself. `samples_per_frame` is expected to be one of the plan's fixed legal chunk buckets (first 12/16/24 frames, steady 32/48/64 frames at the activity frame size, or a caller-chosen block size for this specific feedback path) — this kernel does not itself enforce bucket membership, it just requires `num_samples == num_frames * samples_per_frame` exactly (no partial trailing frame), matching every other Phase 2 kernel's expectation that framing/bucketing is decided by the caller (`stft.js`/`overlap_add.js` take the same stance). One thread per (instance, frame) pair does its own small sequential reduction over `samples_per_frame` samples — deliberately not a parallel-reduction tree, since typical frame sizes here (tens to a few hundred samples) are small enough that per-thread sequential summation is simpler and cheaper than the synchronization a tree reduction would need, the same reasoning `breath_reservoir.js`'s per-instance single-thread recurrence gives for its own necessarily-sequential loop (this kernel's reduction isn't sequential for correctness, just small enough that a loop is the pragmatic choice)." }, { "name": "PHYSIOLOGY_FEEDBACK_REDUCE_WORKGROUP_SIZE", "kind": "constant", "signature": "PHYSIOLOGY_FEEDBACK_REDUCE_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/articulatory/signal_add", "path": "agi/reference/particle_voice/nn/kernels/articulatory/signal_add.md", "source": "agi/particle_voice/nn/kernels/articulatory/signal_add.js", "import": "/agi/particle_voice/nn/kernels/articulatory/signal_add.js", "sourceHash": "63ef0eb74c68d996aad31679a2b66ace574c90f5c541d582437772da18c423b3", "summary": "signal_add.js — Phase 2 ParticleNN articulatory kernel. Elementwise sum of two equal-shaped signals: `out[i] = a[i] + b[i]`. `ParticleTract.js` needs exactly this twice, at the two points its signal graph merges: 1. **Glottal source mix** — `voicing` (`glottal_lf.js`) + `aspiration` (`constriction_noise.js` with a slowly-varying envelope) into the `source_flow` that `tract_waveguide.js` injects at the glottis. 2. **Output mix** — the oral tract's `radiated` signal plus the nasal branch's `radiated` signal (`nasal_junction.js`, already scaled by its own `input_gain` coupling), producing the final PCM. Note that FRICATION is deliberately NOT a third term here. Turbulence belongs at the constriction, not the glottis, so it is fed to `tract_waveguide.js`'s `constriction_noise` input and injected at `constriction_index` — only the cavity in front of the constriction then filters it, which is what makes a fricative sound like a fricative rather than a whisper. That is why this kernel takes two inputs and not three. This kernel exists because nothing in the registry could do it. There was no elementwise-add op, and `speech/crossfade.js` — the only existing two-signal combiner — is NOT a mixer: it sweeps its ratio across the buffer (`t = i/(length-1)`), making it a one-shot transition. Using it here would ramp the voicing/aspiration balance from 0 to 1 across every chunk. There are no gain inputs, deliberately: every amplitude this could scale is already a first-class parameter of the kernel that PRODUCES the term — `glottal_lf.js`'s per-instance `ee`, `constriction_noise.js`'s per-sample `amplitude_envelope`, and `nasal_junction.js`'s `input_gain`. Duplicating that control here would invite the two copies to disagree. Flat-parallel with no cross-sample dependency (one thread per output element), matching `lip_radiation.js`/`constriction_noise.js`. Instance layout is implicit: the caller passes `total_elements = num_instances * num_samples` and both inputs share the same `[num_instances, num_samples]` row-major shape, so no per-instance indexing is needed at all.", "exports": [ { "name": "signalAddShader", "kind": "function", "signature": "signalAddShader()", "summary": "" }, { "name": "SIGNAL_ADD_ENTRY_POINT", "kind": "constant", "signature": "SIGNAL_ADD_ENTRY_POINT", "summary": "signal_add.js — Phase 2 ParticleNN articulatory kernel. Elementwise sum of two equal-shaped signals: `out[i] = a[i] + b[i]`. `ParticleTract.js` needs exactly this twice, at the two points its signal graph merges: 1. **Glottal source mix** — `voicing` (`glottal_lf.js`) + `aspiration` (`constriction_noise.js` with a slowly-varying envelope) into the `source_flow` that `tract_waveguide.js` injects at the glottis. 2. **Output mix** — the oral tract's `radiated` signal plus the nasal branch's `radiated` signal (`nasal_junction.js`, already scaled by its own `input_gain` coupling), producing the final PCM. Note that FRICATION is deliberately NOT a third term here. Turbulence belongs at the constriction, not the glottis, so it is fed to `tract_waveguide.js`'s `constriction_noise` input and injected at `constriction_index` — only the cavity in front of the constriction then filters it, which is what makes a fricative sound like a fricative rather than a whisper. That is why this kernel takes two inputs and not three. This kernel exists because nothing in the registry could do it. There was no elementwise-add op, and `speech/crossfade.js` — the only existing two-signal combiner — is NOT a mixer: it sweeps its ratio across the buffer (`t = i/(length-1)`), making it a one-shot transition. Using it here would ramp the voicing/aspiration balance from 0 to 1 across every chunk. There are no gain inputs, deliberately: every amplitude this could scale is already a first-class parameter of the kernel that PRODUCES the term — `glottal_lf.js`'s per-instance `ee`, `constriction_noise.js`'s per-sample `amplitude_envelope`, and `nasal_junction.js`'s `input_gain`. Duplicating that control here would invite the two copies to disagree. Flat-parallel with no cross-sample dependency (one thread per output element), matching `lip_radiation.js`/`constriction_noise.js`. Instance layout is implicit: the caller passes `total_elements = num_instances * num_samples` and both inputs share the same `[num_instances, num_samples]` row-major shape, so no per-instance indexing is needed at all." }, { "name": "SIGNAL_ADD_WORKGROUP_SIZE", "kind": "constant", "signature": "SIGNAL_ADD_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/articulatory/tract_transfer", "path": "agi/reference/particle_voice/nn/kernels/articulatory/tract_transfer.md", "source": "agi/particle_voice/nn/kernels/articulatory/tract_transfer.js", "import": "/agi/particle_voice/nn/kernels/articulatory/tract_transfer.js", "sourceHash": "847c47587a8d0f908359c38795230967cd94abde570e5b705bb35eab1adda1c7", "summary": "tract_transfer.js — Phase 2 ParticleNN articulatory kernel. Converts a per-instance tube cross-sectional area profile into Kelly- Lochbaum junction reflection coefficients — the exact formula `risk/KellyLochbaumWaveguide.js` (R6)'s proven `reflectionCoefficients()` uses: `k[i] = (A[i] - A[i+1]) / (A[i] + A[i+1] + 1e-6)`. `tract_waveguide.js`'s own docstring notes junction coefficients are \"computed CPU-side by the caller... not recomputed here\", matching `mel_filterbank.js`'s precedent for a fixed-shape precomputation — that is still correct for a STATIC area profile. This kernel exists for the case the plan's `NeuralPhysiologyState.TractGestureHead` implies: an area profile predicted fresh every control frame (100 Hz per `ARCHITECTURE.md` §3), which would otherwise force a GPU-to-CPU-to-GPU round trip every frame just to run one elementwise division — exactly the per-frame readback stall the plan's Production Contract and `engine/core/gpu/VGPUReadbackQueue.js`-style staged-readback convention are meant to avoid. Keeping the whole `TractGestureHead -> junction_k -> tract_waveguide.js` path on GPU is what \"single owned execution path\" requires once area profiles become per-frame instead of per-utterance. Purely elementwise across `(instance, junction)` pairs — no inter-junction dependency at all (unlike `tract_waveguide.js`'s per-sample recurrence), so this is one thread per output element with no workgroup memory or barriers needed.", "exports": [ { "name": "tractTransferShader", "kind": "function", "signature": "tractTransferShader()", "summary": "" }, { "name": "TRACT_TRANSFER_ENTRY_POINT", "kind": "constant", "signature": "TRACT_TRANSFER_ENTRY_POINT", "summary": "tract_transfer.js — Phase 2 ParticleNN articulatory kernel. Converts a per-instance tube cross-sectional area profile into Kelly- Lochbaum junction reflection coefficients — the exact formula `risk/KellyLochbaumWaveguide.js` (R6)'s proven `reflectionCoefficients()` uses: `k[i] = (A[i] - A[i+1]) / (A[i] + A[i+1] + 1e-6)`. `tract_waveguide.js`'s own docstring notes junction coefficients are \"computed CPU-side by the caller... not recomputed here\", matching `mel_filterbank.js`'s precedent for a fixed-shape precomputation — that is still correct for a STATIC area profile. This kernel exists for the case the plan's `NeuralPhysiologyState.TractGestureHead` implies: an area profile predicted fresh every control frame (100 Hz per `ARCHITECTURE.md` §3), which would otherwise force a GPU-to-CPU-to-GPU round trip every frame just to run one elementwise division — exactly the per-frame readback stall the plan's Production Contract and `engine/core/gpu/VGPUReadbackQueue.js`-style staged-readback convention are meant to avoid. Keeping the whole `TractGestureHead -> junction_k -> tract_waveguide.js` path on GPU is what \"single owned execution path\" requires once area profiles become per-frame instead of per-utterance. Purely elementwise across `(instance, junction)` pairs — no inter-junction dependency at all (unlike `tract_waveguide.js`'s per-sample recurrence), so this is one thread per output element with no workgroup memory or barriers needed." }, { "name": "TRACT_TRANSFER_WORKGROUP_SIZE", "kind": "constant", "signature": "TRACT_TRANSFER_WORKGROUP_SIZE", "summary": "" }, { "name": "TRACT_TRANSFER_EPSILON", "kind": "constant", "signature": "TRACT_TRANSFER_EPSILON", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/articulatory/tract_waveguide", "path": "agi/reference/particle_voice/nn/kernels/articulatory/tract_waveguide.md", "source": "agi/particle_voice/nn/kernels/articulatory/tract_waveguide.js", "import": "/agi/particle_voice/nn/kernels/articulatory/tract_waveguide.js", "sourceHash": "1c9857a4ccdcae11da751c66f3d5172ad52aec375a70248ac33ec45f438f89ca", "summary": "tract_waveguide.js — Phase 2 ParticleNN articulatory kernel. Production Kelly-Lochbaum single-delay-per-section digital waveguide vocal tract, generalizing `risk/KellyLochbaumWaveguide.js` (R6)'s proven `createVocalTract().step()` recurrence to run entirely on GPU across a whole chunk of samples and N simultaneous voice/capsule instances. Junction reflection coefficients (`k[i] = (A_i - A_{i+1}) / (A_i + A_{i+1})`) are computed CPU-side by the caller via `risk/KellyLochbaumWaveguide.js`'s `reflectionCoefficients` (a fixed-shape, typically-small computation — same rationale `mel_filterbank.js` gives for precomputing its filter matrix CPU-side rather than reproducing it in WGSL) and passed in as `junction_k`, not recomputed here. Constriction noise injection (`constriction_index` + `constriction_noise`) and the nasal TAP signal (`nasal_tap_index`) ARE implemented, as faithful ports of R6's proven `step()` options — they were deferred when this kernel was first written, but `ParticleTract.js` cannot produce real fricatives or real nasal coupling without them: - `constriction_index >= 0` adds that sample's `constriction_noise` value to the RIGHT-going wave entering junction `constriction_index`, exactly as R6's `if (i === constrictionIndex) incomingRight += constrictionNoiseSample`. Injecting at the junction (rather than mixing noise into `source_flow` at the glottis) is what makes a fricative a fricative: only the cavity IN FRONT of the constriction filters the turbulence. - `nasal_tap_index >= 0` writes `right[i] + left[i]` for that section into the packed output's `nasal_tap` block every sample, giving `nasal_junction.js` an anatomically-meaningful `input_flow` to be driven by. Matching R6 exactly, the tap is a READ-ONLY observation: the oral tract is not itself perturbed by it. That remains a simplification versus a rigorous 3-port scattering junction (R6's own docstring says the same); it is enough for controllable, stable nasal coupling, and the honest limitation is recorded here rather than overstated. Both are opt-in: a negative index disables that feature entirely, so callers that want neither pass `-1` and get bit-identical behavior to this kernel before they existed. ## `radiation_difference` must match what the SOURCE already is Lip radiation is approximately a differentiator, so R6's `step()` ends with `radiated = outputRaw - prevOutputRaw`. That is correct when the excitation is glottal FLOW, which is what R6's `GlottalSource.js` raised-cosine pulse produced. It is WRONG when the excitation is already the flow derivative. `glottal_lf.js` is explicitly the LF glottal flow DERIVATIVE model, so feeding it in and then differencing again yields the SECOND derivative: +6 dB/octave of spurious tilt (audibly reedy/buzzy) and a far spikier waveform, whose large crest factor then drives any downstream limiter into distorting every single pitch pulse. Injecting a derivative source and skipping the difference is what gives the correct radiated pressure, and is why formant synthesizers use the LF derivative directly. `radiation_difference` therefore has to agree with the caller's source: 1.0 for a flow source (R6 parity), 0.0 for `glottal_lf.js`. There is no safe default that suits both, so it is an explicit parameter rather than a built-in assumption. ## `wall_loss`: the tube was perfectly lossless, and that is audible Scattering at a Kelly-Lochbaum junction conserves energy exactly, so with only the glottis and lips absorbing anything, the formants of this tube had very high Q. Real vocal tracts lose energy continuously to yielding walls plus viscous and thermal effects, which is what gives formants their bandwidth (roughly 50-100 Hz for F1, more higher up). A resonator with too little damping rings after every excitation, and a whole tube of them reads as a metallic, synthetic buzz laid over the speech no matter how accurate the formant FREQUENCIES are — accurate centres with no bandwidth still does not sound human. `wall_loss` multiplies each traveling wave once per section per sample, so a wave crossing the whole tract is attenuated `wall_loss^num_sections`. Because it is applied per section rather than once at a boundary, the loss accumulates with distance travelled, which is the correct behaviour for a distributed effect. It is a frequency-INDEPENDENT approximation of a loss that really does grow with frequency; the honest limitation is recorded here rather than overstated, and a one-pole filter per junction would be the refinement. 1.0 restores the lossless tube exactly, which is what the R6 parity test uses. One digital-waveguide step is inherently sequential in time (sample n depends on sample n-1's right/left traveling-wave state), but the N-1 junction updates *within* one sample step are independent of each other (each reads only the previous sample's `right`/`left`, matching R6's `step()` computing a full `nextRight`/`nextLeft` array before committing it) — so this kernel assigns one thread per tube section (`local_invocation_id.x`), keeps the whole tract's traveling-wave state in workgroup memory (double-buffered, since every junction read is the *previous* sample's state), and walks the chunk's samples sequentially with a `workgroupBarrier()` between samples. `workgroup_id.x` selects which of up to `num_instances` simultaneous tracts to process, matching every other Phase 2 kernel's per-instance batching convention (`breath_reservoir.js`, `lip_radiation.js`). `MAX_SECTIONS = 64` is a compile-time workgroup-memory cap, comfortably above R6's proven `NUM_SECTIONS = 32` oral / `NASAL_SECTIONS = 16` nasal tract discretizations (`risk/VoiceBoxWaveguideProbe.js`) — `num_sections` over this cap is a caller error, not a silently-truncated tract. To keep this kernel within the project's \"N read-only storage inputs then one read_write storage output\" binding convention (`KernelRegistry.bindGroupLayoutEntriesFor`), all four pieces of kernel-produced data (`radiated_out`, the two persisted traveling-wave state arrays, and the persisted previous-lip-output scalar needed for the next chunk's radiation first-difference) are packed into ONE flat output buffer at fixed uniform-computed offsets, documented in the struct comments below, rather than needing four separate output bindings.", "exports": [ { "name": "tractWaveguideOutputLayout", "kind": "function", "signature": "tractWaveguideOutputLayout(numSections, numSamples, numInstances)", "summary": "Compute the flat-output-buffer layout `tract_waveguide.js` writes to and `TractWaveguideModel.js` (Phase 3+ consumer) must read from, given `numSections`/`numSamples`/`numInstances` — kept as one shared function so the WGSL offsets below and any future JS-side reader can never drift apart." }, { "name": "tractWaveguideShader", "kind": "function", "signature": "tractWaveguideShader()", "summary": "" }, { "name": "TRACT_WAVEGUIDE_MAX_SECTIONS", "kind": "constant", "signature": "TRACT_WAVEGUIDE_MAX_SECTIONS", "summary": "tract_waveguide.js — Phase 2 ParticleNN articulatory kernel. Production Kelly-Lochbaum single-delay-per-section digital waveguide vocal tract, generalizing `risk/KellyLochbaumWaveguide.js` (R6)'s proven `createVocalTract().step()` recurrence to run entirely on GPU across a whole chunk of samples and N simultaneous voice/capsule instances. Junction reflection coefficients (`k[i] = (A_i - A_{i+1}) / (A_i + A_{i+1})`) are computed CPU-side by the caller via `risk/KellyLochbaumWaveguide.js`'s `reflectionCoefficients` (a fixed-shape, typically-small computation — same rationale `mel_filterbank.js` gives for precomputing its filter matrix CPU-side rather than reproducing it in WGSL) and passed in as `junction_k`, not recomputed here. Constriction noise injection (`constriction_index` + `constriction_noise`) and the nasal TAP signal (`nasal_tap_index`) ARE implemented, as faithful ports of R6's proven `step()` options — they were deferred when this kernel was first written, but `ParticleTract.js` cannot produce real fricatives or real nasal coupling without them: - `constriction_index >= 0` adds that sample's `constriction_noise` value to the RIGHT-going wave entering junction `constriction_index`, exactly as R6's `if (i === constrictionIndex) incomingRight += constrictionNoiseSample`. Injecting at the junction (rather than mixing noise into `source_flow` at the glottis) is what makes a fricative a fricative: only the cavity IN FRONT of the constriction filters the turbulence. - `nasal_tap_index >= 0` writes `right[i] + left[i]` for that section into the packed output's `nasal_tap` block every sample, giving `nasal_junction.js` an anatomically-meaningful `input_flow` to be driven by. Matching R6 exactly, the tap is a READ-ONLY observation: the oral tract is not itself perturbed by it. That remains a simplification versus a rigorous 3-port scattering junction (R6's own docstring says the same); it is enough for controllable, stable nasal coupling, and the honest limitation is recorded here rather than overstated. Both are opt-in: a negative index disables that feature entirely, so callers that want neither pass `-1` and get bit-identical behavior to this kernel before they existed. ## `radiation_difference` must match what the SOURCE already is Lip radiation is approximately a differentiator, so R6's `step()` ends with `radiated = outputRaw - prevOutputRaw`. That is correct when the excitation is glottal FLOW, which is what R6's `GlottalSource.js` raised-cosine pulse produced. It is WRONG when the excitation is already the flow derivative. `glottal_lf.js` is explicitly the LF glottal flow DERIVATIVE model, so feeding it in and then differencing again yields the SECOND derivative: +6 dB/octave of spurious tilt (audibly reedy/buzzy) and a far spikier waveform, whose large crest factor then drives any downstream limiter into distorting every single pitch pulse. Injecting a derivative source and skipping the difference is what gives the correct radiated pressure, and is why formant synthesizers use the LF derivative directly. `radiation_difference` therefore has to agree with the caller's source: 1.0 for a flow source (R6 parity), 0.0 for `glottal_lf.js`. There is no safe default that suits both, so it is an explicit parameter rather than a built-in assumption. ## `wall_loss`: the tube was perfectly lossless, and that is audible Scattering at a Kelly-Lochbaum junction conserves energy exactly, so with only the glottis and lips absorbing anything, the formants of this tube had very high Q. Real vocal tracts lose energy continuously to yielding walls plus viscous and thermal effects, which is what gives formants their bandwidth (roughly 50-100 Hz for F1, more higher up). A resonator with too little damping rings after every excitation, and a whole tube of them reads as a metallic, synthetic buzz laid over the speech no matter how accurate the formant FREQUENCIES are — accurate centres with no bandwidth still does not sound human. `wall_loss` multiplies each traveling wave once per section per sample, so a wave crossing the whole tract is attenuated `wall_loss^num_sections`. Because it is applied per section rather than once at a boundary, the loss accumulates with distance travelled, which is the correct behaviour for a distributed effect. It is a frequency-INDEPENDENT approximation of a loss that really does grow with frequency; the honest limitation is recorded here rather than overstated, and a one-pole filter per junction would be the refinement. 1.0 restores the lossless tube exactly, which is what the R6 parity test uses. One digital-waveguide step is inherently sequential in time (sample n depends on sample n-1's right/left traveling-wave state), but the N-1 junction updates *within* one sample step are independent of each other (each reads only the previous sample's `right`/`left`, matching R6's `step()` computing a full `nextRight`/`nextLeft` array before committing it) — so this kernel assigns one thread per tube section (`local_invocation_id.x`), keeps the whole tract's traveling-wave state in workgroup memory (double-buffered, since every junction read is the *previous* sample's state), and walks the chunk's samples sequentially with a `workgroupBarrier()` between samples. `workgroup_id.x` selects which of up to `num_instances` simultaneous tracts to process, matching every other Phase 2 kernel's per-instance batching convention (`breath_reservoir.js`, `lip_radiation.js`). `MAX_SECTIONS = 64` is a compile-time workgroup-memory cap, comfortably above R6's proven `NUM_SECTIONS = 32` oral / `NASAL_SECTIONS = 16` nasal tract discretizations (`risk/VoiceBoxWaveguideProbe.js`) — `num_sections` over this cap is a caller error, not a silently-truncated tract. To keep this kernel within the project's \"N read-only storage inputs then one read_write storage output\" binding convention (`KernelRegistry.bindGroupLayoutEntriesFor`), all four pieces of kernel-produced data (`radiated_out`, the two persisted traveling-wave state arrays, and the persisted previous-lip-output scalar needed for the next chunk's radiation first-difference) are packed into ONE flat output buffer at fixed uniform-computed offsets, documented in the struct comments below, rather than needing four separate output bindings." }, { "name": "TRACT_WAVEGUIDE_ENTRY_POINT", "kind": "constant", "signature": "TRACT_WAVEGUIDE_ENTRY_POINT", "summary": "" }, { "name": "TRACT_WAVEGUIDE_WORKGROUP_SIZE", "kind": "constant", "signature": "TRACT_WAVEGUIDE_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/articulatory/visual_state_decimate", "path": "agi/reference/particle_voice/nn/kernels/articulatory/visual_state_decimate.md", "source": "agi/particle_voice/nn/kernels/articulatory/visual_state_decimate.js", "import": "/agi/particle_voice/nn/kernels/articulatory/visual_state_decimate.js", "sourceHash": "ac0e231f3e305a5ebf4dedce4addca9b56a5b2ce171fefcb519601b33b5beb36", "summary": "visual_state_decimate.js — Phase 2 ParticleNN articulatory kernel. Decimates a high-rate, multi-CHANNEL tract field (e.g. a per-section pressure-like signal, one channel per tube section) down to one box-averaged value per channel per fixed-size frame — the `VisualAirflowState` `ARCHITECTURE.md` §4 names as \"a decimated field for ribbon/particle/heatmap visualization\". Deliberately NOT a reuse of `physiology_feedback_reduce.js` despite the similar per-thread \"small sequential average over a window\" shape: that kernel reduces a single FLAT per-instance signal to (mean, RMS) pairs for model feedback (a statistics reduction); this kernel decimates a multi-CHANNEL per-instance FIELD (extra channel/section axis) down to mean-only per channel per frame, because a rendered airflow ribbon/ heatmap needs a representative value per tube section over time, not an energy statistic, and box-averaging over the decimation window (rather than picking every Nth raw sample) avoids visual aliasing/flicker in the downsampled field — ordinary decimation-filter practice, and consistent with how `overlap_add.js`/`stft.js` already treat windowing as the caller's/kernel's job rather than raw strided subsampling. `ARCHITECTURE.md` §4 also requires that visualization \"must be bit- identically disable-able without changing rendered PCM\" — this kernel reads its input field only (never writes back into it), so skipping this kernel's dispatch entirely when visualization is off cannot affect the `tract_waveguide.js`/`nasal_junction.js` PCM path in any way; that invariant is structural (this kernel has no read_write access to anything the acoustic path also reads), not merely a runtime convention.", "exports": [ { "name": "visualStateDecimateShader", "kind": "function", "signature": "visualStateDecimateShader()", "summary": "" }, { "name": "VISUAL_STATE_DECIMATE_ENTRY_POINT", "kind": "constant", "signature": "VISUAL_STATE_DECIMATE_ENTRY_POINT", "summary": "visual_state_decimate.js — Phase 2 ParticleNN articulatory kernel. Decimates a high-rate, multi-CHANNEL tract field (e.g. a per-section pressure-like signal, one channel per tube section) down to one box-averaged value per channel per fixed-size frame — the `VisualAirflowState` `ARCHITECTURE.md` §4 names as \"a decimated field for ribbon/particle/heatmap visualization\". Deliberately NOT a reuse of `physiology_feedback_reduce.js` despite the similar per-thread \"small sequential average over a window\" shape: that kernel reduces a single FLAT per-instance signal to (mean, RMS) pairs for model feedback (a statistics reduction); this kernel decimates a multi-CHANNEL per-instance FIELD (extra channel/section axis) down to mean-only per channel per frame, because a rendered airflow ribbon/ heatmap needs a representative value per tube section over time, not an energy statistic, and box-averaging over the decimation window (rather than picking every Nth raw sample) avoids visual aliasing/flicker in the downsampled field — ordinary decimation-filter practice, and consistent with how `overlap_add.js`/`stft.js` already treat windowing as the caller's/kernel's job rather than raw strided subsampling. `ARCHITECTURE.md` §4 also requires that visualization \"must be bit- identically disable-able without changing rendered PCM\" — this kernel reads its input field only (never writes back into it), so skipping this kernel's dispatch entirely when visualization is off cannot affect the `tract_waveguide.js`/`nasal_junction.js` PCM path in any way; that invariant is structural (this kernel has no read_write access to anything the acoustic path also reads), not merely a runtime convention." }, { "name": "VISUAL_STATE_DECIMATE_WORKGROUP_SIZE", "kind": "constant", "signature": "VISUAL_STATE_DECIMATE_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/chunks/complex_math", "path": "agi/reference/particle_voice/nn/kernels/chunks/complex_math.md", "source": "agi/particle_voice/nn/kernels/chunks/complex_math.js", "import": "/agi/particle_voice/nn/kernels/chunks/complex_math.js", "sourceHash": "e136ec85b076d78615a3364edf191b53d7ee160f0c0e2a6a5f2267f5bc545e75", "summary": "chunks/complex_math.js — Phase 1 ParticleNN kernel chunk. Generic complex-arithmetic WGSL fragment (mul/add/sub/twiddle), split out as reusable infrastructure ahead of Phase 2's `fft/fft1024_f32.js` / `fft/complex_mul.js` kernels — R3's `risk/Fft1024Kernel.js` inlined its own twiddle multiply directly in the butterfly loop (fine for a disposable risk spike); Phase 2's production FFT kernel should compose this chunk instead of re-deriving the same four multiplies/two adds. Complex numbers are represented as `vec2` (`.x` = real, `.y` = imag) throughout, not a named struct, to keep it directly usable as a return type/local without an extra struct declaration at every call site.", "exports": [ { "name": "complexMathChunk", "kind": "function", "signature": "complexMathChunk()", "summary": "" }, { "name": "COMPLEX_MATH_CHUNK_NAME", "kind": "constant", "signature": "COMPLEX_MATH_CHUNK_NAME", "summary": "chunks/complex_math.js — Phase 1 ParticleNN kernel chunk. Generic complex-arithmetic WGSL fragment (mul/add/sub/twiddle), split out as reusable infrastructure ahead of Phase 2's `fft/fft1024_f32.js` / `fft/complex_mul.js` kernels — R3's `risk/Fft1024Kernel.js` inlined its own twiddle multiply directly in the butterfly loop (fine for a disposable risk spike); Phase 2's production FFT kernel should compose this chunk instead of re-deriving the same four multiplies/two adds. Complex numbers are represented as `vec2` (`.x` = real, `.y` = imag) throughout, not a named struct, to keep it directly usable as a return type/local without an extra struct declaration at every call site." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/chunks/f16_utils", "path": "agi/reference/particle_voice/nn/kernels/chunks/f16_utils.md", "source": "agi/particle_voice/nn/kernels/chunks/f16_utils.js", "import": "/agi/particle_voice/nn/kernels/chunks/f16_utils.js", "sourceHash": "b0903d02074303a483db5686dc32a281895332f64a2a9da859b54750c7704d2b", "summary": "chunks/f16_utils.js — Phase 1 ParticleNN kernel chunk. On the WGSL side, `f16` kernels use WGSL's native `f16` type directly (`enable f16;` + `f16`/`vec2h` etc.) when `shader-f16` is available — no bit-manipulation WGSL fragment is needed there, unlike `int8_pack.js`'s manual unpack (WGSL has no native `i8` storage type, but it DOES have a native `f16` type). This file's job is the *host-side* JS<->f16 bit conversion needed to build/verify f16 test vectors and read `ParticleTensor`'s raw `Uint16Array` f16 readback (`ParticleTensor.js`'s `wrapReadbackBuffer` deliberately leaves `f16` tensors as raw bit patterns — this is where they get decoded).", "exports": [ { "name": "decodeF16", "kind": "function", "signature": "decodeF16(bits)", "summary": "IEEE 754 binary16 -> JS float64." }, { "name": "encodeF16", "kind": "function", "signature": "encodeF16(value)", "summary": "JS float64 -> IEEE 754 binary16 bit pattern (round-to-nearest-even is not implemented precisely — round-half-away-from-zero on the mantissa, adequate for test-vector construction, not for production-quality quantization-aware training)." }, { "name": "decodeF16Array", "kind": "function", "signature": "decodeF16Array(bitsArray)", "summary": "Decode a raw f16-bits `Uint16Array` (e.g. from `ParticleTensor.getData()`) into a `Float64Array`." }, { "name": "encodeF16Array", "kind": "function", "signature": "encodeF16Array(values)", "summary": "Encode a `Float32Array`/`Float64Array`/plain array into an f16-bits `Uint16Array`, suitable for `ParticleTensor` `data` with `dtype: 'f16'`." }, { "name": "F16_ABS_TOLERANCE", "kind": "re-export", "signature": "F16_ABS_TOLERANCE", "summary": "" }, { "name": "F16_REL_TOLERANCE", "kind": "re-export", "signature": "F16_REL_TOLERANCE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/chunks/int8_pack", "path": "agi/reference/particle_voice/nn/kernels/chunks/int8_pack.md", "source": "agi/particle_voice/nn/kernels/chunks/int8_pack.js", "import": "/agi/particle_voice/nn/kernels/chunks/int8_pack.js", "sourceHash": "7dc96101978d5d20feffcdda25b6b0c086f10c33fba69f12f381d95d8a78b63f", "summary": "chunks/int8_pack.js — Phase 1 ParticleNN kernel chunk. WGSL side: the `unpack_int8` fragment, extracted from R2's `risk/MatmulW8A16Kernel.js` (proven correct there — R2's parity test passed with max abs/rel error ~3.4e-7 against a JS scalar reference) into a shared chunk so `matmul_w8a16.js`/`conv1d_w8a16.js`/ `dequant_int8.js` all use the exact same unpack logic rather than each re-deriving it. JS side: the host-side symmetric block quantizer that produces the `packed`/`scales` pair this WGSL fragment expects, matching `ParticleTensor.js`'s documented `quant` scheme: `value = i8Value * scale` (zero-point-free, one scale per `blockSize`-sized block).", "exports": [ { "name": "int8PackChunk", "kind": "function", "signature": "int8PackChunk()", "summary": "" }, { "name": "quantizeInt8Blockwise", "kind": "function", "signature": "quantizeInt8Blockwise(values, blockSize)", "summary": "Symmetric per-block INT8 quantization: for each contiguous `blockSize`-sized block of `values`, scale = max(abs(block)) / 127, quantized = round(value / scale). Returns `{ packed: Uint32Array, scales: Float32Array, blockSize }`. `values.length` must be a multiple of 4 (four int8 values pack into one u32, matching R2's little-end-is-lowest-index layout)." }, { "name": "dequantizeInt8Blockwise", "kind": "function", "signature": "dequantizeInt8Blockwise(quantized, scales, blockSize)", "summary": "Dequantize `quantizeInt8Blockwise`'s output back to a `Float32Array`, for host-side parity checking against a kernel's GPU output." }, { "name": "INT8_PACK_CHUNK_NAME", "kind": "constant", "signature": "INT8_PACK_CHUNK_NAME", "summary": "chunks/int8_pack.js — Phase 1 ParticleNN kernel chunk. WGSL side: the `unpack_int8` fragment, extracted from R2's `risk/MatmulW8A16Kernel.js` (proven correct there — R2's parity test passed with max abs/rel error ~3.4e-7 against a JS scalar reference) into a shared chunk so `matmul_w8a16.js`/`conv1d_w8a16.js`/ `dequant_int8.js` all use the exact same unpack logic rather than each re-deriving it. JS side: the host-side symmetric block quantizer that produces the `packed`/`scales` pair this WGSL fragment expects, matching `ParticleTensor.js`'s documented `quant` scheme: `value = i8Value * scale` (zero-point-free, one scale per `blockSize`-sized block)." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/chunks/math_common", "path": "agi/reference/particle_voice/nn/kernels/chunks/math_common.md", "source": "agi/particle_voice/nn/kernels/chunks/math_common.js", "import": "/agi/particle_voice/nn/kernels/chunks/math_common.js", "sourceHash": "c3bb5663ea36475ad26d0c6fc280a87c51cc761f9fc3e6fa171b0c4dce9ffedd", "summary": "chunks/math_common.js — Phase 1 ParticleNN kernel chunk. Small reusable WGSL scalar-math fragments shared by multiple kernel generators, so e.g. `silu_f16.js` and any future fused-activation kernel define `siluScalar()`/`sigmoidScalar()` exactly once rather than each inlining its own copy (the kind of duplication the R2 spike's inline `unpack_int8` was an acceptable one-off for, but Phase 1 kernels should not repeat).", "exports": [ { "name": "mathCommonChunk", "kind": "function", "signature": "mathCommonChunk()", "summary": "" }, { "name": "MATH_COMMON_CHUNK_NAME", "kind": "constant", "signature": "MATH_COMMON_CHUNK_NAME", "summary": "chunks/math_common.js — Phase 1 ParticleNN kernel chunk. Small reusable WGSL scalar-math fragments shared by multiple kernel generators, so e.g. `silu_f16.js` and any future fused-activation kernel define `siluScalar()`/`sigmoidScalar()` exactly once rather than each inlining its own copy (the kind of duplication the R2 spike's inline `unpack_int8` was an acceptable one-off for, but Phase 1 kernels should not repeat)." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/convolution/conv1d_w8a16", "path": "agi/reference/particle_voice/nn/kernels/convolution/conv1d_w8a16.md", "source": "agi/particle_voice/nn/kernels/convolution/conv1d_w8a16.js", "import": "/agi/particle_voice/nn/kernels/convolution/conv1d_w8a16.js", "sourceHash": "a34e557313d05b525a9c7e579f1d27233a09b9d7c7b8519aa1159ba1eececbdf", "summary": "convolution/conv1d_w8a16.js — Phase 1 ParticleNN kernel. 1D convolution, INT8 weights (same 4-packed-per-u32 layout and `unpack_int8` as `matmul_w8a16.js`) x FP16/FP32 activations, FP32 accumulation. `[inChannels, kernelWidth]` per output channel, `'same'` padding (input implicitly zero-padded so output length equals input length) — stride 1 only; dilation/stride are Phase 2+ follow-ups if a consumer needs them (R7's toy Conv1D model used stride 1 only, and no Phase -1/0 document commits to anything else yet). Weight layout: `packedWeights[outCh * ceil(inChannels*kernelWidth/4) + k4]`, a u32 whose 4 bytes are int8 weights for the flattened `(inCh, tap)` index `k = k4*4 + 0..3`, where `inCh = k / kernelWidth` and `tap = k % kernelWidth`. `scales[outCh]` is the per-output-channel scale. `inChannels * kernelWidth` must be a multiple of 4.", "exports": [ { "name": "conv1dW8a16Shader", "kind": "function", "signature": "conv1dW8a16Shader({ useShaderF16 = false } = {})", "summary": "" }, { "name": "CONV1D_W8A16_ENTRY_POINT", "kind": "constant", "signature": "CONV1D_W8A16_ENTRY_POINT", "summary": "" }, { "name": "CONV1D_W8A16_WORKGROUP_SIZE", "kind": "constant", "signature": "CONV1D_W8A16_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/core/transpose_2d", "path": "agi/reference/particle_voice/nn/kernels/core/transpose_2d.md", "source": "agi/particle_voice/nn/kernels/core/transpose_2d.js", "import": "/agi/particle_voice/nn/kernels/core/transpose_2d.js", "sourceHash": "6b7fd18cd76b62f07db290eadb286780e8201d2dfa70c581682412d8716b93be", "summary": "core/transpose_2d.js — Phase 3 ParticleNN kernel. 2D transpose: `out[c, r] = in[r, c]`, i.e. `[rows, cols]` → `[cols, rows]`, both row-major. ## Why this exists The Phase 1 kernels disagree about which axis is major, and building `PhonemeEncoder.js` is the first time anything composes them: - `speech/embedding_f16.js` writes `[numIds, embedDim]` — **sequence-major** (one row per token), the natural shape for a gather. - `convolution/conv1d_w8a16.js` reads `[inChannels, seqLen]` — **channel-major**, the natural shape for sliding a kernel along time. - `normalization/rmsnorm_f16.js` normalizes each ROW independently, so per-token normalization over the feature axis needs sequence-major again. Neither layout is wrong for its own kernel, but the encoder has to cross between them, and nothing in the registry could. Rather than duplicating a transposed variant of the convolution (or silently re-interpreting a buffer and producing scrambled activations), the axis swap is its own explicit, testable op. Deliberately naive: one thread per element, no tiling and no shared-memory staging. The encoder's tensors are small (tens of channels x hundreds of frames), so the uncoalesced write is not worth the complexity — and a tiled version can replace this later without changing a single caller, since the contract is just \"swap the axes\".", "exports": [ { "name": "transpose2dShader", "kind": "function", "signature": "transpose2dShader({ useShaderF16 = false } = {})", "summary": "" }, { "name": "TRANSPOSE_2D_ENTRY_POINT", "kind": "constant", "signature": "TRANSPOSE_2D_ENTRY_POINT", "summary": "core/transpose_2d.js — Phase 3 ParticleNN kernel. 2D transpose: `out[c, r] = in[r, c]`, i.e. `[rows, cols]` → `[cols, rows]`, both row-major. ## Why this exists The Phase 1 kernels disagree about which axis is major, and building `PhonemeEncoder.js` is the first time anything composes them: - `speech/embedding_f16.js` writes `[numIds, embedDim]` — **sequence-major** (one row per token), the natural shape for a gather. - `convolution/conv1d_w8a16.js` reads `[inChannels, seqLen]` — **channel-major**, the natural shape for sliding a kernel along time. - `normalization/rmsnorm_f16.js` normalizes each ROW independently, so per-token normalization over the feature axis needs sequence-major again. Neither layout is wrong for its own kernel, but the encoder has to cross between them, and nothing in the registry could. Rather than duplicating a transposed variant of the convolution (or silently re-interpreting a buffer and producing scrambled activations), the axis swap is its own explicit, testable op. Deliberately naive: one thread per element, no tiling and no shared-memory staging. The encoder's tensors are small (tens of channels x hundreds of frames), so the uncoalesced write is not worth the complexity — and a tiled version can replace this later without changing a single caller, since the contract is just \"swap the axes\"." }, { "name": "TRANSPOSE_2D_WORKGROUP_SIZE", "kind": "constant", "signature": "TRANSPOSE_2D_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/fft/complex_mul", "path": "agi/reference/particle_voice/nn/kernels/fft/complex_mul.md", "source": "agi/particle_voice/nn/kernels/fft/complex_mul.js", "import": "/agi/particle_voice/nn/kernels/fft/complex_mul.js", "sourceHash": "3eb4e24f1739e1be87d89b2caa71a480dfafd00c7a9ef72e3d16ae21b642ae22", "summary": "complex_mul.js — Phase 2 ParticleNN DSP kernel. Elementwise complex multiplication: `(a+bi)(c+di) = (ac-bd) + (ad+bc)i`, over interleaved `[re, im, re, im, ...]` buffers, matching `fft1024_f32.js`'s interleaved-complex layout so FFT output can feed this directly (e.g. frequency-domain filtering: `FFT(x) * H` then `IFFT`).", "exports": [ { "name": "complexMulShader", "kind": "function", "signature": "complexMulShader()", "summary": "" }, { "name": "COMPLEX_MUL_ENTRY_POINT", "kind": "constant", "signature": "COMPLEX_MUL_ENTRY_POINT", "summary": "complex_mul.js — Phase 2 ParticleNN DSP kernel. Elementwise complex multiplication: `(a+bi)(c+di) = (ac-bd) + (ad+bc)i`, over interleaved `[re, im, re, im, ...]` buffers, matching `fft1024_f32.js`'s interleaved-complex layout so FFT output can feed this directly (e.g. frequency-domain filtering: `FFT(x) * H` then `IFFT`)." }, { "name": "COMPLEX_MUL_WORKGROUP_SIZE", "kind": "constant", "signature": "COMPLEX_MUL_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/fft/fft1024_f32", "path": "agi/reference/particle_voice/nn/kernels/fft/fft1024_f32.md", "source": "agi/particle_voice/nn/kernels/fft/fft1024_f32.js", "import": "/agi/particle_voice/nn/kernels/fft/fft1024_f32.js", "sourceHash": "371829d47fd3b9f85b62f0eee545ae270a10e5834e98acbf9de2ede297768fd5", "summary": "fft1024_f32.js — Phase 2 ParticleNN DSP kernel. Single-workgroup, in-workgroup-memory, iterative radix-2 Cooley-Tukey forward FFT — generalizes `risk/Fft1024Kernel.js` (R3)'s proven butterfly network to run with **256 threads/workgroup** (each thread handles 2 butterfly operations per stage / 4 elements for load-scatter) instead of R3's 512, so it needs **no elevated `maxComputeWorkgroupSizeX` request** — every conformant WebGPU adapter guarantees 256 by default. This resolves the exact gap `spec/DeviceContract-v0.md` §4 flagged as an unresolved \"Phase 1/2 follow-up\": rather than requesting a higher limit with a fallback path for adapters that refuse it, this kernel simply never needs the higher limit. One workgroup computes exactly one 1024-point complex FFT; `workgroup_id.x` selects which frame of a batch to process (`dispatchWorkgroups(numFrames)`), matching R3's batching design. Complex numbers are interleaved `[re0, im0, re1, im1, ...]` in a single flat `array` per frame (`frame_base = wid.x * N * 2`) — one input buffer, one output buffer, matching every other Phase 1/2 kernel's single-input/single-output convention (unlike R3's separate real/imag arrays). No uniform buffer is needed (frame selection comes entirely from `workgroup_id`), so this kernel registers with `hasUniform: false` in `KernelRegistry.js`.", "exports": [ { "name": "buildFft1024Shader", "kind": "function", "signature": "buildFft1024Shader(direction)", "summary": "Shared by `fft1024_f32.js` and `ifft1024_f32.js` — `direction` (+1 forward, -1 inverse) is baked in at generation time, not read from a uniform, since each op is a distinct, fixed-behavior kernel." }, { "name": "fft1024F32Shader", "kind": "function", "signature": "fft1024F32Shader()", "summary": "" }, { "name": "FFT_N", "kind": "constant", "signature": "FFT_N", "summary": "fft1024_f32.js — Phase 2 ParticleNN DSP kernel. Single-workgroup, in-workgroup-memory, iterative radix-2 Cooley-Tukey forward FFT — generalizes `risk/Fft1024Kernel.js` (R3)'s proven butterfly network to run with **256 threads/workgroup** (each thread handles 2 butterfly operations per stage / 4 elements for load-scatter) instead of R3's 512, so it needs **no elevated `maxComputeWorkgroupSizeX` request** — every conformant WebGPU adapter guarantees 256 by default. This resolves the exact gap `spec/DeviceContract-v0.md` §4 flagged as an unresolved \"Phase 1/2 follow-up\": rather than requesting a higher limit with a fallback path for adapters that refuse it, this kernel simply never needs the higher limit. One workgroup computes exactly one 1024-point complex FFT; `workgroup_id.x` selects which frame of a batch to process (`dispatchWorkgroups(numFrames)`), matching R3's batching design. Complex numbers are interleaved `[re0, im0, re1, im1, ...]` in a single flat `array` per frame (`frame_base = wid.x * N * 2`) — one input buffer, one output buffer, matching every other Phase 1/2 kernel's single-input/single-output convention (unlike R3's separate real/imag arrays). No uniform buffer is needed (frame selection comes entirely from `workgroup_id`), so this kernel registers with `hasUniform: false` in `KernelRegistry.js`." }, { "name": "FFT_LOG2N", "kind": "constant", "signature": "FFT_LOG2N", "summary": "" }, { "name": "FFT_WORKGROUP_THREADS", "kind": "constant", "signature": "FFT_WORKGROUP_THREADS", "summary": "" }, { "name": "FFT_ENTRY_POINT", "kind": "constant", "signature": "FFT_ENTRY_POINT", "summary": "" }, { "name": "FFT_WORKGROUP_SIZE", "kind": "constant", "signature": "FFT_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/fft/ifft1024_f32", "path": "agi/reference/particle_voice/nn/kernels/fft/ifft1024_f32.md", "source": "agi/particle_voice/nn/kernels/fft/ifft1024_f32.js", "import": "/agi/particle_voice/nn/kernels/fft/ifft1024_f32.js", "sourceHash": "22733db23e3f93bd6b455a5dc77e3308f377537ec606c8fe44d648b664fa4aa8", "summary": "ifft1024_f32.js — Phase 2 ParticleNN DSP kernel. Inverse of `fft1024_f32.js`: same butterfly network (see that file's docstring for the full algorithm/limit-generalization rationale), with `direction = -1` baked in — conjugate the input, run the same forward butterfly network, conjugate + scale by `1/N` (`IFFT(X) = (1/N) * conj(FFT(conj(X)))`), matching R3's proven identity.", "exports": [ { "name": "ifft1024F32Shader", "kind": "function", "signature": "ifft1024F32Shader()", "summary": "" }, { "name": "FFT_ENTRY_POINT", "kind": "re-export", "signature": "FFT_ENTRY_POINT", "summary": "" }, { "name": "FFT_LOG2N", "kind": "re-export", "signature": "FFT_LOG2N", "summary": "" }, { "name": "FFT_N", "kind": "re-export", "signature": "FFT_N", "summary": "" }, { "name": "FFT_WORKGROUP_SIZE", "kind": "re-export", "signature": "FFT_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/matmul/matmul_w8a16", "path": "agi/reference/particle_voice/nn/kernels/matmul/matmul_w8a16.md", "source": "agi/particle_voice/nn/kernels/matmul/matmul_w8a16.js", "import": "/agi/particle_voice/nn/kernels/matmul/matmul_w8a16.js", "sourceHash": "e573221354603c35e438ee83cd17121d00705091e6d472733ae2065c6ce38e18", "summary": "matmul/matmul_w8a16.js — Phase 1 ParticleNN kernel. INT8 weights (4-packed per u32, per-output-channel scale, `chunks/int8_pack.js`'s `unpack_int8`) x FP16 activations, FP32 accumulation, FP16 output — the real target this plan names, superseding R2's FP32-activation stand-in (`risk/MatmulW8A16Kernel.js`) now that R1 has proven `shader-f16` is available on at least one reference device. Falls back to FP32 activations/output when `useShaderF16` is false (DeviceContract-v0's `no-f16` tier) — same kernel body, different element type, not two separately-maintained kernels. Weight layout (unchanged from R2, already proven): logical weights are [K, N]; `packedWeights[n * (K/4) + k4]` is a u32 whose 4 bytes are the int8 weights for k = k4*4 + 0..3 (little end = lowest k); `scales[n]` is the per-output-channel dequantization scale. K must be a multiple of 4.", "exports": [ { "name": "matmulW8a16Shader", "kind": "function", "signature": "matmulW8a16Shader({ useShaderF16 = false } = {})", "summary": "" }, { "name": "MATMUL_W8A16_ENTRY_POINT", "kind": "constant", "signature": "MATMUL_W8A16_ENTRY_POINT", "summary": "" }, { "name": "MATMUL_W8A16_WORKGROUP_SIZE", "kind": "constant", "signature": "MATMUL_W8A16_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/normalization/rmsnorm_f16", "path": "agi/reference/particle_voice/nn/kernels/normalization/rmsnorm_f16.md", "source": "agi/particle_voice/nn/kernels/normalization/rmsnorm_f16.js", "import": "/agi/particle_voice/nn/kernels/normalization/rmsnorm_f16.js", "sourceHash": "598ad539ca4a533d2d0a56a11133457094e133738631d217d01f9e5a35cfe5be", "summary": "normalization/rmsnorm_f16.js — Phase 1 ParticleNN kernel. Row-wise RMSNorm: `out[i] = x[i] / sqrt(mean(x^2) + eps) * weight[i]`. One workgroup per row; workgroup-shared reduction for the sum-of-squares (standard tree reduction, `WORKGROUP_SIZE` must be a power of two). Accumulates in f32 regardless of `useShaderF16`, matching `matmul_w8a16.js`'s \"FP32 accumulation\" convention — only the input/output storage element type changes with the feature flag.", "exports": [ { "name": "rmsnormF16Shader", "kind": "function", "signature": "rmsnormF16Shader({ useShaderF16 = false, eps = 1e-6 } = {})", "summary": "" }, { "name": "RMSNORM_F16_ENTRY_POINT", "kind": "constant", "signature": "RMSNORM_F16_ENTRY_POINT", "summary": "normalization/rmsnorm_f16.js — Phase 1 ParticleNN kernel. Row-wise RMSNorm: `out[i] = x[i] / sqrt(mean(x^2) + eps) * weight[i]`. One workgroup per row; workgroup-shared reduction for the sum-of-squares (standard tree reduction, `WORKGROUP_SIZE` must be a power of two). Accumulates in f32 regardless of `useShaderF16`, matching `matmul_w8a16.js`'s \"FP32 accumulation\" convention — only the input/output storage element type changes with the feature flag." }, { "name": "RMSNORM_F16_WORKGROUP_SIZE", "kind": "constant", "signature": "RMSNORM_F16_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/quantization/dequant_int8", "path": "agi/reference/particle_voice/nn/kernels/quantization/dequant_int8.md", "source": "agi/particle_voice/nn/kernels/quantization/dequant_int8.js", "import": "/agi/particle_voice/nn/kernels/quantization/dequant_int8.js", "sourceHash": "7bbca96258783b21efd68b02b9692a392ff0b24392eb92c285e9da9acbcd7ce1", "summary": "quantization/dequant_int8.js — Phase 1 ParticleNN kernel. Standalone unpack+dequantize kernel: `matmul_w8a16.js`/`conv1d_w8a16.js` fuse unpack+dequant+multiply-accumulate inline for performance, but `WeightPageUploader.js`/tooling sometimes need a plain materialized dequantized tensor (e.g. for a CPU-side parity check, or a debug visualization) without running a full matmul — this is that kernel. Uses the same `chunks/int8_pack.js` `unpack_int8` and per-block scale scheme as `ParticleTensor.js`'s documented `quant` metadata.", "exports": [ { "name": "dequantInt8Shader", "kind": "function", "signature": "dequantInt8Shader({ useShaderF16 = false } = {})", "summary": "" }, { "name": "DEQUANT_INT8_ENTRY_POINT", "kind": "constant", "signature": "DEQUANT_INT8_ENTRY_POINT", "summary": "" }, { "name": "DEQUANT_INT8_WORKGROUP_SIZE", "kind": "constant", "signature": "DEQUANT_INT8_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/quantization/pack_unpack", "path": "agi/reference/particle_voice/nn/kernels/quantization/pack_unpack.md", "source": "agi/particle_voice/nn/kernels/quantization/pack_unpack.js", "import": "/agi/particle_voice/nn/kernels/quantization/pack_unpack.js", "sourceHash": "90b0f96a8adb1b4a91da43cea0f3defb250926901d802fbe8edde199ec2d4d29", "summary": "quantization/pack_unpack.js — Phase 1 ParticleNN kernel. The pack direction complementing `dequant_int8.js`'s unpack direction: a GPU kernel that bit-packs already-quantized int8 values (as `i32` inputs already rounded/clamped to [-127, 127] — computing the *scale* is a separate reduction pass, not this kernel's job) into 4-packed u32 words, matching `chunks/int8_pack.js`'s host-side `quantizeInt8Blockwise`'s packed-word layout exactly (so a GPU-side requantization pipeline and the JS host-side one are interchangeable).", "exports": [ { "name": "packInt8Shader", "kind": "function", "signature": "packInt8Shader()", "summary": "Packs `array` (one already-quantized value per element, [-127,127]) into `array` (4 values per word). `count` must be a multiple of 4." }, { "name": "packInt8Reference", "kind": "function", "signature": "packInt8Reference(quantizedInt8Array)", "summary": "JS-side reference pack, for parity-testing `packInt8Shader` against a CPU implementation. Mirrors `chunks/int8_pack.js`'s packing loop exactly." }, { "name": "PACK_INT8_ENTRY_POINT", "kind": "constant", "signature": "PACK_INT8_ENTRY_POINT", "summary": "quantization/pack_unpack.js — Phase 1 ParticleNN kernel. The pack direction complementing `dequant_int8.js`'s unpack direction: a GPU kernel that bit-packs already-quantized int8 values (as `i32` inputs already rounded/clamped to [-127, 127] — computing the *scale* is a separate reduction pass, not this kernel's job) into 4-packed u32 words, matching `chunks/int8_pack.js`'s host-side `quantizeInt8Blockwise`'s packed-word layout exactly (so a GPU-side requantization pipeline and the JS host-side one are interchangeable)." }, { "name": "PACK_INT8_WORKGROUP_SIZE", "kind": "constant", "signature": "PACK_INT8_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/speech/crossfade", "path": "agi/reference/particle_voice/nn/kernels/speech/crossfade.md", "source": "agi/particle_voice/nn/kernels/speech/crossfade.js", "import": "/agi/particle_voice/nn/kernels/speech/crossfade.js", "sourceHash": "6a6d8a82d15cff5ee5fc0818df6413afe55c7a9a1924fd11ccd7a8c236f9a6f1", "summary": "crossfade.js — Phase 2 ParticleNN DSP kernel. Equal-power crossfade between two equal-length signals over their full length: `t = i/(length-1)`, `out = a*cos(t*pi/2) + b*sin(t*pi/2)` — equal-power (not linear) so the perceived loudness stays constant through the fade instead of dipping at the midpoint (linear crossfade's well-known flaw), matching the constant-power crossfade convention `ARCHITECTURE.md`'s reaction-system voice transitions call for.", "exports": [ { "name": "crossfadeShader", "kind": "function", "signature": "crossfadeShader()", "summary": "" }, { "name": "CROSSFADE_ENTRY_POINT", "kind": "constant", "signature": "CROSSFADE_ENTRY_POINT", "summary": "crossfade.js — Phase 2 ParticleNN DSP kernel. Equal-power crossfade between two equal-length signals over their full length: `t = i/(length-1)`, `out = a*cos(t*pi/2) + b*sin(t*pi/2)` — equal-power (not linear) so the perceived loudness stays constant through the fade instead of dipping at the midpoint (linear crossfade's well-known flaw), matching the constant-power crossfade convention `ARCHITECTURE.md`'s reaction-system voice transitions call for." }, { "name": "CROSSFADE_WORKGROUP_SIZE", "kind": "constant", "signature": "CROSSFADE_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/speech/embedding_f16", "path": "agi/reference/particle_voice/nn/kernels/speech/embedding_f16.md", "source": "agi/particle_voice/nn/kernels/speech/embedding_f16.js", "import": "/agi/particle_voice/nn/kernels/speech/embedding_f16.js", "sourceHash": "429357dde15d836e92ad885e48587bdaf14223107ea0287f4acee4ab0c1ca206", "summary": "speech/embedding_f16.js — Phase 1 ParticleNN kernel. Row-gather embedding lookup: `output[i, :] = table[ids[i], :]`. Named under `speech/` (not `matmul/`) because its first production consumer is `PhonemeEncoder.js`'s phoneme-ID embedding (Phase 3), looking up rows out of `PhonemeSet-v0`'s fixed 42-entry table — but the kernel itself is generic over table/embedding-dim size. (That count read \"51\" until Phase 3: the spec's own summary line miscounted its vowel tables. `frontend/PhonemeSet.js` is the executable source of truth and exports `PHONEME_COUNT = 42`, which is what a caller should size `tableRows` from rather than any hard-coded literal.) Output layout is `[numIds, embedDim]` — SEQUENCE-major, one row per token. Note that `convolution/conv1d_w8a16.js` expects CHANNEL-major `[inChannels, seqLen]`, so composing the two requires `core/transpose_2d.js` in between; `PhonemeEncoder.js` does exactly that.", "exports": [ { "name": "embeddingF16Shader", "kind": "function", "signature": "embeddingF16Shader({ useShaderF16 = false } = {})", "summary": "" }, { "name": "EMBEDDING_F16_ENTRY_POINT", "kind": "constant", "signature": "EMBEDDING_F16_ENTRY_POINT", "summary": "speech/embedding_f16.js — Phase 1 ParticleNN kernel. Row-gather embedding lookup: `output[i, :] = table[ids[i], :]`. Named under `speech/` (not `matmul/`) because its first production consumer is `PhonemeEncoder.js`'s phoneme-ID embedding (Phase 3), looking up rows out of `PhonemeSet-v0`'s fixed 42-entry table — but the kernel itself is generic over table/embedding-dim size. (That count read \"51\" until Phase 3: the spec's own summary line miscounted its vowel tables. `frontend/PhonemeSet.js` is the executable source of truth and exports `PHONEME_COUNT = 42`, which is what a caller should size `tableRows` from rather than any hard-coded literal.) Output layout is `[numIds, embedDim]` — SEQUENCE-major, one row per token. Note that `convolution/conv1d_w8a16.js` expects CHANNEL-major `[inChannels, seqLen]`, so composing the two requires `core/transpose_2d.js` in between; `PhonemeEncoder.js` does exactly that." }, { "name": "EMBEDDING_F16_WORKGROUP_SIZE", "kind": "constant", "signature": "EMBEDDING_F16_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/speech/harmonic_source", "path": "agi/reference/particle_voice/nn/kernels/speech/harmonic_source.md", "source": "agi/particle_voice/nn/kernels/speech/harmonic_source.js", "import": "/agi/particle_voice/nn/kernels/speech/harmonic_source.js", "sourceHash": "e4c63320996de935a002ed90d7ee86a1c84839a087e94e90de90a1686366fd1f", "summary": "harmonic_source.js — Phase 2 ParticleNN DSP kernel. Voiced glottal pulse train — the \"LF-lite\" raised-cosine shape proven in `risk/GlottalSource.js` (R6): flow(n) = 0.5*(1-cos(2*pi*cyclePos(n)/openSamples)) for cyclePos(n) < openSamples flow(n) = 0 otherwise Unlike R6's per-sample sequential CPU generator (which tracks `cyclePos` as running state, updated one sample at a time), this kernel computes every sample **in closed form and fully in parallel**: `cyclePos(n) = (start_phase + n) mod period_samples`, using an **absolute sample counter** (`start_phase`) the caller persists and advances across chunk boundaries — exactly the \"LF glottal source with absolute counter\" the plan's checklist calls for, and mathematically identical to R6's per-sample recurrence for as long as `period_samples`/`open_samples` hold constant across the dispatched chunk (the same constant-until-the- next-period-boundary assumption R6's own generator already makes). Aspiration noise is NOT mixed in here (unlike R6's spike, which combined both for simplicity) — that is `noise_source.js`'s job, mixed downstream, since the operator allowlist treats voiced and unvoiced excitation as independent ops that a later stage combines.", "exports": [ { "name": "harmonicSourceShader", "kind": "function", "signature": "harmonicSourceShader()", "summary": "" }, { "name": "HARMONIC_SOURCE_ENTRY_POINT", "kind": "constant", "signature": "HARMONIC_SOURCE_ENTRY_POINT", "summary": "harmonic_source.js — Phase 2 ParticleNN DSP kernel. Voiced glottal pulse train — the \"LF-lite\" raised-cosine shape proven in `risk/GlottalSource.js` (R6): flow(n) = 0.5*(1-cos(2*pi*cyclePos(n)/openSamples)) for cyclePos(n) < openSamples flow(n) = 0 otherwise Unlike R6's per-sample sequential CPU generator (which tracks `cyclePos` as running state, updated one sample at a time), this kernel computes every sample **in closed form and fully in parallel**: `cyclePos(n) = (start_phase + n) mod period_samples`, using an **absolute sample counter** (`start_phase`) the caller persists and advances across chunk boundaries — exactly the \"LF glottal source with absolute counter\" the plan's checklist calls for, and mathematically identical to R6's per-sample recurrence for as long as `period_samples`/`open_samples` hold constant across the dispatched chunk (the same constant-until-the- next-period-boundary assumption R6's own generator already makes). Aspiration noise is NOT mixed in here (unlike R6's spike, which combined both for simplicity) — that is `noise_source.js`'s job, mixed downstream, since the operator allowlist treats voiced and unvoiced excitation as independent ops that a later stage combines." }, { "name": "HARMONIC_SOURCE_WORKGROUP_SIZE", "kind": "constant", "signature": "HARMONIC_SOURCE_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/speech/mel_filterbank", "path": "agi/reference/particle_voice/nn/kernels/speech/mel_filterbank.md", "source": "agi/particle_voice/nn/kernels/speech/mel_filterbank.js", "import": "/agi/particle_voice/nn/kernels/speech/mel_filterbank.js", "sourceHash": "722bcc86cc8aa8e4f93c0be2d7ef3ca0b4a69f2d4bbf1a15ba1623645d0e3425", "summary": "mel_filterbank.js — Phase 2 ParticleNN DSP kernel. Applies a precomputed triangular mel filterbank matrix to a power/ magnitude spectrogram: `mel[f, m] = sum_k filterbank[m, k] * spectrum[f, k]` — a small matmul-shaped reduction, not a general matmul (the filterbank is fixed-shape and typically far smaller than `matmul_w8a16.js`'s tile sizes, so a dedicated one-thread-per-output-element kernel is simpler and avoids forcing an INT8-quantized weight path onto filter coefficients that are naturally small dense f32 matrices, not learned weights). The filterbank matrix itself (triangular mel-scale filters for a given sample rate/`n_mels`/`fmin`/`fmax`) is computed once on the CPU at model-load time — this kernel only applies it.", "exports": [ { "name": "melFilterbankShader", "kind": "function", "signature": "melFilterbankShader()", "summary": "" }, { "name": "MEL_FILTERBANK_ENTRY_POINT", "kind": "constant", "signature": "MEL_FILTERBANK_ENTRY_POINT", "summary": "mel_filterbank.js — Phase 2 ParticleNN DSP kernel. Applies a precomputed triangular mel filterbank matrix to a power/ magnitude spectrogram: `mel[f, m] = sum_k filterbank[m, k] * spectrum[f, k]` — a small matmul-shaped reduction, not a general matmul (the filterbank is fixed-shape and typically far smaller than `matmul_w8a16.js`'s tile sizes, so a dedicated one-thread-per-output-element kernel is simpler and avoids forcing an INT8-quantized weight path onto filter coefficients that are naturally small dense f32 matrices, not learned weights). The filterbank matrix itself (triangular mel-scale filters for a given sample rate/`n_mels`/`fmin`/`fmax`) is computed once on the CPU at model-load time — this kernel only applies it." }, { "name": "MEL_FILTERBANK_WORKGROUP_SIZE", "kind": "constant", "signature": "MEL_FILTERBANK_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/speech/noise_source", "path": "agi/reference/particle_voice/nn/kernels/speech/noise_source.md", "source": "agi/particle_voice/nn/kernels/speech/noise_source.js", "import": "/agi/particle_voice/nn/kernels/speech/noise_source.js", "sourceHash": "ee9442eec7b42af87042930c1b84cea804189903a9c738b7410385c2c7201070", "summary": "noise_source.js — Phase 2 ParticleNN DSP kernel. Deterministic, chunk-boundary-independent aspiration/turbulence noise — the exact integer hash proven in `risk/GlottalSource.js` (R6)'s `noiseAt(absoluteIndex, seed)` (itself the same technique as `StreamingContinuitySource.js`'s counter-based noise): a two-round Murmur-style avalanche hash of `absoluteIndex ^ seed`, mapped to `[-1, 1)`. Counter-based (not a stateful PRNG stream) so any two chunks covering the same absolute sample index always produce the same noise value, regardless of dispatch order or chunk boundaries — required for glitch-free streaming synthesis.", "exports": [ { "name": "noiseSourceShader", "kind": "function", "signature": "noiseSourceShader()", "summary": "" }, { "name": "NOISE_SOURCE_ENTRY_POINT", "kind": "constant", "signature": "NOISE_SOURCE_ENTRY_POINT", "summary": "noise_source.js — Phase 2 ParticleNN DSP kernel. Deterministic, chunk-boundary-independent aspiration/turbulence noise — the exact integer hash proven in `risk/GlottalSource.js` (R6)'s `noiseAt(absoluteIndex, seed)` (itself the same technique as `StreamingContinuitySource.js`'s counter-based noise): a two-round Murmur-style avalanche hash of `absoluteIndex ^ seed`, mapped to `[-1, 1)`. Counter-based (not a stateful PRNG stream) so any two chunks covering the same absolute sample index always produce the same noise value, regardless of dispatch order or chunk boundaries — required for glitch-free streaming synthesis." }, { "name": "NOISE_SOURCE_WORKGROUP_SIZE", "kind": "constant", "signature": "NOISE_SOURCE_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/speech/overlap_add", "path": "agi/reference/particle_voice/nn/kernels/speech/overlap_add.md", "source": "agi/particle_voice/nn/kernels/speech/overlap_add.js", "import": "/agi/particle_voice/nn/kernels/speech/overlap_add.js", "sourceHash": "d8034ad1def3f70176578813a48afd42eb3c50223999e246839a9e060ff454ed", "summary": "overlap_add.js — Phase 2 ParticleNN DSP kernel. Synthesis overlap-add: reconstructs a continuous signal from overlapping `frame_size`-length windowed frames at `hop_size` stride, matching `risk/WolaSignals.js`'s proven `overlapAdd` reference. Implemented as a **gather**, not a scatter: each output thread owns exactly one output sample and sums every frame that overlaps it (`f*hop <= t < f*hop + frame_size`) — WGSL's core spec has no `atomic` add, so a scatter (`output[t] += ...` from many threads across overlapping frames) would race; gathering avoids that entirely with no atomics and no serialized per-frame dispatches needed. `component_stride` is the number of consecutive `f32` components per logical sample in `frames_in`, so this kernel can consume both layouts the pipeline actually produces: - `component_stride = 1` — flat real frames. - `component_stride = 2` — INTERLEAVED COMPLEX frames, which is exactly what `ifft1024_f32.js` emits. Only the REAL component is summed (the imaginary residue of an inverse-transformed real signal is numerical noise), making this the ISTFT synthesis stage directly, with no separate deinterleave kernel needed in between. Without this stride, `frames_in[f*frame_size + n]` reads the interleaved-complex buffer as if it were flat real — silently mixing real and imaginary components of the wrong samples together. That gap was found by the `tests/particle-voice/stft-istft-identity.html` integration test.", "exports": [ { "name": "overlapAddShader", "kind": "function", "signature": "overlapAddShader()", "summary": "" }, { "name": "OVERLAP_ADD_ENTRY_POINT", "kind": "constant", "signature": "OVERLAP_ADD_ENTRY_POINT", "summary": "overlap_add.js — Phase 2 ParticleNN DSP kernel. Synthesis overlap-add: reconstructs a continuous signal from overlapping `frame_size`-length windowed frames at `hop_size` stride, matching `risk/WolaSignals.js`'s proven `overlapAdd` reference. Implemented as a **gather**, not a scatter: each output thread owns exactly one output sample and sums every frame that overlaps it (`f*hop <= t < f*hop + frame_size`) — WGSL's core spec has no `atomic` add, so a scatter (`output[t] += ...` from many threads across overlapping frames) would race; gathering avoids that entirely with no atomics and no serialized per-frame dispatches needed. `component_stride` is the number of consecutive `f32` components per logical sample in `frames_in`, so this kernel can consume both layouts the pipeline actually produces: - `component_stride = 1` — flat real frames. - `component_stride = 2` — INTERLEAVED COMPLEX frames, which is exactly what `ifft1024_f32.js` emits. Only the REAL component is summed (the imaginary residue of an inverse-transformed real signal is numerical noise), making this the ISTFT synthesis stage directly, with no separate deinterleave kernel needed in between. Without this stride, `frames_in[f*frame_size + n]` reads the interleaved-complex buffer as if it were flat real — silently mixing real and imaginary components of the wrong samples together. That gap was found by the `tests/particle-voice/stft-istft-identity.html` integration test." }, { "name": "OVERLAP_ADD_WORKGROUP_SIZE", "kind": "constant", "signature": "OVERLAP_ADD_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/speech/stft", "path": "agi/reference/particle_voice/nn/kernels/speech/stft.md", "source": "agi/particle_voice/nn/kernels/speech/stft.js", "import": "/agi/particle_voice/nn/kernels/speech/stft.js", "sourceHash": "2f1a0d7b155a23e65188b6f88b2782829ab86ed7cd51e9fed95c79fb5439d661", "summary": "stft.js — Phase 2 ParticleNN DSP kernel. The framing half of STFT: slices overlapping `frame_size`-length windows from a flat mono signal at `hop_size` stride (zero-padded past the signal's end), matching `risk/WolaSignals.js`'s proven `sliceFrames` reference exactly. Writes each frame's samples into the real channel of an interleaved-complex output (`fft1024_f32.js`'s layout) with the imaginary channel zeroed, so the output can be windowed (`window.js`) then fed directly to `fft1024_f32.js` — the actual FFT transform is a separate op (already in the operator allowlist), not duplicated here.", "exports": [ { "name": "stftShader", "kind": "function", "signature": "stftShader()", "summary": "" }, { "name": "STFT_ENTRY_POINT", "kind": "constant", "signature": "STFT_ENTRY_POINT", "summary": "stft.js — Phase 2 ParticleNN DSP kernel. The framing half of STFT: slices overlapping `frame_size`-length windows from a flat mono signal at `hop_size` stride (zero-padded past the signal's end), matching `risk/WolaSignals.js`'s proven `sliceFrames` reference exactly. Writes each frame's samples into the real channel of an interleaved-complex output (`fft1024_f32.js`'s layout) with the imaginary channel zeroed, so the output can be windowed (`window.js`) then fed directly to `fft1024_f32.js` — the actual FFT transform is a separate op (already in the operator allowlist), not duplicated here." }, { "name": "STFT_WORKGROUP_SIZE", "kind": "constant", "signature": "STFT_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/kernels/speech/window", "path": "agi/reference/particle_voice/nn/kernels/speech/window.md", "source": "agi/particle_voice/nn/kernels/speech/window.js", "import": "/agi/particle_voice/nn/kernels/speech/window.js", "sourceHash": "ed9150e02394465ffea4789da4d3ed8b7d85d202fce393e562302d25b830f603", "summary": "window.js — Phase 2 ParticleNN DSP kernel. Applies a Hann window in-place across framed audio: `out[f,n] = in[f,n] * 0.5*(1-cos(2*pi*n/(N-1)))`, matching `risk/WolaSignals.js`'s proven `hannWindow`/`applyWindow` CPU reference exactly (same coefficient formula) so R3's WOLA identity tests remain the ground truth this kernel is checked against. The coefficient is computed in-shader from the frame-relative index rather than read from a precomputed buffer — one fewer buffer to manage, and Hann's formula is cheap per-element. `stride` is the number of consecutive `f32` components per logical sample, so the same kernel windows both layouts this pipeline actually produces: - `stride = 1` — flat real frames (`[f0s0, f0s1, ...]`). - `stride = 2` — INTERLEAVED COMPLEX frames (`[re, im, re, im, ...]`), which is exactly what `stft.js` emits and what `fft1024_f32.js` consumes. Both the real and imaginary component of a sample get the SAME coefficient (the correct definition of windowing a complex signal), because `n` is derived from the logical sample index `i / stride`, not the raw component index. Without this stride, `n = i % frame_size` silently mis-assigns coefficients when handed interleaved-complex data (component index and sample index diverge by a factor of 2), so `stft.js`'s documented \"output can be windowed (window.js) then fed directly to fft1024_f32.js\" composition would produce a wrong window. That gap was found by the `tests/particle-voice/stft-istft-identity.html` integration test — each kernel passed its own parity test in isolation, but the composed WOLA round-trip did not reconstruct.", "exports": [ { "name": "windowShader", "kind": "function", "signature": "windowShader()", "summary": "" }, { "name": "WINDOW_ENTRY_POINT", "kind": "constant", "signature": "WINDOW_ENTRY_POINT", "summary": "window.js — Phase 2 ParticleNN DSP kernel. Applies a Hann window in-place across framed audio: `out[f,n] = in[f,n] * 0.5*(1-cos(2*pi*n/(N-1)))`, matching `risk/WolaSignals.js`'s proven `hannWindow`/`applyWindow` CPU reference exactly (same coefficient formula) so R3's WOLA identity tests remain the ground truth this kernel is checked against. The coefficient is computed in-shader from the frame-relative index rather than read from a precomputed buffer — one fewer buffer to manage, and Hann's formula is cheap per-element. `stride` is the number of consecutive `f32` components per logical sample, so the same kernel windows both layouts this pipeline actually produces: - `stride = 1` — flat real frames (`[f0s0, f0s1, ...]`). - `stride = 2` — INTERLEAVED COMPLEX frames (`[re, im, re, im, ...]`), which is exactly what `stft.js` emits and what `fft1024_f32.js` consumes. Both the real and imaginary component of a sample get the SAME coefficient (the correct definition of windowing a complex signal), because `n` is derived from the logical sample index `i / stride`, not the raw component index. Without this stride, `n = i % frame_size` silently mis-assigns coefficients when handed interleaved-complex data (component index and sample index diverge by a factor of 2), so `stft.js`'s documented \"output can be windowed (window.js) then fed directly to fft1024_f32.js\" composition would produce a wrong window. That gap was found by the `tests/particle-voice/stft-istft-identity.html` integration test — each kernel passed its own parity test in isolation, but the composed WOLA round-trip did not reconstruct." }, { "name": "WINDOW_WORKGROUP_SIZE", "kind": "constant", "signature": "WINDOW_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/memory/ActivationArena", "path": "agi/reference/particle_voice/nn/memory/ActivationArena.md", "source": "agi/particle_voice/nn/memory/ActivationArena.js", "import": "/agi/particle_voice/nn/memory/ActivationArena.js", "sourceHash": "eac1b45ac84a89abb447f9b30ed89aa5ca5bbe4e83f48a03039097dd690d0d0c", "summary": "ActivationArena.js — Phase 1 ParticleNN memory. Transient GPU-buffer pool for activation tensors, keyed by byte size: `acquire(tensorName, byteLength)` reuses a same-size buffer already released by an earlier tensor instead of allocating a new one, and `release(tensorName)` (driven by `TensorLifetimePlanner.freedAfter()`) returns a buffer to the pool the moment its last consumer has run.", "exports": [ { "name": "ActivationArena", "kind": "class", "signature": "class ActivationArena", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/memory/GradientArena", "path": "agi/reference/particle_voice/nn/memory/GradientArena.md", "source": "agi/particle_voice/nn/memory/GradientArena.js", "import": "/agi/particle_voice/nn/memory/GradientArena.js", "sourceHash": "8d1d44f0935d341b7e23d69e91cda856d6f1e8f909417d953dd2a5593c0ab6d4", "summary": "GradientArena.js — Phase 1 ParticleNN memory. Transient GPU-buffer pool for gradient tensors during backward passes — identical pooling mechanism to `ActivationArena.js` (same size-bucketed acquire/release), given its own class identity/file per the plan's checklist rather than duplicated logic, since forward-pass activation buffers and backward-pass gradient buffers have separate lifetimes and should never be pooled together (an activation still needed for a backward computation must not be silently reused as a gradient buffer). Not wired into any executor until Phase 11 (autodiff), per the plan.", "exports": [ { "name": "GradientArena", "kind": "class", "signature": "class GradientArena extends ActivationArena", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/memory/TensorLifetimePlanner", "path": "agi/reference/particle_voice/nn/memory/TensorLifetimePlanner.md", "source": "agi/particle_voice/nn/memory/TensorLifetimePlanner.js", "import": "/agi/particle_voice/nn/memory/TensorLifetimePlanner.js", "sourceHash": "bd72d9692af552d764704ccd9c39a049bba77431539f6f6a19ed2e1c7fc67330", "summary": "TensorLifetimePlanner.js — Phase 1 ParticleNN memory. First/last-use analysis over a `ParticleProgram`'s step order: for every tensor name, which step produces it (or `-1` if it's an external input to the program) and which step is the last to read it. `ActivationArena.js`/ `GradientArena.js` use `freedAfter(stepIndex)` to know exactly when a buffer becomes free to hand to the next tensor that needs one, enabling buffer aliasing instead of one allocation per tensor per run.", "exports": [ { "name": "TensorLifetimePlanner", "kind": "class", "signature": "class TensorLifetimePlanner", "summary": "TensorLifetimePlanner.js — Phase 1 ParticleNN memory. First/last-use analysis over a `ParticleProgram`'s step order: for every tensor name, which step produces it (or `-1` if it's an external input to the program) and which step is the last to read it. `ActivationArena.js`/ `GradientArena.js` use `freedAfter(stepIndex)` to know exactly when a buffer becomes free to hand to the next tensor that needs one, enabling buffer aliasing instead of one allocation per tensor per run." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/memory/WeightBindWindow", "path": "agi/reference/particle_voice/nn/memory/WeightBindWindow.md", "source": "agi/particle_voice/nn/memory/WeightBindWindow.js", "import": "/agi/particle_voice/nn/memory/WeightBindWindow.js", "sourceHash": "5385ec8f358658553731ac75f55163cb44af8ad2ddbcb022af55bd8f20766561", "summary": "WeightBindWindow.js — Phase 1 ParticleNN memory. Storage-buffer bind group for a program segment's resident weight pages (up to 16 pages, per the plan's \"never allocate one monolithic buffer over 128 MiB\" rule) — one GPU buffer per page (not one big buffer for the whole window), matching `WeightPageStore.js`'s per-page granularity.", "exports": [ { "name": "WeightBindWindow", "kind": "class", "signature": "class WeightBindWindow", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/memory/WeightPageStore", "path": "agi/reference/particle_voice/nn/memory/WeightPageStore.md", "source": "agi/particle_voice/nn/memory/WeightPageStore.js", "import": "/agi/particle_voice/nn/memory/WeightPageStore.js", "sourceHash": "10d30c53acf5bdc1d72c5eafe213b77d08a60a2bebbba276ffd3d686a93b1e13", "summary": "WeightPageStore.js — Phase 1 ParticleNN memory. Logical 16–32 MiB weight-page manifest: a page = a contiguous tensor set with its own SHA-256 hash, matching `PRNN-v0.md` §6's directory shape exactly (`{ index, byteLength, offset, hash }`) — the EXACT format R8 (`risk/WeightPagingProbe.js`) already proved works for interrupted downloads (retry, not silent data loss) and corruption detection (hash mismatch actually caught, not tautological). Network fetch is injected (`fetchPage(pageIndex, directoryEntry) => Promise`) rather than hardcoded to `fetch()`, so this store is testable with a deterministic fake fetcher (as R8 was) and still usable with a real HTTP fetch in production without a second implementation.", "exports": [ { "name": "WeightPageStore", "kind": "class", "signature": "class WeightPageStore", "summary": "" }, { "name": "buildPageDirectory", "kind": "function", "signature": "async buildPageDirectory(pages)", "summary": "Build a `PRNN-v0` §6-shaped directory from page byte data, computing each page's real hash and cumulative byte offset." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/memory/WeightPageUploader", "path": "agi/reference/particle_voice/nn/memory/WeightPageUploader.md", "source": "agi/particle_voice/nn/memory/WeightPageUploader.js", "import": "/agi/particle_voice/nn/memory/WeightPageUploader.js", "sourceHash": "7435c2d6f05cbf9de1c754623ffa329a6aa7a0bcbca522af8705bce2bdcb3a6b", "summary": "WeightPageUploader.js — Phase 1 ParticleNN memory. Orchestrates `WeightPageStore.js` (download+hash-verify) and `WeightBindWindow.js` (GPU upload) together: priority-ordered upload, resumability (skip already-uploaded pages), and device-loss re-upload — the exact three properties R8 (`risk/WeightPagingProbe.js`) proved for a single/multi-page toy case, generalized here to an arbitrary page count and caller-chosen priority order.", "exports": [ { "name": "WeightPageUploader", "kind": "class", "signature": "class WeightPageUploader", "summary": "" }, { "name": "attachDeviceLossRecovery", "kind": "function", "signature": "attachDeviceLossRecovery(device, uploader, recreateDevice, { maxBackoffMs = 8000 } = {})", "summary": "Wire the `device.lost` recovery contract from `DeviceContract-v0.md` §5: skip recovery if `reason === 'destroyed'` (intentional disposal, not a crash); otherwise recreate the device with exponential backoff and call `uploader.reuploadAfterDeviceLoss(newDevice)`." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/memory/WeightResidencyPlan", "path": "agi/reference/particle_voice/nn/memory/WeightResidencyPlan.md", "source": "agi/particle_voice/nn/memory/WeightResidencyPlan.js", "import": "/agi/particle_voice/nn/memory/WeightResidencyPlan.js", "sourceHash": "ea04fadf8b5ac2e88563b68ba19fbff2a0eae666f0ebb2b124c0a9a9465831cf", "summary": "WeightResidencyPlan.js — Phase 1 ParticleNN memory. For each program segment (from a `PRNN-v0.md` §7 bind-window directory: `{ windows: [{ segmentId, pageIndices, bindGroupLayoutHash }] }`), which pages must be resident — plus the diff between two segments' page sets, so a scheduler can decide exactly which pages to load/evict when moving from one segment to the next instead of reloading everything.", "exports": [ { "name": "WeightResidencyPlan", "kind": "class", "signature": "class WeightResidencyPlan", "summary": "WeightResidencyPlan.js — Phase 1 ParticleNN memory. For each program segment (from a `PRNN-v0.md` §7 bind-window directory: `{ windows: [{ segmentId, pageIndices, bindGroupLayoutHash }] }`), which pages must be resident — plus the diff between two segments' page sets, so a scheduler can decide exactly which pages to load/evict when moving from one segment to the next instead of reloading everything." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/runtime/DeviceProfile", "path": "agi/reference/particle_voice/nn/runtime/DeviceProfile.md", "source": "agi/particle_voice/nn/runtime/DeviceProfile.js", "import": "/agi/particle_voice/nn/runtime/DeviceProfile.js", "sourceHash": "31c8954ef49265dc1501c24513283f86b700e9533fe31ec7db3e31157bb3bc05", "summary": "DeviceProfile.js — Phase 1 ParticleNN runtime. Capability/tier detection, implementing exactly the tier rules frozen in `spec/DeviceContract-v0.md` §1–§2 (hard requirements + `full`/`no-f16`/ `unsupported` tiers) — not a new policy invented here. Reuses the engine's own WebGPU acquisition (`engine/core/gpu/GpuDevice.js`) rather than reimplementing adapter/device request logic, same as R1's `risk/DeviceMatrixProbe.js`.", "exports": [ { "name": "detectDeviceProfile", "kind": "function", "signature": "async detectDeviceProfile()", "summary": "Acquire a throwaway GPUDevice, classify its tier per DeviceContract-v0 §1–§2, then destroy it — mirrors R1's read-only probe discipline. The caller is expected to acquire its OWN long-lived device separately (this function is a classification probe, not a device provider)." }, { "name": "DEVICE_TIER", "kind": "constant", "signature": "DEVICE_TIER", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/runtime/KernelValidation", "path": "agi/reference/particle_voice/nn/runtime/KernelValidation.md", "source": "agi/particle_voice/nn/runtime/KernelValidation.js", "import": "/agi/particle_voice/nn/runtime/KernelValidation.js", "sourceHash": "385a98aa791b1e1e4f2b0e4ded668e3ba44256cebc973d96161ec0d1f4282c9c", "summary": "KernelValidation.js — Phase 1 ParticleNN testing. Reusable dispatch-and-readback plumbing plus the plan's required edge-case test-vector generators (\"odd dims, min dims, zeros, extreme FP16, quantized values\") — kept generic over binding shape rather than one runner-per-kernel, since Phase 1's six kernels all differ in bind-group layout but share the same \"encode uniform + storage buffers, dispatch, read one output buffer back, compare to a JS reference\" shape.", "exports": [ { "name": "dispatchAndReadback", "kind": "function", "signature": "async dispatchAndReadback(device, wgslSource, { uniform, storageInputs = [], outputByteLength, entryPoint = 'main', label = 'KernelValidation' }, workgroups)", "summary": "Run one compute dispatch against a set of storage/uniform buffers built from plain typed arrays, then read one designated output buffer back. Compiles `wgslSource` itself (rather than accepting a pre-built pipeline) so it can pair the shader module with the matching explicit bind group layout described above." }, { "name": "checkParity", "kind": "function", "signature": "checkParity(actual, expected, tolerance)", "summary": "Compare an actual numeric array to an expected one and return a parity-check result object matching R2's `MatmulBenchProbe.js` shape." }, { "name": "randomVector", "kind": "function", "signature": "randomVector(length, seed = 1)", "summary": "Random values in [-1, 1], deterministic given `seed`." }, { "name": "zerosVector", "kind": "function", "signature": "zerosVector(length)", "summary": "" }, { "name": "extremeF16Vector", "kind": "function", "signature": "extremeF16Vector(length)", "summary": "Values right at/near the extremes a well-behaved f16 encoder/kernel must not silently clip or NaN on." }, { "name": "quantizedEdgeVector", "kind": "function", "signature": "quantizedEdgeVector(length)", "summary": "Values already rounded to representable int8 codes, for quantization-path parity tests." }, { "name": "EDGE_CASE_DIMENSIONS", "kind": "constant", "signature": "EDGE_CASE_DIMENSIONS", "summary": "Standard edge-case dimension set: odd, minimal (1), and a \"normal\" power-of-two size, for sweeping a kernel's dimension parameter." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/runtime/NeuralExecutor", "path": "agi/reference/particle_voice/nn/runtime/NeuralExecutor.md", "source": "agi/particle_voice/nn/runtime/NeuralExecutor.js", "import": "/agi/particle_voice/nn/runtime/NeuralExecutor.js", "sourceHash": "ef9bbe66fc96d55c08304075c6b5b97f93a57d069ce12fe5513a6cffe29ffcd6", "summary": "NeuralExecutor.js — Phase 1 ParticleNN runtime. Dispatches a compiled `ParticleProgram`'s steps as one command encoder (one compute pass per step, in program order), then submits through the engine's own `GpuFrameBudgetBroker` when one is supplied — sharing the render queue's frame budget rather than a second, uncoordinated submission path. Falls back to a direct `device.queue.submit()` when no broker is given (e.g. an offline/background compile-and-run context with no render loop to share a budget with).", "exports": [ { "name": "NeuralExecutor", "kind": "class", "signature": "class NeuralExecutor", "summary": "NeuralExecutor.js — Phase 1 ParticleNN runtime. Dispatches a compiled `ParticleProgram`'s steps as one command encoder (one compute pass per step, in program order), then submits through the engine's own `GpuFrameBudgetBroker` when one is supplied — sharing the render queue's frame budget rather than a second, uncoordinated submission path. Falls back to a direct `device.queue.submit()` when no broker is given (e.g. an offline/background compile-and-run context with no render loop to share a budget with)." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/runtime/NeuralScheduler", "path": "agi/reference/particle_voice/nn/runtime/NeuralScheduler.md", "source": "agi/particle_voice/nn/runtime/NeuralScheduler.js", "import": "/agi/particle_voice/nn/runtime/NeuralScheduler.js", "sourceHash": "2363c74ee062bd1970e7142a890ea71a97e670380464ef8a87bc6513c5fa268a", "summary": "NeuralScheduler.js — Phase 1 ParticleNN runtime. Priority-ordered queue of `NeuralExecutor.run()` requests — for when several `ParticleProgram` runs are pending at once (e.g. multiple NPCs queued to speak in the same frame window). Mirrors `engine/core/gpu/AsyncComputeScheduler.js`'s high/normal/low priority bucket design (reference, not imported — ParticleNN stays decoupled from the render-side scheduler's internals) layered on top of `NeuralExecutor.js`, which already defers to a shared `GpuFrameBudgetBroker` for actual frame-budget admission — this file's job is only ordering *which* run gets submitted next, not re-deriving budget admission itself.", "exports": [ { "name": "NeuralScheduler", "kind": "class", "signature": "class NeuralScheduler", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/runtime/NumericalTolerance", "path": "agi/reference/particle_voice/nn/runtime/NumericalTolerance.md", "source": "agi/particle_voice/nn/runtime/NumericalTolerance.js", "import": "/agi/particle_voice/nn/runtime/NumericalTolerance.js", "sourceHash": "aa27534a4aa10491753d2c31f030baedb968226b0051d21db4d8c672eb76b387", "summary": "NumericalTolerance.js — Phase 1 ParticleNN testing. Canonical tolerance constants (single source — `chunks/f16_utils.js` re-exports these rather than defining its own copy) and the shared abs/rel-error comparison used by `KernelValidation.js` and every kernel parity test, matching the exact convention R2's `MatmulBenchProbe.js` already proved out (`maxAbsError`/`maxRelError` against a JS scalar reference).", "exports": [ { "name": "maxErrors", "kind": "function", "signature": "maxErrors(actual, expected)", "summary": "Elementwise max abs/rel error between two same-length numeric arrays." }, { "name": "withinTolerance", "kind": "function", "signature": "withinTolerance(actual, expected, { absTolerance, relTolerance })", "summary": "True if `maxErrors(actual, expected)` is within `{ absTolerance, relTolerance }` (either bound satisfied per-element is sufficient — matches R2's tolerance semantics)." }, { "name": "F16_ABS_TOLERANCE", "kind": "constant", "signature": "F16_ABS_TOLERANCE", "summary": "NumericalTolerance.js — Phase 1 ParticleNN testing. Canonical tolerance constants (single source — `chunks/f16_utils.js` re-exports these rather than defining its own copy) and the shared abs/rel-error comparison used by `KernelValidation.js` and every kernel parity test, matching the exact convention R2's `MatmulBenchProbe.js` already proved out (`maxAbsError`/`maxRelError` against a JS scalar reference)." }, { "name": "F16_REL_TOLERANCE", "kind": "constant", "signature": "F16_REL_TOLERANCE", "summary": "" }, { "name": "F32_ABS_TOLERANCE", "kind": "constant", "signature": "F32_ABS_TOLERANCE", "summary": "" }, { "name": "F32_REL_TOLERANCE", "kind": "constant", "signature": "F32_REL_TOLERANCE", "summary": "" }, { "name": "INT8_ABS_TOLERANCE", "kind": "constant", "signature": "INT8_ABS_TOLERANCE", "summary": "" }, { "name": "INT8_REL_TOLERANCE", "kind": "constant", "signature": "INT8_REL_TOLERANCE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/runtime/PipelineCache", "path": "agi/reference/particle_voice/nn/runtime/PipelineCache.md", "source": "agi/particle_voice/nn/runtime/PipelineCache.js", "import": "/agi/particle_voice/nn/runtime/PipelineCache.js", "sourceHash": "50cf334c904b0186cb1557a0d705696c50062d74cf49c239339a70c010941e48", "summary": "PipelineCache.js — Phase 1 ParticleNN runtime. Hash-keyed compute pipeline cache: avoids recompiling the same WGSL source + entry point on every dispatch. Keyed by a cheap string hash of the generated WGSL source (kernels are JS-generated, so byte-identical source for the same params is expected — see `nn/kernels/ShaderComposer.js`), not by kernel name + params (two different param sets can legitimately generate identical WGSL, and caching by source avoids a redundant compile in that case too).", "exports": [ { "name": "PipelineCache", "kind": "class", "signature": "class PipelineCache", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/nn/runtime/PipelineUtils", "path": "agi/reference/particle_voice/nn/runtime/PipelineUtils.md", "source": "agi/particle_voice/nn/runtime/PipelineUtils.js", "import": "/agi/particle_voice/nn/runtime/PipelineUtils.js", "sourceHash": "0c1b6e24952617f04e3c5e9573573fae2065095eda080ab65687c90c9a204150", "summary": "PipelineUtils.js — Phase 1 ParticleNN runtime. Deliberate byte-for-byte mirror of `agi/llm/kernels/PipelineUtils.js` (design reference, not imported) per the plan's explicit instruction to keep ParticleNN decoupled from the LLM runtime. Already proven correct — every Phase -1 risk spike (R2, R3, R9, etc.) has been using the LLM runtime's copy of this exact logic directly; this is the same logic under ParticleVoice's own module tree.", "exports": [ { "name": "createComputePipelineChecked", "kind": "function", "signature": "async createComputePipelineChecked(device, module, { label, name = label, entryPoint = 'main' } = {})", "summary": "PipelineUtils.js — Phase 1 ParticleNN runtime. Deliberate byte-for-byte mirror of `agi/llm/kernels/PipelineUtils.js` (design reference, not imported) per the plan's explicit instruction to keep ParticleNN decoupled from the LLM runtime. Already proven correct — every Phase -1 risk spike (R2, R3, R9, etc.) has been using the LLM runtime's copy of this exact logic directly; this is the same logic under ParticleVoice's own module tree." }, { "name": "assertShaderCompiled", "kind": "function", "signature": "async assertShaderCompiled(module, name = 'shader')", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/ActivityIntegrationProbe", "path": "agi/reference/particle_voice/risk/ActivityIntegrationProbe.md", "source": "agi/particle_voice/risk/ActivityIntegrationProbe.js", "import": "/agi/particle_voice/risk/ActivityIntegrationProbe.js", "sourceHash": "5f45a5c33268b24bad3b8fbfded957130d998bf5c63cebfe7dd5bfea83354342", "summary": "ActivityIntegrationProbe.js — R15 Phase -1 risk spike orchestrator.", "exports": [ { "name": "runActivityIntegrationProbe", "kind": "function", "signature": "async runActivityIntegrationProbe()", "summary": "" }, { "name": "buildActivityIntegrationReceipt", "kind": "function", "signature": "async buildActivityIntegrationReceipt(result)", "summary": "" }, { "name": "prepareActivityIntegrationReceiptDownload", "kind": "function", "signature": "prepareActivityIntegrationReceiptDownload(receipt)", "summary": "" }, { "name": "R15_ACTIVITY_INTEGRATION_SCHEMA", "kind": "constant", "signature": "R15_ACTIVITY_INTEGRATION_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/BreathReservoir", "path": "agi/reference/particle_voice/risk/BreathReservoir.md", "source": "agi/particle_voice/risk/BreathReservoir.js", "import": "/agi/particle_voice/risk/BreathReservoir.js", "sourceHash": "ffe089a7151a6c9efcf5216328a38ca4ad954711c30c25c3c205903c4603f543", "summary": "BreathReservoir.js — R6A Phase -1 risk spike. \"BreathReservoirState (lung pressure, compliance, target subglottal pressure) -> ParticleTract\" — particle-voice-26357c.md, Phase 2. Minimal first-order lag model: lung pressure exponentially approaches whatever target subglottal pressure RespiratoryDriveHead commands, rate set by `compliance` (higher compliance = slower to respond, matching the physical intuition of a more elastic reservoir). This is the mechanism that lets a physiology intervention on breath effort actually change the glottal source's amplitude sample-by-sample rather than jumping instantly.", "exports": [ { "name": "createBreathReservoir", "kind": "function", "signature": "createBreathReservoir({ sampleRate, compliance = 0.15 })", "summary": "BreathReservoir.js — R6A Phase -1 risk spike. \"BreathReservoirState (lung pressure, compliance, target subglottal pressure) -> ParticleTract\" — particle-voice-26357c.md, Phase 2. Minimal first-order lag model: lung pressure exponentially approaches whatever target subglottal pressure RespiratoryDriveHead commands, rate set by `compliance` (higher compliance = slower to respond, matching the physical intuition of a more elastic reservoir). This is the mechanism that lets a physiology intervention on breath effort actually change the glottal source's amplitude sample-by-sample rather than jumping instantly." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/CaptureGate", "path": "agi/reference/particle_voice/risk/CaptureGate.md", "source": "agi/particle_voice/risk/CaptureGate.js", "import": "/agi/particle_voice/risk/CaptureGate.js", "sourceHash": "7366a995a49542c91c20e99483438c6071e8d4540ca4bf8c1bb0d2b25707a86e", "summary": "CaptureGate.js — R14 Phase -1 risk spike. \"Custom-voice capture rejects insufficient speech, low SNR, clipping, echo, music, another speaker, gain drift, device changes, dropped samples, silence, or poor coverage.\" — Phase -1. Each check is a cheap, independently testable heuristic proxy (not a trained classifier) over a session of R10 `ParticleEnergyMeter` frame analyses plus out-of-band capture metadata (device-change/dropped-sample counts, target-phrase coverage) that a real `MicrophoneAudioWorklet` / `MicrophoneStream` layer — not the energy meter — would track.", "exports": [ { "name": "checkInsufficientSpeech", "kind": "function", "signature": "checkInsufficientSpeech(frames)", "summary": "" }, { "name": "checkLowSnr", "kind": "function", "signature": "checkLowSnr(frames)", "summary": "" }, { "name": "checkClipping", "kind": "function", "signature": "checkClipping(frames)", "summary": "" }, { "name": "checkEcho", "kind": "function", "signature": "checkEcho(echoResidualRatio)", "summary": "Echo contamination: strong correlation between the recording and a known TTS reference." }, { "name": "checkMusic", "kind": "function", "signature": "checkMusic(frames)", "summary": "Music proxy: natural speech's frame-to-frame RMS is far less stable than sustained tonal/musical content." }, { "name": "checkAnotherSpeaker", "kind": "function", "signature": "checkAnotherSpeaker(frames)", "summary": "Another-speaker proxy: an abrupt, sustained shift in low/high band energy balance partway through." }, { "name": "checkGainDrift", "kind": "function", "signature": "checkGainDrift(frames)", "summary": "Gain drift: mean level of the last third vs first third of the speech should stay close." }, { "name": "checkDeviceChanges", "kind": "function", "signature": "checkDeviceChanges(deviceChangeEventCount)", "summary": "" }, { "name": "checkDroppedSamples", "kind": "function", "signature": "checkDroppedSamples(droppedSampleCount)", "summary": "" }, { "name": "checkTooMuchSilence", "kind": "function", "signature": "checkTooMuchSilence(frames)", "summary": "" }, { "name": "checkPoorCoverage", "kind": "function", "signature": "checkPoorCoverage(phraseCoverageRatio)", "summary": "" }, { "name": "evaluateCaptureQuality", "kind": "function", "signature": "evaluateCaptureQuality(session)", "summary": "`session` = { frames, echoResidualRatio, deviceChangeEventCount, droppedSampleCount, phraseCoverageRatio }." }, { "name": "CAPTURE_GATE_REASONS", "kind": "constant", "signature": "CAPTURE_GATE_REASONS", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/CaptureGateProbe", "path": "agi/reference/particle_voice/risk/CaptureGateProbe.md", "source": "agi/particle_voice/risk/CaptureGateProbe.js", "import": "/agi/particle_voice/risk/CaptureGateProbe.js", "sourceHash": "b03045b72df9d73801add171378ba456834a7696c7c44a1eec4084f79fc2b151", "summary": "CaptureGateProbe.js — R14 Phase -1 risk spike orchestrator.", "exports": [ { "name": "runCaptureGateProbe", "kind": "function", "signature": "async runCaptureGateProbe()", "summary": "" }, { "name": "buildCaptureGateReceipt", "kind": "function", "signature": "async buildCaptureGateReceipt(result)", "summary": "" }, { "name": "prepareCaptureGateReceiptDownload", "kind": "function", "signature": "prepareCaptureGateReceiptDownload(receipt)", "summary": "" }, { "name": "R14_CAPTURE_GATE_SCHEMA", "kind": "constant", "signature": "R14_CAPTURE_GATE_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/DeviceMatrixProbe", "path": "agi/reference/particle_voice/risk/DeviceMatrixProbe.md", "source": "agi/particle_voice/risk/DeviceMatrixProbe.js", "import": "/agi/particle_voice/risk/DeviceMatrixProbe.js", "sourceHash": "e268297bbe81287841f8f56f868f67537f54ce9cda6759f84147eff92d89369e", "summary": "DeviceMatrixProbe.js — R1 Phase -1 risk spike. \"device-matrix.html — record shader-f16, workgroup/storage/binding/invocation limits, AudioContext properties, crossOriginIsolated, AudioWorklet/ SharedArrayBuffer, OS VRAM quota.\" — particle-voice-26357c.md, Phase -1. Reuses the engine's own capability-probing primitives instead of reimplementing WebGPU adapter/device acquisition: - engine/core/gpu/GpuDevice.js (GpuDevice.create, detectGpuPlatform) - engine/core/gpu/GpuInit.js (isWebGpuSupported) - webgpu-os/kernel/VRAMTracker.js (default app/global quota) Read-only: the WebGPU device created here is destroyed immediately after limits/features are read, and the AudioContext is closed immediately after its properties are read.", "exports": [ { "name": "probeWebGpu", "kind": "function", "signature": "async probeWebGpu()", "summary": "Acquire a throwaway GPUDevice via the engine's own GpuDevice, read limits/features, destroy it." }, { "name": "probeAudioContext", "kind": "function", "signature": "async probeAudioContext()", "summary": "Construct a throwaway AudioContext, read its properties, close it." }, { "name": "probeCrossOriginIsolation", "kind": "function", "signature": "probeCrossOriginIsolation()", "summary": "" }, { "name": "probeSharedArrayBuffer", "kind": "function", "signature": "probeSharedArrayBuffer()", "summary": "Confirm SharedArrayBuffer is not just present but actually constructible." }, { "name": "probeVramQuota", "kind": "function", "signature": "probeVramQuota()", "summary": "Read the OS default VRAM quota (webgpu-os/kernel/VRAMTracker.js), no kernel required." }, { "name": "runDeviceMatrixProbe", "kind": "function", "signature": "async runDeviceMatrixProbe()", "summary": "Run every device-matrix probe and roll up an overall status. `unsupported` is a distinct outcome from `fail`, matching the plan's own Production Contract language (\"Unsupported hardware is reported explicitly as unsupported... the project does not degrade to an external runtime\"): - unsupported: WebGPU itself is unavailable on this device/browser. - fail: WebGPU is available, but a hard architectural requirement (crossOriginIsolated, SharedArrayBuffer, AudioWorklet) is missing — almost always a *serving* problem (missing COOP/COEP headers), not a hardware ceiling. Re-check via start_server.py before treating as real. - pass: WebGPU + AudioContext + cross-origin isolation + SharedArrayBuffer + AudioWorklet are all present." }, { "name": "buildDeviceMatrixReceipt", "kind": "function", "signature": "async buildDeviceMatrixReceipt(result)", "summary": "Wrap a raw probe result into the immutable JSON receipt described by the R1 exit gate: \"Per-device limits + capability table.\"" }, { "name": "prepareDeviceMatrixReceiptDownload", "kind": "function", "signature": "prepareDeviceMatrixReceiptDownload(receipt)", "summary": "" }, { "name": "R1_DEVICE_MATRIX_SCHEMA", "kind": "constant", "signature": "R1_DEVICE_MATRIX_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/EchoBargeIn", "path": "agi/reference/particle_voice/risk/EchoBargeIn.md", "source": "agi/particle_voice/risk/EchoBargeIn.js", "import": "/agi/particle_voice/risk/EchoBargeIn.js", "sourceHash": "211ae8237cd22101111d83b9733d5269a21814c04db1bb49493594748be9025e", "summary": "EchoBargeIn.js — R12 Phase -1 risk spike. \"echo reference ring, delay estimation, acoustic echo suppression, double-talk detection, no self-interruption.\" — Phase -1. Simplified fixed-delay echo cancellation (cross-correlation delay estimate + least-squares gain fit + direct subtraction), not an adaptive filter (NLMS/Kalman) — enough to prove the architecture correctly distinguishes pure echo from genuine double-talk. `AcousticEchoController.js` (Phase 2+) would use a real adaptive filter for real acoustic paths that drift over time; this fixed-delay model is a feasibility check.", "exports": [ { "name": "createEchoReferenceRing", "kind": "function", "signature": "createEchoReferenceRing(capacitySamples)", "summary": "" }, { "name": "estimateDelay", "kind": "function", "signature": "estimateDelay(reference, microphone, maxDelaySamples)", "summary": "Cross-correlation delay estimate: which shift of `reference` best predicts `microphone`." }, { "name": "estimateGain", "kind": "function", "signature": "estimateGain(referenceAligned, microphone)", "summary": "Least-squares gain fit: minimizes ||microphone - gain*referenceAligned||^2." }, { "name": "cancelEcho", "kind": "function", "signature": "cancelEcho(microphone, reference, delay, gain)", "summary": "" }, { "name": "detectDoubleTalk", "kind": "function", "signature": "detectDoubleTalk(residual, referenceLevel, thresholdRatio = 0.3)", "summary": "" }, { "name": "createBargeInController", "kind": "function", "signature": "createBargeInController({ minSustainedFrames = 3 } = {})", "summary": "Commit bargeInConfirmed only when double-talk is detected AND sustained for `minSustainedFrames`." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/EchoBargeInProbe", "path": "agi/reference/particle_voice/risk/EchoBargeInProbe.md", "source": "agi/particle_voice/risk/EchoBargeInProbe.js", "import": "/agi/particle_voice/risk/EchoBargeInProbe.js", "sourceHash": "72323014c2a785bb1f400fb706a023e439e73d6dc8e50b9ba6d275d2047f3388", "summary": "EchoBargeInProbe.js — R12 Phase -1 risk spike orchestrator.", "exports": [ { "name": "runEchoBargeInProbe", "kind": "function", "signature": "async runEchoBargeInProbe()", "summary": "" }, { "name": "buildEchoBargeInReceipt", "kind": "function", "signature": "async buildEchoBargeInReceipt(result)", "summary": "" }, { "name": "prepareEchoBargeInReceiptDownload", "kind": "function", "signature": "prepareEchoBargeInReceiptDownload(receipt)", "summary": "" }, { "name": "R12_ECHO_BARGE_IN_SCHEMA", "kind": "constant", "signature": "R12_ECHO_BARGE_IN_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/EndpointController", "path": "agi/reference/particle_voice/risk/EndpointController.md", "source": "agi/particle_voice/risk/EndpointController.js", "import": "/agi/particle_voice/risk/EndpointController.js", "sourceHash": "a2aef1d2ffeef9497bfae45565791554370edc51afe9a09b0613e99e48fa328e", "summary": "EndpointController.js — R13 Phase -1 risk spike. \"min speech/silence durations, max-segment cap, causal commit bits (no lookahead).\" — Phase -1. A plain frame-counting debounce state machine on top of a boolean VAD decision (e.g. R11's `hysteresisState`) — every `update()` call only consumes the CURRENT frame's VAD decision plus its own prior internal state, never anything from the future, by construction (no buffering of upcoming frames anywhere in this module).", "exports": [ { "name": "createEndpointController", "kind": "function", "signature": "createEndpointController({ frameMs, minSpeechMs = 200, minSilenceMs = 300, maxSegmentMs = 8000 })", "summary": "EndpointController.js — R13 Phase -1 risk spike. \"min speech/silence durations, max-segment cap, causal commit bits (no lookahead).\" — Phase -1. A plain frame-counting debounce state machine on top of a boolean VAD decision (e.g. R11's `hysteresisState`) — every `update()` call only consumes the CURRENT frame's VAD decision plus its own prior internal state, never anything from the future, by construction (no buffering of upcoming frames anywhere in this module)." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/EndpointLatencyProbe", "path": "agi/reference/particle_voice/risk/EndpointLatencyProbe.md", "source": "agi/particle_voice/risk/EndpointLatencyProbe.js", "import": "/agi/particle_voice/risk/EndpointLatencyProbe.js", "sourceHash": "e409bae8e8d4d9edd0d4674640e18338a59d7cc729f750d8841312a69a082561", "summary": "EndpointLatencyProbe.js — R13 Phase -1 risk spike orchestrator.", "exports": [ { "name": "runEndpointLatencyProbe", "kind": "function", "signature": "async runEndpointLatencyProbe()", "summary": "" }, { "name": "buildEndpointLatencyReceipt", "kind": "function", "signature": "async buildEndpointLatencyReceipt(result)", "summary": "" }, { "name": "prepareEndpointLatencyReceiptDownload", "kind": "function", "signature": "prepareEndpointLatencyReceiptDownload(receipt)", "summary": "" }, { "name": "R13_ENDPOINT_LATENCY_SCHEMA", "kind": "constant", "signature": "R13_ENDPOINT_LATENCY_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/EnergyDomains", "path": "agi/reference/particle_voice/risk/EnergyDomains.md", "source": "agi/particle_voice/risk/EnergyDomains.js", "import": "/agi/particle_voice/risk/EnergyDomains.js", "sourceHash": "206d716aeaa068d8688166ee3e9cf2436f2b4c0324c3dae4ccfa16e409c29ef3", "summary": "EnergyDomains.js — R15 Phase -1 risk spike. \"ObservedInputEnergy, GeneratedPhysiologyEnergy, and RenderedOutputEnergy are correctly separated; mic energy is labelled an uncertain acoustic-equivalent proxy, not lung pressure.\" — Phase -1. Three distinct, runtime-tagged value types plus an `assertDomain` guard that THROWS on cross-domain misuse — the concrete mechanism proving the architecture cannot silently conflate \"what the mic heard\" with \"what the physiology model generated\" or \"what the renderer produced\".", "exports": [ { "name": "ObservedInputEnergy", "kind": "class", "signature": "class ObservedInputEnergy", "summary": "Energy derived from the real microphone signal. This is explicitly an uncertain ACOUSTIC-EQUIVALENT proxy — it correlates with vocal effort but is NOT a measurement of lung pressure, glottal state, or any other physiological quantity (room acoustics, mic gain/placement, and background noise all corrupt the mapping)." }, { "name": "GeneratedPhysiologyEnergy", "kind": "class", "signature": "class GeneratedPhysiologyEnergy", "summary": "Energy/state produced by the neural physiology model (R6A NeuralPhysiologyState/BreathReservoir) driving the Voice Box." }, { "name": "RenderedOutputEnergy", "kind": "class", "signature": "class RenderedOutputEnergy", "summary": "Energy of the final rendered PCM output (post Voice Box waveguide render)." }, { "name": "assertDomain", "kind": "function", "signature": "assertDomain(energyObject, expectedDomain, context)", "summary": "Throws unless `energyObject.domain === expectedDomain` — the runtime separation guard." }, { "name": "driveVoiceBox", "kind": "function", "signature": "driveVoiceBox(energyObject)", "summary": "Stand-in consumer: drives the Voice Box — must only ever accept generated-physiology energy." }, { "name": "computeBargeInEvidence", "kind": "function", "signature": "computeBargeInEvidence(energyObject)", "summary": "Stand-in consumer: barge-in/VAD evidence — must only ever accept observed-input energy." }, { "name": "computeLoudnessDisplay", "kind": "function", "signature": "computeLoudnessDisplay(energyObject)", "summary": "Stand-in consumer: UI loudness meter for what actually came out of the speakers — must only ever accept rendered-output energy." }, { "name": "ENERGY_DOMAIN", "kind": "constant", "signature": "ENERGY_DOMAIN", "summary": "EnergyDomains.js — R15 Phase -1 risk spike. \"ObservedInputEnergy, GeneratedPhysiologyEnergy, and RenderedOutputEnergy are correctly separated; mic energy is labelled an uncertain acoustic-equivalent proxy, not lung pressure.\" — Phase -1. Three distinct, runtime-tagged value types plus an `assertDomain` guard that THROWS on cross-domain misuse — the concrete mechanism proving the architecture cannot silently conflate \"what the mic heard\" with \"what the physiology model generated\" or \"what the renderer produced\"." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/EnergyMeterProbe", "path": "agi/reference/particle_voice/risk/EnergyMeterProbe.md", "source": "agi/particle_voice/risk/EnergyMeterProbe.js", "import": "/agi/particle_voice/risk/EnergyMeterProbe.js", "sourceHash": "d89a83b81983dd55d12bb805a544754bd292c4bb8c21db04c546d2e6b09200a6", "summary": "EnergyMeterProbe.js — R10 Phase -1 risk spike orchestrator. No dedicated filename exists for R10 in the plan's risk/ page list either (named \"mic-energy-meter.html\" in the risk-page description text, used here directly).", "exports": [ { "name": "runEnergyMeterProbe", "kind": "function", "signature": "async runEnergyMeterProbe()", "summary": "" }, { "name": "buildEnergyMeterReceipt", "kind": "function", "signature": "async buildEnergyMeterReceipt(result)", "summary": "" }, { "name": "prepareEnergyMeterReceiptDownload", "kind": "function", "signature": "prepareEnergyMeterReceiptDownload(receipt)", "summary": "" }, { "name": "R10_ENERGY_METER_SCHEMA", "kind": "constant", "signature": "R10_ENERGY_METER_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/Fft1024Kernel", "path": "agi/reference/particle_voice/risk/Fft1024Kernel.md", "source": "agi/particle_voice/risk/Fft1024Kernel.js", "import": "/agi/particle_voice/risk/Fft1024Kernel.js", "sourceHash": "d8385c80c2b0d88c88054730ca0d8dc20dc53434321f2712ce1af4a997c9e740", "summary": "Fft1024Kernel.js — R3 Phase -1 risk spike WGSL generator. No raw `.wgsl` files (Engine Alignment invariant #1): exports a `shader(params)` function, matching the eventual `nn/kernels/fft/fft1024_f32.js` / `ifft1024_f32.js` production kernels. Single-workgroup, in-workgroup-memory, iterative radix-2 Cooley-Tukey FFT. One workgroup (512 threads) computes exactly one 1024-point complex FFT; `workgroup_id.x` selects which frame of a batch to process, so N frames can be transformed in a single dispatch of N workgroups (needed to batch many overlapping STFT frames for the WOLA test). Direction is a per-dispatch uniform, not two separate shaders: forward uses the standard e^{-i2*pi*k/N} twiddle; inverse conjugates the input, runs the same forward butterfly network, then conjugates + scales the output by 1/N (IFFT(X) = (1/N) * conj(FFT(conj(X)))). Buffer layout (flat, frame-major): inputReal/inputImag/outputReal/outputImag are each `numFrames * 1024` f32 values; frame f occupies [f*1024, f*1024+1024).", "exports": [ { "name": "fft1024Shader", "kind": "function", "signature": "fft1024Shader()", "summary": "" }, { "name": "FFT_N", "kind": "constant", "signature": "FFT_N", "summary": "Fft1024Kernel.js — R3 Phase -1 risk spike WGSL generator. No raw `.wgsl` files (Engine Alignment invariant #1): exports a `shader(params)` function, matching the eventual `nn/kernels/fft/fft1024_f32.js` / `ifft1024_f32.js` production kernels. Single-workgroup, in-workgroup-memory, iterative radix-2 Cooley-Tukey FFT. One workgroup (512 threads) computes exactly one 1024-point complex FFT; `workgroup_id.x` selects which frame of a batch to process, so N frames can be transformed in a single dispatch of N workgroups (needed to batch many overlapping STFT frames for the WOLA test). Direction is a per-dispatch uniform, not two separate shaders: forward uses the standard e^{-i2*pi*k/N} twiddle; inverse conjugates the input, runs the same forward butterfly network, then conjugates + scales the output by 1/N (IFFT(X) = (1/N) * conj(FFT(conj(X)))). Buffer layout (flat, frame-major): inputReal/inputImag/outputReal/outputImag are each `numFrames * 1024` f32 values; frame f occupies [f*1024, f*1024+1024)." }, { "name": "FFT_LOG2N", "kind": "constant", "signature": "FFT_LOG2N", "summary": "" }, { "name": "FFT_ENTRY_POINT", "kind": "constant", "signature": "FFT_ENTRY_POINT", "summary": "" }, { "name": "FFT_WORKGROUP_SIZE", "kind": "constant", "signature": "FFT_WORKGROUP_SIZE", "summary": "" }, { "name": "FFT_DIRECTION_FORWARD", "kind": "constant", "signature": "FFT_DIRECTION_FORWARD", "summary": "" }, { "name": "FFT_DIRECTION_INVERSE", "kind": "constant", "signature": "FFT_DIRECTION_INVERSE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/GlottalSource", "path": "agi/reference/particle_voice/risk/GlottalSource.md", "source": "agi/particle_voice/risk/GlottalSource.js", "import": "/agi/particle_voice/risk/GlottalSource.js", "sourceHash": "3d797545905407c2092f248ef593d98e8be41b44b8b07a4647d54a90c4c5efcb", "summary": "GlottalSource.js — R6 Phase -1 risk spike. A simplified (\"LF-lite\") glottal flow source, not the full Liljencrants- Fant model (which requires an iterative numerical solve of its alpha/wg/ ta/b parameters from open/speed quotient — out of scope for a feasibility spike). Each glottal pulse is a raised-cosine bump over the open phase of the cycle: flow(n) = 0.5 * (1 - cos(2*pi*n/Topen)) for 0 <= n < Topen flow(n) = 0 for Topen <= n < T This is deliberately C1-continuous and zero at both pulse boundaries — clicks are a discontinuity in the waveform or its derivative, and this shape has neither, by construction, regardless of how F0 (period T) changes from one pulse to the next. `articulatory/glottal_lf.js` (Phase 2) is the real LF implementation this stands in for. Aspiration noise is mixed in proportional to instantaneous flow (breathy voicing), driven by a counter-based hash so it is chunk-boundary independent (same technique as StreamingContinuitySource.js).", "exports": [ { "name": "createGlottalSource", "kind": "function", "signature": "createGlottalSource({ sampleRate, f0AtSample, openQuotient = 0.6, aspirationLevel = 0.0, noiseSeed = 777 })", "summary": "Create a glottal source generator. `f0AtSample(n)` lets callers drive a pitch sweep (F0 varies per absolute sample index); `openQuotient` is the fraction of each pitch period the folds are open (typical modal voice ~0.5-0.7)." }, { "name": "noiseAt", "kind": "re-export", "signature": "noiseAt", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/GpuReadbackRing", "path": "agi/reference/particle_voice/risk/GpuReadbackRing.md", "source": "agi/particle_voice/risk/GpuReadbackRing.js", "import": "/agi/particle_voice/risk/GpuReadbackRing.js", "sourceHash": "3f7b6547d5aa87aaad922b56317a296d6f381e8679306f6685e94257ba6d0f33", "summary": "GpuReadbackRing.js — R4 Phase -1 risk spike. \"readback-audio.html — 6-8 MAP_READ slots, per-buffer mapAsync(), no global queue.onSubmittedWorkDone() for normal readback.\" — Phase -1. A minimal round-robin ring of MAP_READ|COPY_DST staging buffers. Each slot is copied into and mapped independently; the only synchronization primitive used is that slot's own `mapAsync()` promise — there is no `device.queue.onSubmittedWorkDone()` call anywhere in this module. Backpressure (more than `slotCount` requests in flight) is the caller's responsibility: `acquireFreeSlotIndex()` throws if no slot is free, so a caller must await/release before requesting more than `slotCount` ahead. This is a disposable Phase -1 probe, not the production `streaming/GPUReadbackRing.js` — same technique, smaller surface.", "exports": [ { "name": "createGpuReadbackRing", "kind": "function", "signature": "createGpuReadbackRing(device, slotByteSize, slotCount = 8)", "summary": "GpuReadbackRing.js — R4 Phase -1 risk spike. \"readback-audio.html — 6-8 MAP_READ slots, per-buffer mapAsync(), no global queue.onSubmittedWorkDone() for normal readback.\" — Phase -1. A minimal round-robin ring of MAP_READ|COPY_DST staging buffers. Each slot is copied into and mapped independently; the only synchronization primitive used is that slot's own `mapAsync()` promise — there is no `device.queue.onSubmittedWorkDone()` call anywhere in this module. Backpressure (more than `slotCount` requests in flight) is the caller's responsibility: `acquireFreeSlotIndex()` throws if no slot is free, so a caller must await/release before requesting more than `slotCount` ahead. This is a disposable Phase -1 probe, not the production `streaming/GPUReadbackRing.js` — same technique, smaller surface." }, { "name": "runPipelinedReadbackBenchmark", "kind": "function", "signature": "async runPipelinedReadbackBenchmark(device, ring, sourceBuffer, byteSize, iterations, maxInFlight, makeFrame, updateBufferFn)", "summary": "Run a pipelined readback benchmark: keeps up to `maxInFlight` mapAsync() requests outstanding at once (never more, never a global wait), writing a fresh frame into `sourceBuffer` before each new request." }, { "name": "percentile", "kind": "function", "signature": "percentile(sortedValues, p)", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/HeavySceneKernel", "path": "agi/reference/particle_voice/risk/HeavySceneKernel.md", "source": "agi/particle_voice/risk/HeavySceneKernel.js", "import": "/agi/particle_voice/risk/HeavySceneKernel.js", "sourceHash": "86485a1c03599da0a83472d1b4a988408246a4d8312146de2dc8358a39d77107", "summary": "HeavySceneKernel.js — R9 Phase -1 risk spike. \"renderer-voice-stress.html — voice compute beside a representative heavy ParticleRealms scene.\" — Phase -1. A fully procedural instanced-triangle render (positions/colors derived from @builtin(instance_index) in the vertex shader, no vertex/instance buffers needed) standing in for \"a representative heavy scene\" — many draw-time vertices without needing real mesh/scene data for a disposable risk spike.", "exports": [ { "name": "heavySceneShader", "kind": "function", "signature": "heavySceneShader()", "summary": "" }, { "name": "HEAVY_SCENE_VERTEX_ENTRY", "kind": "constant", "signature": "HEAVY_SCENE_VERTEX_ENTRY", "summary": "HeavySceneKernel.js — R9 Phase -1 risk spike. \"renderer-voice-stress.html — voice compute beside a representative heavy ParticleRealms scene.\" — Phase -1. A fully procedural instanced-triangle render (positions/colors derived from @builtin(instance_index) in the vertex shader, no vertex/instance buffers needed) standing in for \"a representative heavy scene\" — many draw-time vertices without needing real mesh/scene data for a disposable risk spike." }, { "name": "HEAVY_SCENE_FRAGMENT_ENTRY", "kind": "constant", "signature": "HEAVY_SCENE_FRAGMENT_ENTRY", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/IntegrationManifest", "path": "agi/reference/particle_voice/risk/IntegrationManifest.md", "source": "agi/particle_voice/risk/IntegrationManifest.js", "import": "/agi/particle_voice/risk/IntegrationManifest.js", "sourceHash": "cd58598576660846ac0d682383750b132f3eb7bfe0451a437b5738e934837c07", "summary": "IntegrationManifest.js — R0 Phase -1 risk spike data. Every named ParticleRealms module referenced by the ParticleVoice plan's \"Codebase Integration Points\" tables (particle-voice-26357c.md), with the named exports each entry is expected to provide. `integration-path-audit.html` dynamically imports each `path` and checks every name in `exports` is present on the resulting module namespace, producing a pass/fail/missing receipt. Paths are root-relative so they resolve the same regardless of which page imports this manifest (served from the repo root by start_server.py). Exports were verified directly against source (grep for `^export`), not assumed from the plan's prose \"What it provides\" column. Where the plan's description implied an export that does not actually exist at module scope, a `note` field records the discrepancy so the audit page can surface it even on entries that technically \"pass\" (file imports fine, but a *different* name provides the capability than the plan implied).", "exports": [ { "name": "INTEGRATION_MANIFEST", "kind": "constant", "signature": "INTEGRATION_MANIFEST", "summary": "IntegrationManifest.js — R0 Phase -1 risk spike data. Every named ParticleRealms module referenced by the ParticleVoice plan's \"Codebase Integration Points\" tables (particle-voice-26357c.md), with the named exports each entry is expected to provide. `integration-path-audit.html` dynamically imports each `path` and checks every name in `exports` is present on the resulting module namespace, producing a pass/fail/missing receipt. Paths are root-relative so they resolve the same regardless of which page imports this manifest (served from the repo root by start_server.py). Exports were verified directly against source (grep for `^export`), not assumed from the plan's prose \"What it provides\" column. Where the plan's description implied an export that does not actually exist at module scope, a `note` field records the discrepancy so the audit page can surface it even on entries that technically \"pass\" (file imports fine, but a *different* name provides the capability than the plan implied)." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/IntegrationPathAudit", "path": "agi/reference/particle_voice/risk/IntegrationPathAudit.md", "source": "agi/particle_voice/risk/IntegrationPathAudit.js", "import": "/agi/particle_voice/risk/IntegrationPathAudit.js", "sourceHash": "4703d3bae709246ef74517b4bb134c4402ce76338994faee0ab652c95e03960f", "summary": "IntegrationPathAudit.js — R0 Phase -1 risk spike runner. \"Dynamic import/export checks for every named ParticleRealms module\" — particle-voice-26357c.md, Phase -1 / R0 Integration exit receipt. For every entry in IntegrationManifest.js this dynamically imports the module and checks that each expected named export is present on the resulting namespace object. No network/file mutation; read-only probing.", "exports": [ { "name": "runIntegrationPathAudit", "kind": "function", "signature": "async runIntegrationPathAudit({ manifest = INTEGRATION_MANIFEST, importer = (path)", "summary": "Run the audit against a manifest." }, { "name": "buildIntegrationAuditReceipt", "kind": "function", "signature": "async buildIntegrationAuditReceipt(result)", "summary": "Wrap a raw audit result into the immutable JSON receipt described by the R0 exit gate: \"JSON file listing every named import, expected export, actual export, result pass/fail/missing.\"" }, { "name": "prepareIntegrationAuditReceiptDownload", "kind": "function", "signature": "prepareIntegrationAuditReceiptDownload(receipt)", "summary": "" }, { "name": "R0_AUDIT_SCHEMA", "kind": "constant", "signature": "R0_AUDIT_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/KellyLochbaumWaveguide", "path": "agi/reference/particle_voice/risk/KellyLochbaumWaveguide.md", "source": "agi/particle_voice/risk/KellyLochbaumWaveguide.js", "import": "/agi/particle_voice/risk/KellyLochbaumWaveguide.js", "sourceHash": "c3a21ba8e7ebcfdc7bef0f5f6e1f030344acc5adc1170a31aabb43f959c93796", "summary": "KellyLochbaumWaveguide.js — R6 Phase -1 risk spike. Single-delay-per-section digital waveguide vocal tract model (Kelly & Lochbaum 1962 scattering junctions, as described in e.g. Julius O. Smith's \"Physical Audio Signal Processing\"). N cylindrical tube sections with cross-sectional areas A[0..N-1] give N-1 internal junction reflection coefficients k_i = (A_i - A_{i+1}) / (A_i + A_{i+1}). Boundary conditions: - Glottal end: source flow is injected with a partial reflection (`glottalReflection`) of the wave returning from the tract. - Lip end: an idealized open-end reflection (`lipReflection`, negative) plus a first-difference \"radiation\" filter approximating the differentiating characteristic of lip radiation. All boundary/junction coefficients are kept strictly inside (-1, 1), so the closed-loop lattice is passive/BIBO-stable by construction (no combination of area profile changes can cause unbounded energy growth). Nasal coupling and constriction noise are deliberate simplifications, not a rigorous multi-port (3-way) junction scattering derivation — see createNasalBranch() and step()'s constrictionIndex handling. Phase 2's `NasalTractJunction.js`/`ConstrictionNoise.js` need the rigorous version; this is enough to prove the overall architecture is stable and produces plausible, controllable behavior.", "exports": [ { "name": "reflectionCoefficients", "kind": "function", "signature": "reflectionCoefficients(areas)", "summary": "KellyLochbaumWaveguide.js — R6 Phase -1 risk spike. Single-delay-per-section digital waveguide vocal tract model (Kelly & Lochbaum 1962 scattering junctions, as described in e.g. Julius O. Smith's \"Physical Audio Signal Processing\"). N cylindrical tube sections with cross-sectional areas A[0..N-1] give N-1 internal junction reflection coefficients k_i = (A_i - A_{i+1}) / (A_i + A_{i+1}). Boundary conditions: - Glottal end: source flow is injected with a partial reflection (`glottalReflection`) of the wave returning from the tract. - Lip end: an idealized open-end reflection (`lipReflection`, negative) plus a first-difference \"radiation\" filter approximating the differentiating characteristic of lip radiation. All boundary/junction coefficients are kept strictly inside (-1, 1), so the closed-loop lattice is passive/BIBO-stable by construction (no combination of area profile changes can cause unbounded energy growth). Nasal coupling and constriction noise are deliberate simplifications, not a rigorous multi-port (3-way) junction scattering derivation — see createNasalBranch() and step()'s constrictionIndex handling. Phase 2's `NasalTractJunction.js`/`ConstrictionNoise.js` need the rigorous version; this is enough to prove the overall architecture is stable and produces plausible, controllable behavior." }, { "name": "uniformAreaProfile", "kind": "function", "signature": "uniformAreaProfile(numSections, area)", "summary": "" }, { "name": "shapedAreaProfile", "kind": "function", "signature": "shapedAreaProfile(numSections, controlPoints)", "summary": "Linearly interpolated area profile through named (position, area) control points, position in [0, 1]." }, { "name": "createVocalTract", "kind": "function", "signature": "createVocalTract({ numSections, areas, glottalReflection = 0.85, lipReflection = -0.9 })", "summary": "" }, { "name": "createNasalBranch", "kind": "function", "signature": "createNasalBranch({ numSections, areas, nostrilReflection = -0.9 })", "summary": "Simplified nasal branch: its own short KL chain, driven by a coupled fraction of an oral-tract tap signal." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/MatmulBenchProbe", "path": "agi/reference/particle_voice/risk/MatmulBenchProbe.md", "source": "agi/particle_voice/risk/MatmulBenchProbe.js", "import": "/agi/particle_voice/risk/MatmulBenchProbe.js", "sourceHash": "919734368b13c240185108e99c106e9b528a57204202d296b38b8f19cae4e406", "summary": "MatmulBenchProbe.js — R2 Phase -1 risk spike. \"matmul-bench.html — W8A16 packed INT8 x FP16 matmul, FP32 accumulation, FP16 output; representative TTS shapes; full-model cost projection with >=30% headroom.\" — particle-voice-26357c.md, Phase -1. Shapes are PROVISIONAL: Phase 0 (spec freeze) has not happened yet, so the plan does not fix concrete model dimensions. These are derived from C:\\Coding\\PS2\\configs\\r0.yaml's own \"architecture smoke test\" convention (d_model=256, d_ff=4x d_model, n_layers=6) — the same repo's precedent for sizing a first small model before a full spec exists — combined with this plan's own VoiceChunker steady-state chunk bucket (64 frames) and stated mel-bin candidate (128). Revisit once spec/DeviceContract-v0.md exists. Reuses engine primitives instead of reimplementing device/buffer/pipeline plumbing: GpuDevice (engine/core/gpu/GpuDevice.js), GpuBuffer helpers (engine/core/gpu/GpuBuffer.js), and createComputePipelineChecked (agi/llm/kernels/PipelineUtils.js).", "exports": [ { "name": "runMatmulBenchProbe", "kind": "function", "signature": "async runMatmulBenchProbe()", "summary": "" }, { "name": "buildMatmulBenchReceipt", "kind": "function", "signature": "async buildMatmulBenchReceipt(result)", "summary": "Wrap a raw probe result into the R2 exit receipt." }, { "name": "prepareMatmulBenchReceiptDownload", "kind": "function", "signature": "prepareMatmulBenchReceiptDownload(receipt)", "summary": "" }, { "name": "R2_MATMUL_BENCH_SCHEMA", "kind": "constant", "signature": "R2_MATMUL_BENCH_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/MatmulReferenceCpu", "path": "agi/reference/particle_voice/risk/MatmulReferenceCpu.md", "source": "agi/particle_voice/risk/MatmulReferenceCpu.js", "import": "/agi/particle_voice/risk/MatmulReferenceCpu.js", "sourceHash": "7a6851398ef3919b1c02cf5bb4d75c0edc36e040259214e3907b009cb6e025b6", "summary": "MatmulReferenceCpu.js — deterministic test-vector generation and a plain-JS scalar reference matmul for R2 (matmul-bench.html) parity checking. Mirrors the dequantization + accumulation order of MatmulW8A16Kernel.js's `main()` exactly (same k4 outer / b inner loop) so the only expected divergence between CPU (double) and GPU (f32) is floating-point rounding, not algorithmic difference.", "exports": [ { "name": "randomInt8Weights", "kind": "function", "signature": "randomInt8Weights(K, N, seed = 1)", "summary": "Int8Array of length K*N, logical layout weights[n*K + k], values in [-127, 127]." }, { "name": "randomActivations", "kind": "function", "signature": "randomActivations(M, K, seed = 2)", "summary": "Float32Array of length M*K, layout activations[m*K + k], values in [-1, 1]." }, { "name": "randomScales", "kind": "function", "signature": "randomScales(N, seed = 3)", "summary": "Float32Array of length N — typical per-channel INT8 quantization scales." }, { "name": "packWeightsInt8x4", "kind": "function", "signature": "packWeightsInt8x4(weightsInt8, K, N)", "summary": "Pack logical [K,N] int8 weights into the u32 layout MatmulW8A16Kernel.js expects." }, { "name": "referenceMatmul", "kind": "function", "signature": "referenceMatmul(activations, weightsInt8, scales, M, K, N)", "summary": "Plain-JS reference matmul, same math/order as the WGSL kernel. Returns Float64Array[M*N]." }, { "name": "compareResults", "kind": "function", "signature": "compareResults(gpuResult, referenceResult)", "summary": "Max-abs and max-relative error between a GPU result and the CPU reference." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/MatmulW8A16Kernel", "path": "agi/reference/particle_voice/risk/MatmulW8A16Kernel.md", "source": "agi/particle_voice/risk/MatmulW8A16Kernel.js", "import": "/agi/particle_voice/risk/MatmulW8A16Kernel.js", "sourceHash": "4722455b8d4b9a404fd972a26842a005b8fff3a90ad085da26365eb8e0579996", "summary": "MatmulW8A16Kernel.js — R2 Phase -1 risk spike WGSL generator. No raw `.wgsl` files (Engine Alignment invariant #1): this module exports a `shader(params)` function that returns a WGSL string, same convention as `agi/llm/kernels/shaders/*.js` and the eventual `nn/kernels/matmul/matmul_w8a16.js`. MVP scope for this spike: INT8 weights (4-packed per u32, per-output-channel scale) x FP32 activations, FP32 accumulation, FP32 output. This is a deliberately smaller slice of the plan's stated \"W8A16 packed INT8 x FP16 matmul, FP32 accumulation, FP16 output\" — FP16 activation/output packing needs its own bit-packing design (2xf16 per u32, gated on `shader-f16` from R1) and is left as an explicit follow-up rather than an unverified claim. Weight layout expected by this kernel: - Logical weights are [K, N] (K = input/hidden dim, N = output dim). - Packed as `packedWeights[n * (K/4) + k4]`, a u32 whose 4 bytes are the int8 weights for k = k4*4 + 0..3 (little end = lowest k). - `scales[n]` is the per-output-channel dequantization scale. - K must be a multiple of 4.", "exports": [ { "name": "matmulW8a16Shader", "kind": "function", "signature": "matmulW8a16Shader()", "summary": "" }, { "name": "MATMUL_W8A16_ENTRY_POINT", "kind": "constant", "signature": "MATMUL_W8A16_ENTRY_POINT", "summary": "MatmulW8A16Kernel.js — R2 Phase -1 risk spike WGSL generator. No raw `.wgsl` files (Engine Alignment invariant #1): this module exports a `shader(params)` function that returns a WGSL string, same convention as `agi/llm/kernels/shaders/*.js` and the eventual `nn/kernels/matmul/matmul_w8a16.js`. MVP scope for this spike: INT8 weights (4-packed per u32, per-output-channel scale) x FP32 activations, FP32 accumulation, FP32 output. This is a deliberately smaller slice of the plan's stated \"W8A16 packed INT8 x FP16 matmul, FP32 accumulation, FP16 output\" — FP16 activation/output packing needs its own bit-packing design (2xf16 per u32, gated on `shader-f16` from R1) and is left as an explicit follow-up rather than an unverified claim. Weight layout expected by this kernel: - Logical weights are [K, N] (K = input/hidden dim, N = output dim). - Packed as `packedWeights[n * (K/4) + k4]`, a u32 whose 4 bytes are the int8 weights for k = k4*4 + 0..3 (little end = lowest k). - `scales[n]` is the per-output-channel dequantization scale. - K must be a multiple of 4." }, { "name": "MATMUL_W8A16_WORKGROUP_SIZE", "kind": "constant", "signature": "MATMUL_W8A16_WORKGROUP_SIZE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/NeuralPhysiologyState", "path": "agi/reference/particle_voice/risk/NeuralPhysiologyState.md", "source": "agi/particle_voice/risk/NeuralPhysiologyState.js", "import": "/agi/particle_voice/risk/NeuralPhysiologyState.js", "sourceHash": "d4942e133aebf22e0c700ba6d5f6a12191915ee7ef0b2e8a46d787e3fee3fcac", "summary": "NeuralPhysiologyState.js — R6A Phase -1 risk spike. \"NeuralPhysiologyState schema: RespiratoryDriveHead, GlottalStateHead, TractGestureHead, ArticulationEventHead, UncertaintyHead version 0x00010000.\" — particle-voice-26357c.md, Phase 2 (adopted early here for the R6A wiring receipt). No trained `ArticulationHead` model exists yet (that's Phase 3+). This provides the state SCHEMA plus a deterministic scripted stand-in (\"fake head\") that produces plausible per-frame physiology values as a pure function of time and an `intervention` parameter set — enough to prove the wiring ArticulationHead -> NeuralPhysiologyState -> BreathReservoir/ParticleTract -> renderer actually routes control values through to the final PCM, which is what R6A's exit gate asks for.", "exports": [ { "name": "createNeuralPhysiologyState", "kind": "function", "signature": "createNeuralPhysiologyState({ timestampSeconds, respiratoryDrive, glottalState, tractGesture, articulationEvent, uncertainty, })", "summary": "" }, { "name": "createScriptedArticulationHead", "kind": "function", "signature": "createScriptedArticulationHead(intervention = {})", "summary": "Deterministic scripted stand-in for a trained ArticulationHead: a short \"utterance\" that opens into a steady vowel then applies a brief closure gesture, with `intervention.respiratoryScale` and `intervention.constrictionOpennessFloor` letting a caller apply a physiology intervention and compare against a baseline run." }, { "name": "NEURAL_PHYSIOLOGY_STATE_VERSION", "kind": "constant", "signature": "NEURAL_PHYSIOLOGY_STATE_VERSION", "summary": "NeuralPhysiologyState.js — R6A Phase -1 risk spike. \"NeuralPhysiologyState schema: RespiratoryDriveHead, GlottalStateHead, TractGestureHead, ArticulationEventHead, UncertaintyHead version 0x00010000.\" — particle-voice-26357c.md, Phase 2 (adopted early here for the R6A wiring receipt). No trained `ArticulationHead` model exists yet (that's Phase 3+). This provides the state SCHEMA plus a deterministic scripted stand-in (\"fake head\") that produces plausible per-frame physiology values as a pure function of time and an `intervention` parameter set — enough to prove the wiring ArticulationHead -> NeuralPhysiologyState -> BreathReservoir/ParticleTract -> renderer actually routes control values through to the final PCM, which is what R6A's exit gate asks for." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/OsMediaPermissionProbe", "path": "agi/reference/particle_voice/risk/OsMediaPermissionProbe.md", "source": "agi/particle_voice/risk/OsMediaPermissionProbe.js", "import": "/agi/particle_voice/risk/OsMediaPermissionProbe.js", "sourceHash": "775b641f77d994d59d2cf38b6df546cc25a9044317ff469f874b483d3f960a5d", "summary": "OsMediaPermissionProbe.js — R16 Phase -1 risk spike. \"Secure context + user gesture + getUserMedia + enumerateDevices + AudioWorklet + SharedArrayBuffer all succeed through kernel.media.* / kernel.audio.* syscalls; media.audio / audio.play / microphone capabilities are correctly required and enforced by guardSyscalls; OsMediaBridge.js never touches raw navigator.mediaDevices.\" — Phase -1. `agi/particle_voice/activity/bridge/OsMediaBridge.js` does not exist yet (Phase -1 precedes Phase 1+ implementation) — that check is a forward contract placeholder here, not yet applicable. Everything else tests the REAL `webgpu-os/kernel/Syscalls.js` (`createSyscalls`, `guardSyscalls`) and `webgpu-os/kernel/Permissions.js` (`Permissions`) directly, not a stand-in — this spike is about the OS integration contract itself.", "exports": [ { "name": "runOsMediaPermissionProbe", "kind": "function", "signature": "async runOsMediaPermissionProbe()", "summary": "" }, { "name": "buildOsMediaPermissionReceipt", "kind": "function", "signature": "async buildOsMediaPermissionReceipt(result)", "summary": "" }, { "name": "prepareOsMediaPermissionReceiptDownload", "kind": "function", "signature": "prepareOsMediaPermissionReceiptDownload(receipt)", "summary": "" }, { "name": "R16_OS_MEDIA_PERMISSION_SCHEMA", "kind": "constant", "signature": "R16_OS_MEDIA_PERMISSION_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/ParticleEnergyMeter", "path": "agi/reference/particle_voice/risk/ParticleEnergyMeter.md", "source": "agi/particle_voice/risk/ParticleEnergyMeter.js", "import": "/agi/particle_voice/risk/ParticleEnergyMeter.js", "sourceHash": "abf80a11fdc5019d8da1daed093b6d2a754ad786b47013015ded6fe4d781806d", "summary": "ParticleEnergyMeter.js — R10 Phase -1 risk spike. \"RMS, dBFS, peak, clipping, DC offset, crest factor, attack/release, SNR, low/mid/high band energy, spectral flux; adaptive noise floor while no speech/echo present.\" — Phase -1. Plain-JS CPU implementation (small analysis frames, not a GPU kernel — this is a metering/control-path computation, not a bulk DSP kernel like R3's FFT). Includes its own compact FFT for band energy/spectral flux rather than importing Fft1024Kernel.js, which generates a WGSL string for GPU dispatch, not a callable JS magnitude-spectrum function — a different form for a different execution context, same algorithm family as MatmulReferenceCpu.js is to matmul_w8a16.js.", "exports": [ { "name": "createParticleEnergyMeter", "kind": "function", "signature": "createParticleEnergyMeter({ sampleRate, frameSize = 256, attackMs = 5, releaseMs = 60, noiseFloorRecoveryPerFrame = 0.0008 })", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/ParticleVad", "path": "agi/reference/particle_voice/risk/ParticleVad.md", "source": "agi/particle_voice/risk/ParticleVad.js", "import": "/agi/particle_voice/risk/ParticleVad.js", "sourceHash": "956bee93ed0dc39a6adc9930b4538632ba3b717918ceca6635cf1a9897cc2c3b", "summary": "ParticleVad.js — R11 Phase -1 risk spike. \"ParticleVAD-1 11-head output smoothness, hysteresis, no flicker; latency p50/p95 of speech-start/end decisions.\" — Phase -1. No trained ParticleVAD-1 model exists yet — this is a heuristic, energy/spectral-flux-driven stand-in (built on R10's ParticleEnergyMeter), not a neural VAD. The plan names \"11 continuous probability heads\" without enumerating all 11 in the sections read for this spike; the 11 names below are a reasonable, clearly-labeled interpretation, not a verified spec. Testing rigor here focuses on the primary `speechActive` head's smoothness/hysteresis/latency, since that is what a heuristic stand-in can meaningfully validate.", "exports": [ { "name": "createParticleVad", "kind": "function", "signature": "createParticleVad({ sampleRate, frameSize = 256, smoothingMs = 30, riseThreshold = 0.55, fallThreshold = 0.35 })", "summary": "" }, { "name": "VAD_HEAD_NAMES", "kind": "constant", "signature": "VAD_HEAD_NAMES", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/R4ReadbackAudioWorklet.worklet", "path": "agi/reference/particle_voice/risk/R4ReadbackAudioWorklet.worklet.md", "source": "agi/particle_voice/risk/R4ReadbackAudioWorklet.worklet.js", "import": "/agi/particle_voice/risk/R4ReadbackAudioWorklet.worklet.js", "sourceHash": "1d3b3439793159b2564ce26fdb0b656cd168ef2b673b3a445fd62c50479a4d49", "summary": "R4ReadbackAudioWorklet.worklet.js — R4 Phase -1 risk spike. \"allocation-free AudioWorklet.\" — Phase -1. Reference/mirror target: engine/audio/synth/PatchRunner.worklet.js (SAB parameter reads, no allocation in process()). Consumes a single-producer/single-consumer PCM ring living in a SharedArrayBuffer (written by the main thread, standing in for what the production path would fill via GPUReadbackRing.js + SharedPCMRing.js). `process()` performs zero allocation: no `new`, no object/array literals, no `await`, no `throw`, no `JSON` — only typed-array indexing and Atomics on pre-existing SharedArrayBuffer-backed views. Control layout (Int32Array, SharedArrayBuffer, 4 x int32): [0] writeIndex — next PCM slot the producer will write (main thread) [1] readIndex — next PCM slot this processor will read [2] underrunCount — incremented whenever fewer than one quantum of samples are available [3] processCallCount — incremented every process() call This file cannot be dynamically `import()`-ed from a normal page context: `AudioWorkletProcessor`/`registerProcessor` only exist inside the AudioWorkletGlobalScope. Load it via `audioContext.audioWorklet.addModule(url)`.", "exports": [], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/ReadbackAudioProbe", "path": "agi/reference/particle_voice/risk/ReadbackAudioProbe.md", "source": "agi/particle_voice/risk/ReadbackAudioProbe.js", "import": "/agi/particle_voice/risk/ReadbackAudioProbe.js", "sourceHash": "ee382595d2205c5bad45378893ad5a64b97d46942e6561188fb10a94e4032e4e", "summary": "ReadbackAudioProbe.js — R4 Phase -1 risk spike. Exit gate: \"Per-buffer mapAsync() p50/p95/p99; AudioWorklet survives variable quantum and rebuild; one-hour zero-underrun baseline.\" — Phase -1. Honest scoping note: a literal one-hour automated soak is not run by this probe (impractical inside a single interactive/CI session). This runs a short deterministic soak (SHORT_BASELINE_SOAK_MS) as a scaled-down proxy, clearly labeled as such in the receipt, plus an underrun-detector self-test (proves the zero-underrun count is meaningful, not tautological) and a full teardown+rebuild cycle. The full one-hour soak is left as an explicit manual/CI follow-up — see `oneHourSoak` in the result. \"Variable quantum\" is not directly controllable from stable browser APIs (render quantum size is fixed at 128 in all current stable implementations); this is verified as a static property of the processor (R4ReadbackAudioWorklet.worklet.js reads `channel.length` for its loop bound rather than assuming 128) plus dynamic survival across two independent AudioContext instances (which may differ in `sampleRate`).", "exports": [ { "name": "createSharedRing", "kind": "function", "signature": "createSharedRing(sampleRate)", "summary": "" }, { "name": "prefillRing", "kind": "function", "signature": "prefillRing(ring, sampleRate, prefillMs)", "summary": "Synchronously write `prefillMs` of audio into the ring before the worklet node is ever pulled. Absorbs the startup race between the interval-based producer's first tick (~PRODUCER_INTERVAL_MS away) and the AudioWorklet's first process() call, which can happen sooner — without this, a handful of transient underruns at cold start are expected, not a sustained-rate problem, but they'd still show up in a \"zero-underrun baseline\" reading." }, { "name": "startProducer", "kind": "function", "signature": "startProducer(ring, sampleRate, initialSamplesProduced = 0)", "summary": "Wall-clock-paced producer: writes exactly enough samples each tick to match elapsed real time (minus whatever was already prefilled), so it neither underruns (falls behind) nor overflows the fixed-capacity ring (a fixed-chunk-per-tick producer would race arbitrarily far ahead of the consumer and wrap/corrupt the ring)." }, { "name": "createWorkletSetup", "kind": "function", "signature": "async createWorkletSetup()", "summary": "" }, { "name": "teardownWorkletSetup", "kind": "function", "signature": "async teardownWorkletSetup(setup)", "summary": "" }, { "name": "runReadbackAudioProbe", "kind": "function", "signature": "async runReadbackAudioProbe()", "summary": "" }, { "name": "buildReadbackAudioReceipt", "kind": "function", "signature": "async buildReadbackAudioReceipt(result)", "summary": "" }, { "name": "prepareReadbackAudioReceiptDownload", "kind": "function", "signature": "prepareReadbackAudioReceiptDownload(receipt)", "summary": "" }, { "name": "runLongSoak", "kind": "function", "signature": "async runLongSoak(durationMs)", "summary": "Exposed on window for a human/CI to opt into the real one-hour soak manually." }, { "name": "R4_READBACK_AUDIO_SCHEMA", "kind": "constant", "signature": "R4_READBACK_AUDIO_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/ReceiptCrypto", "path": "agi/reference/particle_voice/risk/ReceiptCrypto.md", "source": "agi/particle_voice/risk/ReceiptCrypto.js", "import": "/agi/particle_voice/risk/ReceiptCrypto.js", "sourceHash": "6903c6afc41c12cb74b9ee40f4398a91d9816930f3f12257a7a3e8c68bfcfae2", "summary": "ReceiptCrypto.js — shared canonicalization + SHA-256 hashing for every Phase -1 risk-spike JSON receipt under `agi/particle_voice/risk/`. Kept tiny and dependency-free so any risk page can import it directly.", "exports": [ { "name": "canonicalizeForHash", "kind": "function", "signature": "canonicalizeForHash(value)", "summary": "Recursively sort object keys so hashing is independent of insertion order." }, { "name": "sha256HexOf", "kind": "function", "signature": "async sha256HexOf(value)", "summary": "SHA-256 hex digest of a canonicalized JSON value, or null if WebCrypto is unavailable." }, { "name": "receiptHashOf", "kind": "function", "signature": "async receiptHashOf(value)", "summary": "Convenience: `sha256:` prefixed digest, or null." }, { "name": "prepareJsonDownload", "kind": "function", "signature": "prepareJsonDownload(receipt, filenamePrefix)", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/RendererVoiceStressProbe", "path": "agi/reference/particle_voice/risk/RendererVoiceStressProbe.md", "source": "agi/particle_voice/risk/RendererVoiceStressProbe.js", "import": "/agi/particle_voice/risk/RendererVoiceStressProbe.js", "sourceHash": "a2a49b5f9103ab70f40983bde0956d59882809c0f9a93003b14b11c9f328c83a", "summary": "RendererVoiceStressProbe.js — R9 Phase -1 risk spike. Exit gate: \"Voice + heavy scene runs without audio underruns or persistent render frame drops.\" — Phase -1. Runs a heavy procedural instanced-triangle render pass and a batched FFT \"voice compute\" dispatch every animation frame, concurrently with R4's real AudioWorklet + SharedArrayBuffer PCM ring (imported directly, not reimplemented), for a few seconds. Measures both render frame-time health and audio underrun count over the same window.", "exports": [ { "name": "runRendererVoiceStressProbe", "kind": "function", "signature": "async runRendererVoiceStressProbe()", "summary": "" }, { "name": "buildRendererVoiceStressReceipt", "kind": "function", "signature": "async buildRendererVoiceStressReceipt(result)", "summary": "" }, { "name": "prepareRendererVoiceStressReceiptDownload", "kind": "function", "signature": "prepareRendererVoiceStressReceiptDownload(receipt)", "summary": "" }, { "name": "R9_RENDERER_VOICE_STRESS_SCHEMA", "kind": "constant", "signature": "R9_RENDERER_VOICE_STRESS_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/SignalMetrics", "path": "agi/reference/particle_voice/risk/SignalMetrics.md", "source": "agi/particle_voice/risk/SignalMetrics.js", "import": "/agi/particle_voice/risk/SignalMetrics.js", "sourceHash": "4e86e594094b72b81c2e6a8b4a7dacac0c0a0db830c343558c3dd661be5c57d2", "summary": "SignalMetrics.js — shared signal-quality helpers for Phase -1 risk pages (extracted out of VoiceBoxWaveguideProbe.js when a third consumer appeared, to avoid a third copy-paste of rms/peakAbs/hasNonFinite).", "exports": [ { "name": "rms", "kind": "function", "signature": "rms(signal, start = 0, end = signal.length)", "summary": "SignalMetrics.js — shared signal-quality helpers for Phase -1 risk pages (extracted out of VoiceBoxWaveguideProbe.js when a third consumer appeared, to avoid a third copy-paste of rms/peakAbs/hasNonFinite)." }, { "name": "peakAbs", "kind": "function", "signature": "peakAbs(signal, start = 0, end = signal.length)", "summary": "" }, { "name": "hasNonFinite", "kind": "function", "signature": "hasNonFinite(signal)", "summary": "" }, { "name": "maxAbsDiff", "kind": "function", "signature": "maxAbsDiff(a, b, startIndex = 0, endIndex = a.length)", "summary": "" }, { "name": "detectClicks", "kind": "function", "signature": "detectClicks(signal, windowSize = 256, thresholdMultiplier = 12)", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/StftWolaProbe", "path": "agi/reference/particle_voice/risk/StftWolaProbe.md", "source": "agi/particle_voice/risk/StftWolaProbe.js", "import": "/agi/particle_voice/risk/StftWolaProbe.js", "sourceHash": "9f75b40f63e418cbcf80db58e911d0939a429202201eedf2d681b4d9871b73f3", "summary": "StftWolaProbe.js — R3 Phase -1 risk spike. \"stft-wola.html — 1024-point f32 FFT/IFFT and normalized WOLA for 320-sample hop; identity, impulse, sweep, noise tests.\" — Phase -1. Exit gate: \"Identity tests pass; workgroup limits respected; normalized WOLA ripple below audible threshold.\" Identity tests run a single frame through forward FFT then inverse FFT (both on GPU) and compare to the original signal. The WOLA test runs many overlapping analysis-windowed frames through the same round trip, applies a synthesis window, overlap-adds, and divides by the exact sum-of-squares envelope — with exact normalization the round trip is mathematically identity, so any measured \"ripple\" is real FFT/window/OLA implementation error, not a windowing-shape artifact.", "exports": [ { "name": "runStftWolaProbe", "kind": "function", "signature": "async runStftWolaProbe()", "summary": "" }, { "name": "buildStftWolaReceipt", "kind": "function", "signature": "async buildStftWolaReceipt(result)", "summary": "" }, { "name": "prepareStftWolaReceiptDownload", "kind": "function", "signature": "prepareStftWolaReceiptDownload(receipt)", "summary": "" }, { "name": "R3_STFT_WOLA_SCHEMA", "kind": "constant", "signature": "R3_STFT_WOLA_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/StreamingContinuityProbe", "path": "agi/reference/particle_voice/risk/StreamingContinuityProbe.md", "source": "agi/particle_voice/risk/StreamingContinuityProbe.js", "import": "/agi/particle_voice/risk/StreamingContinuityProbe.js", "sourceHash": "f4d6893db72a4b9c236d7bc60ff856ec2e611b7cebf0611c04be930eb947a099", "summary": "StreamingContinuityProbe.js — R5 Phase -1 risk spike orchestrator. Pure JS, no GPU/AudioContext dependency: R5's exit gate is an architectural/correctness property of the counter design (does chunking change the output?), not a GPU performance question, so no kernel is needed to validate it. See StreamingContinuitySource.js for the mechanism.", "exports": [ { "name": "runStreamingContinuityProbe", "kind": "function", "signature": "async runStreamingContinuityProbe()", "summary": "" }, { "name": "buildStreamingContinuityReceipt", "kind": "function", "signature": "async buildStreamingContinuityReceipt(result)", "summary": "" }, { "name": "prepareStreamingContinuityReceiptDownload", "kind": "function", "signature": "prepareStreamingContinuityReceiptDownload(receipt)", "summary": "" }, { "name": "R5_STREAMING_CONTINUITY_SCHEMA", "kind": "constant", "signature": "R5_STREAMING_CONTINUITY_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/StreamingContinuitySource", "path": "agi/reference/particle_voice/risk/StreamingContinuitySource.md", "source": "agi/particle_voice/risk/StreamingContinuitySource.js", "import": "/agi/particle_voice/risk/StreamingContinuitySource.js", "sourceHash": "341d03da1e1b0ffd7eeb86ff7ca668715da617ee4885e39e3ace0cef2d8e1f26", "summary": "StreamingContinuitySource.js — R5 Phase -1 risk spike. Exit gate: \"Phase-continuous harmonic/noise across arbitrary chunk boundaries; absolute-counter noise chunk-independent.\" — Phase -1. There is no dedicated filename for R5 in the plan's risk/ page list (it names R0-R4, R6-R16 pages explicitly but not R5) — this file/page covers that exit gate directly. The technique: every sample's value is a pure function of its ABSOLUTE sample index (harmonic phase = 2*pi*f0*n/sampleRate; noise = a counter-based hash of n), with no persistent oscillator/PRNG state threaded between chunks and no chunk-relative counter anywhere. Chunking therefore cannot affect the output — not \"close enough\", bit-identical — because the per-sample computation never reads chunk position at all. This is the mechanism `harmonic_source.js`/`noise_source.js` (Phase 2) must use for random chunk-boundary training and streaming to work.", "exports": [ { "name": "noiseAt", "kind": "function", "signature": "noiseAt(absoluteIndex, seed)", "summary": "Counter-based hash PRNG: deterministic pseudo-random float in [-1, 1], pure function of (index, seed)." }, { "name": "harmonicAt", "kind": "function", "signature": "harmonicAt(absoluteIndex, sampleRate, f0Hz)", "summary": "Pure function of absolute sample index — no carried oscillator phase state." }, { "name": "synthesizeAbsoluteCounter", "kind": "function", "signature": "synthesizeAbsoluteCounter(totalSamples, sampleRate, f0Hz, noiseSeed, chunkSizes)", "summary": "Correct (absolute-counter) synthesis: chunking `chunkSizes` (cycled) has zero effect on the output because each sample only ever reads its absolute index `n`, never a position relative to the current chunk." }, { "name": "synthesizeChunkRelativeCounterBuggy", "kind": "function", "signature": "synthesizeChunkRelativeCounterBuggy(totalSamples, sampleRate, f0Hz, noiseSeed, chunkSizes)", "summary": "Deliberately buggy (chunk-relative-counter) synthesis for the self-test: resets its local counter to 0 at the start of every chunk, so output DOES depend on how the signal was chunked — used only to prove the bit-exact comparison in this probe actually catches phase discontinuity." }, { "name": "maxAbsDiff", "kind": "function", "signature": "maxAbsDiff(a, b)", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/TinyAutodiff", "path": "agi/reference/particle_voice/risk/TinyAutodiff.md", "source": "agi/particle_voice/risk/TinyAutodiff.js", "import": "/agi/particle_voice/risk/TinyAutodiff.js", "sourceHash": "ec5c004232925a8f0fcac03bb0685a7bfdbdf568132330c3640e25bfed94b399", "summary": "TinyAutodiff.js — R7 Phase -1 risk spike. Hand-wired forward+backward layers (Linear, Conv1D, ReLU, Sigmoid), losses (MSE, BCE), and an AdamW optimizer — deliberately NOT a general computational-graph autodiff engine. `ParticleTape`/`BackwardGraphCompiler`/ `GradientGraph` (Phase 1, nn/autodiff/) are the real general system; R7's job is to prove models at this parameter scale can be forward+backward trained in-browser at all, not to build that general architecture early. All arrays are plain Float32Array with row/channel-major layouts documented per function; batch=1 throughout (a single fixed sequence/vector per step) is sufficient for R7's memorization-convergence test.", "exports": [ { "name": "makeRng", "kind": "function", "signature": "makeRng(seed)", "summary": "TinyAutodiff.js — R7 Phase -1 risk spike. Hand-wired forward+backward layers (Linear, Conv1D, ReLU, Sigmoid), losses (MSE, BCE), and an AdamW optimizer — deliberately NOT a general computational-graph autodiff engine. `ParticleTape`/`BackwardGraphCompiler`/ `GradientGraph` (Phase 1, nn/autodiff/) are the real general system; R7's job is to prove models at this parameter scale can be forward+backward trained in-browser at all, not to build that general architecture early. All arrays are plain Float32Array with row/channel-major layouts documented per function; batch=1 throughout (a single fixed sequence/vector per step) is sufficient for R7's memorization-convergence test." }, { "name": "createLinear", "kind": "function", "signature": "createLinear(inputDim, outputDim, rng)", "summary": "" }, { "name": "createReLU", "kind": "function", "signature": "createReLU()", "summary": "" }, { "name": "createSigmoid", "kind": "function", "signature": "createSigmoid()", "summary": "" }, { "name": "createConv1D", "kind": "function", "signature": "createConv1D(inChannels, outChannels, kernelSize, rng)", "summary": "" }, { "name": "mseLoss", "kind": "function", "signature": "mseLoss(pred, target)", "summary": "" }, { "name": "bceLoss", "kind": "function", "signature": "bceLoss(pred, target)", "summary": "" }, { "name": "clipGradGlobalNorm", "kind": "function", "signature": "clipGradGlobalNorm(gradArrays, maxNorm)", "summary": "Clip the global L2 norm across all gradient arrays in place — cheap insurance against a deep stack diverging." }, { "name": "createAdamW", "kind": "function", "signature": "createAdamW(paramArrays, { lr = 0.01, beta1 = 0.9, beta2 = 0.999, eps = 1e-8, weightDecay = 0.01 } = {})", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/TinyModels", "path": "agi/reference/particle_voice/risk/TinyModels.md", "source": "agi/particle_voice/risk/TinyModels.js", "import": "/agi/particle_voice/risk/TinyModels.js", "sourceHash": "cfde29bd4820222255a17e49e4d66d8c7fb1246a1116b488b0bacd8458a5dbd5", "summary": "TinyModels.js — R7 Phase -1 risk spike model definitions. \"1M-parameter model, 5M Conv1D model, tiny adversarial audio pair\" — particle-voice-26357c.md, Phase -1. Exact param counts land close to but not exactly at 1,000,000/5,000,000 (real counts are reported, not fudged to hit a round number) — the plan's own number is an order-of-magnitude descriptor.", "exports": [ { "name": "createTinyMlpModel", "kind": "function", "signature": "createTinyMlpModel(rng)", "summary": "~0.93M-param MLP: Linear(64,650)-ReLU x3 -Linear(650,64)." }, { "name": "createTinyConv1dModel", "kind": "function", "signature": "createTinyConv1dModel(rng, sequenceLength = 16)", "summary": "~4.5M-param Conv1D stack: Conv1D(16,384,5)-ReLU, 6x[Conv1D(384,384,5)-ReLU], Conv1D(384,16,5)." }, { "name": "createTinyGan", "kind": "function", "signature": "createTinyGan(rng)", "summary": "Tiny generator (noise[8] -> sample[16]) + discriminator (sample[16] -> real-probability)." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/TrainingSpikeProbe", "path": "agi/reference/particle_voice/risk/TrainingSpikeProbe.md", "source": "agi/particle_voice/risk/TrainingSpikeProbe.js", "import": "/agi/particle_voice/risk/TrainingSpikeProbe.js", "sourceHash": "34634c487999f5b7f1c22135c140bc03790964bd27e4181e090db8dfdd818309", "summary": "TrainingSpikeProbe.js — R7 Phase -1 risk spike orchestrator. Exit gate: \"1M model converges; 5M Conv1D model converges; tiny GAN converges and checkpoints; AdamW memory estimate matches measurement.\" — Phase -1. \"OPFS cache behavior\" and \"device-loss re-upload\" are also named in the risk page description and covered here. Scoping notes (read before trusting a pass): - \"Converges\" here means memorizes a small fixed random input/target pair (loss drops sharply) — a feasibility/mechanics check, not a generalization claim. - \"Device-loss re-upload\" exercises the re-upload PROCEDURE after an intentional device.destroy(); there is no scriptable public API to force an uncontrolled device loss (crash), so that path is not tested.", "exports": [ { "name": "runTrainingSpikeProbe", "kind": "function", "signature": "async runTrainingSpikeProbe()", "summary": "" }, { "name": "buildTrainingSpikeReceipt", "kind": "function", "signature": "async buildTrainingSpikeReceipt(result)", "summary": "" }, { "name": "prepareTrainingSpikeReceiptDownload", "kind": "function", "signature": "prepareTrainingSpikeReceiptDownload(receipt)", "summary": "" }, { "name": "R7_TRAINING_SPIKE_SCHEMA", "kind": "constant", "signature": "R7_TRAINING_SPIKE_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/VadContinuityProbe", "path": "agi/reference/particle_voice/risk/VadContinuityProbe.md", "source": "agi/particle_voice/risk/VadContinuityProbe.js", "import": "/agi/particle_voice/risk/VadContinuityProbe.js", "sourceHash": "52324adc3b4c8c3586f795fbba86bfe2a4e34caf20617ae4d89a2f5d70965f59", "summary": "VadContinuityProbe.js — R11 Phase -1 risk spike orchestrator.", "exports": [ { "name": "runVadContinuityProbe", "kind": "function", "signature": "async runVadContinuityProbe()", "summary": "" }, { "name": "buildVadContinuityReceipt", "kind": "function", "signature": "async buildVadContinuityReceipt(result)", "summary": "" }, { "name": "prepareVadContinuityReceiptDownload", "kind": "function", "signature": "prepareVadContinuityReceiptDownload(receipt)", "summary": "" }, { "name": "R11_VAD_CONTINUITY_SCHEMA", "kind": "constant", "signature": "R11_VAD_CONTINUITY_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/VoiceBoxPhysiologyProbe", "path": "agi/reference/particle_voice/risk/VoiceBoxPhysiologyProbe.md", "source": "agi/particle_voice/risk/VoiceBoxPhysiologyProbe.js", "import": "/agi/particle_voice/risk/VoiceBoxPhysiologyProbe.js", "sourceHash": "b2a0067cf8691acb435642bc00cb315d07f58f9e2333f4ef5cd6f785e1244623", "summary": "VoiceBoxPhysiologyProbe.js — R6A Phase -1 risk spike orchestrator. Exit gate: \"ArticulationHead -> NeuralPhysiologyState -> BreathReservoir/ParticleTract -> acoustic renderer receipt; physiology intervention changes final PCM.\" — Phase -1. No dedicated filename exists for R6A in the plan's risk/ page list either (same situation as R5) — this page covers that exit gate directly. Wires: createScriptedArticulationHead (stand-in for the trained model) -> NeuralPhysiologyState -> createBreathReservoir -> createGlottalSource + createVocalTract (R6's waveguide, reused directly, not re-implemented) -> PCM. Renders the same scripted utterance twice — once at baseline, once with a reduced-respiratory-drive intervention — and requires the two PCM outputs to measurably differ while both remain stable.", "exports": [ { "name": "runVoiceBoxPhysiologyProbe", "kind": "function", "signature": "async runVoiceBoxPhysiologyProbe()", "summary": "" }, { "name": "buildVoiceBoxPhysiologyReceipt", "kind": "function", "signature": "async buildVoiceBoxPhysiologyReceipt(result)", "summary": "" }, { "name": "prepareVoiceBoxPhysiologyReceiptDownload", "kind": "function", "signature": "prepareVoiceBoxPhysiologyReceiptDownload(receipt)", "summary": "" }, { "name": "R6A_VOICEBOX_PHYSIOLOGY_SCHEMA", "kind": "constant", "signature": "R6A_VOICEBOX_PHYSIOLOGY_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/VoiceBoxWaveguideProbe", "path": "agi/reference/particle_voice/risk/VoiceBoxWaveguideProbe.md", "source": "agi/particle_voice/risk/VoiceBoxWaveguideProbe.js", "import": "/agi/particle_voice/risk/VoiceBoxWaveguideProbe.js", "sourceHash": "fa42835c831bf9082202480a07446c2e7a96dc8d1bade4577a549f93584b189b", "summary": "VoiceBoxWaveguideProbe.js — R6 Phase -1 risk spike orchestrator. Exit gate: \"Stable vowels, nasal coupling, closure/release/frication, pitch sweeps with no clicks or energy explosions.\" — Phase -1. Pure JS/CPU (see KellyLochbaumWaveguide.js header for why): this proves the waveguide algorithm itself is stable and produces plausible, controllable behavior. GPU kernel parity (`tract_waveguide.js` etc.) is a separate Phase 2 concern, tested the same way R2 checked matmul parity.", "exports": [ { "name": "runVoiceBoxWaveguideProbe", "kind": "function", "signature": "async runVoiceBoxWaveguideProbe()", "summary": "" }, { "name": "buildVoiceBoxWaveguideReceipt", "kind": "function", "signature": "async buildVoiceBoxWaveguideReceipt(result)", "summary": "" }, { "name": "prepareVoiceBoxWaveguideReceiptDownload", "kind": "function", "signature": "prepareVoiceBoxWaveguideReceiptDownload(receipt)", "summary": "" }, { "name": "R6_VOICEBOX_WAVEGUIDE_SCHEMA", "kind": "constant", "signature": "R6_VOICEBOX_WAVEGUIDE_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/WeightPagingProbe", "path": "agi/reference/particle_voice/risk/WeightPagingProbe.md", "source": "agi/particle_voice/risk/WeightPagingProbe.js", "import": "/agi/particle_voice/risk/WeightPagingProbe.js", "sourceHash": "781fcb693818fca7bf27b02e1954d6b061309a4343fcdbee9521fa919e83e031", "summary": "WeightPagingProbe.js — R8 Phase -1 risk spike. \"Weight page download/recovery/page-hash/interrupted-download works; device-loss re-upload succeeds.\" — Phase -1. No dedicated filename exists for R8 in the plan's risk/ page list — named weight-paging.html here. Simulates WeightPageStore.js's core responsibilities: a per-page SHA-256 directory, an interrupted download that must retry (not silently drop data), corruption detection via hash mismatch, and multi-page device-loss re-upload (extends R7's single-buffer version to several pages).", "exports": [ { "name": "runWeightPagingProbe", "kind": "function", "signature": "async runWeightPagingProbe()", "summary": "" }, { "name": "buildWeightPagingReceipt", "kind": "function", "signature": "async buildWeightPagingReceipt(result)", "summary": "" }, { "name": "prepareWeightPagingReceiptDownload", "kind": "function", "signature": "prepareWeightPagingReceiptDownload(receipt)", "summary": "" }, { "name": "R8_WEIGHT_PAGING_SCHEMA", "kind": "constant", "signature": "R8_WEIGHT_PAGING_SCHEMA", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/risk/WolaSignals", "path": "agi/reference/particle_voice/risk/WolaSignals.md", "source": "agi/particle_voice/risk/WolaSignals.js", "import": "/agi/particle_voice/risk/WolaSignals.js", "sourceHash": "87aae01bb39ae84e1a9a7530bc64e835f0c3b70616dcac4185f1543eb71ea775", "summary": "WolaSignals.js — deterministic test signals, Hann window, and CPU-side sum-of-squares WOLA normalization/overlap-add for R3 (stft-wola.html).", "exports": [ { "name": "hannWindow", "kind": "function", "signature": "hannWindow(N)", "summary": "" }, { "name": "impulseSignal", "kind": "function", "signature": "impulseSignal(N)", "summary": "" }, { "name": "sineSweepSignal", "kind": "function", "signature": "sineSweepSignal(N, sampleRate, f0, f1)", "summary": "Linear chirp from f0 to f1 Hz across N samples at sampleRate." }, { "name": "whiteNoiseSignal", "kind": "function", "signature": "whiteNoiseSignal(N, seed = 7)", "summary": "" }, { "name": "sineSignal", "kind": "function", "signature": "sineSignal(length, sampleRate, freqHz, amplitude = 1.0)", "summary": "" }, { "name": "computeSumOfSquaresEnvelope", "kind": "function", "signature": "computeSumOfSquaresEnvelope(window, hop, totalLength, numFrames)", "summary": "sum_k window[t - k*hop]^2 for every output sample t in [0, totalLength)." }, { "name": "overlapAdd", "kind": "function", "signature": "overlapAdd(frames, hop, totalLength)", "summary": "Overlap-add windowed frames (each already synthesis-windowed) into a flat buffer." }, { "name": "sliceFrames", "kind": "function", "signature": "sliceFrames(signal, N, hop, numFrames)", "summary": "Slice a flat signal into overlapping N-length frames at the given hop (zero-padded past the end)." }, { "name": "applyWindow", "kind": "function", "signature": "applyWindow(frame, window)", "summary": "" }, { "name": "maxAbsDiff", "kind": "function", "signature": "maxAbsDiff(a, b, startIndex = 0, endIndex = a.length)", "summary": "" }, { "name": "peakAbs", "kind": "function", "signature": "peakAbs(a, startIndex = 0, endIndex = a.length)", "summary": "" }, { "name": "toDb", "kind": "function", "signature": "toDb(ratio)", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/streaming/GPUReadbackRing", "path": "agi/reference/particle_voice/streaming/GPUReadbackRing.md", "source": "agi/particle_voice/streaming/GPUReadbackRing.js", "import": "/agi/particle_voice/streaming/GPUReadbackRing.js", "sourceHash": "ef614f2ef264549bc92360ea15a52ca4af03fbccd68d92d396f9fb6bec598695", "summary": "GPUReadbackRing.js — Phase 2 ParticleVoice audio bridge. Production generalization of `risk/GpuReadbackRing.js` (R4)'s proven round-robin `MAP_READ` staging-slot ring — same core technique (each slot is copied into and mapped independently; the ONLY synchronization primitive is that slot's own `mapAsync()` promise, never a global `device.queue.onSubmittedWorkDone()`), generalized from R4's single-fixed-size/offset-0 probe surface to the production needs this module's callers (`ParticleTract.js`'s per-chunk PCM readback, eventually `SharedPCMRing.js`'s producer side) actually have: a byte-offset/length per request (not always the whole buffer from 0), `inFlightCount()` for backpressure introspection instead of only a throw on exhaustion, and GPU buffer accounting via `engine/core/gpu/GpuMetrics.js` (matching `GpuBuffer.js`'s own convention for every other buffer this project creates). R4's exit gate (`ReadbackAudioProbe.js`) already measured this exact technique's p50/p95/p99 readback latency and zero-underrun behavior across an 8-slot ring — this module does not re-derive or change that proven synchronization discipline, only widens its calling surface.", "exports": [ { "name": "GPUReadbackRing", "kind": "class", "signature": "class GPUReadbackRing", "summary": "" }, { "name": "createGPUReadbackRing", "kind": "function", "signature": "createGPUReadbackRing(device, slotByteSize, options)", "summary": "" }, { "name": "DEFAULT_READBACK_SLOT_COUNT", "kind": "constant", "signature": "DEFAULT_READBACK_SLOT_COUNT", "summary": "" }, { "name": "MIN_READBACK_SLOT_COUNT", "kind": "constant", "signature": "MIN_READBACK_SLOT_COUNT", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/streaming/PolyphaseResampler", "path": "agi/reference/particle_voice/streaming/PolyphaseResampler.md", "source": "agi/particle_voice/streaming/PolyphaseResampler.js", "import": "/agi/particle_voice/streaming/PolyphaseResampler.js", "sourceHash": "cab38b9f0b74b585dec4daf90c92eab6475519c18ce741132ca4d17edd295324", "summary": "PolyphaseResampler.js — Phase 2 ParticleVoice audio bridge. \"ParticleVoice's own DSP runs at 32 kHz internally and resamples via `PolyphaseResampler.js` at the audio bridge boundary\" — `ARCHITECTURE.md` §\"Measured lead values\" / `spec/DeviceContract-v0.md` §7 (measured `AudioContext.sampleRate` 48000 Hz on the reference device). No risk-spike precedent exists for this module (checked `risk/` and `engine/` — the only \"resample\" hits in `engine/` are unrelated texture/render resample passes), so this is a fresh CPU-side (not GPU-kernel) implementation — appropriate for the audio bridge, which is already CPU-side per the plan (`SharedPCMRing.js`, `ParticleVoiceProcessor.js`). Classic Crochiere/Rabiner polyphase interpolator-decimator: for an EXACT integer ratio L/M (`inputSampleRate`/`outputSampleRate` reduced by their GCD — both are integers in practice, e.g. 32000 -> 48000 reduces exactly to L=3, M=2), a single windowed-sinc lowpass FIR (cutoff at `min(inputRate, outputRate)/2`, designed at the upsampled L*inputRate rate to suppress both upsampling images and downsampling aliases) is decomposed into L phase sub-filters of `tapsPerPhase` taps each. Per output sample, only `tapsPerPhase` multiplies are needed regardless of L — the O(tapsPerPhase*L) cost is paid once at construction (filter design), not per sample. STREAMING correctness (critical for a chunked audio bridge, where `WaveguideAcousticState` chunks arrive as small windows, not one whole signal): `process()` keeps a persistent tail of not-yet-fully-consumed input samples across calls (`_history`/`_historyBaseIndex`) and a continuously-advancing upsampled-domain position (`_pos`), so `resampler.process(wholeSignal)` and `chunks.map(c => resampler.process(c))` concatenated produce IDENTICAL output — verified directly in `tests/particle-voice/polyphase-resampler.html`. Known limitation (documented, not hidden): the FIR filter's group delay (~`tapsPerPhase/2` input samples) means the first `tapsPerPhase/2`-ish output samples ramp up from a zero-padded history rather than being bit-perfect from sample 0 — a normal, bounded FIR startup transient, not a correctness bug (every streaming FIR filter has this).", "exports": [ { "name": "PolyphaseResampler", "kind": "class", "signature": "class PolyphaseResampler", "summary": "" }, { "name": "gcd", "kind": "function", "signature": "gcd(a, b)", "summary": "PolyphaseResampler.js — Phase 2 ParticleVoice audio bridge. \"ParticleVoice's own DSP runs at 32 kHz internally and resamples via `PolyphaseResampler.js` at the audio bridge boundary\" — `ARCHITECTURE.md` §\"Measured lead values\" / `spec/DeviceContract-v0.md` §7 (measured `AudioContext.sampleRate` 48000 Hz on the reference device). No risk-spike precedent exists for this module (checked `risk/` and `engine/` — the only \"resample\" hits in `engine/` are unrelated texture/render resample passes), so this is a fresh CPU-side (not GPU-kernel) implementation — appropriate for the audio bridge, which is already CPU-side per the plan (`SharedPCMRing.js`, `ParticleVoiceProcessor.js`). Classic Crochiere/Rabiner polyphase interpolator-decimator: for an EXACT integer ratio L/M (`inputSampleRate`/`outputSampleRate` reduced by their GCD — both are integers in practice, e.g. 32000 -> 48000 reduces exactly to L=3, M=2), a single windowed-sinc lowpass FIR (cutoff at `min(inputRate, outputRate)/2`, designed at the upsampled L*inputRate rate to suppress both upsampling images and downsampling aliases) is decomposed into L phase sub-filters of `tapsPerPhase` taps each. Per output sample, only `tapsPerPhase` multiplies are needed regardless of L — the O(tapsPerPhase*L) cost is paid once at construction (filter design), not per sample. STREAMING correctness (critical for a chunked audio bridge, where `WaveguideAcousticState` chunks arrive as small windows, not one whole signal): `process()` keeps a persistent tail of not-yet-fully-consumed input samples across calls (`_history`/`_historyBaseIndex`) and a continuously-advancing upsampled-domain position (`_pos`), so `resampler.process(wholeSignal)` and `chunks.map(c => resampler.process(c))` concatenated produce IDENTICAL output — verified directly in `tests/particle-voice/polyphase-resampler.html`. Known limitation (documented, not hidden): the FIR filter's group delay (~`tapsPerPhase/2` input samples) means the first `tapsPerPhase/2`-ish output samples ramp up from a zero-padded history rather than being bit-perfect from sample 0 — a normal, bounded FIR startup transient, not a correctness bug (every streaming FIR filter has this)." }, { "name": "designWindowedSincLowpass", "kind": "function", "signature": "designWindowedSincLowpass(numTaps, cutoff)", "summary": "Windowed-sinc lowpass FIR, Hann-windowed, normalized to unity DC gain (`sum(h) === 1`). `cutoff` is normalized to the filter's OWN sample rate (0.5 = that rate's Nyquist) — callers designing a polyphase interpolator pass a cutoff normalized to the UPSAMPLED (L*inputRate) rate, per this module's `buildPolyphaseFilter`." }, { "name": "buildPolyphaseFilter", "kind": "function", "signature": "buildPolyphaseFilter(L, M, tapsPerPhase)", "summary": "Builds the L-phase decomposition of a full-length windowed-sinc lowpass sized for L/M polyphase interpolation-decimation." }, { "name": "DEFAULT_TAPS_PER_PHASE", "kind": "constant", "signature": "DEFAULT_TAPS_PER_PHASE", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/streaming/SafetyLimiter", "path": "agi/reference/particle_voice/streaming/SafetyLimiter.md", "source": "agi/particle_voice/streaming/SafetyLimiter.js", "import": "/agi/particle_voice/streaming/SafetyLimiter.js", "sourceHash": "3d2fed75098e26a8be33be3b1455a1569cffb40d96a13c2d30bd38b001f61f05", "summary": "SafetyLimiter.js — Phase 2 ParticleVoice audio bridge. \"SafetyLimiter.js — soft clip, DC removal, fade.\" No existing DC-blocker/soft-clip/limiter precedent exists in this codebase to reuse (checked `engine/audio/` — `PatchRunner.worklet.js`'s `distortion` node is a bare `Math.tanh(x*drive)` waveshaper, not a limiter/DC-blocker), so this is a fresh CPU-side implementation. Sits at the very end of the audio bridge, downstream of `PolyphaseResampler.js`, as the last line of defense before PCM reaches `SharedPCMRing.js`/the AudioContext — a physics/neural solver misbehaving upstream (an unstable `tract_waveguide.js` reflection coefficient, a runaway `glottal_lf.js` Newton-Raphson solve, etc.) should never be able to produce a harsh digital-clip transient, a DC offset, or a click at an utterance boundary — that is this module's entire job. Three independent, composable stages, applied per-sample in this order: 1. DC removal — the standard DC-blocking filter (Julius O. Smith's well-known form): `y[n] = x[n] - x[n-1] + R*y[n-1]`. At DC this converges to exactly 0 (the `z=1` zero cancels any constant component); `R` close to 1 keeps the notch narrow so audible low frequencies are essentially untouched. `R` is derived via this codebase's own established exponential-pole convention (`risk/BreathReservoir.js`'s `lagRate = 1 - exp(-1/(tau*sampleRate))` pattern) rather than inventing a new formula style: here `R = exp(-2*pi*cornerHz/sampleRate)`. 2. Fade — an explicit, persistent linear gain ramp (`beginFadeIn`/`beginFadeOut`), so an utterance start/stop or a cancellation (`SharedPCMRing.js`'s `resetSharedPCMRing()` discontinuity) can be given a clean few-millisecond ramp instead of an audible click. 3. Soft clip — a `tanh`-saturating soft knee above `softClipThreshold` (default 0.8): transparent (identity) below the threshold, then a C1-continuous (matching slope at the knee, so no audible kink) saturating curve that asymptotically approaches +/-1 but never reaches or exceeds it — i.e. this NEVER hard-clips, by construction. All three stages carry PERSISTENT state across `process()` calls (DC filter memory, fade envelope position) — `reset()` clears all of it in one call, mirroring `SharedPCMRing.js`/`PolyphaseResampler.js`'s reset-on-discontinuity convention, so a caller can reset the whole audio bridge chain in lockstep on cancellation/interruption.", "exports": [ { "name": "SafetyLimiter", "kind": "class", "signature": "class SafetyLimiter", "summary": "" }, { "name": "softClip", "kind": "function", "signature": "softClip(x, threshold = DEFAULT_SOFT_CLIP_THRESHOLD)", "summary": "Pure, stateless: `tanh`-saturating soft knee. Identity below `threshold` in magnitude; above it, asymptotically approaches `+/-1` but never reaches or exceeds it. C1-continuous at the knee (`tanh'(0) === 1` matches the identity segment's slope exactly)." }, { "name": "DEFAULT_DC_BLOCK_CORNER_HZ", "kind": "constant", "signature": "DEFAULT_DC_BLOCK_CORNER_HZ", "summary": "SafetyLimiter.js — Phase 2 ParticleVoice audio bridge. \"SafetyLimiter.js — soft clip, DC removal, fade.\" No existing DC-blocker/soft-clip/limiter precedent exists in this codebase to reuse (checked `engine/audio/` — `PatchRunner.worklet.js`'s `distortion` node is a bare `Math.tanh(x*drive)` waveshaper, not a limiter/DC-blocker), so this is a fresh CPU-side implementation. Sits at the very end of the audio bridge, downstream of `PolyphaseResampler.js`, as the last line of defense before PCM reaches `SharedPCMRing.js`/the AudioContext — a physics/neural solver misbehaving upstream (an unstable `tract_waveguide.js` reflection coefficient, a runaway `glottal_lf.js` Newton-Raphson solve, etc.) should never be able to produce a harsh digital-clip transient, a DC offset, or a click at an utterance boundary — that is this module's entire job. Three independent, composable stages, applied per-sample in this order: 1. DC removal — the standard DC-blocking filter (Julius O. Smith's well-known form): `y[n] = x[n] - x[n-1] + R*y[n-1]`. At DC this converges to exactly 0 (the `z=1` zero cancels any constant component); `R` close to 1 keeps the notch narrow so audible low frequencies are essentially untouched. `R` is derived via this codebase's own established exponential-pole convention (`risk/BreathReservoir.js`'s `lagRate = 1 - exp(-1/(tau*sampleRate))` pattern) rather than inventing a new formula style: here `R = exp(-2*pi*cornerHz/sampleRate)`. 2. Fade — an explicit, persistent linear gain ramp (`beginFadeIn`/`beginFadeOut`), so an utterance start/stop or a cancellation (`SharedPCMRing.js`'s `resetSharedPCMRing()` discontinuity) can be given a clean few-millisecond ramp instead of an audible click. 3. Soft clip — a `tanh`-saturating soft knee above `softClipThreshold` (default 0.8): transparent (identity) below the threshold, then a C1-continuous (matching slope at the knee, so no audible kink) saturating curve that asymptotically approaches +/-1 but never reaches or exceeds it — i.e. this NEVER hard-clips, by construction. All three stages carry PERSISTENT state across `process()` calls (DC filter memory, fade envelope position) — `reset()` clears all of it in one call, mirroring `SharedPCMRing.js`/`PolyphaseResampler.js`'s reset-on-discontinuity convention, so a caller can reset the whole audio bridge chain in lockstep on cancellation/interruption." }, { "name": "DEFAULT_SOFT_CLIP_THRESHOLD", "kind": "constant", "signature": "DEFAULT_SOFT_CLIP_THRESHOLD", "summary": "" }, { "name": "DEFAULT_FADE_MS", "kind": "constant", "signature": "DEFAULT_FADE_MS", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/streaming/SharedPCMRing", "path": "agi/reference/particle_voice/streaming/SharedPCMRing.md", "source": "agi/particle_voice/streaming/SharedPCMRing.js", "import": "/agi/particle_voice/streaming/SharedPCMRing.js", "sourceHash": "cd27717ce41748bd7683f89d36fd0fe5761c9dd55ef57f4ca937e3bd7379727e", "summary": "SharedPCMRing.js — Phase 2 ParticleVoice audio bridge. Production generalization of `risk/ReadbackAudioProbe.js` (R4)'s proven `createSharedRing`/`prefillRing`/`startProducer` SharedArrayBuffer PCM ring (single-producer/single-consumer, `[writeIndex, readIndex, underrunCount, processCallCount]` control layout consumed by `R4ReadbackAudioWorklet.worklet.js`'s allocation-free `process()`). Adds the plan's explicit \"generation/sequence IDs\" requirement, which R4's risk spike did not need (a disposable probe never gets reset mid-run): - `generation` (control[4]): bumped by `resetSharedPCMRing()` whenever the producer discards the ring's contents outright (cancellation/ interruption per the plan's Phase 5 \"cancellation resets state cleanly\", or a device-loss GPU recovery restart). The CONSUMER side (`readCurrentGeneration`/the resync check in `worklet/ParticleVoiceProcessor.js`) compares its own cached generation against this value every `process()` call; on mismatch it resyncs `readIndex` to the CURRENT `writeIndex` (dropping whatever stale audio was in the ring before the reset) rather than trusting a `readIndex` that may now point at samples from a discarded utterance. - `writeSequence` (control[5]): incremented once per producer `writeSharedPCMRing()` call (a monotonic chunk counter, not a sample counter) — correlates a ring write with the `WaveguideAcousticState.sampleIndex` that produced it for diagnostics/telemetry; the consumer does not need to read it for correctness (unlike `generation`). The reader-side helper function here (`readAvailable`) is pure arithmetic over caller-supplied typed arrays — no allocation, no closures over per-call state — usable from a non-worklet consumer (e.g. a test harness) without violating an allocation-free constraint. `worklet/ParticleVoiceProcessor.js` (the AudioWorkletProcessor that actually drains this ring in real-time) does NOT import this module — both existing worklet files in this project (`engine/audio/synth/PatchRunner.worklet.js`, `risk/R4ReadbackAudioWorklet.worklet.js`) are self-contained with no ES imports, so `ParticleVoiceProcessor.js` duplicates `CONTROL_INDEX` and the read-position arithmetic inline rather than relying on an unverified assumption that `AudioWorkletGlobalScope` module imports behave identically to this project's other worklet loading paths. Both files' docstrings flag this duplication explicitly so the two `CONTROL_INDEX` definitions cannot silently drift apart unnoticed.", "exports": [ { "name": "createSharedPCMRing", "kind": "function", "signature": "createSharedPCMRing({ sampleRate, capacitySeconds = DEFAULT_RING_CAPACITY_SECONDS })", "summary": "" }, { "name": "writeSharedPCMRing", "kind": "function", "signature": "writeSharedPCMRing(ring, samples)", "summary": "Producer-side write: copies `samples` into the ring starting at the current `writeIndex`, advancing it and incrementing `writeSequence`. Clamps to available free space (`capacity - 1 - available`, the usual ring-buffer one-slot gap to distinguish full from empty) rather than overflowing past the reader's current position and corrupting not-yet-read samples — R4's own `startProducer` avoided this by pacing writes to wall-clock time so it could never get ahead of the ring's capacity, but a production writer driven by GPU chunk completion (irregular timing) cannot assume that pacing, so this function must be defensive." }, { "name": "resetSharedPCMRing", "kind": "function", "signature": "resetSharedPCMRing(ring)", "summary": "Producer-side reset: zeroes both indices and bumps `generation` so the consumer discards its cached read position on its next `process()` call rather than replaying stale audio. Does not zero the PCM data itself (unnecessary — the consumer will resync past it)." }, { "name": "readAvailable", "kind": "function", "signature": "readAvailable(control, capacity)", "summary": "Pure, allocation-free: samples currently available to read (does not mutate anything). Safe to call from `process()`." }, { "name": "CONTROL_INDEX", "kind": "constant", "signature": "CONTROL_INDEX", "summary": "SharedPCMRing.js — Phase 2 ParticleVoice audio bridge. Production generalization of `risk/ReadbackAudioProbe.js` (R4)'s proven `createSharedRing`/`prefillRing`/`startProducer` SharedArrayBuffer PCM ring (single-producer/single-consumer, `[writeIndex, readIndex, underrunCount, processCallCount]` control layout consumed by `R4ReadbackAudioWorklet.worklet.js`'s allocation-free `process()`). Adds the plan's explicit \"generation/sequence IDs\" requirement, which R4's risk spike did not need (a disposable probe never gets reset mid-run): - `generation` (control[4]): bumped by `resetSharedPCMRing()` whenever the producer discards the ring's contents outright (cancellation/ interruption per the plan's Phase 5 \"cancellation resets state cleanly\", or a device-loss GPU recovery restart). The CONSUMER side (`readCurrentGeneration`/the resync check in `worklet/ParticleVoiceProcessor.js`) compares its own cached generation against this value every `process()` call; on mismatch it resyncs `readIndex` to the CURRENT `writeIndex` (dropping whatever stale audio was in the ring before the reset) rather than trusting a `readIndex` that may now point at samples from a discarded utterance. - `writeSequence` (control[5]): incremented once per producer `writeSharedPCMRing()` call (a monotonic chunk counter, not a sample counter) — correlates a ring write with the `WaveguideAcousticState.sampleIndex` that produced it for diagnostics/telemetry; the consumer does not need to read it for correctness (unlike `generation`). The reader-side helper function here (`readAvailable`) is pure arithmetic over caller-supplied typed arrays — no allocation, no closures over per-call state — usable from a non-worklet consumer (e.g. a test harness) without violating an allocation-free constraint. `worklet/ParticleVoiceProcessor.js` (the AudioWorkletProcessor that actually drains this ring in real-time) does NOT import this module — both existing worklet files in this project (`engine/audio/synth/PatchRunner.worklet.js`, `risk/R4ReadbackAudioWorklet.worklet.js`) are self-contained with no ES imports, so `ParticleVoiceProcessor.js` duplicates `CONTROL_INDEX` and the read-position arithmetic inline rather than relying on an unverified assumption that `AudioWorkletGlobalScope` module imports behave identically to this project's other worklet loading paths. Both files' docstrings flag this duplication explicitly so the two `CONTROL_INDEX` definitions cannot silently drift apart unnoticed." }, { "name": "CONTROL_SLOT_COUNT", "kind": "constant", "signature": "CONTROL_SLOT_COUNT", "summary": "" }, { "name": "DEFAULT_RING_CAPACITY_SECONDS", "kind": "constant", "signature": "DEFAULT_RING_CAPACITY_SECONDS", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/streaming/VoiceChunker", "path": "agi/reference/particle_voice/streaming/VoiceChunker.md", "source": "agi/particle_voice/streaming/VoiceChunker.js", "import": "/agi/particle_voice/streaming/VoiceChunker.js", "sourceHash": "9040300c209ffc11c5a59eec53c97faad951fdd844ca4c1c172c507d5bd62932", "summary": "VoiceChunker.js — Phase 2 ParticleVoice audio bridge. \"VoiceChunker.js — legal buckets: first 12/16/24 frames, steady 32/48/64 frames, 16-frame left context, 8-12 frame overlap.\" A \"frame\" here is the Activity frame size (`ARCHITECTURE.md`'s measured-lead-values table: 256 samples @ 32 kHz, 8 ms/frame) — NOT the 100 Hz plan-level analysis frame rate, which `LengthRegulator.js` (Phase 3) reconciles separately. `spec/PRNN-v0.md` §4 (\"Shape buckets\") directly reuses these exact bucket definitions so a compiled model's execution plan only needs to support this small fixed set of shapes rather than arbitrary sequence lengths — this module is the single source of truth those buckets come from, not a second independent copy of them: firstChunkFrames: [12, 16, 24] steadyChunkFrames: [32, 48, 64] leftContextFrames: 16 overlapFrames: [8, 12] `risk/StreamingContinuityProbe.js` (R5) already exercised exactly these bucket sizes (`[12, 16, 24, 32, 48, 64]`) as one of its chunk-boundary patterns and proved that an ABSOLUTE (not chunk-relative) sample/phase counter design makes chunking bit-identical to processing a whole signal at once — this module's `totalFramesEmitted` bookkeeping exists for exactly that reason (a caller can derive an absolute frame index from it), not merely as a diagnostic counter. SCOPE (Phase 2, before any real streaming model exists): this module only decides CHUNK SIZE SCHEDULING (which legal bucket to use next, given how many frames are currently available) — it does not itself run a model, apply left-context frames to a real tensor, or overlap-add output audio (that's `overlap_add.js`/`crossfade.js`, already built and verified in Phase 2's DSP kernels; a future model-execution layer composes THOSE with the chunk-size decisions THIS module makes). Latency/deadline tradeoffs (when to prefer a smaller, faster-available bucket over waiting for a larger one) are explicitly `VoiceDeadlineScheduler.js`'s job, not this module's — `nextChunk()` here always greedily picks the LARGEST legal bucket that currently fits, which is the natural default in the absence of an explicit deadline override.", "exports": [ { "name": "VoiceChunker", "kind": "class", "signature": "class VoiceChunker", "summary": "" }, { "name": "FIRST_CHUNK_FRAME_BUCKETS", "kind": "constant", "signature": "FIRST_CHUNK_FRAME_BUCKETS", "summary": "VoiceChunker.js — Phase 2 ParticleVoice audio bridge. \"VoiceChunker.js — legal buckets: first 12/16/24 frames, steady 32/48/64 frames, 16-frame left context, 8-12 frame overlap.\" A \"frame\" here is the Activity frame size (`ARCHITECTURE.md`'s measured-lead-values table: 256 samples @ 32 kHz, 8 ms/frame) — NOT the 100 Hz plan-level analysis frame rate, which `LengthRegulator.js` (Phase 3) reconciles separately. `spec/PRNN-v0.md` §4 (\"Shape buckets\") directly reuses these exact bucket definitions so a compiled model's execution plan only needs to support this small fixed set of shapes rather than arbitrary sequence lengths — this module is the single source of truth those buckets come from, not a second independent copy of them: firstChunkFrames: [12, 16, 24] steadyChunkFrames: [32, 48, 64] leftContextFrames: 16 overlapFrames: [8, 12] `risk/StreamingContinuityProbe.js` (R5) already exercised exactly these bucket sizes (`[12, 16, 24, 32, 48, 64]`) as one of its chunk-boundary patterns and proved that an ABSOLUTE (not chunk-relative) sample/phase counter design makes chunking bit-identical to processing a whole signal at once — this module's `totalFramesEmitted` bookkeeping exists for exactly that reason (a caller can derive an absolute frame index from it), not merely as a diagnostic counter. SCOPE (Phase 2, before any real streaming model exists): this module only decides CHUNK SIZE SCHEDULING (which legal bucket to use next, given how many frames are currently available) — it does not itself run a model, apply left-context frames to a real tensor, or overlap-add output audio (that's `overlap_add.js`/`crossfade.js`, already built and verified in Phase 2's DSP kernels; a future model-execution layer composes THOSE with the chunk-size decisions THIS module makes). Latency/deadline tradeoffs (when to prefer a smaller, faster-available bucket over waiting for a larger one) are explicitly `VoiceDeadlineScheduler.js`'s job, not this module's — `nextChunk()` here always greedily picks the LARGEST legal bucket that currently fits, which is the natural default in the absence of an explicit deadline override." }, { "name": "STEADY_CHUNK_FRAME_BUCKETS", "kind": "constant", "signature": "STEADY_CHUNK_FRAME_BUCKETS", "summary": "" }, { "name": "LEFT_CONTEXT_FRAMES", "kind": "constant", "signature": "LEFT_CONTEXT_FRAMES", "summary": "" }, { "name": "OVERLAP_FRAME_BUCKETS", "kind": "constant", "signature": "OVERLAP_FRAME_BUCKETS", "summary": "" }, { "name": "DEFAULT_OVERLAP_FRAMES", "kind": "constant", "signature": "DEFAULT_OVERLAP_FRAMES", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/streaming/VoiceDeadlineScheduler", "path": "agi/reference/particle_voice/streaming/VoiceDeadlineScheduler.md", "source": "agi/particle_voice/streaming/VoiceDeadlineScheduler.js", "import": "/agi/particle_voice/streaming/VoiceDeadlineScheduler.js", "sourceHash": "d5f19b8b05d4c3bbf56ca83b1ab5a36d630931026b0dbea4620ba66c9faed5ee", "summary": "VoiceDeadlineScheduler.js — Phase 2 ParticleVoice audio bridge. \"VoiceDeadlineScheduler.js — target >=300 ms, warning 200 ms, emergency 100 ms; GPU budget admission.\" These three thresholds classify how much PLAYBACK RUNWAY remains — how far ahead of the AudioContext's current playback position the produced-but-not-yet-played PCM currently extends (`bufferedAheadMs`, typically derived from `SharedPCMRing.js`'s `readAvailable()` via `bufferedAheadMsFromRing()` below) — into an urgency tier, and maps that tier onto EXISTING scheduling primitives rather than inventing new ones: - `NeuralScheduler.js`'s `'high'|'normal'|'low'` priority buckets (queue ordering among pending `ParticleProgram` runs). - `engine/core/gpu/GpuFrameBudgetBroker.js`'s `workClass === 'render-critical'` bypass (`beforeSubmit()`'s own docstring: \"Render- critical work bypasses the budget\") — this IS the \"GPU budget admission\" the plan names: in the `emergency` tier, this module recommends `workClass: 'render-critical'` so the broker admits the work immediately regardless of the current frame's compute budget, rather than letting a nearly-starved voice ring wait behind unrelated background GPU work. Tier boundaries (this module's own `v0` interpretation of the plan's three named thresholds — documented explicitly since the plan states three thresholds but only two transitions are unambiguous from the wording alone): bufferedAheadMs >= 300 -> 'target' (healthy, target met) 200 <= bufferedAheadMs < 300 -> 'belowTarget' (below target, not yet urgent) 100 <= bufferedAheadMs < 200 -> 'warning' bufferedAheadMs < 100 -> 'emergency'", "exports": [ { "name": "VoiceDeadlineScheduler", "kind": "class", "signature": "class VoiceDeadlineScheduler", "summary": "" }, { "name": "classifyDeadlineTier", "kind": "function", "signature": "classifyDeadlineTier(bufferedAheadMs)", "summary": "" }, { "name": "admissionFor", "kind": "function", "signature": "admissionFor(bufferedAheadMs)", "summary": "" }, { "name": "bufferedAheadMsFromRing", "kind": "function", "signature": "bufferedAheadMsFromRing(ring)", "summary": "Composes with `SharedPCMRing.js`'s `readAvailable()` — the natural real-world source of `bufferedAheadMs` for a live audio bridge — rather than re-deriving ring-position arithmetic here." }, { "name": "TARGET_BUFFERED_MS", "kind": "constant", "signature": "TARGET_BUFFERED_MS", "summary": "" }, { "name": "WARNING_BUFFERED_MS", "kind": "constant", "signature": "WARNING_BUFFERED_MS", "summary": "" }, { "name": "EMERGENCY_BUFFERED_MS", "kind": "constant", "signature": "EMERGENCY_BUFFERED_MS", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/streaming/VoicePlayback", "path": "agi/reference/particle_voice/streaming/VoicePlayback.md", "source": "agi/particle_voice/streaming/VoicePlayback.js", "import": "/agi/particle_voice/streaming/VoicePlayback.js", "sourceHash": "413ad1fdadff4c8f7cfdf8d4274f8f0607fbbbbe1bed35a7709cc255cf257a6b", "summary": "VoicePlayback.js — Phase 3 ParticleVoice audio bridge. The last hop of the Phase 3 path: model PCM → resample → `SharedPCMRing` → `AudioWorklet` → audible speech. Every piece it composes was built and verified in Phase 2; this module only wires them, which is why it is small. ParticleVoiceModel (32 kHz) → PolyphaseResampler (32 kHz → AudioContext.sampleRate) → SafetyLimiter is already applied upstream by the model → SharedPCMRing (SAB, single-producer/single-consumer) → ParticleVoiceProcessor (AudioWorkletProcessor) ## The resample is mandatory, not optional The model's internal DSP rate is 32 kHz (R6's proven `SAMPLE_RATE`), but an `AudioContext` picks its own rate — commonly 48 kHz, sometimes 44.1 kHz. Writing 32 kHz samples into a 48 kHz ring without resampling does not error: it plays back **1.5× too fast and a fifth too high**, which sounds like a chipmunk rather than like a bug. `PolyphaseResampler` handles the exact-integer L/M case (32k→48k reduces to L=3, M=2) and is streaming-correct across chunk boundaries, so feeding it per-utterance or per-chunk gives identical output. ## Backpressure is the producer's problem `writeSharedPCMRing()` CLAMPS to available space and returns how much it actually accepted — it never overwrites unread audio. A producer that ignores the return value silently drops the tail of every utterance that does not fit. `enqueue()` therefore loops, awaiting drain, until everything has been accepted, and reports the total written so a caller can assert it. ## What this module deliberately does NOT do It does not own the `AudioContext`. Creating and resuming one requires a user gesture in a real page, its lifetime belongs to the application, and a test harness needs to build its own — so the context and worklet node are passed in via `attach()`. That also keeps this module testable without assuming any particular page structure.", "exports": [ { "name": "VoicePlayback", "kind": "class", "signature": "class VoicePlayback", "summary": "" }, { "name": "createVoicePlayback", "kind": "function", "signature": "createVoicePlayback(options)", "summary": "" }, { "name": "DEFAULT_PLAYBACK_CONFIG", "kind": "constant", "signature": "DEFAULT_PLAYBACK_CONFIG", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "particle_voice/worklet/ParticleVoiceProcessor", "path": "agi/reference/particle_voice/worklet/ParticleVoiceProcessor.md", "source": "agi/particle_voice/worklet/ParticleVoiceProcessor.js", "import": "/agi/particle_voice/worklet/ParticleVoiceProcessor.js", "sourceHash": "d5ddc22ad0776a4f1c4ebf078bc9a26ae840576f57ee6079f35f6f917435bb04", "summary": "ParticleVoiceProcessor.js — Phase 2 ParticleVoice audio bridge. Production AudioWorkletProcessor consuming `SharedPCMRing.js`'s ring, generalizing `risk/R4ReadbackAudioWorklet.worklet.js` (R4)'s proven allocation-free `process()` (no `new`, no object/array literals, no `await`, no `throw`, no `JSON` — only typed-array indexing and Atomics on pre-existing SharedArrayBuffer-backed views) with the plan's generation-aware resync requirement `SharedPCMRing.js`'s docstring describes. This file is deliberately SELF-CONTAINED (no ES module imports), matching this project's two existing worklet files (`engine/audio/synth/PatchRunner.worklet.js`, `risk/R4ReadbackAudioWorklet.worklet.js`) — `SharedPCMRing.js`'s `CONTROL_INDEX` constants are duplicated here as `CONTROL_INDEX` rather than imported; the two must be kept in sync by hand (flagged in both files' docstrings) rather than relying on an unverified assumption that `AudioWorkletGlobalScope` module imports behave identically to this project's other worklet loading paths. Control layout (Int32Array, SharedArrayBuffer, 6 x int32) — MUST match `SharedPCMRing.js`'s `CONTROL_INDEX` exactly: [0] writeIndex — next PCM slot the producer will write [1] readIndex — next PCM slot this processor will read [2] underrunCount — incremented whenever fewer than one quantum of samples are available [3] processCallCount — incremented every process() call [4] generation — bumped by the producer's resetSharedPCMRing(); on change, this processor jumps readIndex to the CURRENT writeIndex (dropping stale pre-reset audio) instead of continuing from a readIndex that may now point at discarded samples. [5] writeSequence — producer chunk counter; read-only from here, not required for correctness, exposed for parity with SharedPCMRing.js's layout only.", "exports": [], "subsystem": "agi" }, { "schemaVersion": 1, "title": "persistence/CheckpointContracts", "path": "agi/reference/persistence/CheckpointContracts.md", "source": "agi/persistence/CheckpointContracts.js", "import": "/agi/persistence/CheckpointContracts.js", "sourceHash": "7d70b1dee5821f3e9c5445cf8a6b3a3a24d00ea2d860f754ec182b9c297225e6", "summary": "Accept legacy {config,parameters} documents and return canonical v1 data.", "exports": [ { "name": "createNetworkEnvelope", "kind": "function", "signature": "createNetworkEnvelope(kind, config, parameters)", "summary": "" }, { "name": "prepareNetworkEnvelope", "kind": "function", "signature": "prepareNetworkEnvelope(input, expectedKind)", "summary": "Accept legacy {config,parameters} documents and return canonical v1 data." }, { "name": "createCheckpointEnvelope", "kind": "function", "signature": "createCheckpointEnvelope(data)", "summary": "" }, { "name": "prepareCheckpointEnvelope", "kind": "function", "signature": "prepareCheckpointEnvelope(input)", "summary": "Validate both canonical v1 and the pre-envelope checkpoint shape." }, { "name": "AGI_NETWORK_SCHEMA", "kind": "constant", "signature": "AGI_NETWORK_SCHEMA", "summary": "" }, { "name": "AGI_CHECKPOINT_SCHEMA", "kind": "constant", "signature": "AGI_CHECKPOINT_SCHEMA", "summary": "" }, { "name": "AGI_TRAINING_EXPORT_SCHEMA", "kind": "constant", "signature": "AGI_TRAINING_EXPORT_SCHEMA", "summary": "" }, { "name": "AGI_CURRICULUM_STATE_SCHEMA", "kind": "constant", "signature": "AGI_CURRICULUM_STATE_SCHEMA", "summary": "" }, { "name": "AGI_TRAINING_METRICS_SCHEMA", "kind": "constant", "signature": "AGI_TRAINING_METRICS_SCHEMA", "summary": "" }, { "name": "AGI_SCHEMA_VERSION", "kind": "constant", "signature": "AGI_SCHEMA_VERSION", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "rig/BrainVisualizer", "path": "agi/reference/rig/BrainVisualizer.md", "source": "agi/rig/BrainVisualizer.js", "import": "/agi/rig/BrainVisualizer.js", "sourceHash": "cdcb1089acc0790674eb8ce4beaf1ff1e2b3a481c3ebc9d299683df93df58350", "summary": "Brain Visualizer Visualizes neural network activity on the brain sphere", "exports": [ { "name": "BrainVisualizer", "kind": "class", "signature": "class BrainVisualizer", "summary": "Brain Visualizer Visualizes neural network activity on the brain sphere" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "rig/InjectionSystem", "path": "agi/reference/rig/InjectionSystem.md", "source": "agi/rig/InjectionSystem.js", "import": "/agi/rig/InjectionSystem.js", "sourceHash": "b384b97f4e6e45069982e5f1d20f80fc59c23759da7c87a7750f211676f93fd2", "summary": "Injection System Manages tentacle attachment from brain to ragdoll bones", "exports": [ { "name": "InjectionSystem", "kind": "class", "signature": "class InjectionSystem", "summary": "Injection System Manages tentacle attachment from brain to ragdoll bones" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "rig/ParasiteRig", "path": "agi/reference/rig/ParasiteRig.md", "source": "agi/rig/ParasiteRig.js", "import": "/agi/rig/ParasiteRig.js", "sourceHash": "8b107096e5395f4c85a419c851ffa4ba049f54b9842026891b7edd245b1b0857", "summary": "Parasite Rig The \"brain sphere\" entity that hovers above and controls the ragdoll", "exports": [ { "name": "ParasiteRig", "kind": "class", "signature": "class ParasiteRig", "summary": "Parasite Rig The \"brain sphere\" entity that hovers above and controls the ragdoll" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "rig/TentacleRenderer", "path": "agi/reference/rig/TentacleRenderer.md", "source": "agi/rig/TentacleRenderer.js", "import": "/agi/rig/TentacleRenderer.js", "sourceHash": "58066109901eef62fbf56d532a1df8cbd13b373f11e48c0ed9ef78fd44659228", "summary": "Tentacle Renderer Renders tentacles using lightning/electricity effect", "exports": [ { "name": "TentacleRenderer", "kind": "class", "signature": "class TentacleRenderer", "summary": "Tentacle Renderer Renders tentacles using lightning/electricity effect" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "scene/DebugVisualizer", "path": "agi/reference/scene/DebugVisualizer.md", "source": "agi/scene/DebugVisualizer.js", "import": "/agi/scene/DebugVisualizer.js", "sourceHash": "964f8fc855e559602a3d576c2f475f7e17fd61b5c3233239300f28b5293c33ee", "summary": "Debug Visualizer Renders debug overlays for training visualization", "exports": [ { "name": "DebugVisualizer", "kind": "class", "signature": "class DebugVisualizer", "summary": "Debug Visualizer Renders debug overlays for training visualization" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "scene/GroundPlane", "path": "agi/reference/scene/GroundPlane.md", "source": "agi/scene/GroundPlane.js", "import": "/agi/scene/GroundPlane.js", "sourceHash": "e9284e9b81cb3630c56999d8fd7b8f305556d7614361ba66529aa1f1ac8fa659", "summary": "Ground Plane Infinite grid ground for training environment", "exports": [ { "name": "GroundPlane", "kind": "class", "signature": "class GroundPlane", "summary": "Ground Plane Infinite grid ground for training environment" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "scene/SceneRenderer", "path": "agi/reference/scene/SceneRenderer.md", "source": "agi/scene/SceneRenderer.js", "import": "/agi/scene/SceneRenderer.js", "sourceHash": "25abe7add02fc13cfdac49e71c33230d25fff79e187fc5cdd5a40c7f75ecae0c", "summary": "", "exports": [ { "name": "SceneRenderer", "kind": "class", "signature": "class SceneRenderer", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "scene/TrackingCamera", "path": "agi/reference/scene/TrackingCamera.md", "source": "agi/scene/TrackingCamera.js", "import": "/agi/scene/TrackingCamera.js", "sourceHash": "fe8be2ef8487fed5e007c74ca1cd325d043db89f45e490e4e8bfb8f83e34d8ae", "summary": "Tracking Camera Smooth camera that follows the ragdoll", "exports": [ { "name": "TrackingCamera", "kind": "class", "signature": "class TrackingCamera", "summary": "Tracking Camera Smooth camera that follows the ragdoll" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "scene/TrainingScene", "path": "agi/reference/scene/TrainingScene.md", "source": "agi/scene/TrainingScene.js", "import": "/agi/scene/TrainingScene.js", "sourceHash": "bf308868a8cccca4f34704c445fed5b2ed881c21ec03b35662eedbe93c6381ce", "summary": "", "exports": [ { "name": "TrainingScene", "kind": "class", "signature": "class TrainingScene", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "studio/core/StudioApp", "path": "agi/reference/studio/core/StudioApp.md", "source": "agi/studio/core/StudioApp.js", "import": "/agi/studio/core/StudioApp.js", "sourceHash": "ae3cf3abd3d8ad473bed34d84e4bf5359cacf1a75287d9d38ffa028e5f782c04", "summary": "Studio Application Main AGI Studio workspace application", "exports": [ { "name": "StudioApp", "kind": "class", "signature": "class StudioApp", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "studio/core/StudioDirectoryHandleStore", "path": "agi/reference/studio/core/StudioDirectoryHandleStore.md", "source": "agi/studio/core/StudioDirectoryHandleStore.js", "import": "/agi/studio/core/StudioDirectoryHandleStore.js", "sourceHash": "c953ece45ab667f0812f2fc48f698e643c754c7f7a308c7f4331aa3b5017589d", "summary": "Versioned IndexedDB owner for AGI Studio directory handles.", "exports": [ { "name": "AGIStudioHandleStoreError", "kind": "class", "signature": "class AGIStudioHandleStoreError extends Error", "summary": "" }, { "name": "StudioDirectoryHandleStore", "kind": "class", "signature": "class StudioDirectoryHandleStore", "summary": "" }, { "name": "isAGIStudioDirectoryHandle", "kind": "function", "signature": "isAGIStudioDirectoryHandle(value)", "summary": "" }, { "name": "agiStudioDirectoryHandleCurrentKey", "kind": "function", "signature": "agiStudioDirectoryHandleCurrentKey(slot)", "summary": "" }, { "name": "prepareAGIStudioDirectoryHandleRecord", "kind": "function", "signature": "prepareAGIStudioDirectoryHandleRecord(value, expectedSlot)", "summary": "Validate a raw v1 handle or exact v2 envelope without serializing the handle." }, { "name": "AGI_STUDIO_HANDLE_DB_NAME", "kind": "constant", "signature": "AGI_STUDIO_HANDLE_DB_NAME", "summary": "Versioned IndexedDB owner for AGI Studio directory handles." }, { "name": "AGI_STUDIO_HANDLE_STORE_NAME", "kind": "constant", "signature": "AGI_STUDIO_HANDLE_STORE_NAME", "summary": "" }, { "name": "AGI_STUDIO_HANDLE_DB_VERSION", "kind": "constant", "signature": "AGI_STUDIO_HANDLE_DB_VERSION", "summary": "" }, { "name": "AGI_STUDIO_DIRECTORY_HANDLE_SCHEMA", "kind": "constant", "signature": "AGI_STUDIO_DIRECTORY_HANDLE_SCHEMA", "summary": "" }, { "name": "AGI_STUDIO_DIRECTORY_HANDLE_FORMAT", "kind": "constant", "signature": "AGI_STUDIO_DIRECTORY_HANDLE_FORMAT", "summary": "" }, { "name": "AGI_STUDIO_DIRECTORY_HANDLE_VERSION", "kind": "constant", "signature": "AGI_STUDIO_DIRECTORY_HANDLE_VERSION", "summary": "" }, { "name": "AGI_STUDIO_DIRECTORY_HANDLE_SLOTS", "kind": "constant", "signature": "AGI_STUDIO_DIRECTORY_HANDLE_SLOTS", "summary": "" }, { "name": "AGI_STUDIO_HANDLE_LIMITS", "kind": "constant", "signature": "AGI_STUDIO_HANDLE_LIMITS", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "studio/main", "path": "agi/reference/studio/main.md", "source": "agi/studio/main.js", "import": "/agi/studio/main.js", "sourceHash": "8236490f255c697417ba677755c07b3067c1999db3f8788477c3f705d5ee58b3", "summary": "", "exports": [], "subsystem": "agi" }, { "schemaVersion": 1, "title": "studio/ui/LoadingProgress", "path": "agi/reference/studio/ui/LoadingProgress.md", "source": "agi/studio/ui/LoadingProgress.js", "import": "/agi/studio/ui/LoadingProgress.js", "sourceHash": "ef1c4411a2e8cff7daee838096e98e64aeb42f80b83c01a549ddd5f3470f5dcb", "summary": "Loading Progress UI - Shows what's loading and progress", "exports": [ { "name": "LoadingProgress", "kind": "class", "signature": "class LoadingProgress", "summary": "Loading Progress UI - Shows what's loading and progress" }, { "name": "loadingProgress", "kind": "constant", "signature": "loadingProgress", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "tensor/ComputeGraph", "path": "agi/reference/tensor/ComputeGraph.md", "source": "agi/tensor/ComputeGraph.js", "import": "/agi/tensor/ComputeGraph.js", "sourceHash": "26ca9b7e87d7e73cf8f8a75c9dcc10ae3f8b839e09d4eadead6913b9e81649ba", "summary": "Compute Graph Manages operation chaining and execution order for tensor operations", "exports": [ { "name": "ComputeGraph", "kind": "class", "signature": "class ComputeGraph", "summary": "Compute Graph Manages operation chaining and execution order for tensor operations" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "tensor/GradientTape", "path": "agi/reference/tensor/GradientTape.md", "source": "agi/tensor/GradientTape.js", "import": "/agi/tensor/GradientTape.js", "sourceHash": "e96aeba07c60f4fbcfe8075ce345aa4b5fd8b38f4763454e74e31ad16969615b", "summary": "Gradient Tape - Automatic Differentiation Records operations for backward pass computation", "exports": [ { "name": "GradientTape", "kind": "class", "signature": "class GradientTape", "summary": "Gradient Tape - Automatic Differentiation Records operations for backward pass computation" }, { "name": "GradientContext", "kind": "class", "signature": "class GradientContext", "summary": "Context manager for gradient tape" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "tensor/Tensor", "path": "agi/reference/tensor/Tensor.md", "source": "agi/tensor/Tensor.js", "import": "/agi/tensor/Tensor.js", "sourceHash": "684fca9422ac801e2437832d8ddab6095c08198f2a3a826cae4b9686a1ffd61e", "summary": "GPU-resident float32 tensor with explicit readback and ownership.", "exports": [ { "name": "Tensor", "kind": "class", "signature": "class Tensor", "summary": "GPU-resident float32 tensor with explicit readback and ownership." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "tensor/TensorCache", "path": "agi/reference/tensor/TensorCache.md", "source": "agi/tensor/TensorCache.js", "import": "/agi/tensor/TensorCache.js", "sourceHash": "0d8979cee9446b90b1e9f552b93dc7e6c641a12ccfdabc01ef644285169a3751", "summary": "Tensor Cache - Memory Management for GPU Tensors Manages tensor buffer lifecycle and memory reuse", "exports": [ { "name": "TensorCache", "kind": "class", "signature": "class TensorCache", "summary": "Tensor Cache - Memory Management for GPU Tensors Manages tensor buffer lifecycle and memory reuse" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "tensor/TensorOps", "path": "agi/reference/tensor/TensorOps.md", "source": "agi/tensor/TensorOps.js", "import": "/agi/tensor/TensorOps.js", "sourceHash": "f92f4df6708803a2fae8c8e333bfbc0a61b1a26b2f037a82bfccd69dc485a11e", "summary": "GPU-resident float32 elementwise and reduction operations.", "exports": [ { "name": "TensorOps", "kind": "class", "signature": "class TensorOps", "summary": "GPU-resident float32 elementwise and reduction operations." } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "tensor/TensorOpsAdvanced", "path": "agi/reference/tensor/TensorOpsAdvanced.md", "source": "agi/tensor/TensorOpsAdvanced.js", "import": "/agi/tensor/TensorOpsAdvanced.js", "sourceHash": "4646764c86d6e498d4a5b192df9b5d4c7df7fe8435b542b4c6ef9113a459549e", "summary": "", "exports": [ { "name": "TensorOpsAdvanced", "kind": "class", "signature": "class TensorOpsAdvanced", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "tensor/shaders/activation", "path": "agi/reference/tensor/shaders/activation.md", "source": "agi/tensor/shaders/activation.js", "import": "/agi/tensor/shaders/activation.js", "sourceHash": "2c123cb5af1d1adc7bf8699ef1dbe4d8c5af04ae5cbdc7d740a81aad92d86c6c", "summary": "Activation Function Compute Shaders ReLU, Tanh, Sigmoid, and their derivatives", "exports": [ { "name": "createActivationShader", "kind": "function", "signature": "createActivationShader(activationType = 'relu', workgroupSize = 256)", "summary": "Activation Function Compute Shaders ReLU, Tanh, Sigmoid, and their derivatives" }, { "name": "createActivationDerivativeShader", "kind": "function", "signature": "createActivationDerivativeShader(activationType = 'relu', workgroupSize = 256)", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "tensor/shaders/matmul", "path": "agi/reference/tensor/shaders/matmul.md", "source": "agi/tensor/shaders/matmul.js", "import": "/agi/tensor/shaders/matmul.js", "sourceHash": "0591fa80ce07d12cc1a7dcfe7f6a6e9ddc65b3f1987e43c664238859bb2900b7", "summary": "Matrix Multiplication Compute Shader C = A * B where A is [M x K] and B is [K x N]", "exports": [ { "name": "createMatmulShader", "kind": "function", "signature": "createMatmulShader(workgroupSize = 8)", "summary": "Matrix Multiplication Compute Shader C = A * B where A is [M x K] and B is [K x N]" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "tensor/shaders/reduction", "path": "agi/reference/tensor/shaders/reduction.md", "source": "agi/tensor/shaders/reduction.js", "import": "/agi/tensor/shaders/reduction.js", "sourceHash": "7f3ada19ad8db6a3d564df74178aa7cb8491dd3a7456547dee5e5c864b2bc668", "summary": "Reduction Operations Compute Shaders Sum, Max, Min reductions along axes", "exports": [ { "name": "createSumReductionShader", "kind": "function", "signature": "createSumReductionShader(workgroupSize = 256)", "summary": "Reduction Operations Compute Shaders Sum, Max, Min reductions along axes" }, { "name": "createMaxReductionShader", "kind": "function", "signature": "createMaxReductionShader(workgroupSize = 256)", "summary": "" }, { "name": "createMeanReductionShader", "kind": "function", "signature": "createMeanReductionShader(workgroupSize = 256)", "summary": "" }, { "name": "createSoftmaxShader", "kind": "function", "signature": "createSoftmaxShader(workgroupSize = 256)", "summary": "" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "ui/MetricsDisplay", "path": "agi/reference/ui/MetricsDisplay.md", "source": "agi/ui/MetricsDisplay.js", "import": "/agi/ui/MetricsDisplay.js", "sourceHash": "bd57b45b09f3d3fb0e7aa3f6661bd2c4dc974362c16de34c4af133b912bd41fb", "summary": "Metrics Display Real-time training statistics display", "exports": [ { "name": "MetricsDisplay", "kind": "class", "signature": "class MetricsDisplay", "summary": "Metrics Display Real-time training statistics display" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "ui/TrainingUI", "path": "agi/reference/ui/TrainingUI.md", "source": "agi/ui/TrainingUI.js", "import": "/agi/ui/TrainingUI.js", "sourceHash": "b00b6b3bf2d60e010b022348ae2ec48b7a9b543d2605278c23c4d44bf93eed64", "summary": "Training UI Main control panel for training interface", "exports": [ { "name": "TrainingUI", "kind": "class", "signature": "class TrainingUI", "summary": "Training UI Main control panel for training interface" } ], "subsystem": "agi" }, { "schemaVersion": 1, "title": "EditorApp", "path": "editor/reference/EditorApp.md", "source": "editor/js/EditorApp.js", "import": "/editor/js/EditorApp.js", "sourceHash": "15dce8760d6b57df398f8b909cb03eed49dc77b694ce58d828a62985bc95b9dc", "summary": "EditorApp - Main application controller (Modular) Uses lazy loading for heavy modules to improve initial load time", "exports": [ { "name": "EditorApp", "kind": "class", "signature": "class EditorApp", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "ProjectManager", "path": "editor/reference/ProjectManager.md", "source": "editor/js/ProjectManager.js", "import": "/editor/js/ProjectManager.js", "sourceHash": "6da80fcdde3d1994783f6ae4efb8d78ae4351510d293fe49a37b77a2542a609b", "summary": "ProjectManager - Handles project folder selection and initialization", "exports": [ { "name": "ProjectManager", "kind": "class", "signature": "class ProjectManager", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/AudioEditorPanel", "path": "editor/reference/components/AudioEditorPanel.md", "source": "editor/js/components/AudioEditorPanel.js", "import": "/editor/js/components/AudioEditorPanel.js", "sourceHash": "766e0e3423425583173c5bb5a9957d72ae0fb41367906d1d8e05637dea823ad9", "summary": "AudioEditorPanel.js - Main Audio Editor Panel Composes NodeGraph + Palette + Inspector + Materials + PreviewControls into a single editor tab panel for the engine editor.", "exports": [ { "name": "createAudioEditorPanel", "kind": "function", "signature": "createAudioEditorPanel(parentContainer, options = {})", "summary": "Create the audio editor panel." }, { "name": "destroyAudioEditorPanel", "kind": "function", "signature": "destroyAudioEditorPanel(panel)", "summary": "Destroy the audio editor panel." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/AudioMotionTimeline", "path": "editor/reference/components/AudioMotionTimeline.md", "source": "editor/js/components/AudioMotionTimeline.js", "import": "/editor/js/components/AudioMotionTimeline.js", "sourceHash": "b660052fe2975e6a2a3e73691436ca533a01d3467b30ec2552ab461e6d83077d", "summary": "AudioMotionTimeline.js - Sound motion/automation timeline for Audio Editor V1 feature set: - Per-parameter tracks (nodeId + param) - Keyframe authoring (time, value, easing) - Loop + duration + playhead scrubbing - Runtime evaluation using AnimationTrack", "exports": [ { "name": "createAudioMotionTimeline", "kind": "function", "signature": "createAudioMotionTimeline(container, callbacks = {})", "summary": "" }, { "name": "setMotionPatch", "kind": "function", "signature": "setMotionPatch(timeline, motionData, options = {})", "summary": "" }, { "name": "exportMotionPatch", "kind": "function", "signature": "exportMotionPatch(timeline)", "summary": "" }, { "name": "evaluateMotionAtTime", "kind": "function", "signature": "evaluateMotionAtTime(timeline, tSec)", "summary": "" }, { "name": "evaluateActivityAtTime", "kind": "function", "signature": "evaluateActivityAtTime(timeline, tSec)", "summary": "" }, { "name": "resolveAudioMotionTimelineTime", "kind": "function", "signature": "resolveAudioMotionTimelineTime(timeline, tSec)", "summary": "" }, { "name": "destroyAudioMotionTimeline", "kind": "function", "signature": "destroyAudioMotionTimeline(timeline)", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/AudioNodeGraph", "path": "editor/reference/components/AudioNodeGraph.md", "source": "editor/js/components/AudioNodeGraph.js", "import": "/editor/js/components/AudioNodeGraph.js", "sourceHash": "068e9a4c4007fdd8969ff58c87f32ccb71a50bc0d7aec4a637fb9be303c5e418", "summary": "AudioNodeGraph.js - Canvas-Based Node Graph Editor Draggable nodes, wire connections (audio=thick, control=thin/dashed), zoom/pan, selection, and serialization to/from patch JSON.", "exports": [ { "name": "createAudioNodeGraph", "kind": "function", "signature": "createAudioNodeGraph(container, callbacks = {})", "summary": "Create an audio node graph editor." }, { "name": "addNode", "kind": "function", "signature": "addNode(graph, type, x, y, params = {})", "summary": "Add a node to the graph." }, { "name": "removeNode", "kind": "function", "signature": "removeNode(graph, nodeId)", "summary": "Remove a node and its wires." }, { "name": "addWire", "kind": "function", "signature": "addWire(graph, from, to)", "summary": "Add a wire between two ports." }, { "name": "removeWire", "kind": "function", "signature": "removeWire(graph, from, to)", "summary": "Remove a wire." }, { "name": "duplicateNode", "kind": "function", "signature": "duplicateNode(graph, nodeId)", "summary": "Duplicate a node (offset position by 20,20)." }, { "name": "disconnectNode", "kind": "function", "signature": "disconnectNode(graph, nodeId)", "summary": "Disconnect all wires from a node." }, { "name": "fitToView", "kind": "function", "signature": "fitToView(graph)", "summary": "Fit view to show all nodes." }, { "name": "setNodeTypes", "kind": "function", "signature": "setNodeTypes(graph, types)", "summary": "Register available node types." }, { "name": "selectNode", "kind": "function", "signature": "selectNode(graph, nodeId)", "summary": "Select a node." }, { "name": "exportPatch", "kind": "function", "signature": "exportPatch(graph)", "summary": "" }, { "name": "importPatch", "kind": "function", "signature": "importPatch(graph, patch)", "summary": "Import patch JSON into graph." }, { "name": "renderGraph", "kind": "function", "signature": "renderGraph(graph)", "summary": "Render the entire graph." }, { "name": "startGraphAnimation", "kind": "function", "signature": "startGraphAnimation(graph)", "summary": "Start the animation loop for live waveform + wire animation." }, { "name": "stopGraphAnimation", "kind": "function", "signature": "stopGraphAnimation(graph)", "summary": "Stop animation loop." }, { "name": "setNodeAnalysers", "kind": "function", "signature": "setNodeAnalysers(graph, analysers)", "summary": "Set per-node analyser taps for live waveform display." }, { "name": "setMinimapContainer", "kind": "function", "signature": "setMinimapContainer(graph, container)", "summary": "Set an external container for the minimap (rendered separately from the main canvas)." }, { "name": "destroyAudioNodeGraph", "kind": "function", "signature": "destroyAudioNodeGraph(graph)", "summary": "Destroy the graph editor." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/AudioNodeInspector", "path": "editor/reference/components/AudioNodeInspector.md", "source": "editor/js/components/AudioNodeInspector.js", "import": "/editor/js/components/AudioNodeInspector.js", "sourceHash": "4ffd492d0752e04b5141017fd58ce7cc6274fbd9d4f1acb61786bd3ecb41c1b9", "summary": "AudioNodeInspector.js - Right Panel for Selected Node Parameters Shows parameter knobs/sliders for the selected node. Uses SoundSchema when available for rich typed controls. Falls back to PARAM_HINTS for legacy/unschemaed node types.", "exports": [ { "name": "createAudioNodeInspector", "kind": "function", "signature": "createAudioNodeInspector(container, onParamChanged)", "summary": "Create the node inspector panel." }, { "name": "updateInspector", "kind": "function", "signature": "updateInspector(inspector, node)", "summary": "Update the inspector to show a node's parameters." }, { "name": "destroyAudioNodeInspector", "kind": "function", "signature": "destroyAudioNodeInspector(inspector)", "summary": "Destroy the inspector." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/AudioNodePalette", "path": "editor/reference/components/AudioNodePalette.md", "source": "editor/js/components/AudioNodePalette.js", "import": "/editor/js/components/AudioNodePalette.js", "sourceHash": "b4a519c1844fdc8843065d88def5692b13d3c903eee18f661f9749c6af9a7936", "summary": "AudioNodePalette.js - Side Panel with Node Types Lists all available node types grouped by category. Supports drag-to-create from palette onto the graph canvas.", "exports": [ { "name": "createAudioNodePalette", "kind": "function", "signature": "createAudioNodePalette(container, onNodeDragStart)", "summary": "Create the node palette panel." }, { "name": "destroyAudioNodePalette", "kind": "function", "signature": "destroyAudioNodePalette(palette)", "summary": "Destroy the palette." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/AudioPatchEditor", "path": "editor/reference/components/AudioPatchEditor.md", "source": "editor/js/components/AudioPatchEditor.js", "import": "/editor/js/components/AudioPatchEditor.js", "sourceHash": "c44eea13f91ac176dc44ae0ae5828b867a2d11705ba76b91c601d531cbf02499", "summary": "AudioPatchEditor.js - Live Material Patch Editor for Sound Studio Reads real substance audio definitions from the SubstanceRegistry and lets you tweak them on the spot. Changes feed into the ProceduralPatches runtime override system. Edits persist with scene. Layout: Material list (compact cards) + Dedicated param panel below.", "exports": [ { "name": "createAudioPatchEditor", "kind": "function", "signature": "createAudioPatchEditor(container, callbacks = {})", "summary": "" }, { "name": "setPatchEditorAudioContext", "kind": "function", "signature": "setPatchEditorAudioContext(editor, ctx)", "summary": "" }, { "name": "setPatchEditorApp", "kind": "function", "signature": "setPatchEditorApp(patchEditor, editorApp)", "summary": "" }, { "name": "destroyAudioPatchEditor", "kind": "function", "signature": "destroyAudioPatchEditor(editor)", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/AudioPresetBrowser", "path": "editor/reference/components/AudioPresetBrowser.md", "source": "editor/js/components/AudioPresetBrowser.js", "import": "/editor/js/components/AudioPresetBrowser.js", "sourceHash": "671b835d508541f9081ba61628e4970d90930454ec0a22e1cd0183db4d6f3fd1", "summary": "AudioPresetBrowser.js - Load/Save/Browse Patch Presets Browse built-in presets per substance, load/save patches as JSON.", "exports": [ { "name": "getPresetPatch", "kind": "function", "signature": "getPresetPatch(name)", "summary": "Get a preset patch by name." }, { "name": "createAudioPresetBrowser", "kind": "function", "signature": "createAudioPresetBrowser(container, callbacks = {})", "summary": "Create the preset browser panel." }, { "name": "destroyAudioPresetBrowser", "kind": "function", "signature": "destroyAudioPresetBrowser(browser)", "summary": "Destroy the preset browser." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/AudioPreviewControls", "path": "editor/reference/components/AudioPreviewControls.md", "source": "editor/js/components/AudioPreviewControls.js", "import": "/editor/js/components/AudioPreviewControls.js", "sourceHash": "beb0cc41520bc84678d17375eca4c1661b0a69be6d03fd428ec29b75cb76273f", "summary": "AudioPreviewControls.js - Professional Transport Bar Play/Pause/Stop with icons, elapsed time display, wave shape selector, volume control with arc knob, and waveform quick-switch.", "exports": [ { "name": "createAudioPreviewControls", "kind": "function", "signature": "createAudioPreviewControls(container, callbacks = {})", "summary": "Create the transport controls bar." }, { "name": "setPreviewPlaying", "kind": "function", "signature": "setPreviewPlaying(controls, playing)", "summary": "Set playing state externally." }, { "name": "destroyAudioPreviewControls", "kind": "function", "signature": "destroyAudioPreviewControls(controls)", "summary": "Destroy preview controls." }, { "name": "connectAnalyser", "kind": "function", "signature": "connectAnalyser()", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/AudioSignalAnalyzer", "path": "editor/reference/components/AudioSignalAnalyzer.md", "source": "editor/js/components/AudioSignalAnalyzer.js", "import": "/editor/js/components/AudioSignalAnalyzer.js", "sourceHash": "449c3d3a53e86e85bef226b1f016e3b8a31b606514bea1d48dd52a9d377050bd", "summary": "AudioSignalAnalyzer.js - Professional Signal Analysis Panel Full-width bottom panel with switchable visualization modes: - Oscilloscope (time-domain waveform) - Spectrum Analyzer (FFT frequency bars, log scale) - Spectrogram (scrolling waterfall) Plus stereo VU/peak meter and freeze capability.", "exports": [ { "name": "createSignalAnalyzer", "kind": "function", "signature": "createSignalAnalyzer(container)", "summary": "Create the signal analyzer panel." }, { "name": "connectSignalAnalyzer", "kind": "function", "signature": "connectSignalAnalyzer(analyzer, analyserNode)", "summary": "Connect an AnalyserNode for visualization." }, { "name": "disconnectSignalAnalyzer", "kind": "function", "signature": "disconnectSignalAnalyzer(analyzer)", "summary": "Disconnect and stop rendering." }, { "name": "destroySignalAnalyzer", "kind": "function", "signature": "destroySignalAnalyzer(analyzer)", "summary": "Destroy the analyzer." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/CollabPanel", "path": "editor/reference/components/CollabPanel.md", "source": "editor/js/components/CollabPanel.js", "import": "/editor/js/components/CollabPanel.js", "sourceHash": "09963ebad00e9695a3af0be03441649c310a90d998ca19aa99557ced59be0413", "summary": "CollabPanel.js Collaboration sidebar panel for the editor.", "exports": [ { "name": "CollabPanel", "kind": "class", "signature": "class CollabPanel", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/GraphPersistenceContracts", "path": "editor/reference/components/GraphPersistenceContracts.md", "source": "editor/js/components/GraphPersistenceContracts.js", "import": "/editor/js/components/GraphPersistenceContracts.js", "sourceHash": "dfe90d08a06bc37381a730f6071b4345ac8ac66bdfb315b7f35aea9b520a781f", "summary": "Normalize legacy audio patches and validate the full candidate before use.", "exports": [ { "name": "UnsupportedGraphVersionError", "kind": "class", "signature": "class UnsupportedGraphVersionError extends Error", "summary": "" }, { "name": "prepareAudioGraphDocument", "kind": "function", "signature": "prepareAudioGraphDocument(input)", "summary": "Normalize legacy audio patches and validate the full candidate before use." }, { "name": "prepareMaterialGraphDocument", "kind": "function", "signature": "prepareMaterialGraphDocument(input, { allowedNodeTypes = null } = {})", "summary": "Normalize legacy material graphs and reject dangling connections/future schemas." }, { "name": "GRAPH_SCHEMA_VERSION", "kind": "constant", "signature": "GRAPH_SCHEMA_VERSION", "summary": "" }, { "name": "AUDIO_GRAPH_SCHEMA", "kind": "constant", "signature": "AUDIO_GRAPH_SCHEMA", "summary": "" }, { "name": "MATERIAL_GRAPH_SCHEMA", "kind": "constant", "signature": "MATERIAL_GRAPH_SCHEMA", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/MaterialNodeGraph", "path": "editor/reference/components/MaterialNodeGraph.md", "source": "editor/js/components/MaterialNodeGraph.js", "import": "/editor/js/components/MaterialNodeGraph.js", "sourceHash": "932d345d001af2dbb7eeab81b266133893fcbb8e576db5620ffe71298a89284a", "summary": "MaterialNodeGraph.js - Canvas-based node graph editor for materials Features: pan/zoom, node drag, port connections, context menu to add nodes, node deletion, bezier connection rendering, port type coloring.", "exports": [ { "name": "createNodeGraph", "kind": "function", "signature": "createNodeGraph(container, options = {})", "summary": "" }, { "name": "evaluateGraphData", "kind": "function", "signature": "evaluateGraphData(graphData)", "summary": "Standalone evaluator for raw graph data (no canvas UI needed). Used by headless preview animation." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/MaterialNodePresets", "path": "editor/reference/components/MaterialNodePresets.md", "source": "editor/js/components/MaterialNodePresets.js", "import": "/editor/js/components/MaterialNodePresets.js", "sourceHash": "405e4ab4e6a46983ec88bad2d34b33a53c8ff5b80de54bce26794a8956a03c3c", "summary": "MaterialNodePresets.js - Pre-built node graph recipes for all built-in materials Each preset is a valid node graph using only standard MaterialNodeTypes nodes. These serve as demos showing users how to wire nodes to create materials. Graph structure: { nodes: [...], connections: [...], view: { panX, panY, zoom } } Node: { id, type, x, y, params } Connection: { fromNode, fromPort, toNode, toPort }", "exports": [ { "name": "getPresetGraph", "kind": "function", "signature": "getPresetGraph(materialId)", "summary": "Get the preset node graph for a built-in material." }, { "name": "hasPresetGraph", "kind": "function", "signature": "hasPresetGraph(materialId)", "summary": "Check if a material has a preset graph." }, { "name": "listPresetIds", "kind": "function", "signature": "listPresetIds()", "summary": "List all material IDs that have preset graphs." }, { "name": "listSubstancePresetIds", "kind": "function", "signature": "listSubstancePresetIds()", "summary": "Get all substance-linked preset IDs." }, { "name": "listAnimatedPresetIds", "kind": "function", "signature": "listAnimatedPresetIds()", "summary": "Get all animated effect preset IDs (lava, water, hologram, etc.)." }, { "name": "NODE_GRAPH_PRESETS", "kind": "constant", "signature": "NODE_GRAPH_PRESETS", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/MaterialNodeTypes", "path": "editor/reference/components/MaterialNodeTypes.md", "source": "editor/js/components/MaterialNodeTypes.js", "import": "/editor/js/components/MaterialNodeTypes.js", "sourceHash": "ffda7220fade1a0c479119514992dd67d162e4e502c968a4ec4ccf10c150693c", "summary": "MaterialNodeTypes.js - Node type definitions for the material graph editor Modeled after Substance Designer / Material Maker / Unreal Material Editor. Each node type defines inputs, outputs, defaults, and an evaluate function. Port types: 'float', 'vec2', 'vec3', 'vec4', 'color', 'texture'", "exports": [ { "name": "defaultForType", "kind": "function", "signature": "defaultForType(type)", "summary": "" }, { "name": "PORT_COLORS", "kind": "constant", "signature": "PORT_COLORS", "summary": "" }, { "name": "NODE_CATEGORIES", "kind": "constant", "signature": "NODE_CATEGORIES", "summary": "" }, { "name": "NODE_TYPES", "kind": "constant", "signature": "NODE_TYPES", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/MaterialPanel", "path": "editor/reference/components/MaterialPanel.md", "source": "editor/js/components/MaterialPanel.js", "import": "/editor/js/components/MaterialPanel.js", "sourceHash": "93e49cf411fb1158505c830c65d3798296fa5a5d0c3da4f0133dc7e396767516", "summary": "MaterialPanel.js - Material Studio Panel Composes Library + PBR Inspector + 3D Preview into an overlay panel. Follows the Sound Studio (AudioEditorPanel.js) architecture.", "exports": [ { "name": "createMaterialPanel", "kind": "function", "signature": "createMaterialPanel(container, options = {})", "summary": "Create the material panel contents inside the overlay body." }, { "name": "destroyMaterialPanel", "kind": "function", "signature": "destroyMaterialPanel(panel)", "summary": "Destroy the material panel." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/MaterialPatchGraphs", "path": "editor/reference/components/MaterialPatchGraphs.md", "source": "editor/js/components/MaterialPatchGraphs.js", "import": "/editor/js/components/MaterialPatchGraphs.js", "sourceHash": "a2e25f86d21e074d5b362db7899a1e86fd457cda9e11153a006451f9044b0078", "summary": "MaterialPatchGraphs.js - High-level node graph representations for ProceduralPatches.js These graphs provide design-facing topology for each material family. They intentionally summarize synthesis layers so editor UX stays readable even when runtime patches contain deeper stochastic/detail layers.", "exports": [ { "name": "getMaterialGraph", "kind": "function", "signature": "getMaterialGraph(substanceId)", "summary": "Get the node graph for a substance. Returns a deep copy so edits don't mutate the template." }, { "name": "MATERIAL_GRAPHS", "kind": "constant", "signature": "MATERIAL_GRAPHS", "summary": "Maps substance IDs to editor-facing graph representations. Graphs are intentionally compact abstractions of runtime synthesis." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/MaterialStrip", "path": "editor/reference/components/MaterialStrip.md", "source": "editor/js/components/MaterialStrip.js", "import": "/editor/js/components/MaterialStrip.js", "sourceHash": "1fba3ca727861ab9302f38016464c371ad0d5a3fec91c6cf81662ae553608ac4", "summary": "MaterialStrip.js - Compact material browser for bottom panel Horizontal scrollable strip of material thumbnails with preview sidebar. Designed to sit in the bottom panel alongside Console.", "exports": [ { "name": "createMaterialStrip", "kind": "function", "signature": "createMaterialStrip(container, options = {})", "summary": "" }, { "name": "destroyMaterialStrip", "kind": "function", "signature": "destroyMaterialStrip(state)", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/ParticleEffectControls", "path": "editor/reference/components/ParticleEffectControls.md", "source": "editor/js/components/ParticleEffectControls.js", "import": "/editor/js/components/ParticleEffectControls.js", "sourceHash": "d61958379d6ce826791ccbb797e37abc969474e17c238f0e42260ddb48902daa", "summary": "ParticleEffectControls.js - Editor UI Controls for Custom Particle Effects Adds controls to the particle emitter inspector panel: - Checkbox to enable custom effects - Effect selector dropdown - Edit button to open shader editor - Parameter sliders for effect params", "exports": [ { "name": "ParticleEffectControls", "kind": "class", "signature": "class ParticleEffectControls", "summary": "" }, { "name": "createParticleEffectControls", "kind": "function", "signature": "createParticleEffectControls(options = {})", "summary": "Create particle effect controls" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "components/ShaderCodeEditor", "path": "editor/reference/components/ShaderCodeEditor.md", "source": "editor/js/components/ShaderCodeEditor.js", "import": "/editor/js/components/ShaderCodeEditor.js", "sourceHash": "8980f7408ced3e545163c0d35a4cc8fa6321b5274d5cb7e6df4d69b362e1a505", "summary": "ShaderCodeEditor.js - In-Editor WGSL Code Editor Popup A notepad-style popup for editing custom particle effect shaders. Features: - Syntax highlighting for WGSL - Real-time validation - Live preview - Template snippets - Error display with line numbers", "exports": [ { "name": "ShaderCodeEditor", "kind": "class", "signature": "class ShaderCodeEditor", "summary": "" }, { "name": "openShaderCodeEditor", "kind": "function", "signature": "openShaderCodeEditor(effect, options = {})", "summary": "Create and open a shader code editor" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "loader-guard", "path": "editor/reference/loader-guard.md", "source": "editor/js/loader-guard.js", "import": "/editor/js/loader-guard.js", "sourceHash": "8eabd08df80c70f13ef747bd81298c062fa46bca6f82479449db92ac63a2fce8", "summary": "Keep the loading veil's context-menu suppression CSP-safe and scoped to the short interval in which the veil can actually receive pointer input.", "exports": [], "subsystem": "editor" }, { "schemaVersion": 1, "title": "main", "path": "editor/reference/main.md", "source": "editor/js/main.js", "import": "/editor/js/main.js", "sourceHash": "9424b5ca76dc78cc0d7368a15cc95591c98ada8218d8dd750bc15eb446826b51", "summary": "Main entry point for Game Editor", "exports": [], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/ColliderGenerators", "path": "editor/reference/modules/ColliderGenerators.md", "source": "editor/js/modules/ColliderGenerators.js", "import": "/editor/js/modules/ColliderGenerators.js", "sourceHash": "983951e3576607473bc3f1f0e5062e9012c7d3326e685888ece3077e14576950", "summary": "ColliderGenerators.js - Procedural collider generation utilities Extracted from EditorPhysics.js for modularity Includes: - SDF-based collider generation with anti-aliasing - Line/curve to voxel colliders - Network-based colliders (trees, tunnels, pipes) - Noise-based procedural colliders - Spatial hash for collider queries", "exports": [ { "name": "generateCollidersFromSDF", "kind": "function", "signature": "generateCollidersFromSDF(sdfFunc, bounds, resolution = 10, options = {})", "summary": "Generate colliders from ANY SDF function with anti-aliasing" }, { "name": "generateConvexMeshFromSDF", "kind": "function", "signature": "generateConvexMeshFromSDF(sdfFunc, bounds, resolution = 16)", "summary": "Generate a CONVEX MESH collider from SDF" }, { "name": "colliderVertexHash", "kind": "function", "signature": "colliderVertexHash(vertices)", "summary": "" }, { "name": "generateHollowTorusColliders", "kind": "function", "signature": "generateHollowTorusColliders(majorRadius, minorRadius, wallThickness, resolution = 12)", "summary": "Generate hollow torus colliders" }, { "name": "generateHollowConeColliders", "kind": "function", "signature": "generateHollowConeColliders(angle, height, wallThickness, resolution = 12)", "summary": "Generate hollow cone/funnel colliders" }, { "name": "generateLineColliders", "kind": "function", "signature": "generateLineColliders(start, end, radius, resolution = 10)", "summary": "Generate voxel colliders along a line segment" }, { "name": "generateCurveColliders", "kind": "function", "signature": "generateCurveColliders(points, radius, resolution = 10, segments = 20)", "summary": "Generate voxel colliders along a curve" }, { "name": "generateCollidersFromNetwork", "kind": "function", "signature": "generateCollidersFromNetwork(network, resolution = 8)", "summary": "Generate colliders from a LineNetwork" }, { "name": "generateTreeColliders", "kind": "function", "signature": "generateTreeColliders(options = {})", "summary": "Generate tree-shaped colliders" }, { "name": "generateRootColliders", "kind": "function", "signature": "generateRootColliders(options = {})", "summary": "Generate root system colliders" }, { "name": "generateTunnelColliders", "kind": "function", "signature": "generateTunnelColliders(options = {})", "summary": "Generate tunnel/cave colliders" }, { "name": "generatePipeNetworkColliders", "kind": "function", "signature": "generatePipeNetworkColliders(nodes, connections, resolution = 8)", "summary": "Generate custom pipe/beam network colliders" }, { "name": "generateBezierColliders", "kind": "function", "signature": "generateBezierColliders(p0, p1, p2, p3, radius, resolution = 10)", "summary": "Generate colliders along a cubic Bezier curve" }, { "name": "generateSplineColliders", "kind": "function", "signature": "generateSplineColliders(controlPoints, radius, resolution = 10)", "summary": "Generate colliders along a Bezier spline" }, { "name": "testSphereSphere", "kind": "function", "signature": "testSphereSphere(c1, r1, c2, r2)", "summary": "" }, { "name": "testAABBAABB", "kind": "function", "signature": "testAABBAABB(min1, max1, min2, max2)", "summary": "" }, { "name": "testSphereAABB", "kind": "function", "signature": "testSphereAABB(center, radius, aabbMin, aabbMax)", "summary": "" }, { "name": "computeColliderAABB", "kind": "function", "signature": "computeColliderAABB(colliders)", "summary": "" }, { "name": "generateNoisyColliders", "kind": "function", "signature": "generateNoisyColliders(baseSdf, bounds, options = {})", "summary": "Generate rocky/organic colliders using noise-displaced SDF" }, { "name": "generateRockySphereColliders", "kind": "function", "signature": "generateRockySphereColliders(center, radius, roughness = 0.15, resolution = 12)", "summary": "Generate rocky sphere collider" }, { "name": "generateTerrainColliders", "kind": "function", "signature": "generateTerrainColliders(sizeX, sizeZ, height, resolution = 8, seed = 0)", "summary": "Generate terrain chunk collider" }, { "name": "generateCaveColliders", "kind": "function", "signature": "generateCaveColliders(bounds, tunnelRadius = 1.5, resolution = 6, seed = 0)", "summary": "Generate cave/hollow rock colliders" }, { "name": "initColliderSpatialHash", "kind": "function", "signature": "initColliderSpatialHash(cellSize = 2.0)", "summary": "" }, { "name": "addToSpatialHash", "kind": "function", "signature": "addToSpatialHash(id, colliders, worldPosition = [0, 0, 0])", "summary": "" }, { "name": "queryNearbyColliders", "kind": "function", "signature": "queryNearbyColliders(point, radius)", "summary": "" }, { "name": "clearColliderSpatialHash", "kind": "function", "signature": "clearColliderSpatialHash()", "summary": "" }, { "name": "computeBounce", "kind": "function", "signature": "computeBounce(velocity, normal, restitution = 0.5)", "summary": "" }, { "name": "applyFriction", "kind": "function", "signature": "applyFriction(velocity, normal, friction, dt)", "summary": "" }, { "name": "predictLanding", "kind": "function", "signature": "predictLanding(start, velocity, gravity = 9.81)", "summary": "" }, { "name": "generateScatteredColliders", "kind": "function", "signature": "generateScatteredColliders(options = {})", "summary": "" }, { "name": "generateRockFieldColliders", "kind": "function", "signature": "generateRockFieldColliders(options = {})", "summary": "" }, { "name": "LineNetwork", "kind": "re-export", "signature": "LineNetwork", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/CollisionDebugOverlay", "path": "editor/reference/modules/CollisionDebugOverlay.md", "source": "editor/js/modules/CollisionDebugOverlay.js", "import": "/editor/js/modules/CollisionDebugOverlay.js", "sourceHash": "d7029eedb6dbb3557a6f1d36fbc89f104c81321e3a8c3c24555d263f848d33a2", "summary": "CollisionDebugOverlay.js - Visual debug overlay for collision layers and modes Displays collision layer, mask, and mode information for selected entities and optionally renders debug visualizations for collision relationships.", "exports": [ { "name": "createCollisionDebugPanel", "kind": "function", "signature": "createCollisionDebugPanel(editor)", "summary": "Create collision debug overlay panel" }, { "name": "toggleCollisionDebugOverlay", "kind": "function", "signature": "toggleCollisionDebugOverlay(editor)", "summary": "Toggle collision debug overlay" }, { "name": "dumpCollisionInfo", "kind": "function", "signature": "dumpCollisionInfo(editor)", "summary": "Get collision debug info for all entities (for console debugging)" }, { "name": "checkCollisionConflicts", "kind": "function", "signature": "checkCollisionConflicts(editor)", "summary": "Check for collision layer conflicts (entities that should collide but don't)" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorAI", "path": "editor/reference/modules/EditorAI.md", "source": "editor/js/modules/EditorAI.js", "import": "/editor/js/modules/EditorAI.js", "sourceHash": "4fad73e406a5e7125b4848bee6a9eb0d4d15e2566618dabd83dd90e94e13f0df", "summary": "EditorAI.js - AI, Navigation, Steering, and Behavior Trees for Editor Extracted from EditorPhysics.js for modularity", "exports": [ { "name": "getOrCreateNavGrid", "kind": "function", "signature": "getOrCreateNavGrid(options = {})", "summary": "Initialize or get the editor's navigation grid" }, { "name": "findPath", "kind": "function", "signature": "findPath(start, goal, options = {})", "summary": "Find a path between two world positions" }, { "name": "updateNavGridFromColliders", "kind": "function", "signature": "updateNavGridFromColliders(colliders, walkable = false)", "summary": "Mark cells as blocked/walkable based on colliders" }, { "name": "smoothPath", "kind": "function", "signature": "smoothPath(waypoints, smoothing = 0.5)", "summary": "Smooth a path using string-pulling" }, { "name": "getPathSteering", "kind": "function", "signature": "getPathSteering(currentPos, waypoints, lookahead = 1.0)", "summary": "Get steering direction to follow a path" }, { "name": "getNavGridVisualization", "kind": "function", "signature": "getNavGridVisualization()", "summary": "Debug: visualize nav grid walkability" }, { "name": "createAIAgent", "kind": "function", "signature": "createAIAgent(options = {})", "summary": "Create an AI agent with steering behaviors" }, { "name": "updateAIAgent", "kind": "function", "signature": "updateAIAgent(agent, behaviors, dt)", "summary": "Update AI agent with combined steering behaviors" }, { "name": "createFlock", "kind": "function", "signature": "createFlock(count, options = {})", "summary": "Create a flock of AI agents" }, { "name": "updateFlock", "kind": "function", "signature": "updateFlock(agents, dt, options = {})", "summary": "Update entire flock with flocking behavior" }, { "name": "createPatrolBehavior", "kind": "function", "signature": "createPatrolBehavior(waypoints)", "summary": "Create a simple patrol behavior tree" }, { "name": "createChaseFleeBehavior", "kind": "function", "signature": "createChaseFleeBehavior(chaseRadius = 10, fleeHealth = 20)", "summary": "Create a chase/flee behavior tree" }, { "name": "tickBehaviorTree", "kind": "function", "signature": "tickBehaviorTree(tree, blackboard, dt)", "summary": "Run a behavior tree tick" }, { "name": "createAIPerception", "kind": "function", "signature": "createAIPerception(options = {})", "summary": "Create an AI perception component" }, { "name": "canSee", "kind": "function", "signature": "canSee(perception, position, forward, targetPos)", "summary": "Check if an entity can see a target" }, { "name": "canHear", "kind": "function", "signature": "canHear(perception, position, soundPos, soundVolume = 1)", "summary": "Check if an entity can hear a sound" }, { "name": "updateAIPerception", "kind": "function", "signature": "updateAIPerception(perception, position, forward, entities, dt)", "summary": "Update perception - detect nearby entities" }, { "name": "getLastKnownPosition", "kind": "function", "signature": "getLastKnownPosition(perception, entityId)", "summary": "Get last known position of an entity" }, { "name": "NODE_STATUS", "kind": "re-export", "signature": "NODE_STATUS", "summary": "" }, { "name": "arrive", "kind": "re-export", "signature": "arrive", "summary": "" }, { "name": "createAction", "kind": "re-export", "signature": "createAction", "summary": "" }, { "name": "createCondition", "kind": "re-export", "signature": "createCondition", "summary": "" }, { "name": "createNavGrid", "kind": "re-export", "signature": "createNavGrid", "summary": "" }, { "name": "createSelector", "kind": "re-export", "signature": "createSelector", "summary": "" }, { "name": "createSequence", "kind": "re-export", "signature": "createSequence", "summary": "" }, { "name": "createSteeringAgent", "kind": "re-export", "signature": "createSteeringAgent", "summary": "" }, { "name": "evade", "kind": "re-export", "signature": "evade", "summary": "" }, { "name": "findPathInNavWorld", "kind": "re-export", "signature": "findPathInNavWorld", "summary": "" }, { "name": "findPathOnGrid", "kind": "re-export", "signature": "findPathOnGrid", "summary": "" }, { "name": "flee", "kind": "re-export", "signature": "flee", "summary": "" }, { "name": "flock", "kind": "re-export", "signature": "flock", "summary": "" }, { "name": "gridToWorld", "kind": "re-export", "signature": "gridToWorld", "summary": "" }, { "name": "pursue", "kind": "re-export", "signature": "pursue", "summary": "" }, { "name": "seek", "kind": "re-export", "signature": "seek", "summary": "" }, { "name": "tickNode", "kind": "re-export", "signature": "tickNode", "summary": "" }, { "name": "wander", "kind": "re-export", "signature": "wander", "summary": "" }, { "name": "worldToGrid", "kind": "re-export", "signature": "worldToGrid", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorAudio", "path": "editor/reference/modules/EditorAudio.md", "source": "editor/js/modules/EditorAudio.js", "import": "/editor/js/modules/EditorAudio.js", "sourceHash": "9b83387e6c1b77bbf2e7ad681bb340ef23c4e893fcc4b6b3c7549d4740fb3f21", "summary": "EditorAudio.js - Simulation Audio Bridge for the Editor Manages the runtime AudioEngine lifecycle during play mode: - Initializes AudioEngine on first play - Ticks audio each frame while playing - Stops all sim audio on stop/pause - Bridges substance emitters → procedural audio", "exports": [ { "name": "startSimAudio", "kind": "function", "signature": "async startSimAudio(editor)", "summary": "Called when user enters play mode. Initializes engine if needed and starts audio." }, { "name": "stopSimAudio", "kind": "function", "signature": "stopSimAudio()", "summary": "Called when user exits play mode (Stop). Stops all active sources with a short fade." }, { "name": "pauseSimAudio", "kind": "function", "signature": "pauseSimAudio()", "summary": "Called when user pauses. Suspends the AudioContext (freezes all audio in place)." }, { "name": "resumeSimAudio", "kind": "function", "signature": "async resumeSimAudio()", "summary": "Called when user resumes from pause." }, { "name": "tickSimAudio", "kind": "function", "signature": "tickSimAudio(dt)", "summary": "Tick the audio engine. Call once per frame while playing." }, { "name": "destroySimAudio", "kind": "function", "signature": "destroySimAudio()", "summary": "Full cleanup. Call on editor close." }, { "name": "getSimAudioEngine", "kind": "function", "signature": "getSimAudioEngine()", "summary": "Get the current engine instance (for external integration)." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorAudioFX", "path": "editor/reference/modules/EditorAudioFX.md", "source": "editor/js/modules/EditorAudioFX.js", "import": "/editor/js/modules/EditorAudioFX.js", "sourceHash": "27933ed0a89b878a1b03628f353cf7b636e4b6dc78f566456cead83085998f23", "summary": "EditorAudioFX.js - Procedural Editor Sound Effects All sounds are synthesized with Web Audio API oscillators & noise — no sample files. Provides: loading ambient pad, play/stop/pause chimes, UI clicks, error beeps. Usage: import { editorAudioFX } from './EditorAudioFX.js'; editorAudioFX.init(); // call once after first user gesture editorAudioFX.playChime(); // play-mode enter editorAudioFX.stopChime(); // play-mode exit editorAudioFX.pauseClick(); // pause toggle editorAudioFX.uiClick(); // generic button click editorAudioFX.uiHover(); // hover over interactive element editorAudioFX.errorBeep(); // error / invalid action editorAudioFX.startLoadingAmbient(); // loading screen ambient pad editorAudioFX.stopLoadingAmbient(); // fade out loading pad", "exports": [ { "name": "editorAudioFX", "kind": "constant", "signature": "editorAudioFX", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorCollab", "path": "editor/reference/modules/EditorCollab.md", "source": "editor/js/modules/EditorCollab.js", "import": "/editor/js/modules/EditorCollab.js", "sourceHash": "febf26bea6606fe4b8401149e6a7f273502d3da3fcb6f406059c25f7c3c499c0", "summary": "EditorCollab.js Editor-side integration for the collab system. Mounts onto EditorApp and wires all hooks. Hooks wired: - EditorHistory.pushAction → broadcast op to peers - ProjectStorage.saveProject → broadcast snapshot - PrefabLibrary.save/delete → broadcast prefab ops - Viewport render loop → presence tick at 10 Hz - EditorApp.enterPlayMode → broadcast play_sync - EditorApp.togglePause → broadcast pause_sync - EditorApp.exitPlayMode → broadcast stop_sync", "exports": [ { "name": "initEditorCollab", "kind": "function", "signature": "initEditorCollab(editor)", "summary": "Initialize the collab system and attach it to the editor. Called from EditorApp.initialize() at the end." }, { "name": "destroyEditorCollab", "kind": "function", "signature": "destroyEditorCollab(editor)", "summary": "Destroy the collab system and remove all hooks." }, { "name": "getCollabState", "kind": "function", "signature": "getCollabState(editor)", "summary": "Get the current collab state from the editor." }, { "name": "isCollabActive", "kind": "function", "signature": "isCollabActive(editor)", "summary": "" }, { "name": "isCollabConnected", "kind": "function", "signature": "isCollabConnected(editor)", "summary": "" }, { "name": "getCollabPeers", "kind": "function", "signature": "getCollabPeers(editor)", "summary": "" }, { "name": "getCollabPresenceList", "kind": "function", "signature": "getCollabPresenceList(editor)", "summary": "" }, { "name": "getCollabInterpCamera", "kind": "function", "signature": "getCollabInterpCamera(editor, peerId)", "summary": "Get Hermite-interpolated camera for a remote peer (smooth, per-frame). Returns { pos: [x,y,z], target: [x,y,z] } or null." }, { "name": "getCollabStats", "kind": "function", "signature": "getCollabStats(editor)", "summary": "Get collab camera interpolation + connection stats for UI display." }, { "name": "getCollabRouterStats", "kind": "function", "signature": "getCollabRouterStats(editor)", "summary": "Get message router stats for bandwidth monitoring. Returns { sent, dropped, coalesced, bytesSent, backpressureFrames, rateMultiplier }" }, { "name": "getCollabInterpDelay", "kind": "function", "signature": "getCollabInterpDelay(editor)", "summary": "Get the current adaptive interpolation delay (ms). On LAN: ~20ms. On jittery connections: up to 150ms. Auto-adjusts each frame." }, { "name": "collabPresenceTick", "kind": "function", "signature": "collabPresenceTick(editor)", "summary": "Called from Viewport render loop to send presence at 10 Hz." }, { "name": "exportCollabTimeline", "kind": "function", "signature": "exportCollabTimeline(editor)", "summary": "Export local timeline as JSON download." }, { "name": "collabTrackGrab", "kind": "function", "signature": "collabTrackGrab(editor, entityId)", "summary": "Notify collab that local user started grabbing an entity (play mode). Claims per-entity ownership at GRABBED priority so our transforms are authoritative." }, { "name": "collabUntrackGrab", "kind": "function", "signature": "collabUntrackGrab(editor, entityId)", "summary": "Notify collab that local user released a grabbed entity. Releases per-entity ownership so default authority resumes." }, { "name": "collabClaimSelected", "kind": "function", "signature": "collabClaimSelected(editor, entityId)", "summary": "Claim ownership of an entity at SELECTED priority (inspector editing)." }, { "name": "collabReleaseEntity", "kind": "function", "signature": "collabReleaseEntity(editor, entityId)", "summary": "Release ownership of an entity (selected or grabbed)." }, { "name": "getCollabEntityOwner", "kind": "function", "signature": "getCollabEntityOwner(editor, entityId)", "summary": "Get the current owner of an entity. Returns { ownerId, priority } or null." }, { "name": "isCollabEntityLocallyOwned", "kind": "function", "signature": "isCollabEntityLocallyOwned(editor, entityId)", "summary": "Check if the local peer owns an entity." }, { "name": "getCollabGrabGlows", "kind": "function", "signature": "getCollabGrabGlows(editor)", "summary": "Get map of entityId → color hex for entities being grabbed by remote peers. Used by Viewport to render grab glow." }, { "name": "isCollabPlayAuthority", "kind": "function", "signature": "isCollabPlayAuthority(editor)", "summary": "Returns true if this peer is the physics authority during play mode. Non-authority peers should skip local physics stepping and instead receive transforms from the authority." }, { "name": "collabInterpolateFrame", "kind": "function", "signature": "collabInterpolateFrame(editor)", "summary": "Interpolate buffered remote transforms. Call every render frame on non-authority peers. Smoothly tweens entity positions between received keyframes with a 100ms render delay." }, { "name": "hostRoom", "kind": "function", "signature": "hostRoom(editor, roomId, wordKey, numberKey)", "summary": "Host a room. Auto-generates word key and number key if not provided. Starts signaling so peers can discover this host." }, { "name": "setCollabRoom", "kind": "function", "signature": "setCollabRoom(editor, roomId, wordKey, numberKey, hostId, hostFingerprint)", "summary": "Join a room with dual-key authentication (all 3 must match the host). Legacy alias: setCollabRoomId calls this." }, { "name": "setCollabRoomId", "kind": "function", "signature": "setCollabRoomId(editor, roomId)", "summary": "" }, { "name": "setAnonMode", "kind": "function", "signature": "setAnonMode(editor, enabled)", "summary": "Toggle anonymous mode. Must be called BEFORE hostRoom/joinRoom. When enabled: - Peers get random anonymous IDs (different each session) - Real peer IDs are stripped from all ops - TURN-only relay hides IP addresses - Garlic encryption prevents relay from reading message content" }, { "name": "leaveRoom", "kind": "function", "signature": "leaveRoom(editor)", "summary": "Leave the current room. Stops signaling and clears peer state. Does NOT destroy the collab system — user can Host/Join again." }, { "name": "generateWordKey", "kind": "function", "signature": "generateWordKey()", "summary": "Generate a random word key (two words joined by a dash). 120 words × 120 words = 14,400 combinations per word pair." }, { "name": "generateNumberKey", "kind": "function", "signature": "generateNumberKey()", "summary": "Generate a random 6-digit number key. 900,000 combinations (100000-999999). Total key space with words: 120×120×900000 ≈ 12.96 billion combinations." }, { "name": "encodeInviteCode", "kind": "function", "signature": "encodeInviteCode(roomId, wordKey, numberKey, hostId, hostFingerprint)", "summary": "Encode room credentials into a single invite code string. Format: PE- The hostFingerprint (16 hex chars) allows joiners to verify host identity." }, { "name": "decodeInviteCode", "kind": "function", "signature": "decodeInviteCode(code)", "summary": "Decode an invite code back to { roomId, wordKey, numberKey, hostId, hostFingerprint }. Returns null if the code is invalid." }, { "name": "setAutoMod", "kind": "function", "signature": "setAutoMod(editor, enabled)", "summary": "Toggle auto-moderation (auto-kick, mute, throttle from integrity violations). Only the host can enable/disable. Off by default." }, { "name": "kickPeer", "kind": "function", "signature": "kickPeer(editor, peerId)", "summary": "Kick a peer from the room. Only the host (first connected) should call this. Broadcasts a __kick__ op, then the kicked peer clears its stored credentials." }, { "name": "getSavedRoomCredentials", "kind": "function", "signature": "getSavedRoomCredentials()", "summary": "Get saved room credentials from localStorage." }, { "name": "clearRoomCredentials", "kind": "function", "signature": "clearRoomCredentials()", "summary": "Clear saved room credentials (called on kick or manual disconnect)." }, { "name": "injectCollabStorageDeps", "kind": "function", "signature": "injectCollabStorageDeps(deps)", "summary": "" }, { "name": "injectCollabHistoryHelpers", "kind": "function", "signature": "injectCollabHistoryHelpers(helpers)", "summary": "" }, { "name": "editorCollabCompositeSuffix", "kind": "function", "signature": "editorCollabCompositeSuffix(raw)", "summary": "Build a composite project ID from room + wordKey + numberKey. The composite is used as the BitTorrent info_hash seed, so only peers with all 3 matching values will discover each other on the swarm. IMPORTANT: NEVER returns a bare roomId. Even without keys, a random salt is included so two users with the same folder name can't collide. The hostId (selfId of host) is mixed in when hosting to guarantee that different hosts with identical room+word+number still get unique swarms. Uses FNV-1a 64-bit (emulated as two 32-bit hashes) for collision resistance." }, { "name": "buildEditorCollabCompositeId", "kind": "function", "signature": "buildEditorCollabCompositeId(roomId, wordKey, numberKey, hostId)", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorGuide", "path": "editor/reference/modules/EditorGuide.md", "source": "editor/js/modules/EditorGuide.js", "import": "/editor/js/modules/EditorGuide.js", "sourceHash": "bcebabc41b9d2d8a731853d105c324bcdc521fd150b3059788b2f35df5bd0aa2", "summary": "EditorGuide.js — Fullscreen interactive guide overlay Future-proof feature list: - ARIA accessibility (role=dialog, aria-modal, focus trap) - Keyboard nav (Arrow keys sidebar, Tab sections, ? global shortcut) - Search / filter across all section text - localStorage progress tracking with completion badges - First-launch auto-show - Guide versioning — \"what's new\" badge on updates - Deep linking via URL hash (#guide-camera) - Scroll progress bar - Reading time estimates per section - Interactive demo placeholder canvases (ready for engine runtime) - Print-friendly CSS (@media print)", "exports": [ { "name": "show", "kind": "function", "signature": "show(sectionId)", "summary": "" }, { "name": "hide", "kind": "function", "signature": "hide()", "summary": "" }, { "name": "toggle", "kind": "function", "signature": "toggle()", "summary": "" }, { "name": "isVisible", "kind": "function", "signature": "isVisible()", "summary": "" }, { "name": "checkFirstLaunch", "kind": "function", "signature": "checkFirstLaunch()", "summary": "" }, { "name": "checkHashLink", "kind": "function", "signature": "checkHashLink()", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorHistory", "path": "editor/reference/modules/EditorHistory.md", "source": "editor/js/modules/EditorHistory.js", "import": "/editor/js/modules/EditorHistory.js", "sourceHash": "9b1878b55f15a8c5eac6585bd068fc313cf524da470f0ff0afbee7599612bf5e", "summary": "EditorHistory - Undo/Redo System with Clipboard Support Action types: - transform: Entity position/rotation/scale change - create: Entity creation - delete: Entity deletion - delete_multi: Multiple entity deletion - property: Component property change - model_animation: Imported model clip/playback state change - model_morph_weights: Imported model morph ownership/weight change - rename: Entity rename - reparent: Entity moved to different folder - paste: Paste operation (multiple entities) - folder_create: Folder creation - folder_delete: Folder deletion - folder_rename: Folder rename - component_add: Component added to entity - component_remove: Component removed from entity - selection: Selection change (for group operations) Memory optimizations: - Transform actions use quantized floats (0.001 precision for position) - Batches rapid transform changes into single action Component capture: - All ECS components listed in TRACKED_COMPONENTS are captured - Add new component types to TRACKED_COMPONENTS as they're added to engine", "exports": [ { "name": "setCollabBroadcastHook", "kind": "function", "signature": "setCollabBroadcastHook(fn)", "summary": "" }, { "name": "setCollabReplayFlag", "kind": "function", "signature": "setCollabReplayFlag(v)", "summary": "" }, { "name": "initHistory", "kind": "function", "signature": "initHistory(editor)", "summary": "Initialize history system with editor reference" }, { "name": "selectAll", "kind": "function", "signature": "selectAll()", "summary": "Select all entities" }, { "name": "pushAction", "kind": "function", "signature": "pushAction(action)", "summary": "Push an action to the undo stack" }, { "name": "recordTransform", "kind": "function", "signature": "recordTransform(entityId, beforePos, beforeRot, beforeScale, afterPos, afterRot, afterScale)", "summary": "Record a transform change (with batching and compression)" }, { "name": "flushPendingTransform", "kind": "function", "signature": "flushPendingTransform()", "summary": "Force commit any pending transform (call before other operations)" }, { "name": "recordCreate", "kind": "function", "signature": "recordCreate(entityId, entityData)", "summary": "Record entity creation" }, { "name": "recordDelete", "kind": "function", "signature": "recordDelete(entityId, entityData)", "summary": "Record entity deletion" }, { "name": "recordProperty", "kind": "function", "signature": "recordProperty(entityId, componentName, propertyName, beforeValue, afterValue)", "summary": "Record property change" }, { "name": "recordModelAnimation", "kind": "function", "signature": "recordModelAnimation(entityId, beforeValue, afterValue)", "summary": "" }, { "name": "recordModelMorphWeights", "kind": "function", "signature": "recordModelMorphWeights(entityId, beforeValue, afterValue)", "summary": "" }, { "name": "recordRename", "kind": "function", "signature": "recordRename(entityId, beforeName, afterName)", "summary": "Record rename" }, { "name": "recordReparent", "kind": "function", "signature": "recordReparent(entityId, beforeFolderId, afterFolderId)", "summary": "Record entity reparent (move to different folder)" }, { "name": "recordFolderCreate", "kind": "function", "signature": "recordFolderCreate(folderId, folderData)", "summary": "Record folder creation" }, { "name": "recordFolderDelete", "kind": "function", "signature": "recordFolderDelete(folderId, folderData, childEntities)", "summary": "Record folder deletion" }, { "name": "recordFolderRename", "kind": "function", "signature": "recordFolderRename(folderId, beforeName, afterName)", "summary": "Record folder rename" }, { "name": "recordComponentAdd", "kind": "function", "signature": "recordComponentAdd(entityId, componentName, componentData)", "summary": "Record component added to entity" }, { "name": "recordComponentRemove", "kind": "function", "signature": "recordComponentRemove(entityId, componentName, componentData)", "summary": "Record component removed from entity" }, { "name": "recordSelectionChange", "kind": "function", "signature": "recordSelectionChange(beforeSelection, afterSelection)", "summary": "Record selection change (for group operations)" }, { "name": "undo", "kind": "function", "signature": "undo()", "summary": "Undo last action" }, { "name": "redo", "kind": "function", "signature": "redo()", "summary": "Redo last undone action" }, { "name": "copy", "kind": "function", "signature": "copy()", "summary": "Copy selected entities to clipboard" }, { "name": "cut", "kind": "function", "signature": "cut()", "summary": "Cut selected entities (copy + delete)" }, { "name": "paste", "kind": "function", "signature": "async paste()", "summary": "Paste from clipboard" }, { "name": "duplicate", "kind": "function", "signature": "async duplicate()", "summary": "Duplicate selected entities" }, { "name": "deleteSelected", "kind": "function", "signature": "deleteSelected()", "summary": "Delete selected entities" }, { "name": "clearHistory", "kind": "function", "signature": "clearHistory()", "summary": "Clear all history" }, { "name": "getHistoryState", "kind": "function", "signature": "getHistoryState()", "summary": "Get history state for debugging" }, { "name": "canUndo", "kind": "function", "signature": "canUndo()", "summary": "" }, { "name": "canRedo", "kind": "function", "signature": "canRedo()", "summary": "" }, { "name": "hasClipboard", "kind": "function", "signature": "hasClipboard()", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorMeshConversions", "path": "editor/reference/modules/EditorMeshConversions.md", "source": "editor/js/modules/EditorMeshConversions.js", "import": "/editor/js/modules/EditorMeshConversions.js", "sourceHash": "2ba141a3a6ac91d4e804c6cffae4e9a42f6fe3c93937e2f4dc0f2b62ab8f66c1", "summary": "============================================================================ EditorMeshConversions.js — Mesh conversion operations for editor entities Bridges Kaolin conversion modules to the editor: - Mesh → Voxel grid (MeshToVoxel) - Mesh → Point cloud (MeshToPoints) - Mesh → Soft Body (AutoTetMesh → PBD sim) - Points → Mesh (PointsToMesh) - SDF → Mesh (SDFToMesh) - Export mesh as OBJ/PLY/STL (MeshIO) ============================================================================", "exports": [ { "name": "meshToVoxel", "kind": "function", "signature": "async meshToVoxel(editor, entityId, opts = {})", "summary": "Voxelize an entity's mesh and spawn a new entity with the voxel data." }, { "name": "meshToPoints", "kind": "function", "signature": "async meshToPoints(editor, entityId, opts = {})", "summary": "Sample points from an entity's mesh and spawn a point cloud entity." }, { "name": "meshToSoftBody", "kind": "function", "signature": "async meshToSoftBody(editor, entityId, opts = {})", "summary": "Convert an entity's mesh to a soft body using AutoTetMesh." }, { "name": "pointsToMesh", "kind": "function", "signature": "async pointsToMesh(editor, entityId, opts = {})", "summary": "Reconstruct a mesh from a point cloud entity." }, { "name": "sdfToMesh", "kind": "function", "signature": "async sdfToMesh(sdfFn, opts = {})", "summary": "Generate a mesh from an SDF function." }, { "name": "exportMesh", "kind": "function", "signature": "async exportMesh(editor, entityId, format = 'obj')", "summary": "Export an entity's mesh as a downloadable file." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorMeshOps", "path": "editor/reference/modules/EditorMeshOps.md", "source": "editor/js/modules/EditorMeshOps.js", "import": "/editor/js/modules/EditorMeshOps.js", "sourceHash": "ced3876feeee73fd7e7790e3c1eeebd7330414937bae02d305a76bf1b76665b6", "summary": "============================================================================ EditorMeshOps.js — Mesh operations for editor entities Exposes Kaolin mesh ops (subdivide, smooth, normals, validate, flip) on selected entities. Each op clones the mesh, runs the Kaolin function, re-registers with CustomMeshRegistry + EntityMeshRenderer, and pushes an undo snapshot (hybrid: auto for <50k tris, confirm dialog for larger). ============================================================================", "exports": [ { "name": "getMeshDataForEntity", "kind": "function", "signature": "getMeshDataForEntity(editor, entityId)", "summary": "Get mesh geometry data for an entity. Checks CustomMeshRegistry first, then EntityMeshRenderer cache." }, { "name": "applyMeshOp", "kind": "function", "signature": "async applyMeshOp(editor, entityId, opName, params = {})", "summary": "Apply a mesh operation to an entity. Pipeline: get mesh → optional undo snapshot → run op → re-register → update entity." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorMetrics", "path": "editor/reference/modules/EditorMetrics.md", "source": "editor/js/modules/EditorMetrics.js", "import": "/editor/js/modules/EditorMetrics.js", "sourceHash": "528d723e3e03ac2c4a476a2d8f96b7d74ce8f6f94877e71eb0b918f1f9b19b35", "summary": "============================================================================ EditorMetrics.js — 3D mesh comparison metrics for the editor console Exposes Kaolin metrics (Chamfer Distance, Hausdorff, Volumetric IoU) as editor commands for comparing mesh entities. Usage (from editor console or script): editor.compareMeshes(entityA, entityB) editor.meshMetrics(entityA, entityB, 'chamfer') ============================================================================", "exports": [ { "name": "setupMetricsCommands", "kind": "function", "signature": "setupMetricsCommands(editor)", "summary": "Setup mesh metrics commands on the editor instance. Call once during editor initialization." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorParticleSkinning", "path": "editor/reference/modules/EditorParticleSkinning.md", "source": "editor/js/modules/EditorParticleSkinning.js", "import": "/editor/js/modules/EditorParticleSkinning.js", "sourceHash": "b90fd337b2461c7fccc731b67c50846d6b5d23722b20d4cf914c309c0ab0c169", "summary": "============================================================================ EditorParticleSkinning.js — Editor bridge for learned deformation skinning Connects Kaolin's ParticleSkinning pipeline to the editor: 1. Capture deformation snapshots from a running soft body sim 2. Extract PCA deformation modes 3. Compute skinning weights 4. Bake to animation keyframes for replay without physics 5. Runtime preview via skinning evaluator Usage (from editor console or context menu): editor.skinning.startCapture(entityId) editor.skinning.stopCapture(entityId) editor.skinning.train(entityId, { numModes: 8 }) editor.skinning.bake(entityId, { fps: 60 }) editor.skinning.playBaked(entityId) ============================================================================", "exports": [ { "name": "setupSkinningCommands", "kind": "function", "signature": "setupSkinningCommands(editor)", "summary": "Set up particle skinning commands on the editor instance." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorParticles", "path": "editor/reference/modules/EditorParticles.md", "source": "editor/js/modules/EditorParticles.js", "import": "/editor/js/modules/EditorParticles.js", "sourceHash": "f012c2c4e04973b5edd1f61e1e501a6bcbe584c18e867eababb4644436420133", "summary": "Initialize the particle system for the editor", "exports": [ { "name": "applyParticleTimelineSettings", "kind": "function", "signature": "applyParticleTimelineSettings(editor)", "summary": "" }, { "name": "initParticleSystem", "kind": "function", "signature": "async initParticleSystem(editor, device, format)", "summary": "Initialize the particle system for the editor" }, { "name": "stopParticleAudio", "kind": "function", "signature": "stopParticleAudio()", "summary": "Immediately stop all particle audio (impacts + ambients). Called when exiting play mode (Stop button)." }, { "name": "destroyParticleSystem", "kind": "function", "signature": "destroyParticleSystem()", "summary": "Destroy the particle system" }, { "name": "syncWorldSystemsToEmitters", "kind": "function", "signature": "syncWorldSystemsToEmitters()", "summary": "Scan all active emitters' physics profiles and ensure required world systems are initialized. Call this after registering emitters or when emitter substances change." }, { "name": "registerEmitter", "kind": "function", "signature": "registerEmitter(entityId, config)", "summary": "Register an emitter entity" }, { "name": "unregisterEmitter", "kind": "function", "signature": "unregisterEmitter(entityId)", "summary": "Unregister an emitter entity" }, { "name": "createComposedSpellEffect", "kind": "function", "signature": "createComposedSpellEffect(editor, sourceEntityId, elements, baseConfig)", "summary": "=== AUTO-BLENDING SPELL EFFECT COMPOSER === Applies composed spell effect properties directly to the source emitter. Does NOT create child entities — modifies the source emitter's visual properties based on the element mix to produce a richer, more layered look. The composer analyzes the element combination and applies: - Optimized color derived from element combo - Adjusted emit rate, size, lifetime for a \"spell-like\" feel - Temperature and material properties from element chemistry Called by \"Create Spell From This\" button in EmitterInspectorCard.js." }, { "name": "updateEmitter", "kind": "function", "signature": "updateEmitter(entityId, config)", "summary": "Update emitter configuration" }, { "name": "enableEmitter", "kind": "function", "signature": "enableEmitter(entityId)", "summary": "Enable an emitter" }, { "name": "disableEmitter", "kind": "function", "signature": "disableEmitter(entityId)", "summary": "Disable an emitter" }, { "name": "toggleEmitter", "kind": "function", "signature": "toggleEmitter(entityId)", "summary": "Toggle emitter on/off" }, { "name": "isEmitterEnabled", "kind": "function", "signature": "isEmitterEnabled(entityId)", "summary": "Check if emitter is enabled" }, { "name": "getEmitter", "kind": "function", "signature": "getEmitter(entityId)", "summary": "Get emitter by entity ID (for inspector UI binding)" }, { "name": "hasEmitter", "kind": "function", "signature": "hasEmitter(entityId)", "summary": "Check if an entity has an emitter" }, { "name": "saveEmitterToECS", "kind": "function", "signature": "saveEmitterToECS(editor, entityId)", "summary": "Save emitter config to entity metadata for serialization" }, { "name": "seedParticleRng", "kind": "function", "signature": "seedParticleRng(seed, tick = 0)", "summary": "Seed the particle RNG with a shared collab seed. Call at play start so all peers produce identical particle sequences." }, { "name": "saveAllEmittersToECS", "kind": "function", "signature": "saveAllEmittersToECS(editor)", "summary": "" }, { "name": "updateParticleQuality", "kind": "function", "signature": "updateParticleQuality(editor, frameDt, cameraPosition = null)", "summary": "Feed the quality stack once per displayed frame using measured wall-clock time. Fixed simulation ticks must not drive this API because a constant 16.67 ms input hides real render pressure and prevents adaptive quality from reacting." }, { "name": "getParticleQualityStackStatus", "kind": "function", "signature": "getParticleQualityStackStatus()", "summary": "Return a serializable, truthful snapshot of every active particle quality layer." }, { "name": "stepParticles", "kind": "function", "signature": "stepParticles(editor, dt)", "summary": "" }, { "name": "prepareDebugRenderer", "kind": "function", "signature": "async prepareDebugRenderer(mode)", "summary": "Prepare a debug renderer for use (call before switching to debug mode)" }, { "name": "isDebugRendererReady", "kind": "function", "signature": "isDebugRendererReady(mode)", "summary": "Check if a debug renderer is ready" }, { "name": "renderParticlesDepth", "kind": "function", "signature": "renderParticlesDepth(pass, camera)", "summary": "Render particles to depth texture" }, { "name": "renderParticlesNormals", "kind": "function", "signature": "renderParticlesNormals(pass, camera)", "summary": "Render particles normals to texture" }, { "name": "renderParticlesAlbedo", "kind": "function", "signature": "renderParticlesAlbedo(pass, camera)", "summary": "Render particles albedo to texture" }, { "name": "renderParticlesLighting", "kind": "function", "signature": "renderParticlesLighting(pass, camera)", "summary": "Render particles lighting to texture" }, { "name": "renderParticlesVelocity", "kind": "function", "signature": "renderParticlesVelocity(pass, camera)", "summary": "Render particles velocity to texture" }, { "name": "renderParticlesAge", "kind": "function", "signature": "renderParticlesAge(pass, camera)", "summary": "Render particles age to texture" }, { "name": "renderParticlesEmissive", "kind": "function", "signature": "renderParticlesEmissive(pass, camera)", "summary": "Render particles emissive to texture" }, { "name": "renderParticlesSize", "kind": "function", "signature": "renderParticlesSize(pass, camera)", "summary": "Render particles size to texture" }, { "name": "renderParticlesThermal", "kind": "function", "signature": "renderParticlesThermal(pass, camera)", "summary": "Render particles thermal/blackbody to texture" }, { "name": "setThermalEnabled", "kind": "function", "signature": "setThermalEnabled(enabled)", "summary": "Enable/disable blackbody thermal coloring in the main SDF render. When disabled (default), particles render with base colors only. Use the Thermal debug pass to visualize temperature separately." }, { "name": "isThermalEnabled", "kind": "function", "signature": "isThermalEnabled()", "summary": "" }, { "name": "renderParticles", "kind": "function", "signature": "renderParticles(pass, camera, depthTextureView, depthScale)", "summary": "Render particles to the current render pass" }, { "name": "getParticleCount", "kind": "function", "signature": "getParticleCount()", "summary": "Get current particle count" }, { "name": "clearParticles", "kind": "function", "signature": "clearParticles()", "summary": "Clear all particles - kills all living particles immediately" }, { "name": "getParticleDecals", "kind": "function", "signature": "getParticleDecals()", "summary": "Get active decals for rendering (from collision events)" }, { "name": "getDecalSpawner", "kind": "function", "signature": "getDecalSpawner()", "summary": "Get the decal spawner (for Viewport to create its renderer)" }, { "name": "getExtractedParticleLights", "kind": "function", "signature": "getExtractedParticleLights()", "summary": "Get extracted particle lights for scene lighting" }, { "name": "getParticleLightSystem", "kind": "function", "signature": "getParticleLightSystem()", "summary": "Get the particle light system handle" }, { "name": "getDistortionRenderer", "kind": "function", "signature": "getDistortionRenderer(width, height, sceneFormat)", "summary": "Get or lazy-create the distortion renderer for heat haze effects" }, { "name": "initDistortion", "kind": "function", "signature": "initDistortion(sceneColorView)", "summary": "Initialize distortion bind groups (call when scene color view is available)" }, { "name": "executeDistortionPass", "kind": "function", "signature": "executeDistortionPass(encoder, frameData)", "summary": "Execute distortion render pass (accumulate UV offsets from hot particles)" }, { "name": "executeDistortionComposite", "kind": "function", "signature": "executeDistortionComposite(pass)", "summary": "Composite distortion onto scene" }, { "name": "resizeDistortion", "kind": "function", "signature": "resizeDistortion(width, height)", "summary": "Resize distortion texture on viewport resize" }, { "name": "getTrailHistorySystem", "kind": "function", "signature": "getTrailHistorySystem()", "summary": "Get the trail history system handle" }, { "name": "renderTrailHistoryPass", "kind": "function", "signature": "renderTrailHistoryPass(pass, viewProj, cameraPos, time)", "summary": "Render trail histories as additive fading billboards" }, { "name": "getBeamRenderer", "kind": "function", "signature": "getBeamRenderer(format)", "summary": "Get or lazy-create the beam renderer" }, { "name": "renderBeamPass", "kind": "function", "signature": "renderBeamPass(pass, viewProj, viewRight, viewUp, time, segmentCount)", "summary": "Render beam particles" }, { "name": "getBeamSegmentCount", "kind": "function", "signature": "getBeamSegmentCount()", "summary": "Get the number of beam segments to render. Returns 0 unless beam-type emitters are explicitly active in the scene. Prevents the beam renderer from treating all alive particles as a single chain." }, { "name": "updateBeamParams", "kind": "function", "signature": "updateBeamParams(params)", "summary": "Update beam parameters" }, { "name": "getExistingMeshRenderer", "kind": "function", "signature": "getExistingMeshRenderer()", "summary": "Get the existing mesh renderer without triggering creation. Returns null if not yet created. Used by shadow caster integration." }, { "name": "getMeshRenderer", "kind": "function", "signature": "getMeshRenderer(format, meshConfig)", "summary": "Get or lazy-create the mesh particle renderer" }, { "name": "setParticleMeshGeometry", "kind": "function", "signature": "setParticleMeshGeometry(mesh)", "summary": "Set the mesh geometry for particle mesh rendering" }, { "name": "renderMeshPass", "kind": "function", "signature": "renderMeshPass(pass, viewProj, cameraPos, time, instanceCount)", "summary": "Render mesh particles" }, { "name": "hasLiquidEmitters", "kind": "function", "signature": "hasLiquidEmitters()", "summary": "GAP 6: Query whether any active emitter has liquid-phase particles. Viewport uses this to auto-enable/disable SSFR rendering." }, { "name": "getLiquidSurfaceTint", "kind": "function", "signature": "getLiquidSurfaceTint()", "summary": "" }, { "name": "getSPHSurfaceRendererHandle", "kind": "function", "signature": "getSPHSurfaceRendererHandle(format, width, height)", "summary": "Get or lazy-create the SPH surface renderer" }, { "name": "setSPHSurfaceTintColor", "kind": "function", "signature": "setSPHSurfaceTintColor(tint)", "summary": "GAP 13: Set SSFR tint color from substance [r, g, b]." }, { "name": "initSPHComposite", "kind": "function", "signature": "initSPHComposite(sceneColorView)", "summary": "Initialize SPH composite bind group (needs scene color view)" }, { "name": "renderSPHSurfacePass", "kind": "function", "signature": "renderSPHSurfacePass(encoder, options)", "summary": "Render SPH fluid surface depth pass" }, { "name": "compositeSPHSurfacePass", "kind": "function", "signature": "compositeSPHSurfacePass(pass)", "summary": "Composite SPH surface onto scene" }, { "name": "getBondRenderer", "kind": "function", "signature": "getBondRenderer(format)", "summary": "Get or lazy-create the bond renderer" }, { "name": "computeAndUploadVisualBonds", "kind": "function", "signature": "computeAndUploadVisualBonds()", "summary": "" }, { "name": "renderBondPass", "kind": "function", "signature": "renderBondPass(pass, viewProj, cameraPos, viewRight, viewUp)", "summary": "Render bonds" }, { "name": "setBondVisualsEnabled", "kind": "function", "signature": "setBondVisualsEnabled(enabled)", "summary": "Set bond visualization enabled/disabled" }, { "name": "setBondRadius", "kind": "function", "signature": "setBondRadius(radius)", "summary": "Set bond radius for proximity detection" }, { "name": "getFieldRenderer", "kind": "function", "signature": "getFieldRenderer(format)", "summary": "Get or lazy-create the field renderer" }, { "name": "updateFieldVisualization", "kind": "function", "signature": "updateFieldVisualization(chargedParticles, gridConfig)", "summary": "Update field probes from charged particles" }, { "name": "renderFieldPass", "kind": "function", "signature": "renderFieldPass(pass, viewProj, cameraPos, viewRight, viewUp)", "summary": "Render field arrows" }, { "name": "getOrbitalRenderer", "kind": "function", "signature": "getOrbitalRenderer(format)", "summary": "Get or lazy-create the orbital renderer" }, { "name": "renderOrbitalPass", "kind": "function", "signature": "renderOrbitalPass(pass, viewProj, cameraPos, viewRight, viewUp, instanceCount)", "summary": "Render orbital electron clouds" }, { "name": "isReady", "kind": "function", "signature": "isReady()", "summary": "Check if particle system is ready" }, { "name": "getActiveEmitters", "kind": "function", "signature": "getActiveEmitters()", "summary": "Get active emitters" }, { "name": "clearAllEmitters", "kind": "function", "signature": "clearAllEmitters()", "summary": "Clear all emitters and particles (used before scene reload)" }, { "name": "spawnBurst", "kind": "function", "signature": "spawnBurst(position, preset = 'explosion', count = 50)", "summary": "Spawn a burst of particles at a position" }, { "name": "spawnDustPuff", "kind": "function", "signature": "spawnDustPuff(position, color, intensity = 0.5, normal)", "summary": "Spawn a dust puff at a world position when fragments take damage or break. Uses small, soft point particles colored to match the breaking material. Best-practice references (real-time VFX): - Unreal Niagara: one-shot burst, soft sprite, high drag, gravity settle - Unity VFX Graph: short lifetime, size-over-life bell curve, alpha fade - GDC \"The Art of Destruction\": dust = desaturated material color, 0.2-0.6s" }, { "name": "getParticleSettings", "kind": "function", "signature": "getParticleSettings()", "summary": "Get advanced particle system settings" }, { "name": "getParticles", "kind": "function", "signature": "getParticles()", "summary": "" }, { "name": "setParticleSettings", "kind": "function", "signature": "setParticleSettings(settings)", "summary": "Update advanced particle system settings" }, { "name": "getParticlePerformanceStats", "kind": "function", "signature": "getParticlePerformanceStats()", "summary": "Get particle system performance stats" }, { "name": "startParticleRewind", "kind": "function", "signature": "startParticleRewind()", "summary": "Start particle time rewind mode" }, { "name": "stopParticleRewind", "kind": "function", "signature": "stopParticleRewind()", "summary": "Stop particle rewind and resume simulation" }, { "name": "seekParticleTime", "kind": "function", "signature": "seekParticleTime(timeMs)", "summary": "Seek to a specific time in particle history Restores FULL particle state including spawn/death events" }, { "name": "setParticleRewindSpeed", "kind": "function", "signature": "setParticleRewindSpeed(speed)", "summary": "Set particle rewind playback speed" }, { "name": "getParticleRewindInfo", "kind": "function", "signature": "getParticleRewindInfo()", "summary": "Get particle rewind/snapshot info" }, { "name": "isParticleRewinding", "kind": "function", "signature": "isParticleRewinding()", "summary": "Check if particles are currently rewinding" }, { "name": "clearParticleSnapshots", "kind": "function", "signature": "clearParticleSnapshots()", "summary": "Clear all particle snapshots" }, { "name": "truncateParticleSnapshotsAfterTime", "kind": "function", "signature": "truncateParticleSnapshotsAfterTime(timeMs)", "summary": "" }, { "name": "setParticleEasing", "kind": "function", "signature": "setParticleEasing(easingType)", "summary": "Set particle easing type for timeline interpolation" }, { "name": "setAdvancedInterpolation", "kind": "function", "signature": "setAdvancedInterpolation(enabled)", "summary": "Enable/disable advanced interpolation (Catmull-Rom/Hermite splines)" }, { "name": "getInterpolationMode", "kind": "function", "signature": "getInterpolationMode()", "summary": "Get current interpolation mode" }, { "name": "getParticleEasingTypes", "kind": "function", "signature": "getParticleEasingTypes()", "summary": "Get available easing types for particle rewind" }, { "name": "initAdvancedFeatures", "kind": "function", "signature": "initAdvancedFeatures(options = {})", "summary": "Initialize advanced particle features (spatial grid, line generation) Call after initParticleSystem for enhanced features" }, { "name": "resetQualityScale", "kind": "function", "signature": "resetQualityScale()", "summary": "Reset quality scale to 1.0 - call when entering play mode to ensure consistent emission" }, { "name": "updateVolumeSystem", "kind": "function", "signature": "updateVolumeSystem(encoder, camera)", "summary": "Update the hybrid volumetric system (call before render)" }, { "name": "renderVolumeSystem", "kind": "function", "signature": "renderVolumeSystem(pass, sceneColorTexture, sceneDepthTexture)", "summary": "Render the hybrid volumetric system" }, { "name": "setVolumeMode", "kind": "function", "signature": "setVolumeMode(mode)", "summary": "Set volume render mode" }, { "name": "setVolumeEnabled", "kind": "function", "signature": "setVolumeEnabled(enabled)", "summary": "Enable/disable volume rendering" }, { "name": "toggleVolumeRendering", "kind": "function", "signature": "toggleVolumeRendering()", "summary": "Toggle volume rendering" }, { "name": "isVolumeReady", "kind": "function", "signature": "isVolumeReady()", "summary": "Check if volume system is ready" }, { "name": "getVolumeStats", "kind": "function", "signature": "getVolumeStats()", "summary": "Get volume system stats" }, { "name": "setVolumeBounds", "kind": "function", "signature": "setVolumeBounds(min, max)", "summary": "Set volume bounds" }, { "name": "EMITTER_PRESETS", "kind": "constant", "signature": "EMITTER_PRESETS", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorPhysicalMaterial", "path": "editor/reference/modules/EditorPhysicalMaterial.md", "source": "editor/js/modules/EditorPhysicalMaterial.js", "import": "/editor/js/modules/EditorPhysicalMaterial.js", "sourceHash": "b585613d7811168f062b51013563a5b6ea88e890fabe689d28e22dee3abc25ff", "summary": "============================================================================ EditorPhysicalMaterial.js — Runtime bridge for physical material simulation Connects PhysicalMaterial ECS component to existing physics systems: - Collision → damage accumulation - Damage exceeds threshold → deform (voxel crater) or fracture (Voronoi) - Fracture spawns real ECS entities with Renderable + PhysicsBody + Collider - Material-specific debris FX (dust, sparks, splinters) - Fragment count scales with impact energy - Brittleness determines shatter vs bend behavior Lazy-loads heavy modules (VoronoiFracture, AutoTetMesh) only when triggered. ============================================================================", "exports": [ { "name": "clearPlayState", "kind": "function", "signature": "clearPlayState()", "summary": "Clear all play-session state. Must be called when exiting play mode so that damage/fracture/deformation caches don't persist into the next session." }, { "name": "setupPhysicalMaterialBridge", "kind": "function", "signature": "setupPhysicalMaterialBridge(editor)", "summary": "" }, { "name": "handleCollision", "kind": "function", "signature": "handleCollision(editor, entityIdA, entityIdB, impactForce, contactPoint, contactNormal, massA, massB)", "summary": "Handle a collision between two entities. Called from EditorPhysics.js contact callback." }, { "name": "applyDamage", "kind": "function", "signature": "applyDamage(editor, entityId, amount)", "summary": "Apply direct damage to an entity (e.g., from explosions, scripts)." }, { "name": "resetDamage", "kind": "function", "signature": "resetDamage(editor, entityId)", "summary": "Reset damage on an entity." }, { "name": "convertToSoftBody", "kind": "function", "signature": "async convertToSoftBody(editor, entityId)", "summary": "Convert a rigid entity to a soft body on-the-fly. Uses AutoTetMesh to generate tet volume, then PBD solver." }, { "name": "deformAtImpact", "kind": "function", "signature": "async deformAtImpact(editor, entityId, contactPoint, contactNormal, normalizedForce)", "summary": "Deform mesh at impact point by carving a crater via voxel subtraction. If the carve disconnects pieces, broken-off pieces become fragment entities." }, { "name": "fractureEntity", "kind": "function", "signature": "async fractureEntity(editor, entityId, contactPoint, contactNormal, impactForce, normalizedForce)", "summary": "Fracture an entity into visible fragment ECS entities using VoronoiFracture. Each fragment gets its own Renderable, PhysicsBody, and Collider. Fragment count scales with impact energy (Phase D)." }, { "name": "updateDebris", "kind": "function", "signature": "updateDebris(editor)", "summary": "Update debris lifecycle — call from physics step. Removes expired debris entities." }, { "name": "syncColliderFromMaterial", "kind": "function", "signature": "syncColliderFromMaterial(editor, entityId)", "summary": "Sync collider friction/restitution from material properties. Call after material changes." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorPhysics", "path": "editor/reference/modules/EditorPhysics.md", "source": "editor/js/modules/EditorPhysics.js", "import": "/editor/js/modules/EditorPhysics.js", "sourceHash": "9e8c5e79034b3bd00d349ab375562e1270ef24b28495dab5146397de045d9365", "summary": "Public API to manually verify collision state (useful for debugging)", "exports": [ { "name": "initializePhysicsWorld", "kind": "function", "signature": "async initializePhysicsWorld(editor)", "summary": "" }, { "name": "debugVerifyCollisions", "kind": "function", "signature": "debugVerifyCollisions(editor)", "summary": "Public API to manually verify collision state (useful for debugging)" }, { "name": "destroyPhysicsWorld", "kind": "function", "signature": "destroyPhysicsWorld(editor)", "summary": "" }, { "name": "stepPhysics", "kind": "function", "signature": "stepPhysics(editor, dt)", "summary": "" }, { "name": "createHingeJoint", "kind": "function", "signature": "createHingeJoint(world, bodyA, bodyB, options = {})", "summary": "Create a hinge joint between two bodies" }, { "name": "createBallJoint", "kind": "function", "signature": "createBallJoint(world, bodyA, bodyB, options = {})", "summary": "Create a ball-socket joint (spherical)" }, { "name": "createSpringJoint", "kind": "function", "signature": "createSpringJoint(world, bodyA, bodyB, options = {})", "summary": "Create a spring/distance joint" }, { "name": "createParticleChain", "kind": "function", "signature": "createParticleChain(options = {})", "summary": "Create a particle chain using PBD (Position-Based Dynamics)" }, { "name": "createChain", "kind": "function", "signature": "createChain(world, options = {})", "summary": "Create a chain of rigid body links" }, { "name": "createSoftBody", "kind": "function", "signature": "createSoftBody(device, options = {})", "summary": "Create a soft body simulation" }, { "name": "generateSoftBodyParticles", "kind": "function", "signature": "generateSoftBodyParticles(sdfFunc, bounds, density = 100)", "summary": "Generate particles for a soft body in a shape" }, { "name": "initFractureSystem", "kind": "function", "signature": "initFractureSystem(device)", "summary": "Initialize fracture system" }, { "name": "preFractureMesh", "kind": "function", "signature": "preFractureMesh(mesh, options = {})", "summary": "Pre-fracture a mesh into fragments" }, { "name": "generateFragmentColliders", "kind": "function", "signature": "generateFragmentColliders(fragments, resolution = 6)", "summary": "Generate colliders for each fragment" }, { "name": "createBreakableCollider", "kind": "function", "signature": "createBreakableCollider(options = {})", "summary": "Create breakable compound collider that fractures on impact" }, { "name": "raycast", "kind": "function", "signature": "raycast(world, origin, direction, maxDistance = 1000)", "summary": "Cast a ray into the physics world" }, { "name": "raycastCone", "kind": "function", "signature": "raycastCone(world, origin, direction, coneAngle, rayCount = 8, maxDistance = 100)", "summary": "Cast multiple rays in a cone pattern (for shotgun spread, vision cone, etc.)" }, { "name": "createTriggerZone", "kind": "function", "signature": "createTriggerZone(shape, size, position = [0, 0, 0])", "summary": "Create a trigger zone collider config" }, { "name": "pointInTrigger", "kind": "function", "signature": "pointInTrigger(point, trigger)", "summary": "Check if a point is inside a trigger zone" }, { "name": "overlapSphere", "kind": "function", "signature": "overlapSphere(center, radius, entities)", "summary": "Find all entities within a sphere (using spatial hash if available)" }, { "name": "overlapBox", "kind": "function", "signature": "overlapBox(center, halfExtents, entities)", "summary": "Find all entities within a box" }, { "name": "getColliderForType", "kind": "function", "signature": "getColliderForType(editor, type)", "summary": "" }, { "name": "getGeometryForType", "kind": "function", "signature": "getGeometryForType(type)", "summary": "" }, { "name": "addSimTime", "kind": "function", "signature": "addSimTime(editor, dt)", "summary": "" }, { "name": "recordHistorySnapshot", "kind": "function", "signature": "recordHistorySnapshot(editor)", "summary": "" }, { "name": "seekToTime", "kind": "function", "signature": "seekToTime(editor, targetTime)", "summary": "" }, { "name": "registerPhysicsSystem", "kind": "function", "signature": "async registerPhysicsSystem(editor)", "summary": "" }, { "name": "createGroundPlane", "kind": "function", "signature": "async createGroundPlane(editor)", "summary": "" }, { "name": "updatePhysicsWorld", "kind": "function", "signature": "async updatePhysicsWorld(editor)", "summary": "" }, { "name": "createMeshColliderDecomposed", "kind": "function", "signature": "createMeshColliderDecomposed(vertices, indices, options = {})", "summary": "Create a mesh collider with automatic convex decomposition for complex shapes. Use this when you have a mesh that's too complex for a single convex hull." }, { "name": "createSDFCollider", "kind": "function", "signature": "createSDFCollider(sdfFunc, bounds, options = {})", "summary": "Create a collider from an SDF function with automatic voxelization. Use this for procedural or mathematical shapes." }, { "name": "createVoxelCollider", "kind": "function", "signature": "createVoxelCollider(voxels, sizeX, sizeY, sizeZ, voxelSize = 0.1)", "summary": "Create a collider grid from a 3D voxel array. Use this when you already have voxel data." }, { "name": "createSDFGridFromFunction", "kind": "function", "signature": "createSDFGridFromFunction(sdfFunc, bounds, resolution = 32)", "summary": "Create an SDF grid for collision detection with complex shapes. Useful for soft-body or particle interactions." }, { "name": "checkSDFCollision", "kind": "function", "signature": "checkSDFCollision(grid, point, radius = 0)", "summary": "Check if a point or sphere collides with an SDF grid." }, { "name": "createPhysicsChain", "kind": "function", "signature": "async createPhysicsChain(editor, startPos, endPos, options = {})", "summary": "Create articulated chain between two points. Use for physics-based chains, ropes, cables." }, { "name": "enableSpeculativeCCDForAll", "kind": "function", "signature": "enableSpeculativeCCDForAll(editor)", "summary": "Enable speculative CCD on all dynamic bodies in the physics world. Helps prevent fast-moving objects from tunneling through thin walls." }, { "name": "createBroadPhaseGrid", "kind": "function", "signature": "createBroadPhaseGrid(cellSize = 1.0)", "summary": "Create a spatial hash grid for fast broad-phase collision queries. Useful for custom collision detection with many objects." }, { "name": "updateBroadPhaseGrid", "kind": "function", "signature": "updateBroadPhaseGrid(editor, grid)", "summary": "Update all bodies in a spatial hash grid from editor entities." }, { "name": "getBroadPhasePairs", "kind": "function", "signature": "getBroadPhasePairs(grid)", "summary": "Get potential collision pairs from broad phase." }, { "name": "createPhysicsRope", "kind": "constant", "signature": "createPhysicsRope", "summary": "" }, { "name": "createRope", "kind": "constant", "signature": "createRope", "summary": "" }, { "name": "BezierSpline", "kind": "re-export", "signature": "BezierSpline", "summary": "" }, { "name": "ConstitutiveModel", "kind": "re-export", "signature": "ConstitutiveModel", "summary": "" }, { "name": "ConstraintType", "kind": "re-export", "signature": "ConstraintType", "summary": "" }, { "name": "CubicBezier", "kind": "re-export", "signature": "CubicBezier", "summary": "" }, { "name": "DistanceConstraint", "kind": "re-export", "signature": "DistanceConstraint", "summary": "" }, { "name": "FRACTURE_PATTERNS", "kind": "re-export", "signature": "FRACTURE_PATTERNS", "summary": "" }, { "name": "GPUSpatialHashGrid", "kind": "re-export", "signature": "GPUSpatialHashGrid", "summary": "" }, { "name": "LineNetwork", "kind": "re-export", "signature": "LineNetwork", "summary": "" }, { "name": "LineToVoxelizer", "kind": "re-export", "signature": "LineToVoxelizer", "summary": "" }, { "name": "MLSMPMSolver", "kind": "re-export", "signature": "MLSMPMSolver", "summary": "" }, { "name": "MaterialPresets", "kind": "re-export", "signature": "MaterialPresets", "summary": "" }, { "name": "NODE_STATUS", "kind": "re-export", "signature": "NODE_STATUS", "summary": "" }, { "name": "NetworkEdge", "kind": "re-export", "signature": "NetworkEdge", "summary": "" }, { "name": "NetworkNode", "kind": "re-export", "signature": "NetworkNode", "summary": "" }, { "name": "PBDParticle", "kind": "re-export", "signature": "PBDParticle", "summary": "" }, { "name": "PBDSolver", "kind": "re-export", "signature": "PBDSolver", "summary": "" }, { "name": "ParticleFlags", "kind": "re-export", "signature": "ParticleFlags", "summary": "" }, { "name": "SCENT_TYPE", "kind": "re-export", "signature": "SCENT_TYPE", "summary": "" }, { "name": "SDFGrid", "kind": "re-export", "signature": "SDFGrid", "summary": "" }, { "name": "SDFOperations", "kind": "re-export", "signature": "SDFOperations", "summary": "" }, { "name": "SDFPrimitives", "kind": "re-export", "signature": "SDFPrimitives", "summary": "" }, { "name": "ShockPropagationSolver", "kind": "re-export", "signature": "ShockPropagationSolver", "summary": "" }, { "name": "SpatialHash", "kind": "re-export", "signature": "SpatialHash", "summary": "" }, { "name": "SpatialHashGrid", "kind": "re-export", "signature": "SpatialHashGrid", "summary": "" }, { "name": "SpeculativeContactsSolver", "kind": "re-export", "signature": "SpeculativeContactsSolver", "summary": "" }, { "name": "VoronoiFracture", "kind": "re-export", "signature": "VoronoiFracture", "summary": "" }, { "name": "VoxelMaterials", "kind": "re-export", "signature": "VoxelMaterials", "summary": "" }, { "name": "aabbAABB", "kind": "re-export", "signature": "aabbAABB", "summary": "" }, { "name": "addArticulationToScene", "kind": "re-export", "signature": "addArticulationToScene", "summary": "" }, { "name": "addToSpatialHash", "kind": "re-export", "signature": "addToSpatialHash", "summary": "" }, { "name": "applyFriction", "kind": "re-export", "signature": "applyFriction", "summary": "" }, { "name": "applyShockPropagation", "kind": "re-export", "signature": "applyShockPropagation", "summary": "" }, { "name": "arrive", "kind": "re-export", "signature": "arrive", "summary": "" }, { "name": "canHear", "kind": "re-export", "signature": "canHear", "summary": "" }, { "name": "canSee", "kind": "re-export", "signature": "canSee", "summary": "" }, { "name": "clearAllWelds", "kind": "re-export", "signature": "clearAllWelds", "summary": "" }, { "name": "clearColliderSpatialHash", "kind": "re-export", "signature": "clearColliderSpatialHash", "summary": "" }, { "name": "computeBounce", "kind": "re-export", "signature": "computeBounce", "summary": "" }, { "name": "computeColliderAABB", "kind": "re-export", "signature": "computeColliderAABB", "summary": "" }, { "name": "createAIAgent", "kind": "re-export", "signature": "createAIAgent", "summary": "" }, { "name": "createAIPerception", "kind": "re-export", "signature": "createAIPerception", "summary": "" }, { "name": "createAction", "kind": "re-export", "signature": "createAction", "summary": "" }, { "name": "createArticulation", "kind": "re-export", "signature": "createArticulation", "summary": "" }, { "name": "createChaseFleeBehavior", "kind": "re-export", "signature": "createChaseFleeBehavior", "summary": "" }, { "name": "createChildLink", "kind": "re-export", "signature": "createChildLink", "summary": "" }, { "name": "createCondition", "kind": "re-export", "signature": "createCondition", "summary": "" }, { "name": "createD6Joint", "kind": "re-export", "signature": "createD6Joint", "summary": "" }, { "name": "createDangerSense", "kind": "re-export", "signature": "createDangerSense", "summary": "" }, { "name": "createDecomposedCollider", "kind": "re-export", "signature": "createDecomposedCollider", "summary": "" }, { "name": "createDistanceJoint", "kind": "re-export", "signature": "createDistanceJoint", "summary": "" }, { "name": "createFlock", "kind": "re-export", "signature": "createFlock", "summary": "" }, { "name": "createNavGrid", "kind": "re-export", "signature": "createNavGrid", "summary": "" }, { "name": "createPatrolBehavior", "kind": "re-export", "signature": "createPatrolBehavior", "summary": "" }, { "name": "createPhysXRope", "kind": "re-export", "signature": "createPhysXRope", "summary": "" }, { "name": "createRevoluteJoint", "kind": "re-export", "signature": "createRevoluteJoint", "summary": "" }, { "name": "createRootLink", "kind": "re-export", "signature": "createRootLink", "summary": "" }, { "name": "createSDFFromMesh", "kind": "re-export", "signature": "createSDFFromMesh", "summary": "" }, { "name": "createScentParticle", "kind": "re-export", "signature": "createScentParticle", "summary": "" }, { "name": "createScentSystem", "kind": "re-export", "signature": "createScentSystem", "summary": "" }, { "name": "createScentTrail", "kind": "re-export", "signature": "createScentTrail", "summary": "" }, { "name": "createSelector", "kind": "re-export", "signature": "createSelector", "summary": "" }, { "name": "createSequence", "kind": "re-export", "signature": "createSequence", "summary": "" }, { "name": "createSphericalJoint", "kind": "re-export", "signature": "createSphericalJoint", "summary": "" }, { "name": "createSteeringAgent", "kind": "re-export", "signature": "createSteeringAgent", "summary": "" }, { "name": "decomposeMesh", "kind": "re-export", "signature": "decomposeMesh", "summary": "" }, { "name": "elasticCollision", "kind": "re-export", "signature": "elasticCollision", "summary": "" }, { "name": "enablePhysXSpeculativeCCD", "kind": "re-export", "signature": "enablePhysXSpeculativeCCD", "summary": "" }, { "name": "evade", "kind": "re-export", "signature": "evade", "summary": "" }, { "name": "fbm3D", "kind": "re-export", "signature": "fbm3D", "summary": "" }, { "name": "findPath", "kind": "re-export", "signature": "findPath", "summary": "" }, { "name": "findPathInNavWorld", "kind": "re-export", "signature": "findPathInNavWorld", "summary": "" }, { "name": "findPathOnGrid", "kind": "re-export", "signature": "findPathOnGrid", "summary": "" }, { "name": "flee", "kind": "re-export", "signature": "flee", "summary": "" }, { "name": "flock", "kind": "re-export", "signature": "flock", "summary": "" }, { "name": "followScentTrail", "kind": "re-export", "signature": "followScentTrail", "summary": "" }, { "name": "generateBezierColliders", "kind": "re-export", "signature": "generateBezierColliders", "summary": "" }, { "name": "generateCaveColliders", "kind": "re-export", "signature": "generateCaveColliders", "summary": "" }, { "name": "generateCollidersFromNetwork", "kind": "re-export", "signature": "generateCollidersFromNetwork", "summary": "" }, { "name": "generateCollidersFromSDF", "kind": "re-export", "signature": "generateCollidersFromSDF", "summary": "" }, { "name": "generateConvexMeshFromSDF", "kind": "re-export", "signature": "generateConvexMeshFromSDF", "summary": "" }, { "name": "generateCurveColliders", "kind": "re-export", "signature": "generateCurveColliders", "summary": "" }, { "name": "generateHollowConeColliders", "kind": "re-export", "signature": "generateHollowConeColliders", "summary": "" }, { "name": "generateHollowTorusColliders", "kind": "re-export", "signature": "generateHollowTorusColliders", "summary": "" }, { "name": "generateLineColliders", "kind": "re-export", "signature": "generateLineColliders", "summary": "" }, { "name": "generateNoisyColliders", "kind": "re-export", "signature": "generateNoisyColliders", "summary": "" }, { "name": "generatePipeNetworkColliders", "kind": "re-export", "signature": "generatePipeNetworkColliders", "summary": "" }, { "name": "generateRockFieldColliders", "kind": "re-export", "signature": "generateRockFieldColliders", "summary": "" }, { "name": "generateRockySphereColliders", "kind": "re-export", "signature": "generateRockySphereColliders", "summary": "" }, { "name": "generateRootColliders", "kind": "re-export", "signature": "generateRootColliders", "summary": "" }, { "name": "generateScatteredColliders", "kind": "re-export", "signature": "generateScatteredColliders", "summary": "" }, { "name": "generateSplineColliders", "kind": "re-export", "signature": "generateSplineColliders", "summary": "" }, { "name": "generateTerrainColliders", "kind": "re-export", "signature": "generateTerrainColliders", "summary": "" }, { "name": "generateTreeColliders", "kind": "re-export", "signature": "generateTreeColliders", "summary": "" }, { "name": "generateTunnelColliders", "kind": "re-export", "signature": "generateTunnelColliders", "summary": "" }, { "name": "getArticulationLinkTransforms", "kind": "re-export", "signature": "getArticulationLinkTransforms", "summary": "" }, { "name": "getLastKnownPosition", "kind": "re-export", "signature": "getLastKnownPosition", "summary": "" }, { "name": "getNavGridVisualization", "kind": "re-export", "signature": "getNavGridVisualization", "summary": "" }, { "name": "getOrCreateNavGrid", "kind": "re-export", "signature": "getOrCreateNavGrid", "summary": "" }, { "name": "getPathSteering", "kind": "re-export", "signature": "getPathSteering", "summary": "" }, { "name": "getPhysXJointCapabilities", "kind": "re-export", "signature": "getPhysXJointCapabilities", "summary": "" }, { "name": "gridToWorld", "kind": "re-export", "signature": "gridToWorld", "summary": "" }, { "name": "initColliderSpatialHash", "kind": "re-export", "signature": "initColliderSpatialHash", "summary": "" }, { "name": "linearMotion", "kind": "re-export", "signature": "linearMotion", "summary": "" }, { "name": "mulberry32", "kind": "re-export", "signature": "mulberry32", "summary": "" }, { "name": "perlin3D", "kind": "re-export", "signature": "perlin3D", "summary": "" }, { "name": "planeCollisionResponse", "kind": "re-export", "signature": "planeCollisionResponse", "summary": "" }, { "name": "pointInAABB", "kind": "re-export", "signature": "pointInAABB", "summary": "" }, { "name": "pointInSphere", "kind": "re-export", "signature": "pointInSphere", "summary": "" }, { "name": "predictLanding", "kind": "re-export", "signature": "predictLanding", "summary": "" }, { "name": "projectileMotion", "kind": "re-export", "signature": "projectileMotion", "summary": "" }, { "name": "projectilePosition", "kind": "re-export", "signature": "projectilePosition", "summary": "" }, { "name": "pursue", "kind": "re-export", "signature": "pursue", "summary": "" }, { "name": "queryNearbyColliders", "kind": "re-export", "signature": "queryNearbyColliders", "summary": "" }, { "name": "randomInSphere", "kind": "re-export", "signature": "randomInSphere", "summary": "" }, { "name": "randomOnSphere", "kind": "re-export", "signature": "randomOnSphere", "summary": "" }, { "name": "raycastWorld", "kind": "re-export", "signature": "raycastWorld", "summary": "" }, { "name": "ridged3D", "kind": "re-export", "signature": "ridged3D", "summary": "" }, { "name": "sdfBox3D", "kind": "re-export", "signature": "sdfBox3D", "summary": "" }, { "name": "sdfCapsule", "kind": "re-export", "signature": "sdfCapsule", "summary": "" }, { "name": "sdfCone", "kind": "re-export", "signature": "sdfCone", "summary": "" }, { "name": "sdfCylinder", "kind": "re-export", "signature": "sdfCylinder", "summary": "" }, { "name": "sdfIntersect", "kind": "re-export", "signature": "sdfIntersect", "summary": "" }, { "name": "sdfOnion", "kind": "re-export", "signature": "sdfOnion", "summary": "" }, { "name": "sdfSmoothUnion", "kind": "re-export", "signature": "sdfSmoothUnion", "summary": "" }, { "name": "sdfSphere", "kind": "re-export", "signature": "sdfSphere", "summary": "" }, { "name": "sdfSubtract", "kind": "re-export", "signature": "sdfSubtract", "summary": "" }, { "name": "sdfTorus", "kind": "re-export", "signature": "sdfTorus", "summary": "" }, { "name": "sdfUnion", "kind": "re-export", "signature": "sdfUnion", "summary": "" }, { "name": "seek", "kind": "re-export", "signature": "seek", "summary": "" }, { "name": "senseDanger", "kind": "re-export", "signature": "senseDanger", "summary": "" }, { "name": "setAutoWeld", "kind": "re-export", "signature": "setAutoWeld", "summary": "" }, { "name": "setRandomSeed", "kind": "re-export", "signature": "setRandomSeed", "summary": "" }, { "name": "simplex3D", "kind": "re-export", "signature": "simplex3D", "summary": "" }, { "name": "smellAt", "kind": "re-export", "signature": "smellAt", "summary": "" }, { "name": "smoothPath", "kind": "re-export", "signature": "smoothPath", "summary": "" }, { "name": "sphereAABB", "kind": "re-export", "signature": "sphereAABB", "summary": "" }, { "name": "sphereCollisionResponse", "kind": "re-export", "signature": "sphereCollisionResponse", "summary": "" }, { "name": "sphereSphere", "kind": "re-export", "signature": "sphereSphere", "summary": "" }, { "name": "straightLine", "kind": "re-export", "signature": "straightLine", "summary": "" }, { "name": "testAABBAABB", "kind": "re-export", "signature": "testAABBAABB", "summary": "" }, { "name": "testSphereAABB", "kind": "re-export", "signature": "testSphereAABB", "summary": "" }, { "name": "testSphereSphere", "kind": "re-export", "signature": "testSphereSphere", "summary": "" }, { "name": "tickBehaviorTree", "kind": "re-export", "signature": "tickBehaviorTree", "summary": "" }, { "name": "tickNode", "kind": "re-export", "signature": "tickNode", "summary": "" }, { "name": "updateAIAgent", "kind": "re-export", "signature": "updateAIAgent", "summary": "" }, { "name": "updateAIPerception", "kind": "re-export", "signature": "updateAIPerception", "summary": "" }, { "name": "updateFlock", "kind": "re-export", "signature": "updateFlock", "summary": "" }, { "name": "updateNavGridFromColliders", "kind": "re-export", "signature": "updateNavGridFromColliders", "summary": "" }, { "name": "voronoi3D", "kind": "re-export", "signature": "voronoi3D", "summary": "" }, { "name": "wander", "kind": "re-export", "signature": "wander", "summary": "" }, { "name": "worldToGrid", "kind": "re-export", "signature": "worldToGrid", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorPhysicsSim", "path": "editor/reference/modules/EditorPhysicsSim.md", "source": "editor/js/modules/EditorPhysicsSim.js", "import": "/editor/js/modules/EditorPhysicsSim.js", "sourceHash": "78a1d8ac11b0233db08531ed42d155eaf8764a7000fdaa17cfd8be833dacf68e", "summary": "EditorPhysicsSim.js - Physics Simulation Management for Editor Manages rope, wire, hair, cloth, and soft body simulations in the editor. Uses PBD solver with OGC contact model for penetration-free simulation.", "exports": [ { "name": "initRopeSimulation", "kind": "function", "signature": "initRopeSimulation(editor, entityId, position, opts)", "summary": "Initialize rope simulation for an entity" }, { "name": "initRopeSimulationBetweenPoints", "kind": "function", "signature": "initRopeSimulationBetweenPoints(editor, entityId, startPos, endPos, opts)", "summary": "Initialize rope simulation between two points (for tool-created ropes)" }, { "name": "initRopeSimulationFromComponent", "kind": "function", "signature": "initRopeSimulationFromComponent(editor, entityId)", "summary": "" }, { "name": "initPhysXRopeSimulation", "kind": "function", "signature": "initPhysXRopeSimulation(editor, entityId, startPos, endPos, opts)", "summary": "Initialize PhysX articulation-based rope simulation Uses NVIDIA PhysX for more stable, unified physics simulation" }, { "name": "initGPURopeSimulation", "kind": "function", "signature": "initGPURopeSimulation(editor, entityId, startPos, endPos, opts)", "summary": "Initialize GPU-based rope simulation using unified particle system Uses GPU constraint solver for native rope physics (Phase 2)" }, { "name": "initWireSimulation", "kind": "function", "signature": "initWireSimulation(editor, entityId, position, opts)", "summary": "" }, { "name": "initHairSimulation", "kind": "function", "signature": "initHairSimulation(editor, entityId, position, opts)", "summary": "" }, { "name": "initChainSimulation", "kind": "function", "signature": "initChainSimulation(editor, entityId, position, opts)", "summary": "" }, { "name": "initClothSimulation", "kind": "function", "signature": "async initClothSimulation(editor, entityId, position, opts)", "summary": "" }, { "name": "initSoftBodySimulation", "kind": "function", "signature": "initSoftBodySimulation(editor, entityId, position, opts)", "summary": "" }, { "name": "initSoftBodyFromMesh", "kind": "function", "signature": "async initSoftBodyFromMesh(editor, entityId, meshPositions, meshIndices, opts = {})", "summary": "Initialize a soft body from an arbitrary surface mesh using AutoTetMesh. Converts the surface mesh to a tetrahedral volume mesh, then creates PBD particles and constraints from the tet nodes." }, { "name": "initBalloonSimulation", "kind": "function", "signature": "initBalloonSimulation(editor, entityId, position, opts)", "summary": "Initialize balloon simulation (pressure-based soft body)" }, { "name": "initFluidSimulation", "kind": "function", "signature": "initFluidSimulation(editor, entityId, position, opts)", "summary": "Initialize fluid simulation (SPH density-based)" }, { "name": "stepPhysicsSimulations", "kind": "function", "signature": "stepPhysicsSimulations(editor, dt)", "summary": "Step all physics simulations" }, { "name": "syncSimulationsToComponents", "kind": "function", "signature": "syncSimulationsToComponents(editor)", "summary": "Sync all active simulation particle data to ECS components. Call this before saving the scene to ensure particles are persisted." }, { "name": "initTwistedRopeSimulation", "kind": "function", "signature": "initTwistedRopeSimulation(editor, entityId, startPos, endPos, opts = {})", "summary": "Initialize a twisted rope simulation with multiple threads Creates helical thread arrangement that twists together like real rope fibers" }, { "name": "destroyPhysicsSimulation", "kind": "function", "signature": "destroyPhysicsSimulation(editor, entityId, options = {})", "summary": "Destroy a physics simulation." }, { "name": "updateRopeForAnchorMove", "kind": "function", "signature": "updateRopeForAnchorMove(editor, ropeEntityId)", "summary": "" }, { "name": "updateRopesForEntityMove", "kind": "function", "signature": "updateRopesForEntityMove(editor, movedEntityId)", "summary": "Check all ropes that are attached to a given entity and update them. Call this when an entity's transform changes in edit mode." }, { "name": "setupPhysicsSim", "kind": "function", "signature": "setupPhysicsSim(editor)", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorPointCloud", "path": "editor/reference/modules/EditorPointCloud.md", "source": "editor/js/modules/EditorPointCloud.js", "import": "/editor/js/modules/EditorPointCloud.js", "sourceHash": "f3a03b54c3fb686b110725b8d33341df54fb0f2587163fbecc495b1970faed3f", "summary": "============================================================================ EditorPointCloud.js — Point cloud entity management Handles spawning point cloud entities from asset files (PLY/PCD/XYZ), managing the PointCloud component, and bridging to the EntityMeshRenderer point-sprite render pass. ============================================================================", "exports": [ { "name": "spawnPointCloudAsset", "kind": "function", "signature": "async spawnPointCloudAsset(editor, asset)", "summary": "Load a point cloud asset, parse it, and create an entity in the scene." }, { "name": "spawnPointCloudEntity", "kind": "function", "signature": "spawnPointCloudEntity(editor, pcData, opts = {})", "summary": "Create a point cloud entity from raw point data." }, { "name": "unregisterPointCloud", "kind": "function", "signature": "unregisterPointCloud(editor, entityId)", "summary": "Unregister a point cloud entity from the renderer." }, { "name": "getPointCloudData", "kind": "function", "signature": "getPointCloudData(editor, entityId)", "summary": "Get point cloud data for an entity (reads PointCloud component)." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorScene", "path": "editor/reference/modules/EditorScene.md", "source": "editor/js/modules/EditorScene.js", "import": "/editor/js/modules/EditorScene.js", "sourceHash": "4ba84c30c28325f8e9d73656ca97c42d1e2fd070ea24db7f408b7fcd702225fb", "summary": "Get all entities in a welded group (parent + all children) If the entity is a child, finds its parent and returns the whole group If the entity is a parent, returns itself + all children If not welded, returns just the entity", "exports": [ { "name": "createEntity", "kind": "function", "signature": "createEntity(editor, name = 'Entity', options = {})", "summary": "" }, { "name": "selectEntity", "kind": "function", "signature": "selectEntity(editor, entityId)", "summary": "" }, { "name": "getWeldedGroup", "kind": "function", "signature": "getWeldedGroup(editor, entityId)", "summary": "Get all entities in a welded group (parent + all children) If the entity is a child, finds its parent and returns the whole group If the entity is a parent, returns itself + all children If not welded, returns just the entity" }, { "name": "deleteEntity", "kind": "function", "signature": "async deleteEntity(editor, entityId)", "summary": "" }, { "name": "createFolder", "kind": "function", "signature": "createFolder(editor, name = 'New Folder', parentId = null)", "summary": "" }, { "name": "setFolderParent", "kind": "function", "signature": "setFolderParent(editor, folderId, parentId)", "summary": "" }, { "name": "renameEntity", "kind": "function", "signature": "renameEntity(editor, entityId, newName)", "summary": "" }, { "name": "renameFolder", "kind": "function", "signature": "renameFolder(editor, folderId, newName)", "summary": "" }, { "name": "deleteFolder", "kind": "function", "signature": "deleteFolder(editor, folderId)", "summary": "" }, { "name": "setEntityParent", "kind": "function", "signature": "setEntityParent(editor, entityId, parentId)", "summary": "" }, { "name": "moveEntityToFolder", "kind": "function", "signature": "moveEntityToFolder(editor, entityId, folderId)", "summary": "" }, { "name": "captureWorldSnapshot", "kind": "function", "signature": "captureWorldSnapshot(editor)", "summary": "" }, { "name": "captureWorldSnapshotDelta", "kind": "function", "signature": "captureWorldSnapshotDelta(editor)", "summary": "" }, { "name": "restoreWorldSnapshot", "kind": "function", "signature": "restoreWorldSnapshot(editor, snapshot)", "summary": "" }, { "name": "loadScene", "kind": "function", "signature": "async loadScene(editor, scenePath)", "summary": "" }, { "name": "saveScene", "kind": "function", "signature": "async saveScene(editor)", "summary": "" }, { "name": "cleanupInvalidEntities", "kind": "function", "signature": "cleanupInvalidEntities(editor, intervalMs = 1000)", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorSettings", "path": "editor/reference/modules/EditorSettings.md", "source": "editor/js/modules/EditorSettings.js", "import": "/editor/js/modules/EditorSettings.js", "sourceHash": "64488e796fd27229ba052fac79f30e4a6f0a6d2154a85487ae43f3b595b327dd", "summary": "EditorSettings.js - Global Editor Settings with Persistence Features: - Centralized settings management - localStorage persistence - Settings UI with categories/tabs - Live preview of changes", "exports": [ { "name": "showSettingsDialog", "kind": "function", "signature": "showSettingsDialog()", "summary": "" }, { "name": "editorSettings", "kind": "constant", "signature": "editorSettings", "summary": "" }, { "name": "DEFAULT_SETTINGS", "kind": "re-export", "signature": "DEFAULT_SETTINGS", "summary": "" }, { "name": "SETTINGS_METADATA", "kind": "re-export", "signature": "SETTINGS_METADATA", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorSpawnMenu", "path": "editor/reference/modules/EditorSpawnMenu.md", "source": "editor/js/modules/EditorSpawnMenu.js", "import": "/editor/js/modules/EditorSpawnMenu.js", "sourceHash": "1e434a69cf2af629f3ad5efecd698e3e785f3e9aa9377fa7ea6a4ef3de578e70", "summary": "", "exports": [ { "name": "setupSpawnMenu", "kind": "function", "signature": "setupSpawnMenu(editor)", "summary": "" }, { "name": "renderSpawnCategories", "kind": "function", "signature": "renderSpawnCategories(editor)", "summary": "" }, { "name": "renderSpawnGrid", "kind": "function", "signature": "renderSpawnGrid(editor)", "summary": "" }, { "name": "spawnFromMenu", "kind": "function", "signature": "spawnFromMenu(editor, item)", "summary": "" }, { "name": "createEmitter", "kind": "function", "signature": "createEmitter(editor, markerEntityId, type = 'gas')", "summary": "" }, { "name": "getEmitterColor", "kind": "function", "signature": "getEmitterColor(type)", "summary": "" }, { "name": "toggleSpawnMenu", "kind": "function", "signature": "toggleSpawnMenu(editor)", "summary": "" }, { "name": "openSpawnMenu", "kind": "function", "signature": "openSpawnMenu(editor)", "summary": "" }, { "name": "closeSpawnMenu", "kind": "function", "signature": "closeSpawnMenu(editor)", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorTools", "path": "editor/reference/modules/EditorTools.md", "source": "editor/js/modules/EditorTools.js", "import": "/editor/js/modules/EditorTools.js", "sourceHash": "32096585bb4126a4ff0bd2c6500b8c8b9633c3ae11ba61a817ae96d1f1b8681e", "summary": "EditorTools.js - GMod-style Tool System Manages interactive tools like chain tool, weld tool, constraint tool. Tools are activated from spawn menu and handle click events in viewport.", "exports": [ { "name": "ToolManager", "kind": "class", "signature": "class ToolManager", "summary": "" }, { "name": "setupTools", "kind": "function", "signature": "setupTools(editor)", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorTransitions", "path": "editor/reference/modules/EditorTransitions.md", "source": "editor/js/modules/EditorTransitions.js", "import": "/editor/js/modules/EditorTransitions.js", "sourceHash": "cbc2634692fd4b08241eade27eb6796d12a9656b03268f9f02d65f2eadffdd86", "summary": "EditorTransitions.js - Transition Effects System Features: - Multiple transition effects (fade, dissolve, pixelate, wipe, zoom, etc.) - Canvas-based effects for complex transitions - Random effect selection - Configurable duration and easing - Can be used for dialogs, scenes, or any UI element", "exports": [ { "name": "transitions", "kind": "constant", "signature": "transitions", "summary": "" }, { "name": "EASINGS", "kind": "re-export", "signature": "EASINGS", "summary": "" }, { "name": "TRANSITIONS", "kind": "re-export", "signature": "TRANSITIONS", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorUI", "path": "editor/reference/modules/EditorUI.md", "source": "editor/js/modules/EditorUI.js", "import": "/editor/js/modules/EditorUI.js", "sourceHash": "db12507910225fd10e28fa70c6c7d8dc5f3a61b78fc90657c76b20e23815140f", "summary": "============================================================================ EditorUI.js - UI Setup and Menu Handling ============================================================================", "exports": [ { "name": "showPrompt", "kind": "function", "signature": "showPrompt(title, message, defaultValue = '')", "summary": "Show a custom prompt dialog" }, { "name": "showConfirm", "kind": "function", "signature": "showConfirm(title, message, options = {})", "summary": "Show a custom confirm dialog" }, { "name": "showAlert", "kind": "function", "signature": "showAlert(title, message)", "summary": "Show a custom alert dialog" }, { "name": "setupInspectorTabs", "kind": "function", "signature": "setupInspectorTabs(editor)", "summary": "" }, { "name": "setupResizablePanels", "kind": "function", "signature": "setupResizablePanels(editor)", "summary": "" }, { "name": "setupConsoleResize", "kind": "function", "signature": "setupConsoleResize(editor, saveSizes)", "summary": "" }, { "name": "setupToolbar", "kind": "function", "signature": "setupToolbar(editor)", "summary": "" }, { "name": "setupSceneSelector", "kind": "function", "signature": "setupSceneSelector(editor)", "summary": "Setup scene selector dropdown in viewport header" }, { "name": "refreshSceneSelector", "kind": "function", "signature": "async refreshSceneSelector(editor)", "summary": "Refresh scene selector with available scenes" }, { "name": "setupViewportToolbar", "kind": "function", "signature": "setupViewportToolbar(editor)", "summary": "" }, { "name": "updateToolbarState", "kind": "function", "signature": "updateToolbarState(editor)", "summary": "" }, { "name": "handleMenuAction", "kind": "function", "signature": "async handleMenuAction(editor, action)", "summary": "" }, { "name": "setupTimelineScrubbing", "kind": "function", "signature": "setupTimelineScrubbing(editor)", "summary": "" }, { "name": "updateTimelineUI", "kind": "function", "signature": "updateTimelineUI(editor, skipMarkers = false)", "summary": "" }, { "name": "setupBottomTabs", "kind": "function", "signature": "setupBottomTabs(editor)", "summary": "" }, { "name": "setupConsole", "kind": "function", "signature": "setupConsole(editor)", "summary": "" }, { "name": "addConsoleLine", "kind": "function", "signature": "addConsoleLine(editor, type, text)", "summary": "" }, { "name": "isTypingInUi", "kind": "function", "signature": "isTypingInUi()", "summary": "" }, { "name": "showContextMenu", "kind": "re-export", "signature": "showContextMenu", "summary": "" }, { "name": "toast", "kind": "re-export", "signature": "toast", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorUIComponents", "path": "editor/reference/modules/EditorUIComponents.md", "source": "editor/js/modules/EditorUIComponents.js", "import": "/editor/js/modules/EditorUIComponents.js", "sourceHash": "04f1f44a2520ebb1afaa4d136175eb50c1041d1c3175556256ae786ea045b2ce", "summary": "Show a toast notification", "exports": [ { "name": "showToast", "kind": "function", "signature": "showToast(message, options = {})", "summary": "Show a toast notification" }, { "name": "setTheme", "kind": "function", "signature": "setTheme(themeName)", "summary": "Apply a theme by name - delegates to themeManager" }, { "name": "getCurrentTheme", "kind": "function", "signature": "getCurrentTheme()", "summary": "Get current theme name" }, { "name": "getThemes", "kind": "function", "signature": "getThemes()", "summary": "Get all available themes" }, { "name": "initTheme", "kind": "function", "signature": "initTheme()", "summary": "Initialize theme from localStorage" }, { "name": "showThemePicker", "kind": "function", "signature": "showThemePicker()", "summary": "Show theme picker dialog with categories" }, { "name": "showContextMenu", "kind": "function", "signature": "showContextMenu(event, items)", "summary": "Show a custom context menu" }, { "name": "hideContextMenu", "kind": "function", "signature": "hideContextMenu()", "summary": "" }, { "name": "initTooltips", "kind": "function", "signature": "initTooltips()", "summary": "Initialize tooltip system" }, { "name": "showShortcutsHelp", "kind": "function", "signature": "showShortcutsHelp()", "summary": "Show keyboard shortcuts overlay" }, { "name": "initUIComponents", "kind": "function", "signature": "initUIComponents()", "summary": "" }, { "name": "toast", "kind": "constant", "signature": "toast", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EditorWelding", "path": "editor/reference/modules/EditorWelding.md", "source": "editor/js/modules/EditorWelding.js", "import": "/editor/js/modules/EditorWelding.js", "sourceHash": "73359e558661f8e3f890de8cc23a17e4484ad7e2bf061ff4de7cd1b5ddb4fa5b", "summary": "EditorWelding.js - Auto-weld system for physics bodies Extracted from EditorPhysics.js for modularity Features: - Auto-weld colliding bodies into rigid compounds - D6 joint-based welding with PhysX optimizations - ECS component persistence for scene save/load - Emitter weld pre-scanning", "exports": [ { "name": "createFixedJoint", "kind": "function", "signature": "createFixedJoint(editor, bodyA, bodyB, entityB)", "summary": "Create a fixed joint between two bodies Uses D6 joint locked in all axes with PhysX optimizations" }, { "name": "restoreWeldsFromComponents", "kind": "function", "signature": "restoreWeldsFromComponents(editor)", "summary": "Restore welds from WeldConstraint components (for scene load)" }, { "name": "performInitialWelding", "kind": "function", "signature": "performInitialWelding(editor)", "summary": "Perform initial welding of nearby bodies before simulation starts. Graph-based approach: 1. Filter eligible entities (skip ragdolls, skinned meshes, spheres/capsules) 2. Find all directly-touching pairs via AABB overlap 3. Create joints for each touching pair 4. detectWeldGroups (called after) finds connected components from joints Spheres and capsules are excluded because they are projectiles/characters, not structural elements. Only box/convexMesh entities form weldable structures." }, { "name": "setAutoWeld", "kind": "function", "signature": "setAutoWeld(editor, enabled)", "summary": "Enable/disable auto-welding of colliding bodies" }, { "name": "processWeldContacts", "kind": "function", "signature": "processWeldContacts(editor)", "summary": "Process potential welds by checking body proximity (runtime)" }, { "name": "clearAllWelds", "kind": "function", "signature": "clearAllWelds(editor)", "summary": "Break all welds and reset" }, { "name": "preScanEmitterWelds", "kind": "function", "signature": "preScanEmitterWelds(editor)", "summary": "Pre-scan to detect which emitters should be welded based on AABB surface proximity. Uses entity scale and physics body extents to compute surface-to-surface distance, so emitters touching any face of a large/tall object get welded correctly." }, { "name": "detectWeldGroups", "kind": "function", "signature": "detectWeldGroups(editor)", "summary": "Detect connected components of welded entities (weld groups). Runs AFTER performInitialWelding — uses editor.weldParentChildren + weldJoints. Outputs stored on editor: weldGroups: Map> (root included in set) weldChildToRoot: Map (O(1) render skip) weldGroupLocalTransforms: Map" }, { "name": "buildWeldGroupMeshes", "kind": "function", "signature": "buildWeldGroupMeshes(editor, entityMeshRenderer, inferMeshTypeFn)", "summary": "Build merged meshes for each weld group and register them with EntityMeshRenderer. Follows Unity CombineMeshes pattern: transform child vertices into root's local space. Also stores per-member mesh segment info for per-frame vertex updates." }, { "name": "syncWeldedEntities", "kind": "function", "signature": "syncWeldedEntities(editor, rotateVectorByQuatFn)", "summary": "Sync welded child entity transforms to their parent bodies Called from stepPhysics loop" }, { "name": "rotateVectorByQuat", "kind": "re-export", "signature": "rotateVectorByQuat", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/EntitySchema", "path": "editor/reference/modules/EntitySchema.md", "source": "editor/js/modules/EntitySchema.js", "import": "/editor/js/modules/EntitySchema.js", "sourceHash": "9075a367d2be34df865573d3fb839aab0817e1be22ba69790ace78085e9e65c5", "summary": "Generate a full JSON schema for an entity", "exports": [ { "name": "generateEntitySchema", "kind": "function", "signature": "generateEntitySchema(editor, entityId)", "summary": "Generate a full JSON schema for an entity" }, { "name": "generateSceneSchema", "kind": "function", "signature": "generateSceneSchema(editor)", "summary": "Generate schemas for all entities in the scene" }, { "name": "exportSceneToJSON", "kind": "function", "signature": "exportSceneToJSON(editor, pretty = true)", "summary": "Export scene schema to JSON string" }, { "name": "debugEntitySchema", "kind": "function", "signature": "debugEntitySchema(editor, entityId)", "summary": "Print entity schema to console (for debugging)" }, { "name": "debugSceneSchema", "kind": "function", "signature": "debugSceneSchema(editor)", "summary": "Print full scene schema to console (for debugging)" }, { "name": "getRelationshipSummary", "kind": "function", "signature": "getRelationshipSummary(editor, entityId)", "summary": "Get a summary of entity relationships" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/GeometryBuilders", "path": "editor/reference/modules/GeometryBuilders.md", "source": "editor/js/modules/GeometryBuilders.js", "import": "/editor/js/modules/GeometryBuilders.js", "sourceHash": "a1c318aeafa8252015706b6eb5c40a20a1a5fa7d03904b1158970f4670ac0274", "summary": "GeometryBuilders.js - Procedural geometry generation for physics colliders Extracted from EditorPhysics.js for modularity", "exports": [ { "name": "createWedgeGeometry", "kind": "function", "signature": "createWedgeGeometry()", "summary": "Create wedge/ramp geometry - flat bottom, sloped top" }, { "name": "createPrismGeometry", "kind": "function", "signature": "createPrismGeometry()", "summary": "Create hexagonal prism geometry" }, { "name": "createStairsGeometry", "kind": "function", "signature": "createStairsGeometry()", "summary": "Create stairs geometry (4 steps)" }, { "name": "createArchGeometry", "kind": "function", "signature": "createArchGeometry()", "summary": "Create arch geometry with legs and curved top" }, { "name": "createHelixGeometry", "kind": "function", "signature": "createHelixGeometry()", "summary": "Create helix/spring geometry" }, { "name": "createGearGeometry", "kind": "function", "signature": "createGearGeometry()", "summary": "Create gear geometry with teeth" }, { "name": "createStarGeometry", "kind": "function", "signature": "createStarGeometry()", "summary": "Create 5-point star geometry" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/HotkeyManager", "path": "editor/reference/modules/HotkeyManager.md", "source": "editor/js/modules/HotkeyManager.js", "import": "/editor/js/modules/HotkeyManager.js", "sourceHash": "c134ea2f1ecafdb513b204b761cee9edc47377d43af5597634f0e5c0dd9aa21a", "summary": "HotkeyManager.js - Centralized Hotkey System with YAML-style Configuration Features: - Centralized hotkey definitions - Easy configuration via config object (YAML-style) - Runtime hotkey rebinding - Hotkey editor UI - localStorage persistence for custom bindings - Conflict detection", "exports": [ { "name": "showHotkeyEditor", "kind": "function", "signature": "showHotkeyEditor()", "summary": "" }, { "name": "DEFAULT_HOTKEYS", "kind": "re-export", "signature": "DEFAULT_HOTKEYS", "summary": "" }, { "name": "hotkeyManager", "kind": "re-export", "signature": "hotkeyManager", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/LoadingManager", "path": "editor/reference/modules/LoadingManager.md", "source": "editor/js/modules/LoadingManager.js", "import": "/editor/js/modules/LoadingManager.js", "sourceHash": "50cda92dbe845c1833c7a286b8e8241b932b65df03453c7964b6db79878964c5", "summary": "LoadingManager.js - Advanced loading system with progress tracking Manages dynamic loading of editor components with real progress, stage tracking, and a polished loading screen UI.", "exports": [ { "name": "LoadingManager", "kind": "class", "signature": "class LoadingManager", "summary": "LoadingManager - Tracks and displays loading progress" }, { "name": "getLoadingManager", "kind": "function", "signature": "getLoadingManager()", "summary": "" }, { "name": "loadingStage", "kind": "function", "signature": "loadingStage(stageId, subtitle = '')", "summary": "" }, { "name": "loadingProgress", "kind": "function", "signature": "loadingProgress(progress)", "summary": "" }, { "name": "loadingComplete", "kind": "function", "signature": "loadingComplete(stageId)", "summary": "" }, { "name": "loadingFinish", "kind": "function", "signature": "loadingFinish()", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/ModelImporter", "path": "editor/reference/modules/ModelImporter.md", "source": "editor/js/modules/ModelImporter.js", "import": "/editor/js/modules/ModelImporter.js", "sourceHash": "3729d7852026829e792ba1b102941908c8965d475d84c88e09f2ed7f6cad7e18", "summary": "============================================================================ ModelImporter.js - OBJ / glTF / GLB parsers + entity spawning ============================================================================", "exports": [ { "name": "parseModelFile", "kind": "function", "signature": "async parseModelFile(file)", "summary": "Parse a model File into geometry data." }, { "name": "parsePointCloudFile", "kind": "function", "signature": "async parsePointCloudFile(file)", "summary": "Parse a point cloud file into point data." }, { "name": "parseOBJ", "kind": "function", "signature": "parseOBJ(text)", "summary": "Parse Wavefront OBJ text into indexed geometry. Handles v, vn, vt, f directives. Triangulates quads." }, { "name": "parseGLB", "kind": "function", "signature": "parseGLB(arrayBuffer, modelName)", "summary": "Parse a GLB (binary glTF 2.0) ArrayBuffer. Extracts all mesh primitives as flat position/normal/uv/index arrays." }, { "name": "parseGLTFJson", "kind": "function", "signature": "parseGLTFJson(gltf, binBuffer, modelName)", "summary": "Parse glTF JSON + optional binary buffer into mesh geometries." }, { "name": "extractGLTFNodeAnimationGraph", "kind": "function", "signature": "extractGLTFNodeAnimationGraph(gltf)", "summary": "" }, { "name": "collectGLTFNodeInstances", "kind": "function", "signature": "collectGLTFNodeInstances(gltf, suppliedGraph = null)", "summary": "" }, { "name": "createModelInstanceId", "kind": "function", "signature": "createModelInstanceId()", "summary": "" }, { "name": "createModelPartDescriptors", "kind": "function", "signature": "createModelPartDescriptors(result, assetId, instanceId, existingParts = null)", "summary": "" }, { "name": "computeModelBounds", "kind": "function", "signature": "computeModelBounds(result)", "summary": "" }, { "name": "registerModelRuntimeMaterials", "kind": "function", "signature": "async registerModelRuntimeMaterials(editor, result, parts)", "summary": "" }, { "name": "registerModelRuntimeMeshes", "kind": "function", "signature": "async registerModelRuntimeMeshes(editor, result, parts, modelInstanceId = null, modelAnimation = null, modelMorphWeights = null,)", "summary": "" }, { "name": "spawnModelAsset", "kind": "function", "signature": "async spawnModelAsset(editor, asset)", "summary": "Load a model asset, register its mesh, and create an entity in the scene." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/PrefabLibrary", "path": "editor/reference/modules/PrefabLibrary.md", "source": "editor/js/modules/PrefabLibrary.js", "import": "/editor/js/modules/PrefabLibrary.js", "sourceHash": "cb7cf17ba1d40b8ac2a95a69e559b0fdff30b9e0eafc56523c134e4a4b6f8dce", "summary": "PrefabManager.js - Folder-based Prefab System (File-based) Based on J:\\game2 implementation - proper file persistence Every entity folder is a prefab that can be: - Exported to Assets/Prefabs/*.prefab.json - Imported/instantiated into any scene - Updated (re-export overwrites) - Listed and browsed", "exports": [ { "name": "exportFolderAsPrefab", "kind": "function", "signature": "exportFolderAsPrefab(editor, folderId)", "summary": "Export a folder as a prefab data structure" }, { "name": "setCollabPrefabHooks", "kind": "function", "signature": "setCollabPrefabHooks(onSave, onDelete)", "summary": "" }, { "name": "savePrefabToFile", "kind": "function", "signature": "async savePrefabToFile(editor, prefab)", "summary": "Save prefab to Assets/Prefabs/ directory" }, { "name": "exportFolder", "kind": "function", "signature": "async exportFolder(editor, folderId)", "summary": "Export folder and save to file (combined operation)" }, { "name": "listPrefabs", "kind": "function", "signature": "async listPrefabs(editor)", "summary": "List all available prefabs in Assets/Prefabs/" }, { "name": "loadPrefabFile", "kind": "function", "signature": "async loadPrefabFile(editor, fileName)", "summary": "Load prefab from file" }, { "name": "loadPrefabByUUID", "kind": "function", "signature": "async loadPrefabByUUID(editor, uuid)", "summary": "Load prefab by UUID" }, { "name": "instantiatePrefab", "kind": "function", "signature": "instantiatePrefab(editor, prefab, targetFolderId = null, offset = [0, 0, 0])", "summary": "Instantiate a prefab in the scene" }, { "name": "importPrefab", "kind": "function", "signature": "async importPrefab(editor, fileName, targetFolderId = null, offset = [0, 0, 0])", "summary": "Import prefab from file and instantiate" }, { "name": "deletePrefab", "kind": "function", "signature": "async deletePrefab(editor, fileName)", "summary": "Delete prefab file" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/ProjectStorage", "path": "editor/reference/modules/ProjectStorage.md", "source": "editor/js/modules/ProjectStorage.js", "import": "/editor/js/modules/ProjectStorage.js", "sourceHash": "b412f8d2437921bce22b46c044e8b11da0435b6e755c38412420b103d96bd690", "summary": "ProjectManager - Save/load/export projects (pure browser, no Node.js) Uses IndexedDB + File System Access API", "exports": [ { "name": "setCollabSaveHook", "kind": "function", "signature": "setCollabSaveHook(fn)", "summary": "" }, { "name": "saveProject", "kind": "function", "signature": "async saveProject(project)", "summary": "Save project to IndexedDB" }, { "name": "loadProject", "kind": "function", "signature": "async loadProject(projectUuid)", "summary": "Load project from IndexedDB" }, { "name": "listProjects", "kind": "function", "signature": "async listProjects()", "summary": "List all projects" }, { "name": "deleteProject", "kind": "function", "signature": "async deleteProject(projectUuid)", "summary": "Delete project" }, { "name": "getLastProjectUuid", "kind": "function", "signature": "getLastProjectUuid()", "summary": "Get last opened project UUID" }, { "name": "createProject", "kind": "function", "signature": "createProject(name = 'New Project')", "summary": "Create new project" }, { "name": "exportProject", "kind": "function", "signature": "async exportProject(project, options = {})", "summary": "Export project to ZIP for distribution Strips editor-only data and packs for runtime" }, { "name": "downloadProjectBackup", "kind": "function", "signature": "async downloadProjectBackup(project)", "summary": "Download project as JSON file (backup)" }, { "name": "importProjectFromFile", "kind": "function", "signature": "async importProjectFromFile(file)", "summary": "Import project from JSON file" }, { "name": "enableAutoSave", "kind": "function", "signature": "enableAutoSave(project, intervalMs = 60000)", "summary": "" }, { "name": "disableAutoSave", "kind": "function", "signature": "disableAutoSave()", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "modules/SubScene", "path": "editor/reference/modules/SubScene.md", "source": "editor/js/modules/SubScene.js", "import": "/editor/js/modules/SubScene.js", "sourceHash": "c4a015897c6e42b368c893ce975b6c0ff9803833c5a63f787bc5acad715bb79d", "summary": "============================================================================ SubScene.js — Parallel scene layer for debris, fragments & world environment Lives alongside the editor scene but is NOT part of it. Objects here: - Are NOT in editor.scene.entities - Are NOT selectable, saveable, or undoable - Have their own PhysX bodies for physics simulation - Are rendered via EntityMeshRenderer in a dedicated pass - Have automatic lifecycle (fade, expire, cleanup) Categories: 'debris' — tiny short-lived particles (dust, sparks, splinters) 'fragment' — larger breakoff chunks from fractured meshes 'env' — persistent world environment objects (no auto-expire) Usage: const sub = editor.subScene; sub.spawn({ category: 'debris', meshType: 'cube', position, velocity, ... }); sub.spawnFragment(parentEntityId, { meshType, position, ... }); sub.tick(dt); // called from stepPhysics sub.render(rp, vp, emr); // called from Viewport sub.clear(); // on play→edit transition ============================================================================", "exports": [ { "name": "SubScene", "kind": "class", "signature": "class SubScene", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "panels/AssetPanel", "path": "editor/reference/panels/AssetPanel.md", "source": "editor/js/panels/AssetPanel.js", "import": "/editor/js/panels/AssetPanel.js", "sourceHash": "7ede4830fa3b0f3dd3e1c9c067a13ddb6996f909e3a23351977c5b789da55f86", "summary": "============================================================================ AssetPanel.js - Bottom-panel asset browser (Unity/Unreal-inspired) ============================================================================", "exports": [ { "name": "setupAssetPanel", "kind": "function", "signature": "setupAssetPanel(editor)", "summary": "" }, { "name": "renderAssetGrid", "kind": "function", "signature": "renderAssetGrid()", "summary": "" }, { "name": "getSelectedAssetUuid", "kind": "function", "signature": "getSelectedAssetUuid()", "summary": "" }, { "name": "refreshAssets", "kind": "function", "signature": "refreshAssets()", "summary": "" }, { "name": "sampleAssetAnimationTransforms", "kind": "function", "signature": "sampleAssetAnimationTransforms(gltf, animIdx, time, binStart, buf)", "summary": "" }, { "name": "base64ToArrayBuffer", "kind": "function", "signature": "base64ToArrayBuffer(base64)", "summary": "" }, { "name": "handleRemoteAssetImport", "kind": "function", "signature": "async handleRemoteAssetImport(payload)", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "panels/Hierarchy", "path": "editor/reference/panels/Hierarchy.md", "source": "editor/js/panels/Hierarchy.js", "import": "/editor/js/panels/Hierarchy.js", "sourceHash": "92e5c243b81dd668f5c3df0833c79a150cc650d1c96dbd084a7a8113690cc298", "summary": "HierarchyPanel - Entity tree view", "exports": [ { "name": "HierarchyPanel", "kind": "class", "signature": "class HierarchyPanel", "summary": "HierarchyPanel - Entity tree view" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "panels/Inspector", "path": "editor/reference/panels/Inspector.md", "source": "editor/js/panels/Inspector.js", "import": "/editor/js/panels/Inspector.js", "sourceHash": "800e63996182932ce48dca62638920636eae86737aadbfdba21b62c8f093d42d", "summary": "InspectorPanel - Component property editor", "exports": [ { "name": "InspectorPanel", "kind": "class", "signature": "class InspectorPanel", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "panels/SpellGeneratorPanel", "path": "editor/reference/panels/SpellGeneratorPanel.md", "source": "editor/js/panels/SpellGeneratorPanel.js", "import": "/editor/js/panels/SpellGeneratorPanel.js", "sourceHash": "1352f7889193570da9c22f163a4bee80f2eefdfd2a78f40d49448657d7102914", "summary": "SpellGeneratorPanel.js - Spell Generator Editor UI A panel for procedurally generating spells in the editor. Features: - Element selection (with combination preview) - Spell type selection - Modifier toggles - Power level slider - Live preview - Save to spell library", "exports": [ { "name": "SpellGeneratorPanel", "kind": "class", "signature": "class SpellGeneratorPanel", "summary": "" }, { "name": "createSpellGeneratorPanel", "kind": "function", "signature": "createSpellGeneratorPanel(options = {})", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "panels/Viewport", "path": "editor/reference/panels/Viewport.md", "source": "editor/js/panels/Viewport.js", "import": "/editor/js/panels/Viewport.js", "sourceHash": "74c753272ac0ba29420760ee99ea09b3f5a1cb742f114bbd03ef9786ae506ea8", "summary": "", "exports": [ { "name": "ViewportPanel", "kind": "class", "signature": "class ViewportPanel", "summary": "" }, { "name": "clearMeshTypeCache", "kind": "re-export", "signature": "clearMeshTypeCache", "summary": "" }, { "name": "inferEntityMeshTypeAndColor", "kind": "re-export", "signature": "inferEntityMeshTypeAndColor", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "project/AssetRegistry", "path": "editor/reference/project/AssetRegistry.md", "source": "editor/js/project/AssetRegistry.js", "import": "/editor/js/project/AssetRegistry.js", "sourceHash": "0642841e85cdaab6722229f350ace053cf4e9799c00d5cc96e58e9f2ff29e859", "summary": "AssetRegistry.js - UUID-based asset management Adapted from J:\\game2 - handles: - Asset registration and UUID assignment - Path ↔ UUID lookup - Lazy loading of asset data - Asset index persistence (Assets/index.json) - Import and update operations", "exports": [ { "name": "UnsupportedAssetIndexVersionError", "kind": "class", "signature": "class UnsupportedAssetIndexVersionError extends Error", "summary": "" }, { "name": "AssetRegistry", "kind": "class", "signature": "class AssetRegistry", "summary": "" }, { "name": "prepareAssetIndex", "kind": "function", "signature": "prepareAssetIndex(input)", "summary": "" }, { "name": "getAssetTypeFromExtension", "kind": "function", "signature": "getAssetTypeFromExtension(filename)", "summary": "Get asset type from file extension" }, { "name": "getAssetRegistry", "kind": "function", "signature": "getAssetRegistry()", "summary": "" }, { "name": "initAssetRegistry", "kind": "function", "signature": "async initAssetRegistry(projectDir)", "summary": "" }, { "name": "ASSET_INDEX_SCHEMA_VERSION", "kind": "constant", "signature": "ASSET_INDEX_SCHEMA_VERSION", "summary": "" }, { "name": "ASSET_TYPES", "kind": "constant", "signature": "ASSET_TYPES", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "project/AutoSave", "path": "editor/reference/project/AutoSave.md", "source": "editor/js/project/AutoSave.js", "import": "/editor/js/project/AutoSave.js", "sourceHash": "d948e46bc8254e6c26a3dad857ec670d6179028c5449571d6deda157c6815553", "summary": "Wrap editor methods to track dirty state", "exports": [ { "name": "DirtyTracker", "kind": "class", "signature": "class DirtyTracker", "summary": "" }, { "name": "AutoSaveManager", "kind": "class", "signature": "class AutoSaveManager", "summary": "" }, { "name": "setupDirtyTracking", "kind": "function", "signature": "setupDirtyTracking(editor, autoSaveManager)", "summary": "Wrap editor methods to track dirty state" }, { "name": "setupSaveShortcut", "kind": "function", "signature": "setupSaveShortcut(autoSaveManager)", "summary": "Setup Ctrl+S shortcut" }, { "name": "setupNewSceneShortcut", "kind": "function", "signature": "setupNewSceneShortcut(editor)", "summary": "Setup Ctrl+N for new scene" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "project/ProjectCompatibility", "path": "editor/reference/project/ProjectCompatibility.md", "source": "editor/js/project/ProjectCompatibility.js", "import": "/editor/js/project/ProjectCompatibility.js", "sourceHash": "7eb298a0667049e0218024d39c4963b6f782aa0632a849b425edbd60c3ec82cd", "summary": "Normalize a persisted/imported project without mutating the source object.", "exports": [ { "name": "prepareProjectSettings", "kind": "function", "signature": "prepareProjectSettings(input)", "summary": "" }, { "name": "prepareProjectRecord", "kind": "function", "signature": "prepareProjectRecord(input, { deserializeMaps = true } = {})", "summary": "Normalize a persisted/imported project without mutating the source object." }, { "name": "PROJECT_SETTINGS_SCHEMA_VERSION", "kind": "constant", "signature": "PROJECT_SETTINGS_SCHEMA_VERSION", "summary": "" }, { "name": "PROJECT_RECORD_SCHEMA_VERSION", "kind": "constant", "signature": "PROJECT_RECORD_SCHEMA_VERSION", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "project/ProjectExporter", "path": "editor/reference/project/ProjectExporter.md", "source": "editor/js/project/ProjectExporter.js", "import": "/editor/js/project/ProjectExporter.js", "sourceHash": "122818ce60344f4ba53fc8ff290abfb97d1ddbc6b7d2bb6e2d7f332bca367b91", "summary": "Pack data into binary format Format: [magic:4][version:4][indexOffset:4][...blobs...][index]", "exports": [ { "name": "packData", "kind": "function", "signature": "packData(entries)", "summary": "Pack data into binary format Format: [magic:4][version:4][indexOffset:4][...blobs...][index]" }, { "name": "unpackData", "kind": "function", "signature": "unpackData(buffer)", "summary": "Unpack binary data (for runtime)" }, { "name": "exportScene", "kind": "function", "signature": "async exportScene(editor, sceneData)", "summary": "Export a single scene to packed binary" }, { "name": "exportProject", "kind": "function", "signature": "async exportProject(editor, sceneDataList, options = {})", "summary": "Export full project with multiple scenes" }, { "name": "downloadZip", "kind": "function", "signature": "downloadZip(zipBuffer, filename = 'game-export.zip')", "summary": "" }, { "name": "exportAndDownload", "kind": "function", "signature": "async exportAndDownload(editor, sceneDataList, options = {})", "summary": "Export and download project" }, { "name": "RuntimeLoader", "kind": "re-export", "signature": "RuntimeLoader", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "project/ProjectLauncher", "path": "editor/reference/project/ProjectLauncher.md", "source": "editor/js/project/ProjectLauncher.js", "import": "/editor/js/project/ProjectLauncher.js", "sourceHash": "db928ae3a5aa441dc590f518de189ce7b4646cf4fad04503d1ab5821150dea7d", "summary": "ProjectLauncher.js - Startup screen with recent projects Adapted from J:\\game2 - Unity Hub / Godot style launcher: - Recent projects list with thumbnails - New project / Open project buttons - Project templates (future)", "exports": [ { "name": "getRecentProjects", "kind": "function", "signature": "getRecentProjects()", "summary": "" }, { "name": "addRecentProject", "kind": "function", "signature": "addRecentProject(project)", "summary": "" }, { "name": "removeRecentProject", "kind": "function", "signature": "removeRecentProject(projectName)", "summary": "" }, { "name": "clearRecentProjects", "kind": "function", "signature": "clearRecentProjects()", "summary": "" }, { "name": "createLauncherUI", "kind": "function", "signature": "createLauncherUI()", "summary": "" }, { "name": "renderRecentProjects", "kind": "function", "signature": "renderRecentProjects(container)", "summary": "" }, { "name": "injectLauncherStyles", "kind": "function", "signature": "injectLauncherStyles()", "summary": "" }, { "name": "showLauncher", "kind": "function", "signature": "async showLauncher(onProjectSelected)", "summary": "" }, { "name": "hideLauncher", "kind": "function", "signature": "hideLauncher()", "summary": "Hide launcher (for when editor is already initialized)" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "project/SceneManager", "path": "editor/reference/project/SceneManager.md", "source": "editor/js/project/SceneManager.js", "import": "/editor/js/project/SceneManager.js", "sourceHash": "bfda4a9f7fbda4f8c4aa1829a5169029a5013e5e12cae0f94d531ef312bdc3f6", "summary": "SceneManager.js - Scene loading, saving, and management Handles: - Scene file I/O (Scenes/*.scene.json) - Scene serialization/deserialization - Multi-scene support - Scene switching", "exports": [ { "name": "layerMask", "kind": "function", "signature": "layerMask(...layers)", "summary": "" }, { "name": "hasLayer", "kind": "function", "signature": "hasLayer(mask, layer)", "summary": "" }, { "name": "prepareSceneForImport", "kind": "function", "signature": "prepareSceneForImport(input)", "summary": "Validate and fully normalize a serialized scene before touching live editor state. Missing schemaVersion is the legacy v1 format; future versions fail closed." }, { "name": "createSceneData", "kind": "function", "signature": "createSceneData(name = 'Untitled')", "summary": "Create empty scene data with full Unity/Godot-style structure" }, { "name": "serializeScene", "kind": "function", "signature": "serializeScene(editor, sceneName = null)", "summary": "Serialize current editor scene to JSON-compatible object" }, { "name": "deserializeScene", "kind": "function", "signature": "async deserializeScene(editor, sceneData)", "summary": "Validate and stage a complete scene before replacing live editor state. If an unexpected runtime failure occurs while applying it, restore the previously serialized scene so callers never inherit a half-loaded scene." }, { "name": "clearScene", "kind": "function", "signature": "clearScene(editor)", "summary": "Clear all entities and folders from scene" }, { "name": "saveSceneToFile", "kind": "function", "signature": "async saveSceneToFile(editor, sceneName = null)", "summary": "Save scene to file system" }, { "name": "loadSceneFromFile", "kind": "function", "signature": "async loadSceneFromFile(editor, fileName)", "summary": "Load scene from file system" }, { "name": "listScenes", "kind": "function", "signature": "async listScenes(editor)", "summary": "List all scenes in project" }, { "name": "deleteSceneFile", "kind": "function", "signature": "async deleteSceneFile(editor, fileName)", "summary": "Delete scene file" }, { "name": "newScene", "kind": "function", "signature": "newScene(editor, name = 'Untitled')", "summary": "Create new scene (clears current and sets name)" }, { "name": "findEntitiesByLayer", "kind": "function", "signature": "findEntitiesByLayer(editor, layer)", "summary": "Find all entities on a specific layer" }, { "name": "findEntitiesByLayerMask", "kind": "function", "signature": "findEntitiesByLayerMask(editor, mask)", "summary": "Find all entities matching a layer mask" }, { "name": "findEntitiesByTag", "kind": "function", "signature": "findEntitiesByTag(editor, tag)", "summary": "Find all entities with a specific tag" }, { "name": "findEntityByTag", "kind": "function", "signature": "findEntityByTag(editor, tag)", "summary": "Find first entity with a specific tag" }, { "name": "findEnabledEntities", "kind": "function", "signature": "findEnabledEntities(editor)", "summary": "Find all enabled entities (active in scene)" }, { "name": "findEntitiesByRenderFlags", "kind": "function", "signature": "findEntitiesByRenderFlags(editor, flags, matchAll = true)", "summary": "Find all entities with specific render flags" }, { "name": "findPrefabInstances", "kind": "function", "signature": "findPrefabInstances(editor, prefabUuid = null)", "summary": "Find all prefab instances" }, { "name": "getEntityConnections", "kind": "function", "signature": "getEntityConnections(editor, entityId)", "summary": "Get all connections for an entity (both incoming and outgoing)" }, { "name": "addConnection", "kind": "function", "signature": "addConnection(editor, fromEntity, signal, toEntity, method, flags = 0, binds = [])", "summary": "Add a signal connection between entities" }, { "name": "removeConnection", "kind": "function", "signature": "removeConnection(editor, fromEntity, signal, toEntity, method)", "summary": "Remove a signal connection" }, { "name": "setEntityLayer", "kind": "function", "signature": "setEntityLayer(editor, entityId, layer)", "summary": "Set entity layer" }, { "name": "setEntityTag", "kind": "function", "signature": "setEntityTag(editor, entityId, tag)", "summary": "Set entity tag" }, { "name": "addEntityTag", "kind": "function", "signature": "addEntityTag(editor, entityId, tag)", "summary": "Add tag to entity's tags array" }, { "name": "removeEntityTag", "kind": "function", "signature": "removeEntityTag(editor, entityId, tag)", "summary": "Remove tag from entity's tags array" }, { "name": "setEntityRenderFlags", "kind": "function", "signature": "setEntityRenderFlags(editor, entityId, flags)", "summary": "Set entity render flags" }, { "name": "setEntityEnabled", "kind": "function", "signature": "setEntityEnabled(editor, entityId, enabled)", "summary": "Set entity enabled state" }, { "name": "SCENE_SCHEMA_VERSION", "kind": "constant", "signature": "SCENE_SCHEMA_VERSION", "summary": "" }, { "name": "LAYERS", "kind": "constant", "signature": "LAYERS", "summary": "" }, { "name": "LAYER_NAMES", "kind": "constant", "signature": "LAYER_NAMES", "summary": "" }, { "name": "BUILTIN_TAGS", "kind": "constant", "signature": "BUILTIN_TAGS", "summary": "" }, { "name": "RENDER_FLAGS", "kind": "constant", "signature": "RENDER_FLAGS", "summary": "" }, { "name": "DEFAULT_RENDER_FLAGS", "kind": "constant", "signature": "DEFAULT_RENDER_FLAGS", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "project/index", "path": "editor/reference/project/index.md", "source": "editor/js/project/index.js", "import": "/editor/js/project/index.js", "sourceHash": "6ef6d15c18d36cc7b26856ae7110d19faded52af27be953343ce0f1de68b9341", "summary": "", "exports": [ { "name": "ASSET_TYPES", "kind": "re-export", "signature": "ASSET_TYPES", "summary": "" }, { "name": "AssetRegistry", "kind": "re-export", "signature": "AssetRegistry", "summary": "" }, { "name": "AutoSaveManager", "kind": "re-export", "signature": "AutoSaveManager", "summary": "" }, { "name": "BUILTIN_TAGS", "kind": "re-export", "signature": "BUILTIN_TAGS", "summary": "" }, { "name": "DEFAULT_RENDER_FLAGS", "kind": "re-export", "signature": "DEFAULT_RENDER_FLAGS", "summary": "" }, { "name": "DirtyTracker", "kind": "re-export", "signature": "DirtyTracker", "summary": "" }, { "name": "LAYERS", "kind": "re-export", "signature": "LAYERS", "summary": "" }, { "name": "LAYER_NAMES", "kind": "re-export", "signature": "LAYER_NAMES", "summary": "" }, { "name": "ProjectExporter", "kind": "re-export", "signature": "ProjectExporter", "summary": "" }, { "name": "ProjectLauncher", "kind": "re-export", "signature": "ProjectLauncher", "summary": "" }, { "name": "RENDER_FLAGS", "kind": "re-export", "signature": "RENDER_FLAGS", "summary": "" }, { "name": "SceneManager", "kind": "re-export", "signature": "SceneManager", "summary": "" }, { "name": "addConnection", "kind": "re-export", "signature": "addConnection", "summary": "" }, { "name": "addEntityTag", "kind": "re-export", "signature": "addEntityTag", "summary": "" }, { "name": "addRecentProject", "kind": "re-export", "signature": "addRecentProject", "summary": "" }, { "name": "clearRecentProjects", "kind": "re-export", "signature": "clearRecentProjects", "summary": "" }, { "name": "clearScene", "kind": "re-export", "signature": "clearScene", "summary": "" }, { "name": "createSceneData", "kind": "re-export", "signature": "createSceneData", "summary": "" }, { "name": "deleteSceneFile", "kind": "re-export", "signature": "deleteSceneFile", "summary": "" }, { "name": "deserializeScene", "kind": "re-export", "signature": "deserializeScene", "summary": "" }, { "name": "downloadZip", "kind": "re-export", "signature": "downloadZip", "summary": "" }, { "name": "exportAndDownload", "kind": "re-export", "signature": "exportAndDownload", "summary": "" }, { "name": "exportProject", "kind": "re-export", "signature": "exportProject", "summary": "" }, { "name": "exportScene", "kind": "re-export", "signature": "exportScene", "summary": "" }, { "name": "findEnabledEntities", "kind": "re-export", "signature": "findEnabledEntities", "summary": "" }, { "name": "findEntitiesByLayer", "kind": "re-export", "signature": "findEntitiesByLayer", "summary": "" }, { "name": "findEntitiesByLayerMask", "kind": "re-export", "signature": "findEntitiesByLayerMask", "summary": "" }, { "name": "findEntitiesByRenderFlags", "kind": "re-export", "signature": "findEntitiesByRenderFlags", "summary": "" }, { "name": "findEntitiesByTag", "kind": "re-export", "signature": "findEntitiesByTag", "summary": "" }, { "name": "findEntityByTag", "kind": "re-export", "signature": "findEntityByTag", "summary": "" }, { "name": "findPrefabInstances", "kind": "re-export", "signature": "findPrefabInstances", "summary": "" }, { "name": "getAssetRegistry", "kind": "re-export", "signature": "getAssetRegistry", "summary": "" }, { "name": "getAssetTypeFromExtension", "kind": "re-export", "signature": "getAssetTypeFromExtension", "summary": "" }, { "name": "getEntityConnections", "kind": "re-export", "signature": "getEntityConnections", "summary": "" }, { "name": "getRecentProjects", "kind": "re-export", "signature": "getRecentProjects", "summary": "" }, { "name": "hasLayer", "kind": "re-export", "signature": "hasLayer", "summary": "" }, { "name": "hideLauncher", "kind": "re-export", "signature": "hideLauncher", "summary": "" }, { "name": "initAssetRegistry", "kind": "re-export", "signature": "initAssetRegistry", "summary": "" }, { "name": "layerMask", "kind": "re-export", "signature": "layerMask", "summary": "" }, { "name": "listScenes", "kind": "re-export", "signature": "listScenes", "summary": "" }, { "name": "loadSceneFromFile", "kind": "re-export", "signature": "loadSceneFromFile", "summary": "" }, { "name": "newScene", "kind": "re-export", "signature": "newScene", "summary": "" }, { "name": "packData", "kind": "re-export", "signature": "packData", "summary": "" }, { "name": "removeConnection", "kind": "re-export", "signature": "removeConnection", "summary": "" }, { "name": "removeEntityTag", "kind": "re-export", "signature": "removeEntityTag", "summary": "" }, { "name": "removeRecentProject", "kind": "re-export", "signature": "removeRecentProject", "summary": "" }, { "name": "saveSceneToFile", "kind": "re-export", "signature": "saveSceneToFile", "summary": "" }, { "name": "serializeScene", "kind": "re-export", "signature": "serializeScene", "summary": "" }, { "name": "setEntityEnabled", "kind": "re-export", "signature": "setEntityEnabled", "summary": "" }, { "name": "setEntityLayer", "kind": "re-export", "signature": "setEntityLayer", "summary": "" }, { "name": "setEntityRenderFlags", "kind": "re-export", "signature": "setEntityRenderFlags", "summary": "" }, { "name": "setEntityTag", "kind": "re-export", "signature": "setEntityTag", "summary": "" }, { "name": "setupDirtyTracking", "kind": "re-export", "signature": "setupDirtyTracking", "summary": "" }, { "name": "setupNewSceneShortcut", "kind": "re-export", "signature": "setupNewSceneShortcut", "summary": "" }, { "name": "setupSaveShortcut", "kind": "re-export", "signature": "setupSaveShortcut", "summary": "" }, { "name": "showLauncher", "kind": "re-export", "signature": "showLauncher", "summary": "" }, { "name": "unpackData", "kind": "re-export", "signature": "unpackData", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/SpawnableItem", "path": "editor/reference/spawnables/SpawnableItem.md", "source": "editor/js/spawnables/SpawnableItem.js", "import": "/editor/js/spawnables/SpawnableItem.js", "sourceHash": "8d3d8fbec0a5103ab4115ba186faebbe915687531cbc334c8954188364317463", "summary": "SpawnableItem - Base class for all spawnable objects in the editor. Physics collider options: - Override getCollider() to define custom colliders - Use helper imports from EditorPhysics for advanced physics: - generateCollidersFromSDF(sdfFunc, bounds, resolution) - createMeshColliderDecomposed(vertices, indices, options) - createSDFCollider(sdfFunc, bounds, options) - createVoxelCollider(voxels, sizeX, sizeY, sizeZ, voxelSize) ```js import { generateCollidersFromSDF } from '../../modules/EditorPhysics.js'; static getCollider() { return { shape: 'box', halfExtents: [0.01, 0.01, 0.01], compoundColliders: generateCollidersFromSDF( (x, y, z) => mySDF(x, y, z), { min: [-1, -1, -1], max: [1, 1, 1] }, 12 ), }; } ```", "exports": [ { "name": "SpawnableItem", "kind": "class", "signature": "class SpawnableItem", "summary": "SpawnableItem - Base class for all spawnable objects in the editor. Physics collider options: - Override getCollider() to define custom colliders - Use helper imports from EditorPhysics for advanced physics: - generateCollidersFromSDF(sdfFunc, bounds, resolution) - createMeshColliderDecomposed(vertices, indices, options) - createSDFCollider(sdfFunc, bounds, options) - createVoxelCollider(voxels, sizeX, sizeY, sizeZ, voxelSize) ```js import { generateCollidersFromSDF } from '../../modules/EditorPhysics.js'; static getCollider() { return { shape: 'box', halfExtents: [0.01, 0.01, 0.01], compoundColliders: generateCollidersFromSDF( (x, y, z) => mySDF(x, y, z), { min: [-1, -1, -1], max: [1, 1, 1] }, 12 ), }; } ```" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/cameras/Camera", "path": "editor/reference/spawnables/cameras/Camera.md", "source": "editor/js/spawnables/cameras/Camera.js", "import": "/editor/js/spawnables/cameras/Camera.js", "sourceHash": "373d99038e659a5b8c9b48c59fb0d90b8d6bfb01b326c6b82a4e40dcbf85ed8f", "summary": "", "exports": [ { "name": "Camera", "kind": "class", "signature": "class Camera extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/complex/Arch", "path": "editor/reference/spawnables/complex/Arch.md", "source": "editor/js/spawnables/complex/Arch.js", "import": "/editor/js/spawnables/complex/Arch.js", "sourceHash": "a96c9e4bccf76ae59b891e014866ff082dc127d8b4890e6b8201f7ad5dd39c15", "summary": "", "exports": [ { "name": "Arch", "kind": "class", "signature": "class Arch extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/complex/CSGShape", "path": "editor/reference/spawnables/complex/CSGShape.md", "source": "editor/js/spawnables/complex/CSGShape.js", "import": "/editor/js/spawnables/complex/CSGShape.js", "sourceHash": "33c3c6862d88d3a4e1c889f50c277045c972df47aaabcb82181ca89a264cf24e", "summary": "============================================================================ CSGShape.js — CSG Boolean operations on mesh entities Select 2 mesh entities → right-click → CSG Union / Subtract / Intersect V1: Voxelize both → VoxelOps boolean → SDFToMesh marching cubes reconstruct V2: Voxelize both → VoxelOps boolean → DualContouring for sharp features ============================================================================", "exports": [ { "name": "performCSG", "kind": "function", "signature": "async performCSG(editor, entityIdA, entityIdB, operation = 'union', opts = {})", "summary": "Perform a CSG boolean operation on two mesh entities." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/complex/Gear", "path": "editor/reference/spawnables/complex/Gear.md", "source": "editor/js/spawnables/complex/Gear.js", "import": "/editor/js/spawnables/complex/Gear.js", "sourceHash": "4275567fb6f9a9aa30cdfcbd967b4d982f8e4341edccfdabffdf8f1af69bb84b", "summary": "", "exports": [ { "name": "Gear", "kind": "class", "signature": "class Gear extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/complex/Helix", "path": "editor/reference/spawnables/complex/Helix.md", "source": "editor/js/spawnables/complex/Helix.js", "import": "/editor/js/spawnables/complex/Helix.js", "sourceHash": "bfee49e017a88b56cfc267024d5c2b804930ee6a35894b50fe925b711a322a0e", "summary": "", "exports": [ { "name": "Helix", "kind": "class", "signature": "class Helix extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/complex/Prism", "path": "editor/reference/spawnables/complex/Prism.md", "source": "editor/js/spawnables/complex/Prism.js", "import": "/editor/js/spawnables/complex/Prism.js", "sourceHash": "19a5024860b31323106b0a30c2d63ae33ac2de2fc82b86ed0a8ae9ebaf4fbd48", "summary": "", "exports": [ { "name": "Prism", "kind": "class", "signature": "class Prism extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/complex/Pyramid", "path": "editor/reference/spawnables/complex/Pyramid.md", "source": "editor/js/spawnables/complex/Pyramid.js", "import": "/editor/js/spawnables/complex/Pyramid.js", "sourceHash": "523e067543404a729fa519d07a32f495c207d98949c1c3b80591899f3a4b144b", "summary": "", "exports": [ { "name": "Pyramid", "kind": "class", "signature": "class Pyramid extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/complex/SDFShape", "path": "editor/reference/spawnables/complex/SDFShape.md", "source": "editor/js/spawnables/complex/SDFShape.js", "import": "/editor/js/spawnables/complex/SDFShape.js", "sourceHash": "d915ac0c6428410d673e6a288f68746cc5bcd80c60e39952ef1135cc27897b93", "summary": "", "exports": [ { "name": "SDFShape", "kind": "class", "signature": "class SDFShape extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/complex/Stairs", "path": "editor/reference/spawnables/complex/Stairs.md", "source": "editor/js/spawnables/complex/Stairs.js", "import": "/editor/js/spawnables/complex/Stairs.js", "sourceHash": "0a0d107c1702209cb6cedcd7be8f06c28ac58c90dd1a75679ecc2181079d008b", "summary": "", "exports": [ { "name": "Stairs", "kind": "class", "signature": "class Stairs extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/complex/Star", "path": "editor/reference/spawnables/complex/Star.md", "source": "editor/js/spawnables/complex/Star.js", "import": "/editor/js/spawnables/complex/Star.js", "sourceHash": "22be327fc9f38b152f8812d758b9e49cd448f52f68d8ca89eb597966f9e788bd", "summary": "", "exports": [ { "name": "Star", "kind": "class", "signature": "class Star extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/complex/Wedge", "path": "editor/reference/spawnables/complex/Wedge.md", "source": "editor/js/spawnables/complex/Wedge.js", "import": "/editor/js/spawnables/complex/Wedge.js", "sourceHash": "b1db40a7a8e5aa94aae028ddf9da9a4c7245dcada86800445d7938af9df43687", "summary": "", "exports": [ { "name": "Wedge", "kind": "class", "signature": "class Wedge extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/emitters/ParticleEmitter", "path": "editor/reference/spawnables/emitters/ParticleEmitter.md", "source": "editor/js/spawnables/emitters/ParticleEmitter.js", "import": "/editor/js/spawnables/emitters/ParticleEmitter.js", "sourceHash": "0f6094887e4f28a8bf9011d9e7c6a8bf134bc411d6a30f3f4689fc716d464b5c", "summary": "", "exports": [ { "name": "ParticleEmitter", "kind": "class", "signature": "class ParticleEmitter extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/emitters/PhaseEmitters", "path": "editor/reference/spawnables/emitters/PhaseEmitters.md", "source": "editor/js/spawnables/emitters/PhaseEmitters.js", "import": "/editor/js/spawnables/emitters/PhaseEmitters.js", "sourceHash": "21043cc003c9a7477aeea843d30b7e6884bc868609a06484ee9bf52980b56a4e", "summary": "", "exports": [ { "name": "FireEmitter", "kind": "constant", "signature": "FireEmitter", "summary": "" }, { "name": "SmokeEmitter", "kind": "constant", "signature": "SmokeEmitter", "summary": "" }, { "name": "SteamEmitter", "kind": "constant", "signature": "SteamEmitter", "summary": "" }, { "name": "WaterEmitter", "kind": "constant", "signature": "WaterEmitter", "summary": "" }, { "name": "FountainEmitter", "kind": "constant", "signature": "FountainEmitter", "summary": "" }, { "name": "LavaEmitter", "kind": "constant", "signature": "LavaEmitter", "summary": "" }, { "name": "SnowEmitter", "kind": "constant", "signature": "SnowEmitter", "summary": "" }, { "name": "SparksEmitter", "kind": "constant", "signature": "SparksEmitter", "summary": "" }, { "name": "DebrisEmitter", "kind": "constant", "signature": "DebrisEmitter", "summary": "" }, { "name": "PlasmaEmitter", "kind": "constant", "signature": "PlasmaEmitter", "summary": "" }, { "name": "MagicEmitter", "kind": "constant", "signature": "MagicEmitter", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/index", "path": "editor/reference/spawnables/index.md", "source": "editor/js/spawnables/index.js", "import": "/editor/js/spawnables/index.js", "sourceHash": "595aa31072a16cd734c338631a1f908df25824e2116306b23df370e1140eacb8", "summary": "", "exports": [ { "name": "getSpawnable", "kind": "function", "signature": "getSpawnable(id)", "summary": "" }, { "name": "getSpawnablesByCategory", "kind": "function", "signature": "getSpawnablesByCategory(category)", "summary": "" }, { "name": "getAllCategories", "kind": "function", "signature": "getAllCategories()", "summary": "" }, { "name": "getAllSpawnables", "kind": "function", "signature": "getAllSpawnables()", "summary": "" }, { "name": "spawnables", "kind": "constant", "signature": "spawnables", "summary": "" }, { "name": "spawnableRegistry", "kind": "constant", "signature": "spawnableRegistry", "summary": "" }, { "name": "categories", "kind": "constant", "signature": "categories", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/lights/DirectionalLight", "path": "editor/reference/spawnables/lights/DirectionalLight.md", "source": "editor/js/spawnables/lights/DirectionalLight.js", "import": "/editor/js/spawnables/lights/DirectionalLight.js", "sourceHash": "68e2d9c5b23fa7cbe36f7013759eff47784d3a5c527353f175d7788e90cfb32c", "summary": "", "exports": [ { "name": "DirectionalLight", "kind": "class", "signature": "class DirectionalLight extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/lights/PointLight", "path": "editor/reference/spawnables/lights/PointLight.md", "source": "editor/js/spawnables/lights/PointLight.js", "import": "/editor/js/spawnables/lights/PointLight.js", "sourceHash": "b14c8f757628b2ea39a44610abbf250a4fc858f11d5775a8a3256a2f6cfc2449", "summary": "", "exports": [ { "name": "PointLight", "kind": "class", "signature": "class PointLight extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/lights/SpotLight", "path": "editor/reference/spawnables/lights/SpotLight.md", "source": "editor/js/spawnables/lights/SpotLight.js", "import": "/editor/js/spawnables/lights/SpotLight.js", "sourceHash": "eafd370d38d63f7348b618400e3a67795cd81a7b9961ddfdcb21a9c31d5d92e1", "summary": "", "exports": [ { "name": "SpotLight", "kind": "class", "signature": "class SpotLight extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/physics/Balloon", "path": "editor/reference/spawnables/physics/Balloon.md", "source": "editor/js/spawnables/physics/Balloon.js", "import": "/editor/js/spawnables/physics/Balloon.js", "sourceHash": "dabc368d2716c7738c65c676720f0f354b39888c674054038ce16841d9ab3861", "summary": "", "exports": [ { "name": "Balloon", "kind": "class", "signature": "class Balloon extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/physics/Chain", "path": "editor/reference/spawnables/physics/Chain.md", "source": "editor/js/spawnables/physics/Chain.js", "import": "/editor/js/spawnables/physics/Chain.js", "sourceHash": "3ec6d2b59ab238906d4c4f6b5956e2e16c8d0b706a990c035e6e177280e8af22", "summary": "", "exports": [ { "name": "Chain", "kind": "class", "signature": "class Chain extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/physics/Cloth", "path": "editor/reference/spawnables/physics/Cloth.md", "source": "editor/js/spawnables/physics/Cloth.js", "import": "/editor/js/spawnables/physics/Cloth.js", "sourceHash": "daa01e7b3324d11b95a12cdfb7243713132161f628099254ded2c001497c1c54", "summary": "", "exports": [ { "name": "Cloth", "kind": "class", "signature": "class Cloth extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/physics/Fluid", "path": "editor/reference/spawnables/physics/Fluid.md", "source": "editor/js/spawnables/physics/Fluid.js", "import": "/editor/js/spawnables/physics/Fluid.js", "sourceHash": "723aa8d478a1254a151d7d966faf1d36ce04e038ff85018f614af2e4987e32e1", "summary": "", "exports": [ { "name": "Fluid", "kind": "class", "signature": "class Fluid extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/physics/Hair", "path": "editor/reference/spawnables/physics/Hair.md", "source": "editor/js/spawnables/physics/Hair.js", "import": "/editor/js/spawnables/physics/Hair.js", "sourceHash": "fa67f44ccd2519563f8a6777f829976372491396cf6cf0dfc102d1f2f973beec", "summary": "", "exports": [ { "name": "Hair", "kind": "class", "signature": "class Hair extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/physics/Ragdoll", "path": "editor/reference/spawnables/physics/Ragdoll.md", "source": "editor/js/spawnables/physics/Ragdoll.js", "import": "/editor/js/spawnables/physics/Ragdoll.js", "sourceHash": "51fbbc0849780fc09037b47a777daa32638ae8482b588e6653f75a9031e96bee", "summary": "", "exports": [ { "name": "Ragdoll", "kind": "class", "signature": "class Ragdoll extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/physics/Rope", "path": "editor/reference/spawnables/physics/Rope.md", "source": "editor/js/spawnables/physics/Rope.js", "import": "/editor/js/spawnables/physics/Rope.js", "sourceHash": "77ba73989bb0eb85d247005402fc0d1d46ace877555eadc27ef7f882d5724569", "summary": "", "exports": [ { "name": "Rope", "kind": "class", "signature": "class Rope extends SpawnableItem", "summary": "" }, { "name": "FIBER_MATERIALS", "kind": "re-export", "signature": "FIBER_MATERIALS", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/physics/RopeSchema", "path": "editor/reference/spawnables/physics/RopeSchema.md", "source": "editor/js/spawnables/physics/RopeSchema.js", "import": "/editor/js/spawnables/physics/RopeSchema.js", "sourceHash": "6467fdf238bb85fe79cb3513ddce92f719731e6ce66e34afee5b293e757c2f36", "summary": "============================================================================= ROPE SCHEMA - Shared schema for RopeTool and PhysicsRopeComponentEditor =============================================================================", "exports": [ { "name": "getFiberMaterial", "kind": "function", "signature": "getFiberMaterial(name)", "summary": "Get fiber material properties by name" }, { "name": "applyFiberMaterial", "kind": "function", "signature": "applyFiberMaterial(data, materialName)", "summary": "Apply fiber material preset to rope data" }, { "name": "FIBER_MATERIALS", "kind": "constant", "signature": "FIBER_MATERIALS", "summary": "Fiber material properties - affects both physics and rendering" }, { "name": "ROPE_DEFAULTS", "kind": "constant", "signature": "ROPE_DEFAULTS", "summary": "Default values for rope properties" }, { "name": "MATERIAL_PRESETS", "kind": "constant", "signature": "MATERIAL_PRESETS", "summary": "Material presets for quick setup" }, { "name": "FIBER_MATERIAL_OPTIONS", "kind": "constant", "signature": "FIBER_MATERIAL_OPTIONS", "summary": "Fiber material options for dropdown" }, { "name": "ROPE_INSPECTOR_SCHEMA", "kind": "constant", "signature": "ROPE_INSPECTOR_SCHEMA", "summary": "Unified inspector schema for rope properties Used by both RopeTool and PhysicsRopeComponentEditor Organized into logical groups with the most commonly used options first" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/physics/SoftBody", "path": "editor/reference/spawnables/physics/SoftBody.md", "source": "editor/js/spawnables/physics/SoftBody.js", "import": "/editor/js/spawnables/physics/SoftBody.js", "sourceHash": "b23d60ae989bb6d57de17539a065a789b0ed29b0657193cec4fd4aef30d961c3", "summary": "", "exports": [ { "name": "SoftBody", "kind": "class", "signature": "class SoftBody extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/physics/Wire", "path": "editor/reference/spawnables/physics/Wire.md", "source": "editor/js/spawnables/physics/Wire.js", "import": "/editor/js/spawnables/physics/Wire.js", "sourceHash": "9d95a3abc8add1dc4152c298a1dd1d4d1e0f1a1edff3052688acb5813c682084", "summary": "", "exports": [ { "name": "Wire", "kind": "class", "signature": "class Wire extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/primitives/Capsule", "path": "editor/reference/spawnables/primitives/Capsule.md", "source": "editor/js/spawnables/primitives/Capsule.js", "import": "/editor/js/spawnables/primitives/Capsule.js", "sourceHash": "24cd6928e080999525051c4ba39cdfd23fa0e0fd98ff3b7f9e711b0db18a211d", "summary": "", "exports": [ { "name": "Capsule", "kind": "class", "signature": "class Capsule extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/primitives/Cone", "path": "editor/reference/spawnables/primitives/Cone.md", "source": "editor/js/spawnables/primitives/Cone.js", "import": "/editor/js/spawnables/primitives/Cone.js", "sourceHash": "8761e98ef72045d9bef0892e3e97cc7d2a04fc8eccd6b7ae40650e36ee22ab0a", "summary": "", "exports": [ { "name": "Cone", "kind": "class", "signature": "class Cone extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/primitives/Cube", "path": "editor/reference/spawnables/primitives/Cube.md", "source": "editor/js/spawnables/primitives/Cube.js", "import": "/editor/js/spawnables/primitives/Cube.js", "sourceHash": "b7f0d0a0262792eee13c0b9d5c6c6c6883e8ab899c2d98055f40257da644fdc8", "summary": "", "exports": [ { "name": "Cube", "kind": "class", "signature": "class Cube extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/primitives/Cylinder", "path": "editor/reference/spawnables/primitives/Cylinder.md", "source": "editor/js/spawnables/primitives/Cylinder.js", "import": "/editor/js/spawnables/primitives/Cylinder.js", "sourceHash": "37023f7fd64ad3d14fccbeed0dab29f64e96e2fa287c4466c8416aff28075dc3", "summary": "", "exports": [ { "name": "Cylinder", "kind": "class", "signature": "class Cylinder extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/primitives/Plane", "path": "editor/reference/spawnables/primitives/Plane.md", "source": "editor/js/spawnables/primitives/Plane.js", "import": "/editor/js/spawnables/primitives/Plane.js", "sourceHash": "2da477b1d1ef7579bead9778849ee2584dcafa3641beabd2db9ae75fab16ba83", "summary": "", "exports": [ { "name": "Plane", "kind": "class", "signature": "class Plane extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/primitives/Sphere", "path": "editor/reference/spawnables/primitives/Sphere.md", "source": "editor/js/spawnables/primitives/Sphere.js", "import": "/editor/js/spawnables/primitives/Sphere.js", "sourceHash": "f0e528d593584f73e347c1e3947705cea5343e41855b0803536388a05bbd0553", "summary": "", "exports": [ { "name": "Sphere", "kind": "class", "signature": "class Sphere extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/primitives/Torus", "path": "editor/reference/spawnables/primitives/Torus.md", "source": "editor/js/spawnables/primitives/Torus.js", "import": "/editor/js/spawnables/primitives/Torus.js", "sourceHash": "825162aac20dd5baec3991e82f67dd516570ed6c249225ae7d8852a4c77b45ec", "summary": "", "exports": [ { "name": "Torus", "kind": "class", "signature": "class Torus extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/tools/ConstraintTool", "path": "editor/reference/spawnables/tools/ConstraintTool.md", "source": "editor/js/spawnables/tools/ConstraintTool.js", "import": "/editor/js/spawnables/tools/ConstraintTool.js", "sourceHash": "6e590ec574f3a1d6a2bcc482f4345b18340aa625570b2a9cc82d3e525e496d62", "summary": "", "exports": [ { "name": "ConstraintTool", "kind": "class", "signature": "class ConstraintTool extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/tools/RemoverTool", "path": "editor/reference/spawnables/tools/RemoverTool.md", "source": "editor/js/spawnables/tools/RemoverTool.js", "import": "/editor/js/spawnables/tools/RemoverTool.js", "sourceHash": "77f116c0956e25ba142b02d0fd8b8674ef15d09538efa9c07df04402fa1d084c", "summary": "", "exports": [ { "name": "RemoverTool", "kind": "class", "signature": "class RemoverTool extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/tools/RopeTool", "path": "editor/reference/spawnables/tools/RopeTool.md", "source": "editor/js/spawnables/tools/RopeTool.js", "import": "/editor/js/spawnables/tools/RopeTool.js", "sourceHash": "b295a96d0acc33f420f798e0427db3904e167a5f56ad3be852bf7aff99df7828", "summary": "", "exports": [ { "name": "RopeTool", "kind": "class", "signature": "class RopeTool extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/tools/SpringTool", "path": "editor/reference/spawnables/tools/SpringTool.md", "source": "editor/js/spawnables/tools/SpringTool.js", "import": "/editor/js/spawnables/tools/SpringTool.js", "sourceHash": "969e5dd429a1fe9fc46c0a17dd995e446fbaf960e43911a99de030c3eb4d630f", "summary": "", "exports": [ { "name": "SpringTool", "kind": "class", "signature": "class SpringTool extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "spawnables/tools/WeldTool", "path": "editor/reference/spawnables/tools/WeldTool.md", "source": "editor/js/spawnables/tools/WeldTool.js", "import": "/editor/js/spawnables/tools/WeldTool.js", "sourceHash": "ef05323b964962e45aaf5d2c6daca79b5ed32ebe478ffb84ad6af472116b6501", "summary": "", "exports": [ { "name": "WeldTool", "kind": "class", "signature": "class WeldTool extends SpawnableItem", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "storage/EditorPreferenceContracts", "path": "editor/reference/storage/EditorPreferenceContracts.md", "source": "editor/js/storage/EditorPreferenceContracts.js", "import": "/editor/js/storage/EditorPreferenceContracts.js", "sourceHash": "baa643eca439808d555ccc80d22f3198869ba478397fc0d355d6de8962a2a8d3", "summary": "Canonical localStorage contracts for structured editor preferences. The original keys remain v1 rollback mirrors. Current clients publish the legacy payload first and the v2 envelope last. The envelope remembers the exact legacy JSON it accompanied, allowing a later write from an older tab to be detected and read instead of being shadowed by stale v2 data.", "exports": [ { "name": "EditorPreferenceContractError", "kind": "class", "signature": "class EditorPreferenceContractError extends Error", "summary": "" }, { "name": "readEditorSettings", "kind": "function", "signature": "readEditorSettings(storage)", "summary": "" }, { "name": "writeEditorSettings", "kind": "function", "signature": "writeEditorSettings(value, storage)", "summary": "" }, { "name": "clearEditorSettings", "kind": "function", "signature": "clearEditorSettings(storage)", "summary": "" }, { "name": "readEditorHotkeys", "kind": "function", "signature": "readEditorHotkeys(storage)", "summary": "" }, { "name": "writeEditorHotkeys", "kind": "function", "signature": "writeEditorHotkeys(value, storage)", "summary": "" }, { "name": "clearEditorHotkeys", "kind": "function", "signature": "clearEditorHotkeys(storage)", "summary": "" }, { "name": "readRecentProjects", "kind": "function", "signature": "readRecentProjects(storage)", "summary": "" }, { "name": "writeRecentProjects", "kind": "function", "signature": "writeRecentProjects(value, storage)", "summary": "" }, { "name": "clearRecentProjectsRecord", "kind": "function", "signature": "clearRecentProjectsRecord(storage)", "summary": "" }, { "name": "readWorldEnvironment", "kind": "function", "signature": "readWorldEnvironment(storage)", "summary": "" }, { "name": "writeWorldEnvironment", "kind": "function", "signature": "writeWorldEnvironment(value, storage)", "summary": "" }, { "name": "readWorldPostprocess", "kind": "function", "signature": "readWorldPostprocess(storage)", "summary": "" }, { "name": "writeWorldPostprocess", "kind": "function", "signature": "writeWorldPostprocess(value, storage)", "summary": "" }, { "name": "readWorldPanelCollapse", "kind": "function", "signature": "readWorldPanelCollapse(storage)", "summary": "" }, { "name": "writeWorldPanelCollapse", "kind": "function", "signature": "writeWorldPanelCollapse(value, storage)", "summary": "" }, { "name": "readCollabRoom", "kind": "function", "signature": "readCollabRoom(storage)", "summary": "" }, { "name": "writeCollabRoom", "kind": "function", "signature": "writeCollabRoom(value, storage)", "summary": "" }, { "name": "clearCollabRoom", "kind": "function", "signature": "clearCollabRoom(storage)", "summary": "" }, { "name": "readAudioMotion", "kind": "function", "signature": "readAudioMotion(storage)", "summary": "" }, { "name": "writeAudioMotion", "kind": "function", "signature": "writeAudioMotion(value, storage)", "summary": "" }, { "name": "readAudioFavorites", "kind": "function", "signature": "readAudioFavorites(storage)", "summary": "" }, { "name": "writeAudioFavorites", "kind": "function", "signature": "writeAudioFavorites(value, storage)", "summary": "" }, { "name": "readAudioRecents", "kind": "function", "signature": "readAudioRecents(storage)", "summary": "" }, { "name": "writeAudioRecents", "kind": "function", "signature": "writeAudioRecents(value, storage)", "summary": "" }, { "name": "EDITOR_PREFERENCE_SCHEMA_VERSION", "kind": "constant", "signature": "EDITOR_PREFERENCE_SCHEMA_VERSION", "summary": "Canonical localStorage contracts for structured editor preferences. The original keys remain v1 rollback mirrors. Current clients publish the legacy payload first and the v2 envelope last. The envelope remembers the exact legacy JSON it accompanied, allowing a later write from an older tab to be detected and read instead of being shadowed by stale v2 data." }, { "name": "EDITOR_PREFERENCE_MAX_RECORD_BYTES", "kind": "constant", "signature": "EDITOR_PREFERENCE_MAX_RECORD_BYTES", "summary": "" }, { "name": "EDITOR_PREFERENCE_CONTRACTS", "kind": "constant", "signature": "EDITOR_PREFERENCE_CONTRACTS", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "storage/GameEditorDatabase", "path": "editor/reference/storage/GameEditorDatabase.md", "source": "editor/js/storage/GameEditorDatabase.js", "import": "/editor/js/storage/GameEditorDatabase.js", "sourceHash": "919572adb5c8e5e38c64501e08be49397d748da4149becacf2fb092861c34635", "summary": "The single schema owner for editor IndexedDB persistence. Version 1 was opened independently by main.js and ProjectStorage.js, which meant only the first caller's object store was created. Version 2 expands the database to contain both stores without removing any version-1 data.", "exports": [ { "name": "closeGameEditorDatabase", "kind": "function", "signature": "closeGameEditorDatabase()", "summary": "" }, { "name": "openGameEditorDatabase", "kind": "function", "signature": "openGameEditorDatabase()", "summary": "" }, { "name": "GAME_EDITOR_DB_NAME", "kind": "constant", "signature": "GAME_EDITOR_DB_NAME", "summary": "The single schema owner for editor IndexedDB persistence. Version 1 was opened independently by main.js and ProjectStorage.js, which meant only the first caller's object store was created. Version 2 expands the database to contain both stores without removing any version-1 data." }, { "name": "GAME_EDITOR_DB_VERSION", "kind": "constant", "signature": "GAME_EDITOR_DB_VERSION", "summary": "" }, { "name": "PROJECT_HANDLES_STORE", "kind": "constant", "signature": "PROJECT_HANDLES_STORE", "summary": "" }, { "name": "PROJECTS_STORE", "kind": "constant", "signature": "PROJECTS_STORE", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "themes/cyberpunk", "path": "editor/reference/themes/cyberpunk.md", "source": "editor/js/themes/cyberpunk.js", "import": "/editor/js/themes/cyberpunk.js", "sourceHash": "01d96011663fc488e8c1a728199f0ecb8cf6ccf7442d99c0f1d165d920ecffbf", "summary": "Cyberpunk Theme - Neon pink and cyan", "exports": [ { "name": "themeCyberpunk", "kind": "constant", "signature": "themeCyberpunk", "summary": "Cyberpunk Theme - Neon pink and cyan" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "themes/dark", "path": "editor/reference/themes/dark.md", "source": "editor/js/themes/dark.js", "import": "/editor/js/themes/dark.js", "sourceHash": "2562929b9f74e2ae1e4b77c7adfe52037abf012350917bff42566f5ab5834771", "summary": "Dark Theme - Default editor theme", "exports": [ { "name": "themeDark", "kind": "constant", "signature": "themeDark", "summary": "Dark Theme - Default editor theme" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "themes/index", "path": "editor/reference/themes/index.md", "source": "editor/js/themes/index.js", "import": "/editor/js/themes/index.js", "sourceHash": "f30d19f264bf5adee0759fb64421bbb783cd1d3d5a3c3747ab33fbddf6b35a25", "summary": "Theme System Index Central theme management with modular theme files", "exports": [ { "name": "themes", "kind": "constant", "signature": "themes", "summary": "" }, { "name": "themeManager", "kind": "constant", "signature": "themeManager", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "themes/light", "path": "editor/reference/themes/light.md", "source": "editor/js/themes/light.js", "import": "/editor/js/themes/light.js", "sourceHash": "a9756ae07055ca2eed8cca4076e16f3f30ea481ba408abbea5825575fce94587", "summary": "Light Theme - Clean bright interface", "exports": [ { "name": "themeLight", "kind": "constant", "signature": "themeLight", "summary": "Light Theme - Clean bright interface" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "themes/matrix", "path": "editor/reference/themes/matrix.md", "source": "editor/js/themes/matrix.js", "import": "/editor/js/themes/matrix.js", "sourceHash": "0d8ab2841c7b55b443961e4f96c24c2cc35452493de7dcfedf1122ae9ac715fc", "summary": "Matrix Theme - Hacker green aesthetic", "exports": [ { "name": "themeMatrix", "kind": "constant", "signature": "themeMatrix", "summary": "Matrix Theme - Hacker green aesthetic" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "themes/midnight", "path": "editor/reference/themes/midnight.md", "source": "editor/js/themes/midnight.js", "import": "/editor/js/themes/midnight.js", "sourceHash": "1f30dcc3fd0977c841142cc18484a199f527be2adeb0d1f19c96f47b9f8318e4", "summary": "Midnight Blue Theme - Deep blue professional theme", "exports": [ { "name": "themeMidnight", "kind": "constant", "signature": "themeMidnight", "summary": "Midnight Blue Theme - Deep blue professional theme" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "themes/monokai", "path": "editor/reference/themes/monokai.md", "source": "editor/js/themes/monokai.js", "import": "/editor/js/themes/monokai.js", "sourceHash": "efbfed2e342ca71ce9ea3b3d435e9b6b70644750e328ff1ac3c55910fa94a14b", "summary": "Monokai Theme - Classic code editor colors", "exports": [ { "name": "themeMonokai", "kind": "constant", "signature": "themeMonokai", "summary": "Monokai Theme - Classic code editor colors" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "themes/nord", "path": "editor/reference/themes/nord.md", "source": "editor/js/themes/nord.js", "import": "/editor/js/themes/nord.js", "sourceHash": "204cad676eba278d247f54f2e06125b0e257f412eb5cc171c5f78af904e3639e", "summary": "Nord Theme - Arctic, north-bluish color palette", "exports": [ { "name": "themeNord", "kind": "constant", "signature": "themeNord", "summary": "Nord Theme - Arctic, north-bluish color palette" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "themes/ocean", "path": "editor/reference/themes/ocean.md", "source": "editor/js/themes/ocean.js", "import": "/editor/js/themes/ocean.js", "sourceHash": "ff0fc759e25e09c31cb4c85a2b08450a5320238c21cae7e92f741ae8f9ccf65e", "summary": "Ocean Theme - Deep sea blues and teals", "exports": [ { "name": "themeOcean", "kind": "constant", "signature": "themeOcean", "summary": "Ocean Theme - Deep sea blues and teals" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "themes/purple", "path": "editor/reference/themes/purple.md", "source": "editor/js/themes/purple.js", "import": "/editor/js/themes/purple.js", "sourceHash": "4957ca0ac55c9cf68ea5e4ee50e867f258e5793098b070e4ff0f427499f84bd9", "summary": "Purple Haze Theme - Vibrant purple aesthetic", "exports": [ { "name": "themePurple", "kind": "constant", "signature": "themePurple", "summary": "Purple Haze Theme - Vibrant purple aesthetic" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "themes/solarized", "path": "editor/reference/themes/solarized.md", "source": "editor/js/themes/solarized.js", "import": "/editor/js/themes/solarized.js", "sourceHash": "cff589dc6e883e521cab2c2e24b6700282068bad183d92c31dc83fe36971814e", "summary": "Solarized Dark Theme - Ethan Schoonover's iconic palette", "exports": [ { "name": "themeSolarized", "kind": "constant", "signature": "themeSolarized", "summary": "Solarized Dark Theme - Ethan Schoonover's iconic palette" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "utils/CompressionManager", "path": "editor/reference/utils/CompressionManager.md", "source": "editor/js/utils/CompressionManager.js", "import": "/editor/js/utils/CompressionManager.js", "sourceHash": "388712d64979a40361c510ee48e21baea129a5f366d7b121636fe2e29981697c", "summary": "CompressionManager - Manages background compression via WebWorker Provides async compression/decompression for timeline and undo history", "exports": [ { "name": "initCompressionWorker", "kind": "function", "signature": "initCompressionWorker()", "summary": "Initialize the compression worker" }, { "name": "compressSnapshot", "kind": "function", "signature": "async compressSnapshot(snapshot)", "summary": "" }, { "name": "computeDelta", "kind": "function", "signature": "async computeDelta(prev, current)", "summary": "" }, { "name": "decompressSnapshot", "kind": "function", "signature": "async decompressSnapshot(compressed)", "summary": "" }, { "name": "estimateCompressedSize", "kind": "function", "signature": "estimateCompressedSize(data)", "summary": "Get memory estimate for compressed data" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "utils/DialogAnimations", "path": "editor/reference/utils/DialogAnimations.md", "source": "editor/js/utils/DialogAnimations.js", "import": "/editor/js/utils/DialogAnimations.js", "sourceHash": "d0906c8a193d6e0eb300d1483f43a4e5a07662e4ade8beffcfd58687a2f68cc9", "summary": "DialogAnimations.js - Smooth open/close animations for all dialogs Provides consistent animation utilities for modals and dialogs", "exports": [ { "name": "smoothCloseDialog", "kind": "function", "signature": "smoothCloseDialog(dialog, duration = 300)", "summary": "Smoothly close a dialog with fade-out animation" }, { "name": "smoothCloseModal", "kind": "function", "signature": "smoothCloseModal(modal, duration = 300)", "summary": "Smoothly close a modal with fade-out animation" }, { "name": "closeOnBackdropClick", "kind": "function", "signature": "closeOnBackdropClick(dialog, contentSelector = '.editor-dialog-box, .modal-content, .settings-dialog')", "summary": "Close dialog on backdrop click (outside content area)" }, { "name": "closeOnEscape", "kind": "function", "signature": "closeOnEscape(dialog)", "summary": "Close dialog on Escape key" }, { "name": "setupDialogCloseHandlers", "kind": "function", "signature": "setupDialogCloseHandlers(dialog, options = {})", "summary": "Setup all standard dialog close handlers" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "utils/FrameSpikeDetector", "path": "editor/reference/utils/FrameSpikeDetector.md", "source": "editor/js/utils/FrameSpikeDetector.js", "import": "/editor/js/utils/FrameSpikeDetector.js", "sourceHash": "03e62fbfbc0a4e09fde3ba4758d9a25818a70797f8f3d69392bd60af209648f5", "summary": "FrameSpikeDetector.js - Detect and log frame time spikes Monitors frame times and logs detailed information when spikes occur, helping identify performance bottlenecks and optimization opportunities.", "exports": [ { "name": "FrameSpikeDetector", "kind": "class", "signature": "class FrameSpikeDetector", "summary": "FrameSpikeDetector.js - Detect and log frame time spikes Monitors frame times and logs detailed information when spikes occur, helping identify performance bottlenecks and optimization opportunities." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "utils/FrustumCulling", "path": "editor/reference/utils/FrustumCulling.md", "source": "editor/js/utils/FrustumCulling.js", "import": "/editor/js/utils/FrustumCulling.js", "sourceHash": "59f878cb600c910cdac917199b413b636fc8ef9b3315464cd7002ee0ef0c0899", "summary": "Extract and normalize frustum planes from a 4×4 view-projection matrix. Uses Gribb-Hartmann method (column-major matrix). Must be called once per frame before any culling tests.", "exports": [ { "name": "extractFrustumPlanes", "kind": "function", "signature": "extractFrustumPlanes(vp)", "summary": "Extract and normalize frustum planes from a 4×4 view-projection matrix. Uses Gribb-Hartmann method (column-major matrix). Must be called once per frame before any culling tests." }, { "name": "isSphereInFrustum", "kind": "function", "signature": "isSphereInFrustum(center, radius, planes)", "summary": "Test if a bounding sphere is inside or intersects the frustum." }, { "name": "isAABBInFrustum", "kind": "function", "signature": "isAABBInFrustum(minX, minY, minZ, maxX, maxY, maxZ, planes)", "summary": "Test if a world-space AABB intersects the frustum. Uses the P-vertex method: for each plane pick the AABB corner most in the direction of the plane normal (the \"positive\" vertex). If that corner is behind the plane, the entire box is outside." }, { "name": "isAABBCenterExtentsInFrustum", "kind": "function", "signature": "isAABBCenterExtentsInFrustum(cx, cy, cz, ex, ey, ez, planes)", "summary": "Convenience: test AABB from center + half-extents (world space). Converts to min/max and delegates." }, { "name": "isEntityAABBVisible", "kind": "function", "signature": "isEntityAABBVisible(entityPos, entityScale, localCenter, localExtents, planes)", "summary": "High-level entity visibility test using AABB. Takes the mesh's local-space AABB center+extents, the entity's world position and scale, and produces the world-space AABB for frustum testing." }, { "name": "isEntitySphereVisible", "kind": "function", "signature": "isEntitySphereVisible(position, scale, baseRadius)", "summary": "Legacy: entity visibility using bounding sphere (kept for broad-phase / fallback)." }, { "name": "getCullingStats", "kind": "function", "signature": "getCullingStats()", "summary": "" }, { "name": "resetStats", "kind": "function", "signature": "resetStats()", "summary": "" }, { "name": "getFrustumPlanes", "kind": "function", "signature": "getFrustumPlanes()", "summary": "Get current frustum planes (for debugging / external use)" }, { "name": "getFrustumCorners", "kind": "function", "signature": "getFrustumCorners(invViewProjMatrix)", "summary": "Calculate frustum corners in world space (for debug visualization)" }, { "name": "frustumContainsAABB", "kind": "re-export", "signature": "frustumContainsAABB", "summary": "" }, { "name": "frustumContainsSphere", "kind": "re-export", "signature": "frustumContainsSphere", "summary": "" }, { "name": "frustumFromMatrix", "kind": "re-export", "signature": "frustumFromMatrix", "summary": "" }, { "name": "frustumNormalizePlanes", "kind": "re-export", "signature": "frustumNormalizePlanes", "summary": "" }, { "name": "frustumTestAABB", "kind": "re-export", "signature": "frustumTestAABB", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "utils/GPUBufferPool", "path": "editor/reference/utils/GPUBufferPool.md", "source": "editor/js/utils/GPUBufferPool.js", "import": "/editor/js/utils/GPUBufferPool.js", "sourceHash": "c611b996bb56ae4f1ca94a1f74d51baf8cd5678309f0d3340072c7dbb7172ae7", "summary": "Get a buffer from pool or create new one", "exports": [ { "name": "getBuffer", "kind": "function", "signature": "getBuffer(device, size, usage, label = '')", "summary": "Get a buffer from pool or create new one" }, { "name": "releaseBuffer", "kind": "function", "signature": "releaseBuffer(buffer, usage)", "summary": "Return a buffer to the pool" }, { "name": "getPoolStats", "kind": "function", "signature": "getPoolStats()", "summary": "Get pool statistics" }, { "name": "clearPools", "kind": "function", "signature": "clearPools()", "summary": "Clear all pools and destroy buffers" }, { "name": "trimPools", "kind": "function", "signature": "trimPools(keepCount = 2)", "summary": "Trim pools to reduce memory" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "utils/InterpolationCurves", "path": "editor/reference/utils/InterpolationCurves.md", "source": "editor/js/utils/InterpolationCurves.js", "import": "/editor/js/utils/InterpolationCurves.js", "sourceHash": "15f592eb2709edb8548608bb2cde818fdadf4af39a722a7c9be0d46f872db374", "summary": "Animation track - keyframe-based animation", "exports": [ { "name": "AnimationTrack", "kind": "class", "signature": "class AnimationTrack", "summary": "Animation track - keyframe-based animation" }, { "name": "Tween", "kind": "class", "signature": "class Tween", "summary": "Tween - simple value animation" }, { "name": "smoothstep", "kind": "function", "signature": "smoothstep(t)", "summary": "Smoothstep interpolation (Hermite)" }, { "name": "smootherstep", "kind": "function", "signature": "smootherstep(t)", "summary": "Smootherstep (Ken Perlin's improved version)" }, { "name": "springInterpolation", "kind": "function", "signature": "springInterpolation(t, stiffness = 100, damping = 10)", "summary": "Spring interpolation with damping" }, { "name": "bounceInterpolation", "kind": "function", "signature": "bounceInterpolation(t)", "summary": "Bounce interpolation" }, { "name": "lerp", "kind": "function", "signature": "lerp(from, to, t, easing = 'linear')", "summary": "Interpolate between two values with easing" }, { "name": "lerpVec3", "kind": "function", "signature": "lerpVec3(from, to, t, easing = 'linear')", "summary": "Interpolate between two vec3s with easing" }, { "name": "slerp", "kind": "function", "signature": "slerp(q1, q2, t, easing = 'linear')", "summary": "Spherical linear interpolation for quaternions (SLERP)" }, { "name": "catmullRom", "kind": "function", "signature": "catmullRom(points, t, closed = false)", "summary": "Catmull-Rom spline interpolation (passes through all control points)" }, { "name": "bSpline", "kind": "function", "signature": "bSpline(points, t, degree = 3)", "summary": "B-Spline interpolation (smooth curve, doesn't pass through control points)" }, { "name": "hermite", "kind": "function", "signature": "hermite(p0, m0, p1, m1, t)", "summary": "Hermite spline interpolation" }, { "name": "EASING_FUNCTIONS", "kind": "constant", "signature": "EASING_FUNCTIONS", "summary": "" }, { "name": "CubicBezier", "kind": "re-export", "signature": "CubicBezier", "summary": "" }, { "name": "easeInBack", "kind": "re-export", "signature": "easeInBack", "summary": "" }, { "name": "easeInCirc", "kind": "re-export", "signature": "easeInCirc", "summary": "" }, { "name": "easeInCubic", "kind": "re-export", "signature": "easeInCubic", "summary": "" }, { "name": "easeInElastic", "kind": "re-export", "signature": "easeInElastic", "summary": "" }, { "name": "easeInExpo", "kind": "re-export", "signature": "easeInExpo", "summary": "" }, { "name": "easeInOutBack", "kind": "re-export", "signature": "easeInOutBack", "summary": "" }, { "name": "easeInOutCirc", "kind": "re-export", "signature": "easeInOutCirc", "summary": "" }, { "name": "easeInOutCubic", "kind": "re-export", "signature": "easeInOutCubic", "summary": "" }, { "name": "easeInOutElastic", "kind": "re-export", "signature": "easeInOutElastic", "summary": "" }, { "name": "easeInOutExpo", "kind": "re-export", "signature": "easeInOutExpo", "summary": "" }, { "name": "easeInOutQuad", "kind": "re-export", "signature": "easeInOutQuad", "summary": "" }, { "name": "easeInOutQuart", "kind": "re-export", "signature": "easeInOutQuart", "summary": "" }, { "name": "easeInOutQuint", "kind": "re-export", "signature": "easeInOutQuint", "summary": "" }, { "name": "easeInOutSine", "kind": "re-export", "signature": "easeInOutSine", "summary": "" }, { "name": "easeInQuad", "kind": "re-export", "signature": "easeInQuad", "summary": "" }, { "name": "easeInQuart", "kind": "re-export", "signature": "easeInQuart", "summary": "" }, { "name": "easeInQuint", "kind": "re-export", "signature": "easeInQuint", "summary": "" }, { "name": "easeInSine", "kind": "re-export", "signature": "easeInSine", "summary": "" }, { "name": "easeLinear", "kind": "re-export", "signature": "easeLinear", "summary": "" }, { "name": "easeOutBack", "kind": "re-export", "signature": "easeOutBack", "summary": "" }, { "name": "easeOutCirc", "kind": "re-export", "signature": "easeOutCirc", "summary": "" }, { "name": "easeOutCubic", "kind": "re-export", "signature": "easeOutCubic", "summary": "" }, { "name": "easeOutElastic", "kind": "re-export", "signature": "easeOutElastic", "summary": "" }, { "name": "easeOutExpo", "kind": "re-export", "signature": "easeOutExpo", "summary": "" }, { "name": "easeOutQuad", "kind": "re-export", "signature": "easeOutQuad", "summary": "" }, { "name": "easeOutQuart", "kind": "re-export", "signature": "easeOutQuart", "summary": "" }, { "name": "easeOutQuint", "kind": "re-export", "signature": "easeOutQuint", "summary": "" }, { "name": "easeOutSine", "kind": "re-export", "signature": "easeOutSine", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "utils/MemoryIntegration", "path": "editor/reference/utils/MemoryIntegration.md", "source": "editor/js/utils/MemoryIntegration.js", "import": "/editor/js/utils/MemoryIntegration.js", "sourceHash": "cd2fe6cdd7b0ed3a6891d326f9d5135313dc8899ec9a35c01def8ffd8f607e7d", "summary": "MemoryIntegration.js - Wires up off-heap memory to editor/engine systems Integrates OffHeapMemoryManager with: - Particle snapshot system (large frame buffers → WASM/Worker) - Editor history (old undo entries → IDB) - Asset cache (loaded assets → Worker memory) - Profiler timeline (frame history → off-heap)", "exports": [ { "name": "initMemoryIntegration", "kind": "function", "signature": "async initMemoryIntegration(gpuDevice = null)", "summary": "Initialize memory integration" }, { "name": "getMemoryPressure", "kind": "function", "signature": "getMemoryPressure()", "summary": "Get current memory pressure (0-1)" }, { "name": "shouldOffload", "kind": "function", "signature": "shouldOffload()", "summary": "Check if we should offload to off-heap storage" }, { "name": "storeParticleFrame", "kind": "function", "signature": "async storeParticleFrame(frameIndex, frameData)", "summary": "Store particle frame in off-heap memory Large frames (>100KB) go to worker memory" }, { "name": "retrieveParticleFrame", "kind": "function", "signature": "async retrieveParticleFrame(frameIndex)", "summary": "Retrieve particle frame from off-heap storage" }, { "name": "freeParticleFrame", "kind": "function", "signature": "async freeParticleFrame(frameIndex)", "summary": "" }, { "name": "archiveHistoryEntry", "kind": "function", "signature": "async archiveHistoryEntry(index, entry)", "summary": "Store old history entry to IDB when memory pressure is high" }, { "name": "retrieveHistoryEntry", "kind": "function", "signature": "async retrieveHistoryEntry(index)", "summary": "Retrieve archived history entry from IDB" }, { "name": "cacheAsset", "kind": "function", "signature": "async cacheAsset(uuid, data)", "summary": "Store large asset in worker memory" }, { "name": "retrieveCachedAsset", "kind": "function", "signature": "async retrieveCachedAsset(uuid, asText = false)", "summary": "Retrieve cached asset from worker memory" }, { "name": "storeProfilerFrames", "kind": "function", "signature": "storeProfilerFrames(frames)", "summary": "Store profiler frame batch in WASM memory" }, { "name": "getMemoryStats", "kind": "function", "signature": "async getMemoryStats()", "summary": "Get comprehensive memory stats" }, { "name": "formatMemoryForProfiler", "kind": "function", "signature": "formatMemoryForProfiler(stats)", "summary": "Format memory stats for profiler display" }, { "name": "getManager", "kind": "function", "signature": "getManager()", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "utils/ObjectPool", "path": "editor/reference/utils/ObjectPool.md", "source": "editor/js/utils/ObjectPool.js", "import": "/editor/js/utils/ObjectPool.js", "sourceHash": "4b5a94b58d6822b5d0b9a6b7cf858c5cf84ca8f1af947f93706d5d1b750ef984", "summary": "Get a Float32Array of specified size from pool", "exports": [ { "name": "getFloat32Array", "kind": "function", "signature": "getFloat32Array(size)", "summary": "Get a Float32Array of specified size from pool" }, { "name": "releaseFloat32Array", "kind": "function", "signature": "releaseFloat32Array(arr)", "summary": "Return a Float32Array to the pool" }, { "name": "getArray", "kind": "function", "signature": "getArray()", "summary": "Get a generic array from pool" }, { "name": "releaseArray", "kind": "function", "signature": "releaseArray(arr)", "summary": "Return a generic array to the pool" }, { "name": "getVec3", "kind": "function", "signature": "getVec3(x = 0, y = 0, z = 0)", "summary": "Get a vec3 [x, y, z] from pool" }, { "name": "releaseVec3", "kind": "function", "signature": "releaseVec3(v)", "summary": "Return a vec3 to pool" }, { "name": "getVec4", "kind": "function", "signature": "getVec4(x = 0, y = 0, z = 0, w = 1)", "summary": "Get a vec4 [x, y, z, w] from pool" }, { "name": "releaseVec4", "kind": "function", "signature": "releaseVec4(v)", "summary": "Return a vec4 to pool" }, { "name": "getMat4", "kind": "function", "signature": "getMat4()", "summary": "Get a mat4 (16 floats) from pool" }, { "name": "releaseMat4", "kind": "function", "signature": "releaseMat4(m)", "summary": "Return a mat4 to pool" }, { "name": "getPoolStats", "kind": "function", "signature": "getPoolStats()", "summary": "Get pool statistics" }, { "name": "clearPools", "kind": "function", "signature": "clearPools()", "summary": "Clear all pools (for memory pressure situations)" }, { "name": "trimPools", "kind": "function", "signature": "trimPools(keepRatio = 0.5)", "summary": "Trim pools to reduce memory (keep some for reuse)" }, { "name": "transformPool", "kind": "constant", "signature": "transformPool", "summary": "" }, { "name": "snapshotEntityPool", "kind": "constant", "signature": "snapshotEntityPool", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "utils/OffHeapMemory", "path": "editor/reference/utils/OffHeapMemory.md", "source": "editor/js/utils/OffHeapMemory.js", "import": "/editor/js/utils/OffHeapMemory.js", "sourceHash": "9c486be0279902350b24eacd1e64d7a1e3e0eef52dd1bcf87ad31e27185149a8", "summary": "OffHeapMemory.js - MAXIMUM Memory Expansion System Pushes browser memory limits to the absolute maximum using every available strategy: 1. Multi-WASM Pool - Multiple 4GB WASM modules (up to 16GB+ total) 2. Worker Memory Pool - Each worker has its own ~4GB heap 3. SharedArrayBuffer - Zero-copy cross-worker/thread communication 4. GPU Buffer Storage - VRAM is separate from system RAM limits 5. IndexedDB Sharding - Multiple databases for unlimited persistent storage 6. ArrayBuffer Pooling - Aggressive reuse to minimize GC pressure 7. Memory Pressure Management - Auto-offloading and tiered storage THEORETICAL MAXIMUM: - 4 WASM modules × 4GB = 16GB - 8 Workers × 4GB heap = 32GB (but shared address space limits this) - GPU buffers = Limited by VRAM (8-24GB on modern GPUs) - IndexedDB = Unlimited (disk-backed) PRACTICAL MAXIMUM: ~8-16GB usable off-heap memory", "exports": [ { "name": "MultiWasmMemoryPool", "kind": "class", "signature": "class MultiWasmMemoryPool", "summary": "Multi-WASM Memory Pool Creates multiple WASM memory instances, each up to 4GB Total capacity: up to 16GB off-heap" }, { "name": "ArrayBufferPool", "kind": "class", "signature": "class ArrayBufferPool", "summary": "ArrayBuffer pool for reducing GC pressure Reuses buffers instead of creating new ones" }, { "name": "GPUBufferStorage", "kind": "class", "signature": "class GPUBufferStorage", "summary": "GPU buffer storage for large data Keeps data in VRAM instead of JS heap" }, { "name": "IndexedDBStorage", "kind": "class", "signature": "class IndexedDBStorage", "summary": "IndexedDB storage for large persistent data" }, { "name": "WorkerMemoryPool", "kind": "class", "signature": "class WorkerMemoryPool", "summary": "Worker-based memory expansion Each Web Worker has its own JS heap (~4GB potential) Spawn multiple workers to multiply available memory" }, { "name": "SharedRingBuffer", "kind": "class", "signature": "class SharedRingBuffer", "summary": "SharedArrayBuffer Ring Buffer Zero-copy data sharing between main thread and workers Requires Cross-Origin-Isolation headers" }, { "name": "MaxGPUBufferStorage", "kind": "class", "signature": "class MaxGPUBufferStorage extends GPUBufferStorage", "summary": "Maximum GPU Buffer Storage Aggressively uses VRAM for data storage" }, { "name": "OffHeapMemoryManager", "kind": "class", "signature": "class OffHeapMemoryManager", "summary": "MAXIMUM Memory Expansion Manager Combines ALL strategies for absolute maximum memory capacity" }, { "name": "invalidateLegacyOffHeapCaches", "kind": "function", "signature": "async invalidateLegacyOffHeapCaches(indexedDBApi = globalThis.indexedDB)", "summary": "" }, { "name": "getOffHeapManager", "kind": "function", "signature": "getOffHeapManager()", "summary": "" }, { "name": "initOffHeapManager", "kind": "function", "signature": "async initOffHeapManager(device = null, options = {})", "summary": "" }, { "name": "OFFHEAP_CACHE_NAMESPACE", "kind": "constant", "signature": "OFFHEAP_CACHE_NAMESPACE", "summary": "" }, { "name": "OFFHEAP_CACHE_VERSION", "kind": "constant", "signature": "OFFHEAP_CACHE_VERSION", "summary": "" }, { "name": "OFFHEAP_CACHE_DB_NAME", "kind": "constant", "signature": "OFFHEAP_CACHE_DB_NAME", "summary": "" }, { "name": "OFFHEAP_LEGACY_CACHE_DB_NAMES", "kind": "constant", "signature": "OFFHEAP_LEGACY_CACHE_DB_NAMES", "summary": "" }, { "name": "WasmMemoryPool", "kind": "constant", "signature": "WasmMemoryPool", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "utils/PhysicsBodyPool", "path": "editor/reference/utils/PhysicsBodyPool.md", "source": "editor/js/utils/PhysicsBodyPool.js", "import": "/editor/js/utils/PhysicsBodyPool.js", "sourceHash": "38f7c419908abc9483ee5b89ec23beb008e85bc4965af46389b7f2dd8a36dff5", "summary": "Get a body handle from pool or signal that new one is needed", "exports": [ { "name": "getPooledBody", "kind": "function", "signature": "getPooledBody(simMode, colliderShape)", "summary": "Get a body handle from pool or signal that new one is needed" }, { "name": "releaseBody", "kind": "function", "signature": "releaseBody(physicsWorld, bodyHandle, simMode, colliderShape)", "summary": "Return a body to the pool for reuse" }, { "name": "resetPooledBody", "kind": "function", "signature": "resetPooledBody(physicsWorld, bodyHandle, position, rotation, scale)", "summary": "Reset a pooled body for reuse with new transform" }, { "name": "getPoolStats", "kind": "function", "signature": "getPoolStats()", "summary": "Get pool statistics" }, { "name": "clearPools", "kind": "function", "signature": "clearPools(physicsWorld)", "summary": "Clear all pools (destroys pooled bodies)" }, { "name": "trimPools", "kind": "function", "signature": "trimPools(keepCount = 5)", "summary": "Trim pools to reduce memory" }, { "name": "BODY_TYPES", "kind": "re-export", "signature": "BODY_TYPES", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "utils/RenderBundleCache", "path": "editor/reference/utils/RenderBundleCache.md", "source": "editor/js/utils/RenderBundleCache.js", "import": "/editor/js/utils/RenderBundleCache.js", "sourceHash": "435b4b2309494af850cd462728e09854185e25137376dd16cef7f0e9e4996df9", "summary": "Create or get cached render bundle", "exports": [ { "name": "getOrCreateBundle", "kind": "function", "signature": "getOrCreateBundle(device, key, version, descriptor, recordFn)", "summary": "Create or get cached render bundle" }, { "name": "invalidateBundle", "kind": "function", "signature": "invalidateBundle(key)", "summary": "Invalidate a specific bundle (force re-record next frame)" }, { "name": "invalidateBundlesWithPrefix", "kind": "function", "signature": "invalidateBundlesWithPrefix(prefix)", "summary": "Invalidate all bundles matching a prefix" }, { "name": "clearBundleCache", "kind": "function", "signature": "clearBundleCache()", "summary": "Clear all cached bundles" }, { "name": "pruneOldBundles", "kind": "function", "signature": "pruneOldBundles(maxAgeMs = 60000)", "summary": "Remove bundles not used recently" }, { "name": "getCacheStats", "kind": "function", "signature": "getCacheStats()", "summary": "Get cache statistics" }, { "name": "createStandardDescriptor", "kind": "function", "signature": "createStandardDescriptor(colorFormat = 'bgra8unorm', depthFormat = 'depth24plus')", "summary": "Helper to create standard descriptor for color + depth rendering" }, { "name": "executeBundles", "kind": "function", "signature": "executeBundles(passEncoder, bundles)", "summary": "Execute render bundles in a render pass" }, { "name": "EngineRenderBundleCache", "kind": "re-export", "signature": "EngineRenderBundleCache", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "utils/SIMDMath", "path": "editor/reference/utils/SIMDMath.md", "source": "editor/js/utils/SIMDMath.js", "import": "/editor/js/utils/SIMDMath.js", "sourceHash": "7c63032b5269c92c8a44ab789195c733b46b1aa6246998c4c86172b755552a2e", "summary": "Create a batch of vec3s in SoA format", "exports": [ { "name": "createVec3Batch", "kind": "function", "signature": "createVec3Batch(count)", "summary": "Create a batch of vec3s in SoA format" }, { "name": "vec3ArrayToBatch", "kind": "function", "signature": "vec3ArrayToBatch(vectors)", "summary": "Create batch from array of [x,y,z] vectors" }, { "name": "batchToVec3Array", "kind": "function", "signature": "batchToVec3Array(batch)", "summary": "Convert batch back to array of [x,y,z]" }, { "name": "batchAdd", "kind": "function", "signature": "batchAdd(a, b, out = createVec3Batch(a.count)", "summary": "Batch add: out = a + b" }, { "name": "batchSub", "kind": "function", "signature": "batchSub(a, b, out = createVec3Batch(a.count)", "summary": "Batch subtract: out = a - b" }, { "name": "batchScale", "kind": "function", "signature": "batchScale(a, scalar, out = createVec3Batch(a.count)", "summary": "Batch scale: out = a * scalar" }, { "name": "batchMul", "kind": "function", "signature": "batchMul(a, b, out = createVec3Batch(a.count)", "summary": "Batch multiply component-wise: out = a * b" }, { "name": "batchDot", "kind": "function", "signature": "batchDot(a, b, out = new Float32Array(a.count)", "summary": "Batch dot product: out[i] = dot(a[i], b[i])" }, { "name": "batchCross", "kind": "function", "signature": "batchCross(a, b, out = createVec3Batch(a.count)", "summary": "Batch cross product: out = a × b" }, { "name": "batchLengthSq", "kind": "function", "signature": "batchLengthSq(a, out = new Float32Array(a.count)", "summary": "Batch length squared: out[i] = |a[i]|²" }, { "name": "batchLength", "kind": "function", "signature": "batchLength(a, out = new Float32Array(a.count)", "summary": "Batch length: out[i] = |a[i]|" }, { "name": "batchNormalize", "kind": "function", "signature": "batchNormalize(a, out = createVec3Batch(a.count)", "summary": "Batch normalize: out[i] = normalize(a[i])" }, { "name": "batchLerp", "kind": "function", "signature": "batchLerp(a, b, t, out = createVec3Batch(a.count)", "summary": "Batch lerp: out = lerp(a, b, t)" }, { "name": "batchTransform", "kind": "function", "signature": "batchTransform(batch, m, out = createVec3Batch(batch.count)", "summary": "Batch transform by 4x4 matrix" }, { "name": "batchDistanceToPoint", "kind": "function", "signature": "batchDistanceToPoint(batch, point, out = new Float32Array(batch.count)", "summary": "Batch distance to point" }, { "name": "batchDistanceSqToPoint", "kind": "function", "signature": "batchDistanceSqToPoint(batch, point, out = new Float32Array(batch.count)", "summary": "Batch distance squared to point (faster, for comparisons)" }, { "name": "batchFindWithinRadius", "kind": "function", "signature": "batchFindWithinRadius(batch, point, radius)", "summary": "Find indices within radius of point" }, { "name": "batchFindKNearest", "kind": "function", "signature": "batchFindKNearest(batch, point, k)", "summary": "Find K nearest neighbors" }, { "name": "batchComputeAABB", "kind": "function", "signature": "batchComputeAABB(batch)", "summary": "Batch AABB computation" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "utils/SpatialIndex", "path": "editor/reference/utils/SpatialIndex.md", "source": "editor/js/utils/SpatialIndex.js", "import": "/editor/js/utils/SpatialIndex.js", "sourceHash": "ce07bd44a5fc58434a7d2a31fc067d039310487ad753ce81e013ccede4c9244d", "summary": "Simple Octree for dynamic entity queries Better for frequently changing scenes than BVH", "exports": [ { "name": "Octree", "kind": "class", "signature": "class Octree", "summary": "Simple Octree for dynamic entity queries Better for frequently changing scenes than BVH" }, { "name": "EntitySpatialIndex", "kind": "class", "signature": "class EntitySpatialIndex", "summary": "EntitySpatialIndex - Manages spatial indexing for editor entities" }, { "name": "BVHBuilder", "kind": "re-export", "signature": "BVHBuilder", "summary": "" }, { "name": "BVHNode", "kind": "re-export", "signature": "BVHNode", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "utils/TextureCompression", "path": "editor/reference/utils/TextureCompression.md", "source": "editor/js/utils/TextureCompression.js", "import": "/editor/js/utils/TextureCompression.js", "sourceHash": "41f6e7d6b4ff7ec44bb32b57773db17a5b8dcdd0c8017055fefda182d41816ab", "summary": "TextureCompression - WebGPU compressed texture format support. Supports: - BC formats (Desktop: DXT/S3TC) - ASTC formats (Mobile/Apple) - ETC2 formats (Android/WebGL fallback)", "exports": [ { "name": "detectCompressedFormats", "kind": "function", "signature": "detectCompressedFormats(adapter)", "summary": "Detect supported compressed texture formats." }, { "name": "getOptimalFormat", "kind": "function", "signature": "getOptimalFormat(adapter, needsAlpha = true)", "summary": "Get optimal texture format for device." }, { "name": "getCompressedSize", "kind": "function", "signature": "getCompressedSize(width, height, format)", "summary": "Calculate compressed texture size." }, { "name": "getMemorySavings", "kind": "function", "signature": "getMemorySavings(width, height, compressedFormat)", "summary": "Calculate memory savings percentage." }, { "name": "getQualitySizeScore", "kind": "function", "signature": "getQualitySizeScore(width, height, format, options = {})", "summary": "Calculate a quality-size report for picker and audit UI." }, { "name": "createCompressedTexture", "kind": "function", "signature": "createCompressedTexture(device, adapter, descriptor)", "summary": "Create compressed texture with fallback." }, { "name": "getFormatInfo", "kind": "function", "signature": "getFormatInfo(format)", "summary": "Get format info for display." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "utils/WeakCache", "path": "editor/reference/utils/WeakCache.md", "source": "editor/js/utils/WeakCache.js", "import": "/editor/js/utils/WeakCache.js", "sourceHash": "56411761902844f58da03283d3f8b22627c15e1d731c5bedc1e79dbdc33435e8", "summary": "WeakValueMap - Map with weak references to values Values are auto-removed when garbage collected", "exports": [ { "name": "WeakValueMap", "kind": "class", "signature": "class WeakValueMap", "summary": "WeakValueMap - Map with weak references to values Values are auto-removed when garbage collected" }, { "name": "LRUCache", "kind": "class", "signature": "class LRUCache", "summary": "LRUCache - Least Recently Used cache with max size" }, { "name": "TTLCache", "kind": "class", "signature": "class TTLCache", "summary": "TTLCache - Cache with time-to-live expiration" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/AuraRenderer", "path": "editor/reference/viewport/AuraRenderer.md", "source": "editor/js/viewport/AuraRenderer.js", "import": "/editor/js/viewport/AuraRenderer.js", "sourceHash": "8456893608ffdb4fc3c6ef6ab0aca21b16b199a18cc77098b5edb3495edadd60", "summary": "AuraRenderer — System 1: Outer Energy Shell / Aura Layer ========================================================= Renders the actual model mesh at slightly expanded scale with electric blue-cyan color — same approach as SkinRenderer but bigger and more transparent. No hull approximation needed; the real mesh IS the aura shell. LAYER ROLE: Outermost visible layer — glowing energy field that exactly traces the body shape at AURA_SCALE (8% larger than entity scale). VISUAL: - Full-res model mesh, electric blue-cyan [0.2, 0.7, 1.0, 0.15] - Scale multiplied by AURA_SCALE so it sits slightly outside the skin - High roughness for a soft diffuse glow look DATA SOURCE: EntityMeshRenderer already has 'custom_' registered. No extra work. INDEPENDENCE: - No imports needed beyond EntityMeshRenderer (draw) - No reference to SkinRenderer, SkeletonRenderer, SDFColliderRenderer", "exports": [ { "name": "AuraRenderer", "kind": "class", "signature": "class AuraRenderer", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/CameraController", "path": "editor/reference/viewport/CameraController.md", "source": "editor/js/viewport/CameraController.js", "import": "/editor/js/viewport/CameraController.js", "sourceHash": "0f3cf6284abebfff96e9c7edf52ce7b0fae14991b940d46703ee6ae908490459", "summary": "", "exports": [ { "name": "CameraController", "kind": "class", "signature": "class CameraController", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/CollabOverlayRenderer", "path": "editor/reference/viewport/CollabOverlayRenderer.md", "source": "editor/js/viewport/CollabOverlayRenderer.js", "import": "/editor/js/viewport/CollabOverlayRenderer.js", "sourceHash": "e5081da39c3b05c3657b2423b59f5afe6fee567013f27e6b5838a1d69d054dfa", "summary": "CollabOverlayRenderer.js Renders peer cameras as small 3D camcorder-style pyramids in the viewport, with colored tint matching the peer's chosen color and a floating name label. Uses the existing EntityMeshRenderer to draw pyramids (no new GPU pipelines needed). Name labels are HTML overlays positioned via 3D→2D projection.", "exports": [ { "name": "CollabOverlayRenderer", "kind": "class", "signature": "class CollabOverlayRenderer", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/GhostPreviewRenderer", "path": "editor/reference/viewport/GhostPreviewRenderer.md", "source": "editor/js/viewport/GhostPreviewRenderer.js", "import": "/editor/js/viewport/GhostPreviewRenderer.js", "sourceHash": "f5fba947677b0d389645ab7efc411b55dd416f1480714d8040c2fa90c0a5addf", "summary": "", "exports": [ { "name": "GhostPreviewRenderer", "kind": "class", "signature": "class GhostPreviewRenderer", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/SDFColliderRenderer", "path": "editor/reference/viewport/SDFColliderRenderer.md", "source": "editor/js/viewport/SDFColliderRenderer.js", "import": "/editor/js/viewport/SDFColliderRenderer.js", "sourceHash": "a31e779474372f262f8866dc8fc0158cc25e822f6b13f88dd28ffe5de82ff887", "summary": "", "exports": [ { "name": "SDFColliderRenderer", "kind": "class", "signature": "class SDFColliderRenderer", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/ShapeWireframes", "path": "editor/reference/viewport/ShapeWireframes.md", "source": "editor/js/viewport/ShapeWireframes.js", "import": "/editor/js/viewport/ShapeWireframes.js", "sourceHash": "420ffad89328f100b5c1b77088cee47b5b0eb0189ce6eab94064cb94e843be6a", "summary": "ShapeWireframes.js — Shared shape-specific wireframe generators ================================================================ Used by SkeletonRenderer, SkinRenderer, and AuraRenderer to render shape-accurate wireframe overlays that match the SDF collider shapes. Each generator returns { joints: [[x,y,z],...], edges: [[i,j],...] } in LOCAL space. The caller transforms to world space.", "exports": [ { "name": "generateShapeWireframe", "kind": "function", "signature": "generateShapeWireframe(meshType, es, ep, er, doRot)", "summary": "Generate a shape-specific wireframe for an entity." }, { "name": "quatFromDir", "kind": "function", "signature": "quatFromDir(dx, dy, dz)", "summary": "Compute quaternion that aligns Y-axis [0,1,0] with direction [dx,dy,dz]. Exported for use in renderers that draw capsule sticks between joints." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/SkeletonRenderer", "path": "editor/reference/viewport/SkeletonRenderer.md", "source": "editor/js/viewport/SkeletonRenderer.js", "import": "/editor/js/viewport/SkeletonRenderer.js", "sourceHash": "e7d4dbd709b5d554151d2f13c28b7264f2d82e653e3a3a024dcf50f00592acb6", "summary": "SkeletonRenderer — System 3: X-Ray Skeleton / Bone Layer ========================================================= Renders the internal skeleton as solid physical geometry — gold ball joints at each bone pivot, ivory metallic bone sticks connecting them. Think medical X-ray imaging or the internal rig view in a 3D animation tool. LAYER ROLE: Innermost visible layer — inside the skin capsules. Fully opaque metallic geometry. Shows the exact bone hierarchy as a physical rig. VISUAL: Ball joints: gold [1.0, 0.85, 0.3, 1.0], metallic=0.9, roughness=0.15 Bone sticks: ivory [0.95, 0.9, 0.8, 1.0], metallic=0.85, roughness=0.2 Sizes scaled by body height — proportionally correct DATA SOURCE: getAnimatedBoneShapes() → .joints[] (all joint world positions + child links) INDEPENDENCE: - Imports ONLY from SkeletalAnimation.js (data) and EntityMeshRenderer (draw) - No reference to AuraRenderer, SkinRenderer, SDFColliderRenderer - Can be deleted without affecting any other system EDIT MODE vs PLAY MODE: Edit: animated bone joints from getAnimatedBoneShapes() Play (ragdoll): bone positions from live physics bodies", "exports": [ { "name": "SkeletonRenderer", "kind": "class", "signature": "class SkeletonRenderer", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/SkinRenderer", "path": "editor/reference/viewport/SkinRenderer.md", "source": "editor/js/viewport/SkinRenderer.js", "import": "/editor/js/viewport/SkinRenderer.js", "sourceHash": "56e1889b47b491894bbe347759f68e378db4413251762af53a0762f31cf99f95", "summary": "SkinRenderer — System 2: High-Detail Body Skin ================================================ Renders the ACTUAL mesh geometry of the entity, semi-transparent, with a warm skin tone. Full triangle count of the imported model — this is NOT a hull approximation. The mesh IS the skin layer. LAYER ROLE: Inner visible layer — shows the real body geometry as a translucent skin shell. Since it uses the same mesh as the actual entity render, it is perfectly shape-accurate at full detail. VISUAL: - Full-res model mesh, warm skin tone [0.9, 0.6, 0.4, 0.28] - Rendered via the existing 'custom_' mesh key already in EntityMeshRenderer - No separate mesh registration needed — the mesh is already uploaded DATA SOURCE: EntityMeshRenderer already has the 'custom_' mesh registered when the entity loads. No separate computation needed — just pass entity transform directly. INDEPENDENCE: - No external imports needed beyond EntityMeshRenderer (draw) - No reference to AuraRenderer, SkeletonRenderer, SDFColliderRenderer", "exports": [ { "name": "SkinRenderer", "kind": "class", "signature": "class SkinRenderer", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/SurfaceGridRenderer", "path": "editor/reference/viewport/SurfaceGridRenderer.md", "source": "editor/js/viewport/SurfaceGridRenderer.js", "import": "/editor/js/viewport/SurfaceGridRenderer.js", "sourceHash": "5e59066084c974ded5200d0a3b1faecb515b662ec38cb375cecaa2ab5d4efb2d", "summary": "SurfaceGridRenderer.js GMod-style surface grid overlay for precise tool placement Shows a transparent green grid aligned to the surface normal", "exports": [ { "name": "SurfaceGridRenderer", "kind": "class", "signature": "class SurfaceGridRenderer", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/ViewportMeshUtils", "path": "editor/reference/viewport/ViewportMeshUtils.md", "source": "editor/js/viewport/ViewportMeshUtils.js", "import": "/editor/js/viewport/ViewportMeshUtils.js", "sourceHash": "d6a6704aa13454e7e3ded7da3955846153918de2125a8df9354938df0066c3ba", "summary": "ViewportMeshUtils - Mesh type inference and color mapping utilities Extracted from Viewport.js for modularity", "exports": [ { "name": "getSpawnIdLower", "kind": "function", "signature": "getSpawnIdLower(entityMeta)", "summary": "Get lowercase spawnId for an entityMeta (no caching — small string allocs are cheaper than WeakMap GC overhead)" }, { "name": "isEmitterEntity", "kind": "function", "signature": "isEmitterEntity(entityMeta)", "summary": "Check if entityMeta represents an emitter" }, { "name": "getEntityMeshTypes", "kind": "function", "signature": "getEntityMeshTypes(entityMeta, fallbackMeshType = null)", "summary": "" }, { "name": "getEntityMeshParts", "kind": "function", "signature": "getEntityMeshParts(entityMeta, fallbackMeshType = null)", "summary": "" }, { "name": "getModelPartLocalMatrix", "kind": "function", "signature": "getModelPartLocalMatrix(part, animatedMatrix = null)", "summary": "" }, { "name": "composeEntityPartMatrix", "kind": "function", "signature": "composeEntityPartMatrix(position, rotation, scale, part, animatedMatrix = null)", "summary": "" }, { "name": "transformAabbByMatrix", "kind": "function", "signature": "transformAabbByMatrix(bounds, matrix)", "summary": "" }, { "name": "getAggregateMeshBounds", "kind": "function", "signature": "getAggregateMeshBounds(entityMeta, meshRenderer, fallbackMeshType = null, resolveAnimatedMatrix = null)", "summary": "" }, { "name": "inferMeshMaterial", "kind": "function", "signature": "inferMeshMaterial(meshType)", "summary": "Get PBR material properties for a mesh type" }, { "name": "inferEntityMeshTypeAndColor", "kind": "function", "signature": "inferEntityMeshTypeAndColor(entityMeta)", "summary": "Infer mesh type and color from entity metadata Results are cached for performance" }, { "name": "clearMeshTypeCache", "kind": "function", "signature": "clearMeshTypeCache()", "summary": "Clear mesh type cache (call when entities are added/removed/renamed)" }, { "name": "snapToGrid", "kind": "function", "signature": "snapToGrid(value, gridSize, enabled)", "summary": "Snap a value to grid" }, { "name": "DEFAULT_COLOR", "kind": "re-export", "signature": "DEFAULT_COLOR", "summary": "" }, { "name": "MESH_TYPE_COLORS", "kind": "re-export", "signature": "MESH_TYPE_COLORS", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/ViewportProfiler", "path": "editor/reference/viewport/ViewportProfiler.md", "source": "editor/js/viewport/ViewportProfiler.js", "import": "/editor/js/viewport/ViewportProfiler.js", "sourceHash": "750e6d51fe652b34b79d0df1b853823de999463ce03420cd85fc48845a886cf4", "summary": "ViewportProfiler - Performance profiler UI for the viewport Extracted from Viewport.js for modularity", "exports": [ { "name": "ViewportProfiler", "kind": "class", "signature": "class ViewportProfiler", "summary": "" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/ViewportRaycasting", "path": "editor/reference/viewport/ViewportRaycasting.md", "source": "editor/js/viewport/ViewportRaycasting.js", "import": "/editor/js/viewport/ViewportRaycasting.js", "sourceHash": "aab744e4f628740bea2ded19bb0457fff83e07c1cc845bee2fcefd12265d4807", "summary": "ViewportRaycasting.js - Pure raycasting math utilities Extracted from Viewport.js for modularity", "exports": [ { "name": "rayGroundPlaneIntersect", "kind": "function", "signature": "rayGroundPlaneIntersect(rayOrigin, rayDir, planeY = 0)", "summary": "Ray-ground plane intersection" }, { "name": "raySegmentDistance", "kind": "function", "signature": "raySegmentDistance(rayOrigin, rayDir, segA, segB)", "summary": "Calculate distance from ray to line segment (for rope picking)" }, { "name": "raySphereIntersect", "kind": "function", "signature": "raySphereIntersect(rayOrigin, rayDir, sphereCenter, radius)", "summary": "Ray-sphere intersection test" }, { "name": "rotatePointByQuaternion", "kind": "function", "signature": "rotatePointByQuaternion(point, quat)", "summary": "Rotate a point by quaternion" }, { "name": "multiplyQuaternions", "kind": "function", "signature": "multiplyQuaternions(a, b)", "summary": "Multiply two quaternions: result = a * b" }, { "name": "rayOBBIntersect", "kind": "function", "signature": "rayOBBIntersect(rayOrigin, rayDir, boxCenter, boxRotation, halfExtents)", "summary": "Ray-OBB (Oriented Bounding Box) intersection" }, { "name": "closestPointOnAxis", "kind": "function", "signature": "closestPointOnAxis(rayOrigin, rayDir, axisOrigin, axisDir)", "summary": "Closest point on axis from ray" } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/stages/FixedStepStages", "path": "editor/reference/viewport/stages/FixedStepStages.md", "source": "editor/js/viewport/stages/FixedStepStages.js", "import": "/editor/js/viewport/stages/FixedStepStages.js", "sourceHash": "a47d08836d2629a90568ccbc1624487771562c3309f0396e2c5f3701070871c3", "summary": "FixedStepStages — Physics, elastic drag, sim audio, particle step. These run 0..N times per frame on a fixed timestep accumulator. Only active in play mode (condition-gated).", "exports": [ { "name": "registerFixedStepStages", "kind": "function", "signature": "registerFixedStepStages(pipeline, vp)", "summary": "Register all fixedStep-phase stages into the pipeline." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/stages/PostRenderStages", "path": "editor/reference/viewport/stages/PostRenderStages.md", "source": "editor/js/viewport/stages/PostRenderStages.js", "import": "/editor/js/viewport/stages/PostRenderStages.js", "sourceHash": "9e94d6f9f61ca501cba58a619e65410bc717ccde6eb69c3b95a86201ffbff715", "summary": "PostRenderStages — Composite passes, post-FX, GPU submit, profiler, spike detection, collab presence. During the transitional period, post-render work still lives inside Viewport.renderFrame(). These stages will be populated one-by-one as code is extracted.", "exports": [ { "name": "registerPostRenderStages", "kind": "function", "signature": "registerPostRenderStages(pipeline, vp)", "summary": "Register all postRender-phase stages into the pipeline." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/stages/RenderStages", "path": "editor/reference/viewport/stages/RenderStages.md", "source": "editor/js/viewport/stages/RenderStages.js", "import": "/editor/js/viewport/stages/RenderStages.js", "sourceHash": "a98b5d5df8ab2502210769ef84efd71d8cf353142b99b859fc612abd776a010a", "summary": "RenderStages — GPU render pass stages: debug targets, volume compute, clear pass, grid, entities, physics lines, cloth, surface grid, particles, diagnostics, SDF colliders, bone directions, gizmos. During the transitional period, the main renderFrame() body still runs inline. These stages will be populated one-by-one as code is extracted from Viewport.renderFrame(). Stage order values reserve gaps (10, 20, 30…) so new stages can be inserted between existing ones without renumbering.", "exports": [ { "name": "registerRenderStages", "kind": "function", "signature": "registerRenderStages(pipeline, vp)", "summary": "Register all render-phase stages into the pipeline." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "viewport/stages/UpdateStages", "path": "editor/reference/viewport/stages/UpdateStages.md", "source": "editor/js/viewport/stages/UpdateStages.js", "import": "/editor/js/viewport/stages/UpdateStages.js", "sourceHash": "ba2e50edc6527a13cae7f49c699ac4d5568a61bfcde124de823b2ff859a94ddc", "summary": "UpdateStages — Per-frame update logic: timing, vGPU, camera, matrices, lights, animation, frustum, collab, stats UI, cleanup. Runs once per frame before GPU render passes.", "exports": [ { "name": "registerUpdateStages", "kind": "function", "signature": "registerUpdateStages(pipeline, vp)", "summary": "Register all update-phase stages into the pipeline." } ], "subsystem": "editor" }, { "schemaVersion": 1, "title": "workers/CollabSignalWorker", "path": "editor/reference/workers/CollabSignalWorker.md", "source": "editor/js/workers/CollabSignalWorker.js", "import": "/editor/js/workers/CollabSignalWorker.js", "sourceHash": "b432979ffa2747b6e60d4ae1562351b249c0241d08c1ed78edf65b672a7e71e9", "summary": "CollabSignalWorker.js — SharedWorker In-memory SDP relay for all editor tabs on the same machine. Runs once per origin, shared across all tabs. Message types (client → worker): HELLO { peerId, username } OFFER { from, to, offerId, payload } ANSWER { from, to, offerId, payload } CANDIDATE { from, to, offerId, payload } LEAVE { peerId } LIST (request peer list) Message types (worker → client): HELLO_ACK { peerId, peers: [{peerId, username}] } PEER_JOINED { peerId, username } PEER_LEFT { peerId } OFFER { from, to, offerId, payload } ANSWER { from, to, offerId, payload } CANDIDATE { from, to, offerId, payload } LIST { peers: [{peerId, username}] }", "exports": [], "subsystem": "editor" }, { "schemaVersion": 1, "title": "workers/CompressionWorker", "path": "editor/reference/workers/CompressionWorker.md", "source": "editor/js/workers/CompressionWorker.js", "import": "/editor/js/workers/CompressionWorker.js", "sourceHash": "da8c2f3f14a29e9c2dce9912936eef946bf180e835d7cea7b5e0423a72bc8b10", "summary": "CompressionWorker - Offloads timeline/history compression to background thread Uses delta+entropy residual encoding for lossless reconstruction", "exports": [], "subsystem": "editor" }, { "schemaVersion": 1, "title": "workers/ProfilerCanvasWorker", "path": "editor/reference/workers/ProfilerCanvasWorker.md", "source": "editor/js/workers/ProfilerCanvasWorker.js", "import": "/editor/js/workers/ProfilerCanvasWorker.js", "sourceHash": "f8c087f2eada652469df7f1ca9ac12d12cc481164bd979ec154ad7071d29c150", "summary": "ProfilerCanvasWorker.js - OffscreenCanvas worker for profiler rendering Moves ALL canvas rendering off the main thread: - Timeline graph - Thread lanes - Flame graph bars Main thread only sends frame data, worker handles all drawing.", "exports": [], "subsystem": "editor" }, { "schemaVersion": 1, "title": "EcsImports", "path": "engine/reference/EcsImports.md", "source": "engine/EcsImports.js", "import": "/engine/EcsImports.js", "sourceHash": "b34f5d45409cca55fac88d7cbd4ea3f85d5cd27da9a535a5a77b3544a1ddd966", "summary": "", "exports": [ { "name": "World", "kind": "constant", "signature": "World", "summary": "" }, { "name": "Camera", "kind": "constant", "signature": "Camera", "summary": "" }, { "name": "Light", "kind": "constant", "signature": "Light", "summary": "" }, { "name": "PhysicsBody", "kind": "constant", "signature": "PhysicsBody", "summary": "" }, { "name": "Collider", "kind": "constant", "signature": "Collider", "summary": "" }, { "name": "Transform", "kind": "constant", "signature": "Transform", "summary": "" }, { "name": "ParticleEmitter", "kind": "constant", "signature": "ParticleEmitter", "summary": "" }, { "name": "NetReplicated", "kind": "constant", "signature": "NetReplicated", "summary": "" }, { "name": "ReplicationProfiles", "kind": "constant", "signature": "ReplicationProfiles", "summary": "" }, { "name": "Storage", "kind": "constant", "signature": "Storage", "summary": "" }, { "name": "createCamera", "kind": "constant", "signature": "createCamera", "summary": "" }, { "name": "createLight", "kind": "constant", "signature": "createLight", "summary": "" }, { "name": "createPhysicsBody", "kind": "constant", "signature": "createPhysicsBody", "summary": "" }, { "name": "createCollider", "kind": "constant", "signature": "createCollider", "summary": "" }, { "name": "createTransform", "kind": "constant", "signature": "createTransform", "summary": "" }, { "name": "createParticleEmitter", "kind": "constant", "signature": "createParticleEmitter", "summary": "" }, { "name": "createNetReplicated", "kind": "constant", "signature": "createNetReplicated", "summary": "" }, { "name": "setEntityComponent", "kind": "constant", "signature": "setEntityComponent", "summary": "" }, { "name": "getEntityComponent", "kind": "constant", "signature": "getEntityComponent", "summary": "" }, { "name": "removeEntityComponent", "kind": "constant", "signature": "removeEntityComponent", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "EngineBootstrap", "path": "engine/reference/EngineBootstrap.md", "source": "engine/EngineBootstrap.js", "import": "/engine/EngineBootstrap.js", "sourceHash": "5505cfd446c76de676c7da6c248e1e33232dd3ab1421b16eb9968df018a7db1b", "summary": "EngineBootstrap.js - Unified engine import for games and tests Single import point for all engine functionality: - Math utilities - ECS (Entity Component System) - Rendering (meshes, shaders, pipelines) - Tools (inspector, camera, physics sandbox) - GPU utilities (buffers, WebGPU init) - Simulation (particles, fluids) - Configuration", "exports": [ { "name": "Engine", "kind": "constant", "signature": "Engine", "summary": "" }, { "name": "ADAPTIVE_QUALITY_TIERS", "kind": "re-export", "signature": "ADAPTIVE_QUALITY_TIERS", "summary": "" }, { "name": "AGI_CORE_FULL", "kind": "re-export", "signature": "AGI_CORE_FULL", "summary": "" }, { "name": "AGI_CORE_VERSION", "kind": "re-export", "signature": "AGI_CORE_VERSION", "summary": "" }, { "name": "AI", "kind": "re-export", "signature": "AI", "summary": "" }, { "name": "AdaptiveQualityGovernor", "kind": "re-export", "signature": "AdaptiveQualityGovernor", "summary": "" }, { "name": "Anatomy", "kind": "re-export", "signature": "Anatomy", "summary": "" }, { "name": "Animation", "kind": "re-export", "signature": "Animation", "summary": "" }, { "name": "AnimationLearning", "kind": "re-export", "signature": "AnimationLearning", "summary": "" }, { "name": "Assets", "kind": "re-export", "signature": "Assets", "summary": "" }, { "name": "Audio", "kind": "re-export", "signature": "Audio", "summary": "" }, { "name": "BUILD_TAG", "kind": "re-export", "signature": "BUILD_TAG", "summary": "" }, { "name": "BVHBuilder", "kind": "re-export", "signature": "BVHBuilder", "summary": "" }, { "name": "BVHNode", "kind": "re-export", "signature": "BVHNode", "summary": "" }, { "name": "CAMERA_CONTROLLER_LIMITS", "kind": "re-export", "signature": "CAMERA_CONTROLLER_LIMITS", "summary": "" }, { "name": "CORE_STORYLETS", "kind": "re-export", "signature": "CORE_STORYLETS", "summary": "" }, { "name": "CitySystem", "kind": "re-export", "signature": "CitySystem", "summary": "" }, { "name": "Collab", "kind": "re-export", "signature": "Collab", "summary": "" }, { "name": "Compat", "kind": "re-export", "signature": "Compat", "summary": "" }, { "name": "Config", "kind": "re-export", "signature": "Config", "summary": "" }, { "name": "ContractSystem", "kind": "re-export", "signature": "ContractSystem", "summary": "" }, { "name": "Core", "kind": "re-export", "signature": "Core", "summary": "" }, { "name": "CrimeType", "kind": "re-export", "signature": "CrimeType", "summary": "" }, { "name": "DEFAULT_CONFIG", "kind": "re-export", "signature": "DEFAULT_CONFIG", "summary": "" }, { "name": "DEFAULT_CRYSTAL_PARAMS", "kind": "re-export", "signature": "DEFAULT_CRYSTAL_PARAMS", "summary": "" }, { "name": "DEFAULT_PHYSICS", "kind": "re-export", "signature": "DEFAULT_PHYSICS", "summary": "" }, { "name": "DEFAULT_RENDER", "kind": "re-export", "signature": "DEFAULT_RENDER", "summary": "" }, { "name": "DEFAULT_STANDARD_INPUT_ACTION_MAP", "kind": "re-export", "signature": "DEFAULT_STANDARD_INPUT_ACTION_MAP", "summary": "" }, { "name": "DialogueRunner", "kind": "re-export", "signature": "DialogueRunner", "summary": "" }, { "name": "DialogueSystem", "kind": "re-export", "signature": "DialogueSystem", "summary": "" }, { "name": "DirectorEventType", "kind": "re-export", "signature": "DirectorEventType", "summary": "" }, { "name": "DomainGraph", "kind": "re-export", "signature": "DomainGraph", "summary": "" }, { "name": "DriveType", "kind": "re-export", "signature": "DriveType", "summary": "" }, { "name": "EDITOR_FULL", "kind": "re-export", "signature": "EDITOR_FULL", "summary": "" }, { "name": "EDITOR_STARTED", "kind": "re-export", "signature": "EDITOR_STARTED", "summary": "" }, { "name": "EDITOR_VERSION", "kind": "re-export", "signature": "EDITOR_VERSION", "summary": "" }, { "name": "ELEMENTS", "kind": "re-export", "signature": "ELEMENTS", "summary": "" }, { "name": "EMITTER_TYPES", "kind": "re-export", "signature": "EMITTER_TYPES", "summary": "" }, { "name": "ENGINE_FULL", "kind": "re-export", "signature": "ENGINE_FULL", "summary": "" }, { "name": "ENGINE_STARTED", "kind": "re-export", "signature": "ENGINE_STARTED", "summary": "" }, { "name": "ENGINE_VERSION", "kind": "re-export", "signature": "ENGINE_VERSION", "summary": "" }, { "name": "EPSILON", "kind": "re-export", "signature": "EPSILON", "summary": "" }, { "name": "EquipSlot", "kind": "re-export", "signature": "EquipSlot", "summary": "" }, { "name": "EventGraph", "kind": "re-export", "signature": "EventGraph", "summary": "" }, { "name": "FactionAction", "kind": "re-export", "signature": "FactionAction", "summary": "" }, { "name": "FactionGraph", "kind": "re-export", "signature": "FactionGraph", "summary": "" }, { "name": "FluidPhase", "kind": "re-export", "signature": "FluidPhase", "summary": "" }, { "name": "GPUTimestampProfiler", "kind": "re-export", "signature": "GPUTimestampProfiler", "summary": "" }, { "name": "GRAB_CONTROLLER_LIMITS", "kind": "re-export", "signature": "GRAB_CONTROLLER_LIMITS", "summary": "" }, { "name": "HiZPass", "kind": "re-export", "signature": "HiZPass", "summary": "" }, { "name": "INF_T", "kind": "re-export", "signature": "INF_T", "summary": "" }, { "name": "ImageHeatHazePass", "kind": "re-export", "signature": "ImageHeatHazePass", "summary": "" }, { "name": "IndexedClusterCuller", "kind": "re-export", "signature": "IndexedClusterCuller", "summary": "" }, { "name": "InstinctGraph", "kind": "re-export", "signature": "InstinctGraph", "summary": "" }, { "name": "Inventory", "kind": "re-export", "signature": "Inventory", "summary": "" }, { "name": "ItemOwnership", "kind": "re-export", "signature": "ItemOwnership", "summary": "" }, { "name": "ItemSoulSystem", "kind": "re-export", "signature": "ItemSoulSystem", "summary": "" }, { "name": "LawGraph", "kind": "re-export", "signature": "LawGraph", "summary": "" }, { "name": "LifePhases", "kind": "re-export", "signature": "LifePhases", "summary": "" }, { "name": "Math", "kind": "re-export", "signature": "Math", "summary": "" }, { "name": "MessageChannel", "kind": "re-export", "signature": "MessageChannel", "summary": "" }, { "name": "MotionClip", "kind": "re-export", "signature": "MotionClip", "summary": "" }, { "name": "MotionDataset", "kind": "re-export", "signature": "MotionDataset", "summary": "" }, { "name": "MotionMatcher", "kind": "re-export", "signature": "MotionMatcher", "summary": "" }, { "name": "NPCBrain", "kind": "re-export", "signature": "NPCBrain", "summary": "" }, { "name": "Network", "kind": "re-export", "signature": "Network", "summary": "" }, { "name": "NodeType", "kind": "re-export", "signature": "NodeType", "summary": "" }, { "name": "PARTICLE_PHASE_STRIDE", "kind": "re-export", "signature": "PARTICLE_PHASE_STRIDE", "summary": "" }, { "name": "PARTICLE_QUALITY_PRESETS", "kind": "re-export", "signature": "PARTICLE_QUALITY_PRESETS", "summary": "" }, { "name": "PLAUNA_FULL", "kind": "re-export", "signature": "PLAUNA_FULL", "summary": "" }, { "name": "PLAUNA_VERSION", "kind": "re-export", "signature": "PLAUNA_VERSION", "summary": "" }, { "name": "PROXY_MODE", "kind": "re-export", "signature": "PROXY_MODE", "summary": "" }, { "name": "PROXY_TIER", "kind": "re-export", "signature": "PROXY_TIER", "summary": "" }, { "name": "PathTracingPass", "kind": "re-export", "signature": "PathTracingPass", "summary": "" }, { "name": "PerceptionGraph", "kind": "re-export", "signature": "PerceptionGraph", "summary": "" }, { "name": "PerceptionLevel", "kind": "re-export", "signature": "PerceptionLevel", "summary": "" }, { "name": "Phase", "kind": "re-export", "signature": "Phase", "summary": "" }, { "name": "PhysXPhysicsWorld", "kind": "re-export", "signature": "PhysXPhysicsWorld", "summary": "" }, { "name": "PowerGraph", "kind": "re-export", "signature": "PowerGraph", "summary": "" }, { "name": "ProxyBillboardAlign", "kind": "re-export", "signature": "ProxyBillboardAlign", "summary": "" }, { "name": "ProxyGBufferPass", "kind": "re-export", "signature": "ProxyGBufferPass", "summary": "" }, { "name": "ProxyGeometrySystem", "kind": "re-export", "signature": "ProxyGeometrySystem", "summary": "" }, { "name": "ProxyMaskPass", "kind": "re-export", "signature": "ProxyMaskPass", "summary": "" }, { "name": "ProxyOctahedralCache", "kind": "re-export", "signature": "ProxyOctahedralCache", "summary": "" }, { "name": "ProxySDF", "kind": "re-export", "signature": "ProxySDF", "summary": "" }, { "name": "ProxyShadePass", "kind": "re-export", "signature": "ProxyShadePass", "summary": "" }, { "name": "PunishmentType", "kind": "re-export", "signature": "PunishmentType", "summary": "" }, { "name": "RASTERIZER_MODE", "kind": "re-export", "signature": "RASTERIZER_MODE", "summary": "" }, { "name": "RAY_PICKER_LIMITS", "kind": "re-export", "signature": "RAY_PICKER_LIMITS", "summary": "" }, { "name": "ROOM_PICKING_LIMITS", "kind": "re-export", "signature": "ROOM_PICKING_LIMITS", "summary": "" }, { "name": "ReSTIRGIPass", "kind": "re-export", "signature": "ReSTIRGIPass", "summary": "" }, { "name": "Render", "kind": "re-export", "signature": "Render", "summary": "" }, { "name": "ResolveSystem", "kind": "re-export", "signature": "ResolveSystem", "summary": "" }, { "name": "Rig", "kind": "re-export", "signature": "Rig", "summary": "" }, { "name": "RuleCategory", "kind": "re-export", "signature": "RuleCategory", "summary": "" }, { "name": "RuleEffect", "kind": "re-export", "signature": "RuleEffect", "summary": "" }, { "name": "RuleGraph", "kind": "re-export", "signature": "RuleGraph", "summary": "" }, { "name": "SANDBOX_BEHAVIOR", "kind": "re-export", "signature": "SANDBOX_BEHAVIOR", "summary": "" }, { "name": "SANDBOX_FLAGS", "kind": "re-export", "signature": "SANDBOX_FLAGS", "summary": "" }, { "name": "SANDBOX_INTERACTION", "kind": "re-export", "signature": "SANDBOX_INTERACTION", "summary": "" }, { "name": "SANDBOX_OBJECT", "kind": "re-export", "signature": "SANDBOX_OBJECT", "summary": "" }, { "name": "SANDBOX_OBJECTS", "kind": "re-export", "signature": "SANDBOX_OBJECTS", "summary": "" }, { "name": "SANDBOX_PHASE", "kind": "re-export", "signature": "SANDBOX_PHASE", "summary": "" }, { "name": "SANDBOX_REACTION", "kind": "re-export", "signature": "SANDBOX_REACTION", "summary": "" }, { "name": "SANDBOX_REFERENCE_TEMPERATURE_K", "kind": "re-export", "signature": "SANDBOX_REFERENCE_TEMPERATURE_K", "summary": "" }, { "name": "SANDBOX_SPECIES_CAPACITY", "kind": "re-export", "signature": "SANDBOX_SPECIES_CAPACITY", "summary": "" }, { "name": "SANDBOX_SUBSTANCE_CODE_BASE", "kind": "re-export", "signature": "SANDBOX_SUBSTANCE_CODE_BASE", "summary": "" }, { "name": "SANDBOX_TEMPERATURE_STEP_K", "kind": "re-export", "signature": "SANDBOX_TEMPERATURE_STEP_K", "summary": "" }, { "name": "SAVE_SCHEMA_VERSION", "kind": "re-export", "signature": "SAVE_SCHEMA_VERSION", "summary": "" }, { "name": "SCREEN_RAY_LIMITS", "kind": "re-export", "signature": "SCREEN_RAY_LIMITS", "summary": "" }, { "name": "SOUL_STAGE_NAMES", "kind": "re-export", "signature": "SOUL_STAGE_NAMES", "summary": "" }, { "name": "SPAWN_TYPE_CATEGORIES", "kind": "re-export", "signature": "SPAWN_TYPE_CATEGORIES", "summary": "" }, { "name": "SPAWN_TYPE_COLORS", "kind": "re-export", "signature": "SPAWN_TYPE_COLORS", "summary": "" }, { "name": "SPAWN_TYPE_MESHES", "kind": "re-export", "signature": "SPAWN_TYPE_MESHES", "summary": "" }, { "name": "SPELL_EFFECT_TYPES", "kind": "re-export", "signature": "SPELL_EFFECT_TYPES", "summary": "" }, { "name": "SPELL_PASS_TYPES", "kind": "re-export", "signature": "SPELL_PASS_TYPES", "summary": "" }, { "name": "STANDARD_CAMERA_LIMITS", "kind": "re-export", "signature": "STANDARD_CAMERA_LIMITS", "summary": "" }, { "name": "STANDARD_INPUT_LIMITS", "kind": "re-export", "signature": "STANDARD_INPUT_LIMITS", "summary": "" }, { "name": "STATES", "kind": "re-export", "signature": "STATES", "summary": "" }, { "name": "STATE_FIRST_DIRTY", "kind": "re-export", "signature": "STATE_FIRST_DIRTY", "summary": "" }, { "name": "STATE_FIRST_ECS_METADATA_VERSION", "kind": "re-export", "signature": "STATE_FIRST_ECS_METADATA_VERSION", "summary": "" }, { "name": "STATE_FIRST_EXECUTION_BACKEND", "kind": "re-export", "signature": "STATE_FIRST_EXECUTION_BACKEND", "summary": "" }, { "name": "STATE_FIRST_PARITY_STATUS", "kind": "re-export", "signature": "STATE_FIRST_PARITY_STATUS", "summary": "" }, { "name": "STATE_FIRST_QUALITY_PROFILE", "kind": "re-export", "signature": "STATE_FIRST_QUALITY_PROFILE", "summary": "" }, { "name": "STATE_FIRST_REPRESENTATION", "kind": "re-export", "signature": "STATE_FIRST_REPRESENTATION", "summary": "" }, { "name": "STATE_FIRST_REPRESENTATION_NAMES", "kind": "re-export", "signature": "STATE_FIRST_REPRESENTATION_NAMES", "summary": "" }, { "name": "STATE_FIRST_RETAINED_INDEX_BYTES", "kind": "re-export", "signature": "STATE_FIRST_RETAINED_INDEX_BYTES", "summary": "" }, { "name": "STATE_FIRST_RETAINED_RECORD_BYTES", "kind": "re-export", "signature": "STATE_FIRST_RETAINED_RECORD_BYTES", "summary": "" }, { "name": "STATE_FIRST_RETAINED_RECORD_FLOATS", "kind": "re-export", "signature": "STATE_FIRST_RETAINED_RECORD_FLOATS", "summary": "" }, { "name": "STATE_FIRST_SOURCE", "kind": "re-export", "signature": "STATE_FIRST_SOURCE", "summary": "" }, { "name": "STATE_FIRST_SOURCE_KIND", "kind": "re-export", "signature": "STATE_FIRST_SOURCE_KIND", "summary": "" }, { "name": "STATE_FIRST_SOURCE_VERSION", "kind": "re-export", "signature": "STATE_FIRST_SOURCE_VERSION", "summary": "" }, { "name": "STATS", "kind": "re-export", "signature": "STATS", "summary": "" }, { "name": "SVGFDenoise", "kind": "re-export", "signature": "SVGFDenoise", "summary": "" }, { "name": "SaveSystem", "kind": "re-export", "signature": "SaveSystem", "summary": "" }, { "name": "SchemaValidator", "kind": "re-export", "signature": "SchemaValidator", "summary": "" }, { "name": "SimLevel", "kind": "re-export", "signature": "SimLevel", "summary": "" }, { "name": "SimulationManager", "kind": "re-export", "signature": "SimulationManager", "summary": "" }, { "name": "SituationBucket", "kind": "re-export", "signature": "SituationBucket", "summary": "" }, { "name": "SituationGraph", "kind": "re-export", "signature": "SituationGraph", "summary": "" }, { "name": "SkeletonHierarchy", "kind": "re-export", "signature": "SkeletonHierarchy", "summary": "" }, { "name": "SoulGraph", "kind": "re-export", "signature": "SoulGraph", "summary": "" }, { "name": "SoulGraphMessaging", "kind": "re-export", "signature": "SoulGraphMessaging", "summary": "" }, { "name": "SoulStage", "kind": "re-export", "signature": "SoulStage", "summary": "" }, { "name": "State", "kind": "re-export", "signature": "State", "summary": "" }, { "name": "StateFirstEcsSourceAdapter", "kind": "re-export", "signature": "StateFirstEcsSourceAdapter", "summary": "" }, { "name": "StateFirstExecutionBackend", "kind": "re-export", "signature": "StateFirstExecutionBackend", "summary": "" }, { "name": "StateFirstGpuCuller", "kind": "re-export", "signature": "StateFirstGpuCuller", "summary": "" }, { "name": "StateFirstRasterizer", "kind": "re-export", "signature": "StateFirstRasterizer", "summary": "" }, { "name": "StateFirstRetainedStorage", "kind": "re-export", "signature": "StateFirstRetainedStorage", "summary": "" }, { "name": "StateFirstSourceBridge", "kind": "re-export", "signature": "StateFirstSourceBridge", "summary": "" }, { "name": "StoryGraph", "kind": "re-export", "signature": "StoryGraph", "summary": "" }, { "name": "StoryletRarity", "kind": "re-export", "signature": "StoryletRarity", "summary": "" }, { "name": "Structural", "kind": "re-export", "signature": "Structural", "summary": "" }, { "name": "SurfaceCacheExtractor", "kind": "re-export", "signature": "SurfaceCacheExtractor", "summary": "" }, { "name": "Surfaces", "kind": "re-export", "signature": "Surfaces", "summary": "" }, { "name": "TLASBuilder", "kind": "re-export", "signature": "TLASBuilder", "summary": "" }, { "name": "TransferType", "kind": "re-export", "signature": "TransferType", "summary": "" }, { "name": "UnderwaterSiltField", "kind": "re-export", "signature": "UnderwaterSiltField", "summary": "" }, { "name": "VERSION_BANNER", "kind": "re-export", "signature": "VERSION_BANNER", "summary": "" }, { "name": "VoiceStyle", "kind": "re-export", "signature": "VoiceStyle", "summary": "" }, { "name": "Voxel", "kind": "re-export", "signature": "Voxel", "summary": "" }, { "name": "World", "kind": "re-export", "signature": "World", "summary": "" }, { "name": "WorldDirector", "kind": "re-export", "signature": "WorldDirector", "summary": "" }, { "name": "addGhostToSelection", "kind": "re-export", "signature": "addGhostToSelection", "summary": "" }, { "name": "applyBoundaries", "kind": "re-export", "signature": "applyBoundaries", "summary": "" }, { "name": "applyEngineConfigToPhysics", "kind": "re-export", "signature": "applyEngineConfigToPhysics", "summary": "" }, { "name": "applyEngineConfigToState", "kind": "re-export", "signature": "applyEngineConfigToState", "summary": "" }, { "name": "applyPhaseVisuals", "kind": "re-export", "signature": "applyPhaseVisuals", "summary": "" }, { "name": "attachFluidWorld", "kind": "re-export", "signature": "attachFluidWorld", "summary": "" }, { "name": "attachInputListeners", "kind": "re-export", "signature": "attachInputListeners", "summary": "" }, { "name": "attachInspectorPanel", "kind": "re-export", "signature": "attachInspectorPanel", "summary": "" }, { "name": "attachPhysicsSandboxInspector", "kind": "re-export", "signature": "attachPhysicsSandboxInspector", "summary": "" }, { "name": "augmentGeoWithSkeleton", "kind": "re-export", "signature": "augmentGeoWithSkeleton", "summary": "" }, { "name": "bakeNoiseTexture", "kind": "re-export", "signature": "bakeNoiseTexture", "summary": "" }, { "name": "beatFrequency", "kind": "re-export", "signature": "beatFrequency", "summary": "" }, { "name": "beginStandardRenderPass", "kind": "re-export", "signature": "beginStandardRenderPass", "summary": "" }, { "name": "bootstrapApp", "kind": "re-export", "signature": "bootstrapApp", "summary": "" }, { "name": "branchNode", "kind": "re-export", "signature": "branchNode", "summary": "" }, { "name": "buildColliderBuffer", "kind": "re-export", "signature": "buildColliderBuffer", "summary": "" }, { "name": "buildEffectKeyFromElements", "kind": "re-export", "signature": "buildEffectKeyFromElements", "summary": "" }, { "name": "buildFluidDomainFromColliders", "kind": "re-export", "signature": "buildFluidDomainFromColliders", "summary": "" }, { "name": "buildFluidSources", "kind": "re-export", "signature": "buildFluidSources", "summary": "" }, { "name": "buildJointPositionDataset", "kind": "re-export", "signature": "buildJointPositionDataset", "summary": "" }, { "name": "buildMotionFeatureIndex", "kind": "re-export", "signature": "buildMotionFeatureIndex", "summary": "" }, { "name": "buildNeighborGrid", "kind": "re-export", "signature": "buildNeighborGrid", "summary": "" }, { "name": "buildViewProjData", "kind": "re-export", "signature": "buildViewProjData", "summary": "" }, { "name": "cameraCollisionOptionsReport", "kind": "re-export", "signature": "cameraCollisionOptionsReport", "summary": "" }, { "name": "cameraControllerEntityReport", "kind": "re-export", "signature": "cameraControllerEntityReport", "summary": "" }, { "name": "cameraControllerStepReport", "kind": "re-export", "signature": "cameraControllerStepReport", "summary": "" }, { "name": "cameraEntityBoundsReport", "kind": "re-export", "signature": "cameraEntityBoundsReport", "summary": "" }, { "name": "cameraEntityFocusReport", "kind": "re-export", "signature": "cameraEntityFocusReport", "summary": "" }, { "name": "cameraFocusReport", "kind": "re-export", "signature": "cameraFocusReport", "summary": "" }, { "name": "cameraFocusTransitionReport", "kind": "re-export", "signature": "cameraFocusTransitionReport", "summary": "" }, { "name": "cameraModeSwitchReport", "kind": "re-export", "signature": "cameraModeSwitchReport", "summary": "" }, { "name": "cancelGrabCandidate", "kind": "re-export", "signature": "cancelGrabCandidate", "summary": "" }, { "name": "choiceNode", "kind": "re-export", "signature": "choiceNode", "summary": "" }, { "name": "chooseStateFirstRepresentation", "kind": "re-export", "signature": "chooseStateFirstRepresentation", "summary": "" }, { "name": "clamp", "kind": "re-export", "signature": "clamp", "summary": "" }, { "name": "clearFluidDensity", "kind": "re-export", "signature": "clearFluidDensity", "summary": "" }, { "name": "clearFluidSimWorld", "kind": "re-export", "signature": "clearFluidSimWorld", "summary": "" }, { "name": "clearFreezeRegion", "kind": "re-export", "signature": "clearFreezeRegion", "summary": "" }, { "name": "clearGrabForEntity", "kind": "re-export", "signature": "clearGrabForEntity", "summary": "" }, { "name": "compareLongRangeVectors", "kind": "re-export", "signature": "compareLongRangeVectors", "summary": "" }, { "name": "computeAimBetweenEntities", "kind": "re-export", "signature": "computeAimBetweenEntities", "summary": "" }, { "name": "computeAimFromEntityToPoint", "kind": "re-export", "signature": "computeAimFromEntityToPoint", "summary": "" }, { "name": "computeVisualPower", "kind": "re-export", "signature": "computeVisualPower", "summary": "" }, { "name": "configureParticleLongRange", "kind": "re-export", "signature": "configureParticleLongRange", "summary": "" }, { "name": "configurePhysicsSandboxScene", "kind": "re-export", "signature": "configurePhysicsSandboxScene", "summary": "" }, { "name": "consumeMouseDelta", "kind": "re-export", "signature": "consumeMouseDelta", "summary": "" }, { "name": "consumeZoomDelta", "kind": "re-export", "signature": "consumeZoomDelta", "summary": "" }, { "name": "createAdaptiveQualityGovernor", "kind": "re-export", "signature": "createAdaptiveQualityGovernor", "summary": "" }, { "name": "createAllState", "kind": "re-export", "signature": "createAllState", "summary": "" }, { "name": "createAudioEngine", "kind": "re-export", "signature": "createAudioEngine", "summary": "" }, { "name": "createAudioState", "kind": "re-export", "signature": "createAudioState", "summary": "" }, { "name": "createBoundaryPipeline", "kind": "re-export", "signature": "createBoundaryPipeline", "summary": "" }, { "name": "createBoundaryShader", "kind": "re-export", "signature": "createBoundaryShader", "summary": "" }, { "name": "createCamera", "kind": "re-export", "signature": "createCamera", "summary": "" }, { "name": "createCameraState", "kind": "re-export", "signature": "createCameraState", "summary": "" }, { "name": "createCharacterAudioBridge", "kind": "re-export", "signature": "createCharacterAudioBridge", "summary": "" }, { "name": "createCity", "kind": "re-export", "signature": "createCity", "summary": "" }, { "name": "createCollider", "kind": "re-export", "signature": "createCollider", "summary": "" }, { "name": "createConfigState", "kind": "re-export", "signature": "createConfigState", "summary": "" }, { "name": "createCrimeRecord", "kind": "re-export", "signature": "createCrimeRecord", "summary": "" }, { "name": "createCrystallizationPipeline", "kind": "re-export", "signature": "createCrystallizationPipeline", "summary": "" }, { "name": "createCrystallizationShader", "kind": "re-export", "signature": "createCrystallizationShader", "summary": "" }, { "name": "createCubeGeometry", "kind": "re-export", "signature": "createCubeGeometry", "summary": "" }, { "name": "createCylinderGeometry", "kind": "re-export", "signature": "createCylinderGeometry", "summary": "" }, { "name": "createDefaultFromSchema", "kind": "re-export", "signature": "createDefaultFromSchema", "summary": "" }, { "name": "createEcsState", "kind": "re-export", "signature": "createEcsState", "summary": "" }, { "name": "createEmitter", "kind": "re-export", "signature": "createEmitter", "summary": "" }, { "name": "createEmittersForEffect", "kind": "re-export", "signature": "createEmittersForEffect", "summary": "" }, { "name": "createEngineMesh", "kind": "re-export", "signature": "createEngineMesh", "summary": "" }, { "name": "createEntity", "kind": "re-export", "signature": "createEntity", "summary": "" }, { "name": "createEvent", "kind": "re-export", "signature": "createEvent", "summary": "" }, { "name": "createFaction", "kind": "re-export", "signature": "createFaction", "summary": "" }, { "name": "createFluidSimWorld", "kind": "re-export", "signature": "createFluidSimWorld", "summary": "" }, { "name": "createFluidWaterPass", "kind": "re-export", "signature": "createFluidWaterPass", "summary": "" }, { "name": "createFmmSystem", "kind": "re-export", "signature": "createFmmSystem", "summary": "" }, { "name": "createGhostSelectionState", "kind": "re-export", "signature": "createGhostSelectionState", "summary": "" }, { "name": "createGpuState", "kind": "re-export", "signature": "createGpuState", "summary": "" }, { "name": "createGrabState", "kind": "re-export", "signature": "createGrabState", "summary": "" }, { "name": "createGroundGeometry", "kind": "re-export", "signature": "createGroundGeometry", "summary": "" }, { "name": "createInputController", "kind": "re-export", "signature": "createInputController", "summary": "" }, { "name": "createInputState", "kind": "re-export", "signature": "createInputState", "summary": "" }, { "name": "createInspectorConfig", "kind": "re-export", "signature": "createInspectorConfig", "summary": "" }, { "name": "createInventory", "kind": "re-export", "signature": "createInventory", "summary": "" }, { "name": "createLight", "kind": "re-export", "signature": "createLight", "summary": "" }, { "name": "createLocalStorageAdapter", "kind": "re-export", "signature": "createLocalStorageAdapter", "summary": "" }, { "name": "createMPMBuffers", "kind": "re-export", "signature": "createMPMBuffers", "summary": "" }, { "name": "createMPMPipelines", "kind": "re-export", "signature": "createMPMPipelines", "summary": "" }, { "name": "createMPMWorld", "kind": "re-export", "signature": "createMPMWorld", "summary": "" }, { "name": "createMainLoop", "kind": "re-export", "signature": "createMainLoop", "summary": "" }, { "name": "createMeshLookup", "kind": "re-export", "signature": "createMeshLookup", "summary": "" }, { "name": "createMeshParticleBuffers", "kind": "re-export", "signature": "createMeshParticleBuffers", "summary": "" }, { "name": "createMessage", "kind": "re-export", "signature": "createMessage", "summary": "" }, { "name": "createMinimalWorld", "kind": "re-export", "signature": "createMinimalWorld", "summary": "" }, { "name": "createNBodySystem", "kind": "re-export", "signature": "createNBodySystem", "summary": "" }, { "name": "createNeighborGridSystem", "kind": "re-export", "signature": "createNeighborGridSystem", "summary": "" }, { "name": "createNoiseTextureSystem", "kind": "re-export", "signature": "createNoiseTextureSystem", "summary": "" }, { "name": "createOscillator", "kind": "re-export", "signature": "createOscillator", "summary": "" }, { "name": "createOscillatorBank", "kind": "re-export", "signature": "createOscillatorBank", "summary": "" }, { "name": "createOwnedItem", "kind": "re-export", "signature": "createOwnedItem", "summary": "" }, { "name": "createParticleBillboardDataBindGroup", "kind": "re-export", "signature": "createParticleBillboardDataBindGroup", "summary": "" }, { "name": "createParticleBillboardRenderer", "kind": "re-export", "signature": "createParticleBillboardRenderer", "summary": "" }, { "name": "createParticleMeshEwaldSystem", "kind": "re-export", "signature": "createParticleMeshEwaldSystem", "summary": "" }, { "name": "createParticleQualityManager", "kind": "re-export", "signature": "createParticleQualityManager", "summary": "" }, { "name": "createParticleSimWorld", "kind": "re-export", "signature": "createParticleSimWorld", "summary": "" }, { "name": "createParticlesState", "kind": "re-export", "signature": "createParticlesState", "summary": "" }, { "name": "createPhaseChangeBuffers", "kind": "re-export", "signature": "createPhaseChangeBuffers", "summary": "" }, { "name": "createPhysXVehicle", "kind": "re-export", "signature": "createPhysXVehicle", "summary": "" }, { "name": "createPhysicsBody", "kind": "re-export", "signature": "createPhysicsBody", "summary": "" }, { "name": "createPhysicsState", "kind": "re-export", "signature": "createPhysicsState", "summary": "" }, { "name": "createPlaneGeometry", "kind": "re-export", "signature": "createPlaneGeometry", "summary": "" }, { "name": "createPower", "kind": "re-export", "signature": "createPower", "summary": "" }, { "name": "createQuery", "kind": "re-export", "signature": "createQuery", "summary": "" }, { "name": "createRayPicker", "kind": "re-export", "signature": "createRayPicker", "summary": "" }, { "name": "createRenderState", "kind": "re-export", "signature": "createRenderState", "summary": "" }, { "name": "createRule", "kind": "re-export", "signature": "createRule", "summary": "" }, { "name": "createSandboxMaterialCatalog", "kind": "re-export", "signature": "createSandboxMaterialCatalog", "summary": "" }, { "name": "createSandboxSpeciesLut", "kind": "re-export", "signature": "createSandboxSpeciesLut", "summary": "" }, { "name": "createSceneFileInput", "kind": "re-export", "signature": "createSceneFileInput", "summary": "" }, { "name": "createSeedInjectionParams", "kind": "re-export", "signature": "createSeedInjectionParams", "summary": "" }, { "name": "createShaderLoader", "kind": "re-export", "signature": "createShaderLoader", "summary": "" }, { "name": "createSkyboxGeometry", "kind": "re-export", "signature": "createSkyboxGeometry", "summary": "" }, { "name": "createSmokeState", "kind": "re-export", "signature": "createSmokeState", "summary": "" }, { "name": "createSmokeVolumeRenderer", "kind": "re-export", "signature": "createSmokeVolumeRenderer", "summary": "" }, { "name": "createSolidMaskTexture", "kind": "re-export", "signature": "createSolidMaskTexture", "summary": "" }, { "name": "createSpawnState", "kind": "re-export", "signature": "createSpawnState", "summary": "" }, { "name": "createSpellEffectPass", "kind": "re-export", "signature": "createSpellEffectPass", "summary": "" }, { "name": "createSpellForce", "kind": "re-export", "signature": "createSpellForce", "summary": "" }, { "name": "createSphereGeometry", "kind": "re-export", "signature": "createSphereGeometry", "summary": "" }, { "name": "createStandardEntityRenderResources", "kind": "re-export", "signature": "createStandardEntityRenderResources", "summary": "" }, { "name": "createStandardRoomRenderer", "kind": "re-export", "signature": "createStandardRoomRenderer", "summary": "" }, { "name": "createStateFirstEcsSourceAdapter", "kind": "re-export", "signature": "createStateFirstEcsSourceAdapter", "summary": "" }, { "name": "createStateFirstExecutionBackend", "kind": "re-export", "signature": "createStateFirstExecutionBackend", "summary": "" }, { "name": "createStateFirstGpuCuller", "kind": "re-export", "signature": "createStateFirstGpuCuller", "summary": "" }, { "name": "createStateFirstRasterizer", "kind": "re-export", "signature": "createStateFirstRasterizer", "summary": "" }, { "name": "createStateFirstRetainedStorage", "kind": "re-export", "signature": "createStateFirstRetainedStorage", "summary": "" }, { "name": "createStateFirstSourceBridge", "kind": "re-export", "signature": "createStateFirstSourceBridge", "summary": "" }, { "name": "createStorageBuffer", "kind": "re-export", "signature": "createStorageBuffer", "summary": "" }, { "name": "createStorylet", "kind": "re-export", "signature": "createStorylet", "summary": "" }, { "name": "createTransform", "kind": "re-export", "signature": "createTransform", "summary": "" }, { "name": "createUniformBuffer", "kind": "re-export", "signature": "createUniformBuffer", "summary": "" }, { "name": "createUnitCubeMesh", "kind": "re-export", "signature": "createUnitCubeMesh", "summary": "" }, { "name": "createVoxelWorldRenderer", "kind": "re-export", "signature": "createVoxelWorldRenderer", "summary": "" }, { "name": "createWaterPassState", "kind": "re-export", "signature": "createWaterPassState", "summary": "" }, { "name": "createWorld", "kind": "re-export", "signature": "createWorld", "summary": "" }, { "name": "createWorldFluidDomain", "kind": "re-export", "signature": "createWorldFluidDomain", "summary": "" }, { "name": "defaultResolveEquipSlot", "kind": "re-export", "signature": "defaultResolveEquipSlot", "summary": "" }, { "name": "defineComponentType", "kind": "re-export", "signature": "defineComponentType", "summary": "" }, { "name": "deleteEntity", "kind": "re-export", "signature": "deleteEntity", "summary": "" }, { "name": "deleteSelectedEntity", "kind": "re-export", "signature": "deleteSelectedEntity", "summary": "" }, { "name": "deriveColorFromElements", "kind": "re-export", "signature": "deriveColorFromElements", "summary": "" }, { "name": "destroyAudioEngine", "kind": "re-export", "signature": "destroyAudioEngine", "summary": "" }, { "name": "destroyBuffer", "kind": "re-export", "signature": "destroyBuffer", "summary": "" }, { "name": "destroyBuffers", "kind": "re-export", "signature": "destroyBuffers", "summary": "" }, { "name": "destroyCharacterAudioBridge", "kind": "re-export", "signature": "destroyCharacterAudioBridge", "summary": "" }, { "name": "destroyEntity", "kind": "re-export", "signature": "destroyEntity", "summary": "" }, { "name": "destroyFluidWaterPass", "kind": "re-export", "signature": "destroyFluidWaterPass", "summary": "" }, { "name": "destroyFmmSystem", "kind": "re-export", "signature": "destroyFmmSystem", "summary": "" }, { "name": "destroyMPMWorld", "kind": "re-export", "signature": "destroyMPMWorld", "summary": "" }, { "name": "destroyNBodySystem", "kind": "re-export", "signature": "destroyNBodySystem", "summary": "" }, { "name": "destroyNeighborGridSystem", "kind": "re-export", "signature": "destroyNeighborGridSystem", "summary": "" }, { "name": "destroyNoiseTextureSystem", "kind": "re-export", "signature": "destroyNoiseTextureSystem", "summary": "" }, { "name": "destroyParticleMeshEwaldSystem", "kind": "re-export", "signature": "destroyParticleMeshEwaldSystem", "summary": "" }, { "name": "destroyParticleSimWorld", "kind": "re-export", "signature": "destroyParticleSimWorld", "summary": "" }, { "name": "destroyPhaseChangeBuffers", "kind": "re-export", "signature": "destroyPhaseChangeBuffers", "summary": "" }, { "name": "destroyWorldFluidDomain", "kind": "re-export", "signature": "destroyWorldFluidDomain", "summary": "" }, { "name": "detachInputListeners", "kind": "re-export", "signature": "detachInputListeners", "summary": "" }, { "name": "directLongRangeAccelerations", "kind": "re-export", "signature": "directLongRangeAccelerations", "summary": "" }, { "name": "discoverStateFirstSource", "kind": "re-export", "signature": "discoverStateFirstSource", "summary": "" }, { "name": "downloadScene", "kind": "re-export", "signature": "downloadScene", "summary": "" }, { "name": "drawMesh", "kind": "re-export", "signature": "drawMesh", "summary": "" }, { "name": "drawMeshes", "kind": "re-export", "signature": "drawMeshes", "summary": "" }, { "name": "encodeEntitiesClusterCulling", "kind": "re-export", "signature": "encodeEntitiesClusterCulling", "summary": "" }, { "name": "encodeIndexedMeshClusterCulling", "kind": "re-export", "signature": "encodeIndexedMeshClusterCulling", "summary": "" }, { "name": "encodeOctahedralNormal", "kind": "re-export", "signature": "encodeOctahedralNormal", "summary": "" }, { "name": "endNode", "kind": "re-export", "signature": "endNode", "summary": "" }, { "name": "ensureDepthTexture", "kind": "re-export", "signature": "ensureDepthTexture", "summary": "" }, { "name": "ensureSceneColorTexture", "kind": "re-export", "signature": "ensureSceneColorTexture", "summary": "" }, { "name": "entityPickingOptionsReport", "kind": "re-export", "signature": "entityPickingOptionsReport", "summary": "" }, { "name": "estimateFmmMemory", "kind": "re-export", "signature": "estimateFmmMemory", "summary": "" }, { "name": "estimateParticleMeshMemory", "kind": "re-export", "signature": "estimateParticleMeshMemory", "summary": "" }, { "name": "executeFmm", "kind": "re-export", "signature": "executeFmm", "summary": "" }, { "name": "executeNBody", "kind": "re-export", "signature": "executeNBody", "summary": "" }, { "name": "executeParticleMeshEwald", "kind": "re-export", "signature": "executeParticleMeshEwald", "summary": "" }, { "name": "exportSceneToJson", "kind": "re-export", "signature": "exportSceneToJson", "summary": "" }, { "name": "extractFrozenParticles", "kind": "re-export", "signature": "extractFrozenParticles", "summary": "" }, { "name": "extractFrozenShape", "kind": "re-export", "signature": "extractFrozenShape", "summary": "" }, { "name": "extractMotionClipFromFbxAscii", "kind": "re-export", "signature": "extractMotionClipFromFbxAscii", "summary": "" }, { "name": "extractMotionClipFromGltf", "kind": "re-export", "signature": "extractMotionClipFromGltf", "summary": "" }, { "name": "extractMotionDatasetFromFbxAsciiEntries", "kind": "re-export", "signature": "extractMotionDatasetFromFbxAsciiEntries", "summary": "" }, { "name": "extractMotionDatasetFromFbxDirectoryHandle", "kind": "re-export", "signature": "extractMotionDatasetFromFbxDirectoryHandle", "summary": "" }, { "name": "extractMotionDatasetFromFbxFiles", "kind": "re-export", "signature": "extractMotionDatasetFromFbxFiles", "summary": "" }, { "name": "extractMotionDatasetFromGltf", "kind": "re-export", "signature": "extractMotionDatasetFromGltf", "summary": "" }, { "name": "extractOriginTags", "kind": "re-export", "signature": "extractOriginTags", "summary": "" }, { "name": "fillRagdollFeature", "kind": "re-export", "signature": "fillRagdollFeature", "summary": "" }, { "name": "fmmCellCoordinate", "kind": "re-export", "signature": "fmmCellCoordinate", "summary": "" }, { "name": "fmmInteractionCells", "kind": "re-export", "signature": "fmmInteractionCells", "summary": "" }, { "name": "fmmLevelCellCount", "kind": "re-export", "signature": "fmmLevelCellCount", "summary": "" }, { "name": "fmmLevelOffset", "kind": "re-export", "signature": "fmmLevelOffset", "summary": "" }, { "name": "fmmMortonCellIndex", "kind": "re-export", "signature": "fmmMortonCellIndex", "summary": "" }, { "name": "fmmSelectDepth", "kind": "re-export", "signature": "fmmSelectDepth", "summary": "" }, { "name": "fmmTotalCellCount", "kind": "re-export", "signature": "fmmTotalCellCount", "summary": "" }, { "name": "focusThirdPersonCamera", "kind": "re-export", "signature": "focusThirdPersonCamera", "summary": "" }, { "name": "focusThirdPersonCameraOnEntities", "kind": "re-export", "signature": "focusThirdPersonCameraOnEntities", "summary": "" }, { "name": "forEachEntity", "kind": "re-export", "signature": "forEachEntity", "summary": "" }, { "name": "generateMeshParticlesIntoParticlesState", "kind": "re-export", "signature": "generateMeshParticlesIntoParticlesState", "summary": "" }, { "name": "generateMeshParticlesIntoWorld", "kind": "re-export", "signature": "generateMeshParticlesIntoWorld", "summary": "" }, { "name": "generateOrigin", "kind": "re-export", "signature": "generateOrigin", "summary": "" }, { "name": "generateProceduralSkeleton", "kind": "re-export", "signature": "generateProceduralSkeleton", "summary": "" }, { "name": "generateProlateSplitTable", "kind": "re-export", "signature": "generateProlateSplitTable", "summary": "" }, { "name": "generateProlateWindowTable", "kind": "re-export", "signature": "generateProlateWindowTable", "summary": "" }, { "name": "getActiveGhost", "kind": "re-export", "signature": "getActiveGhost", "summary": "" }, { "name": "getActiveGhostWorldPosition", "kind": "re-export", "signature": "getActiveGhostWorldPosition", "summary": "" }, { "name": "getAvailableSpawnTypes", "kind": "re-export", "signature": "getAvailableSpawnTypes", "summary": "" }, { "name": "getCameraEyeBasisFromState", "kind": "re-export", "signature": "getCameraEyeBasisFromState", "summary": "" }, { "name": "getComponentDefinition", "kind": "re-export", "signature": "getComponentDefinition", "summary": "" }, { "name": "getComponentSchema", "kind": "re-export", "signature": "getComponentSchema", "summary": "" }, { "name": "getElements", "kind": "re-export", "signature": "getElements", "summary": "" }, { "name": "getEmitterPreset", "kind": "re-export", "signature": "getEmitterPreset", "summary": "" }, { "name": "getEmitterTypes", "kind": "re-export", "signature": "getEmitterTypes", "summary": "" }, { "name": "getEntityComponent", "kind": "re-export", "signature": "getEntityComponent", "summary": "" }, { "name": "getEntityWorldPosition", "kind": "re-export", "signature": "getEntityWorldPosition", "summary": "" }, { "name": "getGhostPreviewInfo", "kind": "re-export", "signature": "getGhostPreviewInfo", "summary": "" }, { "name": "getGhostWorldPosition", "kind": "re-export", "signature": "getGhostWorldPosition", "summary": "" }, { "name": "getInputActionMap", "kind": "re-export", "signature": "getInputActionMap", "summary": "" }, { "name": "getInputActions", "kind": "re-export", "signature": "getInputActions", "summary": "" }, { "name": "getKeys", "kind": "re-export", "signature": "getKeys", "summary": "" }, { "name": "getLastMousePosition", "kind": "re-export", "signature": "getLastMousePosition", "summary": "" }, { "name": "getMovementAxes", "kind": "re-export", "signature": "getMovementAxes", "summary": "" }, { "name": "getNeighborGridBuffers", "kind": "re-export", "signature": "getNeighborGridBuffers", "summary": "" }, { "name": "getParticleLongRangeState", "kind": "re-export", "signature": "getParticleLongRangeState", "summary": "" }, { "name": "getPickRayForCanvasFromScreen", "kind": "re-export", "signature": "getPickRayForCanvasFromScreen", "summary": "" }, { "name": "getPickRayFromState", "kind": "re-export", "signature": "getPickRayFromState", "summary": "" }, { "name": "getRegisteredSystems", "kind": "re-export", "signature": "getRegisteredSystems", "summary": "" }, { "name": "getSpawnTypeColor", "kind": "re-export", "signature": "getSpawnTypeColor", "summary": "" }, { "name": "getSpawnTypeMeshKey", "kind": "re-export", "signature": "getSpawnTypeMeshKey", "summary": "" }, { "name": "getSpawnTypesByCategory", "kind": "re-export", "signature": "getSpawnTypesByCategory", "summary": "" }, { "name": "getStandardCameraEyeBasis", "kind": "re-export", "signature": "getStandardCameraEyeBasis", "summary": "" }, { "name": "getStates", "kind": "re-export", "signature": "getStates", "summary": "" }, { "name": "getVertexBufferLayoutForMesh", "kind": "re-export", "signature": "getVertexBufferLayoutForMesh", "summary": "" }, { "name": "grabControllerEntityReport", "kind": "re-export", "signature": "grabControllerEntityReport", "summary": "" }, { "name": "grabControllerRayReport", "kind": "re-export", "signature": "grabControllerRayReport", "summary": "" }, { "name": "grabControllerTimingReport", "kind": "re-export", "signature": "grabControllerTimingReport", "summary": "" }, { "name": "initAudioEngine", "kind": "re-export", "signature": "initAudioEngine", "summary": "" }, { "name": "initEcsWorld", "kind": "re-export", "signature": "initEcsWorld", "summary": "" }, { "name": "initFluidSimWorldLazy", "kind": "re-export", "signature": "initFluidSimWorldLazy", "summary": "" }, { "name": "initFmmBindGroups", "kind": "re-export", "signature": "initFmmBindGroups", "summary": "" }, { "name": "initGpuState", "kind": "re-export", "signature": "initGpuState", "summary": "" }, { "name": "initNBodyBindGroups", "kind": "re-export", "signature": "initNBodyBindGroups", "summary": "" }, { "name": "initNeighborGridBindGroups", "kind": "re-export", "signature": "initNeighborGridBindGroups", "summary": "" }, { "name": "initParticleMeshEwaldBindGroups", "kind": "re-export", "signature": "initParticleMeshEwaldBindGroups", "summary": "" }, { "name": "initParticleSystem", "kind": "re-export", "signature": "initParticleSystem", "summary": "" }, { "name": "initSimulationRendering", "kind": "re-export", "signature": "initSimulationRendering", "summary": "" }, { "name": "initSlotTracking", "kind": "re-export", "signature": "initSlotTracking", "summary": "" }, { "name": "initSmokeRenderer", "kind": "re-export", "signature": "initSmokeRenderer", "summary": "" }, { "name": "initWebGpuCanvas", "kind": "re-export", "signature": "initWebGpuCanvas", "summary": "" }, { "name": "injectFreezeSeeds", "kind": "re-export", "signature": "injectFreezeSeeds", "summary": "" }, { "name": "injectHeatSeeds", "kind": "re-export", "signature": "injectHeatSeeds", "summary": "" }, { "name": "injectMeltedFluid", "kind": "re-export", "signature": "injectMeltedFluid", "summary": "" }, { "name": "inverseLerp", "kind": "re-export", "signature": "inverseLerp", "summary": "" }, { "name": "isPhysXVehicleSupported", "kind": "re-export", "signature": "isPhysXVehicleSupported", "summary": "" }, { "name": "isWebGpuSupported", "kind": "re-export", "signature": "isWebGpuSupported", "summary": "" }, { "name": "lerp", "kind": "re-export", "signature": "lerp", "summary": "" }, { "name": "listComponentDefinitions", "kind": "re-export", "signature": "listComponentDefinitions", "summary": "" }, { "name": "loadSceneFromFile", "kind": "re-export", "signature": "loadSceneFromFile", "summary": "" }, { "name": "loadSceneFromJson", "kind": "re-export", "signature": "loadSceneFromJson", "summary": "" }, { "name": "mapTagsToOrigin", "kind": "re-export", "signature": "mapTagsToOrigin", "summary": "" }, { "name": "mat4FromRotationTranslation", "kind": "re-export", "signature": "mat4FromRotationTranslation", "summary": "" }, { "name": "mat4Identity", "kind": "re-export", "signature": "mat4Identity", "summary": "" }, { "name": "mat4Inverse", "kind": "re-export", "signature": "mat4Inverse", "summary": "" }, { "name": "mat4LookAt", "kind": "re-export", "signature": "mat4LookAt", "summary": "" }, { "name": "mat4Multiply", "kind": "re-export", "signature": "mat4Multiply", "summary": "" }, { "name": "mat4Orthographic", "kind": "re-export", "signature": "mat4Orthographic", "summary": "" }, { "name": "mat4OrthographicWebGPU", "kind": "re-export", "signature": "mat4OrthographicWebGPU", "summary": "" }, { "name": "mat4PerspectiveDeg", "kind": "re-export", "signature": "mat4PerspectiveDeg", "summary": "" }, { "name": "mat4PerspectiveDegWebGPU", "kind": "re-export", "signature": "mat4PerspectiveDegWebGPU", "summary": "" }, { "name": "mat4PerspectiveRad", "kind": "re-export", "signature": "mat4PerspectiveRad", "summary": "" }, { "name": "mat4PerspectiveRadWebGPU", "kind": "re-export", "signature": "mat4PerspectiveRadWebGPU", "summary": "" }, { "name": "mat4Scale", "kind": "re-export", "signature": "mat4Scale", "summary": "" }, { "name": "mat4Translate", "kind": "re-export", "signature": "mat4Translate", "summary": "" }, { "name": "mixElementPower", "kind": "re-export", "signature": "mixElementPower", "summary": "" }, { "name": "network", "kind": "re-export", "signature": "network", "summary": "" }, { "name": "node", "kind": "re-export", "signature": "node", "summary": "" }, { "name": "normalizeElementPower", "kind": "re-export", "signature": "normalizeElementPower", "summary": "" }, { "name": "normalizeFmmConfig", "kind": "re-export", "signature": "normalizeFmmConfig", "summary": "" }, { "name": "normalizeParticleMeshConfig", "kind": "re-export", "signature": "normalizeParticleMeshConfig", "summary": "" }, { "name": "packSandboxCell", "kind": "re-export", "signature": "packSandboxCell", "summary": "" }, { "name": "packSandboxObject", "kind": "re-export", "signature": "packSandboxObject", "summary": "" }, { "name": "parseSceneJson", "kind": "re-export", "signature": "parseSceneJson", "summary": "" }, { "name": "particleAI", "kind": "re-export", "signature": "particleAI", "summary": "" }, { "name": "particleAIUtility", "kind": "re-export", "signature": "particleAIUtility", "summary": "" }, { "name": "particleAIVehicles", "kind": "re-export", "signature": "particleAIVehicles", "summary": "" }, { "name": "particleAnatomy", "kind": "re-export", "signature": "particleAnatomy", "summary": "" }, { "name": "particleAssets", "kind": "re-export", "signature": "particleAssets", "summary": "" }, { "name": "particleMathGeometry", "kind": "re-export", "signature": "particleMathGeometry", "summary": "" }, { "name": "particleMathRandom", "kind": "re-export", "signature": "particleMathRandom", "summary": "" }, { "name": "particlePBD", "kind": "re-export", "signature": "particlePBD", "summary": "" }, { "name": "particlePhysXPhysicsWorld", "kind": "re-export", "signature": "particlePhysXPhysicsWorld", "summary": "" }, { "name": "particlePhysXVehicle", "kind": "re-export", "signature": "particlePhysXVehicle", "summary": "" }, { "name": "particleRig", "kind": "re-export", "signature": "particleRig", "summary": "" }, { "name": "particleState", "kind": "re-export", "signature": "particleState", "summary": "" }, { "name": "particleStructural", "kind": "re-export", "signature": "particleStructural", "summary": "" }, { "name": "particleSubstances", "kind": "re-export", "signature": "particleSubstances", "summary": "" }, { "name": "particleSurfaces", "kind": "re-export", "signature": "particleSurfaces", "summary": "" }, { "name": "particleVoxel", "kind": "re-export", "signature": "particleVoxel", "summary": "" }, { "name": "phaseCoherence", "kind": "re-export", "signature": "phaseCoherence", "summary": "" }, { "name": "pickEntityFromRay", "kind": "re-export", "signature": "pickEntityFromRay", "summary": "" }, { "name": "pickRoomSurfaceFromRay", "kind": "re-export", "signature": "pickRoomSurfaceFromRay", "summary": "" }, { "name": "pickingRayReport", "kind": "re-export", "signature": "pickingRayReport", "summary": "" }, { "name": "playBuffer", "kind": "re-export", "signature": "playBuffer", "summary": "" }, { "name": "playStandardGamepadHaptics", "kind": "re-export", "signature": "playStandardGamepadHaptics", "summary": "" }, { "name": "pollInputGamepad", "kind": "re-export", "signature": "pollInputGamepad", "summary": "" }, { "name": "projectImagePointToViewport", "kind": "re-export", "signature": "projectImagePointToViewport", "summary": "" }, { "name": "prolateSplitFourierResponse", "kind": "re-export", "signature": "prolateSplitFourierResponse", "summary": "" }, { "name": "quatConjugate", "kind": "re-export", "signature": "quatConjugate", "summary": "" }, { "name": "quatDifference", "kind": "re-export", "signature": "quatDifference", "summary": "" }, { "name": "quatFromAxisAngle", "kind": "re-export", "signature": "quatFromAxisAngle", "summary": "" }, { "name": "quatFromEuler", "kind": "re-export", "signature": "quatFromEuler", "summary": "" }, { "name": "quatIdentity", "kind": "re-export", "signature": "quatIdentity", "summary": "" }, { "name": "quatInverse", "kind": "re-export", "signature": "quatInverse", "summary": "" }, { "name": "quatLookAt", "kind": "re-export", "signature": "quatLookAt", "summary": "" }, { "name": "quatMultiply", "kind": "re-export", "signature": "quatMultiply", "summary": "" }, { "name": "quatNormalize", "kind": "re-export", "signature": "quatNormalize", "summary": "" }, { "name": "quatRotateTowards", "kind": "re-export", "signature": "quatRotateTowards", "summary": "" }, { "name": "quatRotateVec3", "kind": "re-export", "signature": "quatRotateVec3", "summary": "" }, { "name": "quatSlerp", "kind": "re-export", "signature": "quatSlerp", "summary": "" }, { "name": "rayPickerOptionsReport", "kind": "re-export", "signature": "rayPickerOptionsReport", "summary": "" }, { "name": "rayTerminationWGSL", "kind": "re-export", "signature": "rayTerminationWGSL", "summary": "" }, { "name": "readFmmDiagnostics", "kind": "re-export", "signature": "readFmmDiagnostics", "summary": "" }, { "name": "readParticleMeshEwaldDiagnostics", "kind": "re-export", "signature": "readParticleMeshEwaldDiagnostics", "summary": "" }, { "name": "rebindStandardInputAction", "kind": "re-export", "signature": "rebindStandardInputAction", "summary": "" }, { "name": "rebuildSolidMask", "kind": "re-export", "signature": "rebuildSolidMask", "summary": "" }, { "name": "registerAudioEvent", "kind": "re-export", "signature": "registerAudioEvent", "summary": "" }, { "name": "registerFootstepEvents", "kind": "re-export", "signature": "registerFootstepEvents", "summary": "" }, { "name": "registerSystem", "kind": "re-export", "signature": "registerSystem", "summary": "" }, { "name": "releaseGrabbed", "kind": "re-export", "signature": "releaseGrabbed", "summary": "" }, { "name": "remap", "kind": "re-export", "signature": "remap", "summary": "" }, { "name": "removeCharacter", "kind": "re-export", "signature": "removeCharacter", "summary": "" }, { "name": "removeEntityComponent", "kind": "re-export", "signature": "removeEntityComponent", "summary": "" }, { "name": "removeEntityFromStorage", "kind": "re-export", "signature": "removeEntityFromStorage", "summary": "" }, { "name": "renderEntities", "kind": "re-export", "signature": "renderEntities", "summary": "" }, { "name": "renderFluidWater", "kind": "re-export", "signature": "renderFluidWater", "summary": "" }, { "name": "renderLightCube", "kind": "re-export", "signature": "renderLightCube", "summary": "" }, { "name": "renderParticleBillboards", "kind": "re-export", "signature": "renderParticleBillboards", "summary": "" }, { "name": "renderRoom", "kind": "re-export", "signature": "renderRoom", "summary": "" }, { "name": "renderSpellEffects", "kind": "re-export", "signature": "renderSpellEffects", "summary": "" }, { "name": "renderVolumetricSmoke", "kind": "re-export", "signature": "renderVolumetricSmoke", "summary": "" }, { "name": "resizeFluidWaterPass", "kind": "re-export", "signature": "resizeFluidWaterPass", "summary": "" }, { "name": "resolveFootstepMaterial", "kind": "re-export", "signature": "resolveFootstepMaterial", "summary": "" }, { "name": "resolvePickFovRadians", "kind": "re-export", "signature": "resolvePickFovRadians", "summary": "" }, { "name": "resolveSpawnAppearance", "kind": "re-export", "signature": "resolveSpawnAppearance", "summary": "" }, { "name": "resonanceWeight", "kind": "re-export", "signature": "resonanceWeight", "summary": "" }, { "name": "restirGuidePolicyWGSL", "kind": "re-export", "signature": "restirGuidePolicyWGSL", "summary": "" }, { "name": "resumeAudioEngine", "kind": "re-export", "signature": "resumeAudioEngine", "summary": "" }, { "name": "roomPickingOptionsReport", "kind": "re-export", "signature": "roomPickingOptionsReport", "summary": "" }, { "name": "rootAlgebraBasisName", "kind": "re-export", "signature": "rootAlgebraBasisName", "summary": "" }, { "name": "rootAlgebraCompileExecutionPlan", "kind": "re-export", "signature": "rootAlgebraCompileExecutionPlan", "summary": "" }, { "name": "rootAlgebraDimension", "kind": "re-export", "signature": "rootAlgebraDimension", "summary": "" }, { "name": "rootAlgebraEncodedMultiply", "kind": "re-export", "signature": "rootAlgebraEncodedMultiply", "summary": "" }, { "name": "rootAlgebraEncodedTrace", "kind": "re-export", "signature": "rootAlgebraEncodedTrace", "summary": "" }, { "name": "rootAlgebraEvaluateExecutionPlan", "kind": "re-export", "signature": "rootAlgebraEvaluateExecutionPlan", "summary": "" }, { "name": "rootAlgebraExecutionPlanWGSL", "kind": "re-export", "signature": "rootAlgebraExecutionPlanWGSL", "summary": "" }, { "name": "rootAlgebraFindSimpleZeroDivisors", "kind": "re-export", "signature": "rootAlgebraFindSimpleZeroDivisors", "summary": "" }, { "name": "rootAlgebraFormatElement", "kind": "re-export", "signature": "rootAlgebraFormatElement", "summary": "" }, { "name": "rootAlgebraGenerateTable", "kind": "re-export", "signature": "rootAlgebraGenerateTable", "summary": "" }, { "name": "rootAlgebraGeneratorName", "kind": "re-export", "signature": "rootAlgebraGeneratorName", "summary": "" }, { "name": "rootAlgebraMask", "kind": "re-export", "signature": "rootAlgebraMask", "summary": "" }, { "name": "rootAlgebraMultiply", "kind": "re-export", "signature": "rootAlgebraMultiply", "summary": "" }, { "name": "rootAlgebraPropertyReport", "kind": "re-export", "signature": "rootAlgebraPropertyReport", "summary": "" }, { "name": "rootAlgebraReverseMaskBits", "kind": "re-export", "signature": "rootAlgebraReverseMaskBits", "summary": "" }, { "name": "rootAlgebraSearchEncodedMultipliers", "kind": "re-export", "signature": "rootAlgebraSearchEncodedMultipliers", "summary": "" }, { "name": "rootAlgebraSquare", "kind": "re-export", "signature": "rootAlgebraSquare", "summary": "" }, { "name": "rootAlgebraTraceMultiply", "kind": "re-export", "signature": "rootAlgebraTraceMultiply", "summary": "" }, { "name": "rootAlgebraValidate", "kind": "re-export", "signature": "rootAlgebraValidate", "summary": "" }, { "name": "runApp", "kind": "re-export", "signature": "runApp", "summary": "" }, { "name": "sampleAmplitudeModulated", "kind": "re-export", "signature": "sampleAmplitudeModulated", "summary": "" }, { "name": "sampleOscillator", "kind": "re-export", "signature": "sampleOscillator", "summary": "" }, { "name": "samplePhaseModulated", "kind": "re-export", "signature": "samplePhaseModulated", "summary": "" }, { "name": "sampleRingModulated", "kind": "re-export", "signature": "sampleRingModulated", "summary": "" }, { "name": "sampleWave", "kind": "re-export", "signature": "sampleWave", "summary": "" }, { "name": "sandboxBucketToTemperature", "kind": "re-export", "signature": "sandboxBucketToTemperature", "summary": "" }, { "name": "sandboxSpeciesIdForSubstance", "kind": "re-export", "signature": "sandboxSpeciesIdForSubstance", "summary": "" }, { "name": "saturate", "kind": "re-export", "signature": "saturate", "summary": "" }, { "name": "screenCameraBasisReport", "kind": "re-export", "signature": "screenCameraBasisReport", "summary": "" }, { "name": "screenCameraStateReport", "kind": "re-export", "signature": "screenCameraStateReport", "summary": "" }, { "name": "screenPickInputReport", "kind": "re-export", "signature": "screenPickInputReport", "summary": "" }, { "name": "serializeBVHForGPU", "kind": "re-export", "signature": "serializeBVHForGPU", "summary": "" }, { "name": "serializeScene", "kind": "re-export", "signature": "serializeScene", "summary": "" }, { "name": "setActiveGhostBasePosition", "kind": "re-export", "signature": "setActiveGhostBasePosition", "summary": "" }, { "name": "setActiveGhostInSelection", "kind": "re-export", "signature": "setActiveGhostInSelection", "summary": "" }, { "name": "setActiveGhostOffset", "kind": "re-export", "signature": "setActiveGhostOffset", "summary": "" }, { "name": "setBusVolumeByName", "kind": "re-export", "signature": "setBusVolumeByName", "summary": "" }, { "name": "setEntityComponent", "kind": "re-export", "signature": "setEntityComponent", "summary": "" }, { "name": "setMPMWorldBounds", "kind": "re-export", "signature": "setMPMWorldBounds", "summary": "" }, { "name": "setMasterVolume", "kind": "re-export", "signature": "setMasterVolume", "summary": "" }, { "name": "setNode", "kind": "re-export", "signature": "setNode", "summary": "" }, { "name": "setParticleBillboardParams", "kind": "re-export", "signature": "setParticleBillboardParams", "summary": "" }, { "name": "setSystemEnabled", "kind": "re-export", "signature": "setSystemEnabled", "summary": "" }, { "name": "setSystemGroupEnabled", "kind": "re-export", "signature": "setSystemGroupEnabled", "summary": "" }, { "name": "smoothstep", "kind": "re-export", "signature": "smoothstep", "summary": "" }, { "name": "spawnEntity", "kind": "re-export", "signature": "spawnEntity", "summary": "" }, { "name": "spawnParticleEmitter", "kind": "re-export", "signature": "spawnParticleEmitter", "summary": "" }, { "name": "spawnPhysicsObjectAtPosition", "kind": "re-export", "signature": "spawnPhysicsObjectAtPosition", "summary": "" }, { "name": "spellConfigToInstance", "kind": "re-export", "signature": "spellConfigToInstance", "summary": "" }, { "name": "spellElementToEffectType", "kind": "re-export", "signature": "spellElementToEffectType", "summary": "" }, { "name": "splatFluidSources", "kind": "re-export", "signature": "splatFluidSources", "summary": "" }, { "name": "splatParticleDensity", "kind": "re-export", "signature": "splatParticleDensity", "summary": "" }, { "name": "standardCameraBoomReport", "kind": "re-export", "signature": "standardCameraBoomReport", "summary": "" }, { "name": "standardCameraBoundsFocusReport", "kind": "re-export", "signature": "standardCameraBoundsFocusReport", "summary": "" }, { "name": "standardCameraBoundsReport", "kind": "re-export", "signature": "standardCameraBoundsReport", "summary": "" }, { "name": "standardCameraFocusReport", "kind": "re-export", "signature": "standardCameraFocusReport", "summary": "" }, { "name": "standardCameraFocusTransitionReport", "kind": "re-export", "signature": "standardCameraFocusTransitionReport", "summary": "" }, { "name": "standardCameraKeysReport", "kind": "re-export", "signature": "standardCameraKeysReport", "summary": "" }, { "name": "standardCameraMovementIntentReport", "kind": "re-export", "signature": "standardCameraMovementIntentReport", "summary": "" }, { "name": "standardCameraMovementResponseReport", "kind": "re-export", "signature": "standardCameraMovementResponseReport", "summary": "" }, { "name": "standardCameraOptionsReport", "kind": "re-export", "signature": "standardCameraOptionsReport", "summary": "" }, { "name": "standardCameraSphereFitReport", "kind": "re-export", "signature": "standardCameraSphereFitReport", "summary": "" }, { "name": "standardCameraStateReport", "kind": "re-export", "signature": "standardCameraStateReport", "summary": "" }, { "name": "standardCameraUpdateReport", "kind": "re-export", "signature": "standardCameraUpdateReport", "summary": "" }, { "name": "standardCameraZoomReport", "kind": "re-export", "signature": "standardCameraZoomReport", "summary": "" }, { "name": "standardGamepadButtonReport", "kind": "re-export", "signature": "standardGamepadButtonReport", "summary": "" }, { "name": "standardGamepadHapticEffectReport", "kind": "re-export", "signature": "standardGamepadHapticEffectReport", "summary": "" }, { "name": "standardGamepadInputReport", "kind": "re-export", "signature": "standardGamepadInputReport", "summary": "" }, { "name": "standardGamepadMovementReport", "kind": "re-export", "signature": "standardGamepadMovementReport", "summary": "" }, { "name": "standardInputActionMapReport", "kind": "re-export", "signature": "standardInputActionMapReport", "summary": "" }, { "name": "standardInputActionStateReport", "kind": "re-export", "signature": "standardInputActionStateReport", "summary": "" }, { "name": "standardInputWheelZoomReport", "kind": "re-export", "signature": "standardInputWheelZoomReport", "summary": "" }, { "name": "startGrabCandidate", "kind": "re-export", "signature": "startGrabCandidate", "summary": "" }, { "name": "startImageHeatHaze", "kind": "re-export", "signature": "startImageHeatHaze", "summary": "" }, { "name": "startUnderwaterSiltField", "kind": "re-export", "signature": "startUnderwaterSiltField", "summary": "" }, { "name": "stateFirstModeLabel", "kind": "re-export", "signature": "stateFirstModeLabel", "summary": "" }, { "name": "stepAllSimulations", "kind": "re-export", "signature": "stepAllSimulations", "summary": "" }, { "name": "stepCamera", "kind": "re-export", "signature": "stepCamera", "summary": "" }, { "name": "stepCoupledOscillators", "kind": "re-export", "signature": "stepCoupledOscillators", "summary": "" }, { "name": "stepCrystallization", "kind": "re-export", "signature": "stepCrystallization", "summary": "" }, { "name": "stepEmitters", "kind": "re-export", "signature": "stepEmitters", "summary": "" }, { "name": "stepFluid", "kind": "re-export", "signature": "stepFluid", "summary": "" }, { "name": "stepFluidSimWorld", "kind": "re-export", "signature": "stepFluidSimWorld", "summary": "" }, { "name": "stepMPMWorld", "kind": "re-export", "signature": "stepMPMWorld", "summary": "" }, { "name": "stepParticleSimWorld", "kind": "re-export", "signature": "stepParticleSimWorld", "summary": "" }, { "name": "stepParticles", "kind": "re-export", "signature": "stepParticles", "summary": "" }, { "name": "stepWorld", "kind": "re-export", "signature": "stepWorld", "summary": "" }, { "name": "stepWorldFrame", "kind": "re-export", "signature": "stepWorldFrame", "summary": "" }, { "name": "stopAllSources", "kind": "re-export", "signature": "stopAllSources", "summary": "" }, { "name": "stopSource", "kind": "re-export", "signature": "stopSource", "summary": "" }, { "name": "switchCameraMode", "kind": "re-export", "signature": "switchCameraMode", "summary": "" }, { "name": "syncCameraToEcs", "kind": "re-export", "signature": "syncCameraToEcs", "summary": "" }, { "name": "temperatureToSandboxBucket", "kind": "re-export", "signature": "temperatureToSandboxBucket", "summary": "" }, { "name": "textNode", "kind": "re-export", "signature": "textNode", "summary": "" }, { "name": "tickAudioEngine", "kind": "re-export", "signature": "tickAudioEngine", "summary": "" }, { "name": "tickCharacterAudio", "kind": "re-export", "signature": "tickCharacterAudio", "summary": "" }, { "name": "triggerAudioEvent", "kind": "re-export", "signature": "triggerAudioEvent", "summary": "" }, { "name": "unpackSandboxCell", "kind": "re-export", "signature": "unpackSandboxCell", "summary": "" }, { "name": "unpackSandboxObject", "kind": "re-export", "signature": "unpackSandboxObject", "summary": "" }, { "name": "unregisterAudioEvent", "kind": "re-export", "signature": "unregisterAudioEvent", "summary": "" }, { "name": "unregisterFootstepEvents", "kind": "re-export", "signature": "unregisterFootstepEvents", "summary": "" }, { "name": "unregisterSystem", "kind": "re-export", "signature": "unregisterSystem", "summary": "" }, { "name": "updateAttachedParticlesIntoParticlesState", "kind": "re-export", "signature": "updateAttachedParticlesIntoParticlesState", "summary": "" }, { "name": "updateAttachedParticlesIntoWorld", "kind": "re-export", "signature": "updateAttachedParticlesIntoWorld", "summary": "" }, { "name": "updateAudioListener", "kind": "re-export", "signature": "updateAudioListener", "summary": "" }, { "name": "updateBuffer", "kind": "re-export", "signature": "updateBuffer", "summary": "" }, { "name": "updateCameraFull", "kind": "re-export", "signature": "updateCameraFull", "summary": "" }, { "name": "updateGrabbedEntity", "kind": "re-export", "signature": "updateGrabbedEntity", "summary": "" }, { "name": "updateParticleCounts", "kind": "re-export", "signature": "updateParticleCounts", "summary": "" }, { "name": "updateStandardCamera", "kind": "re-export", "signature": "updateStandardCamera", "summary": "" }, { "name": "updateStandardLights", "kind": "re-export", "signature": "updateStandardLights", "summary": "" }, { "name": "updateStandardUniforms", "kind": "re-export", "signature": "updateStandardUniforms", "summary": "" }, { "name": "updateVoxelWorldFrameUniforms", "kind": "re-export", "signature": "updateVoxelWorldFrameUniforms", "summary": "" }, { "name": "updateWorldFluidDomainParams", "kind": "re-export", "signature": "updateWorldFluidDomainParams", "summary": "" }, { "name": "validateComponentSchema", "kind": "re-export", "signature": "validateComponentSchema", "summary": "" }, { "name": "validateSandboxMaterialCatalog", "kind": "re-export", "signature": "validateSandboxMaterialCatalog", "summary": "" }, { "name": "vec2", "kind": "re-export", "signature": "vec2", "summary": "" }, { "name": "vec2Add", "kind": "re-export", "signature": "vec2Add", "summary": "" }, { "name": "vec2Clone", "kind": "re-export", "signature": "vec2Clone", "summary": "" }, { "name": "vec2Distance", "kind": "re-export", "signature": "vec2Distance", "summary": "" }, { "name": "vec2Dot", "kind": "re-export", "signature": "vec2Dot", "summary": "" }, { "name": "vec2Length", "kind": "re-export", "signature": "vec2Length", "summary": "" }, { "name": "vec2Lerp", "kind": "re-export", "signature": "vec2Lerp", "summary": "" }, { "name": "vec2Normalize", "kind": "re-export", "signature": "vec2Normalize", "summary": "" }, { "name": "vec2Scale", "kind": "re-export", "signature": "vec2Scale", "summary": "" }, { "name": "vec2Sub", "kind": "re-export", "signature": "vec2Sub", "summary": "" }, { "name": "vec3", "kind": "re-export", "signature": "vec3", "summary": "" }, { "name": "vec3Add", "kind": "re-export", "signature": "vec3Add", "summary": "" }, { "name": "vec3Bounce", "kind": "re-export", "signature": "vec3Bounce", "summary": "" }, { "name": "vec3Clone", "kind": "re-export", "signature": "vec3Clone", "summary": "" }, { "name": "vec3Cross", "kind": "re-export", "signature": "vec3Cross", "summary": "" }, { "name": "vec3DirectionTo", "kind": "re-export", "signature": "vec3DirectionTo", "summary": "" }, { "name": "vec3Distance", "kind": "re-export", "signature": "vec3Distance", "summary": "" }, { "name": "vec3DistanceSq", "kind": "re-export", "signature": "vec3DistanceSq", "summary": "" }, { "name": "vec3Dot", "kind": "re-export", "signature": "vec3Dot", "summary": "" }, { "name": "vec3FaceForward", "kind": "re-export", "signature": "vec3FaceForward", "summary": "" }, { "name": "vec3Forward", "kind": "re-export", "signature": "vec3Forward", "summary": "" }, { "name": "vec3Length", "kind": "re-export", "signature": "vec3Length", "summary": "" }, { "name": "vec3LengthSq", "kind": "re-export", "signature": "vec3LengthSq", "summary": "" }, { "name": "vec3Lerp", "kind": "re-export", "signature": "vec3Lerp", "summary": "" }, { "name": "vec3Midpoint", "kind": "re-export", "signature": "vec3Midpoint", "summary": "" }, { "name": "vec3Mul", "kind": "re-export", "signature": "vec3Mul", "summary": "" }, { "name": "vec3Negate", "kind": "re-export", "signature": "vec3Negate", "summary": "" }, { "name": "vec3Normalize", "kind": "re-export", "signature": "vec3Normalize", "summary": "" }, { "name": "vec3OctDecode", "kind": "re-export", "signature": "vec3OctDecode", "summary": "" }, { "name": "vec3OctEncode", "kind": "re-export", "signature": "vec3OctEncode", "summary": "" }, { "name": "vec3One", "kind": "re-export", "signature": "vec3One", "summary": "" }, { "name": "vec3Project", "kind": "re-export", "signature": "vec3Project", "summary": "" }, { "name": "vec3Reflect", "kind": "re-export", "signature": "vec3Reflect", "summary": "" }, { "name": "vec3Refract", "kind": "re-export", "signature": "vec3Refract", "summary": "" }, { "name": "vec3Right", "kind": "re-export", "signature": "vec3Right", "summary": "" }, { "name": "vec3RotateTowards", "kind": "re-export", "signature": "vec3RotateTowards", "summary": "" }, { "name": "vec3Saturate", "kind": "re-export", "signature": "vec3Saturate", "summary": "" }, { "name": "vec3Scale", "kind": "re-export", "signature": "vec3Scale", "summary": "" }, { "name": "vec3SmoothDamp", "kind": "re-export", "signature": "vec3SmoothDamp", "summary": "" }, { "name": "vec3Sub", "kind": "re-export", "signature": "vec3Sub", "summary": "" }, { "name": "vec3Up", "kind": "re-export", "signature": "vec3Up", "summary": "" }, { "name": "vec3Zero", "kind": "re-export", "signature": "vec3Zero", "summary": "" }, { "name": "voxel", "kind": "re-export", "signature": "voxel", "summary": "" }, { "name": "waitForCanvasReady", "kind": "re-export", "signature": "waitForCanvasReady", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "EngineEditorBootstrap", "path": "engine/reference/EngineEditorBootstrap.md", "source": "engine/EngineEditorBootstrap.js", "import": "/engine/EngineEditorBootstrap.js", "sourceHash": "a8fe16ba18fadfc618d35d10f0047efe5c658b3ba1cef5823a387fdc2da65443", "summary": "EngineEditorBootstrap.js - Combined Engine + Editor entry point Use this as the entry point when you want the FULL library bundled: - All engine modules (math, ECS, rendering, simulation, audio, tools) - All editor modules (viewport, physics sim, particles, collab, UI) Usage: python bundle_engine.py --entry engine/EngineEditorBootstrap.js --eager The bundled runtime exposes everything on window.PE / window.ParticleEngine: PE.vec3(), PE.createWorld(), PE.EditorApp, etc.", "exports": [ { "name": "initializePlauna", "kind": "function", "signature": "async initializePlauna(options = {})", "summary": "" }, { "name": "Editor", "kind": "constant", "signature": "Editor", "summary": "" }, { "name": "EditorApp", "kind": "re-export", "signature": "EditorApp", "summary": "" }, { "name": "Engine", "kind": "re-export", "signature": "Engine", "summary": "" }, { "name": "ProjectManager", "kind": "re-export", "signature": "ProjectManager", "summary": "" }, { "name": "createPlaunaApp", "kind": "re-export", "signature": "createPlaunaApp", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "EngineImports", "path": "engine/reference/EngineImports.md", "source": "engine/EngineImports.js", "import": "/engine/EngineImports.js", "sourceHash": "11e1315d0714124ddeae94e60169e42c525a1fd50fc47c1e822e5b5819dc7ffb", "summary": "Global barrel for engine modules, grouped by domain. This is intended for games/tests/tools that want a single import and then access Math/Gpu/Ecs/Render/Tools/etc as namespaces.", "exports": [ { "name": "Aim", "kind": "re-export", "signature": "Aim", "summary": "" }, { "name": "Animation", "kind": "re-export", "signature": "Animation", "summary": "" }, { "name": "Camera", "kind": "re-export", "signature": "Camera", "summary": "" }, { "name": "CameraTools", "kind": "re-export", "signature": "CameraTools", "summary": "" }, { "name": "Collider", "kind": "re-export", "signature": "Collider", "summary": "" }, { "name": "Config", "kind": "re-export", "signature": "Config", "summary": "" }, { "name": "CoreSave", "kind": "re-export", "signature": "CoreSave", "summary": "" }, { "name": "CoreSchema", "kind": "re-export", "signature": "CoreSchema", "summary": "" }, { "name": "GameplayAI", "kind": "re-export", "signature": "GameplayAI", "summary": "" }, { "name": "GameplayEvents", "kind": "re-export", "signature": "GameplayEvents", "summary": "" }, { "name": "GameplayInventory", "kind": "re-export", "signature": "GameplayInventory", "summary": "" }, { "name": "GameplayItems", "kind": "re-export", "signature": "GameplayItems", "summary": "" }, { "name": "GameplayPerception", "kind": "re-export", "signature": "GameplayPerception", "summary": "" }, { "name": "GameplayProgression", "kind": "re-export", "signature": "GameplayProgression", "summary": "" }, { "name": "GameplayRules", "kind": "re-export", "signature": "GameplayRules", "summary": "" }, { "name": "GameplaySimulation", "kind": "re-export", "signature": "GameplaySimulation", "summary": "" }, { "name": "GameplaySocial", "kind": "re-export", "signature": "GameplaySocial", "summary": "" }, { "name": "GameplaySociety", "kind": "re-export", "signature": "GameplaySociety", "summary": "" }, { "name": "Geometry", "kind": "re-export", "signature": "Geometry", "summary": "" }, { "name": "Ghost", "kind": "re-export", "signature": "Ghost", "summary": "" }, { "name": "Gpu", "kind": "re-export", "signature": "Gpu", "summary": "" }, { "name": "GpuDevice", "kind": "re-export", "signature": "GpuDevice", "summary": "" }, { "name": "Grab", "kind": "re-export", "signature": "Grab", "summary": "" }, { "name": "Inspector", "kind": "re-export", "signature": "Inspector", "summary": "" }, { "name": "Light", "kind": "re-export", "signature": "Light", "summary": "" }, { "name": "Math", "kind": "re-export", "signature": "Math", "summary": "" }, { "name": "Mesh", "kind": "re-export", "signature": "Mesh", "summary": "" }, { "name": "Narrative", "kind": "re-export", "signature": "Narrative", "summary": "" }, { "name": "NetReplicated", "kind": "re-export", "signature": "NetReplicated", "summary": "" }, { "name": "Network", "kind": "re-export", "signature": "Network", "summary": "" }, { "name": "ParticleBillboards", "kind": "re-export", "signature": "ParticleBillboards", "summary": "" }, { "name": "ParticleEmitter", "kind": "re-export", "signature": "ParticleEmitter", "summary": "" }, { "name": "ParticleQuality", "kind": "re-export", "signature": "ParticleQuality", "summary": "" }, { "name": "PhysicsBody", "kind": "re-export", "signature": "PhysicsBody", "summary": "" }, { "name": "PhysicsScenes", "kind": "re-export", "signature": "PhysicsScenes", "summary": "" }, { "name": "Picking", "kind": "re-export", "signature": "Picking", "summary": "" }, { "name": "Platform", "kind": "re-export", "signature": "Platform", "summary": "" }, { "name": "ReplicationProfiles", "kind": "re-export", "signature": "ReplicationProfiles", "summary": "" }, { "name": "Rig", "kind": "re-export", "signature": "Rig", "summary": "" }, { "name": "ScreenRayCaster", "kind": "re-export", "signature": "ScreenRayCaster", "summary": "" }, { "name": "Shaders", "kind": "re-export", "signature": "Shaders", "summary": "" }, { "name": "SmokeVolumes", "kind": "re-export", "signature": "SmokeVolumes", "summary": "" }, { "name": "Spawn", "kind": "re-export", "signature": "Spawn", "summary": "" }, { "name": "SpectralRender", "kind": "re-export", "signature": "SpectralRender", "summary": "" }, { "name": "StandardEntityRenderResources", "kind": "re-export", "signature": "StandardEntityRenderResources", "summary": "" }, { "name": "StandardRoom", "kind": "re-export", "signature": "StandardRoom", "summary": "" }, { "name": "StandardUniforms", "kind": "re-export", "signature": "StandardUniforms", "summary": "" }, { "name": "Storage", "kind": "re-export", "signature": "Storage", "summary": "" }, { "name": "Transform", "kind": "re-export", "signature": "Transform", "summary": "" }, { "name": "VoxelWorld", "kind": "re-export", "signature": "VoxelWorld", "summary": "" }, { "name": "World", "kind": "re-export", "signature": "World", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "MathImports", "path": "engine/reference/MathImports.md", "source": "engine/MathImports.js", "import": "/engine/MathImports.js", "sourceHash": "751a3e0d53604a3c63c6793aab8f1b79580e202a43a82ed29b09bcabfd30eb6d", "summary": "MathImports: convenience barrel for engine math utilities. Provides both a grouped Math namespace and flat re-exports for common ops.", "exports": [ { "name": "Math", "kind": "constant", "signature": "Math", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "RenderImports", "path": "engine/reference/RenderImports.md", "source": "engine/RenderImports.js", "import": "/engine/RenderImports.js", "sourceHash": "0ca25a938e4c7e6bdf092ed2af5977ee930ea805a80bcb5b1052885148588b9e", "summary": "", "exports": [ { "name": "RenderMesh", "kind": "constant", "signature": "RenderMesh", "summary": "" }, { "name": "RenderGeometry", "kind": "constant", "signature": "RenderGeometry", "summary": "" }, { "name": "RenderShaders", "kind": "constant", "signature": "RenderShaders", "summary": "" }, { "name": "RenderRoom", "kind": "constant", "signature": "RenderRoom", "summary": "" }, { "name": "RenderVoxelWorld", "kind": "constant", "signature": "RenderVoxelWorld", "summary": "" }, { "name": "RenderUniforms", "kind": "constant", "signature": "RenderUniforms", "summary": "" }, { "name": "RenderEntityResources", "kind": "constant", "signature": "RenderEntityResources", "summary": "" }, { "name": "RenderSpectral", "kind": "constant", "signature": "RenderSpectral", "summary": "" }, { "name": "createUnitCubeMesh", "kind": "constant", "signature": "createUnitCubeMesh", "summary": "" }, { "name": "getVertexBufferLayoutForMesh", "kind": "constant", "signature": "getVertexBufferLayoutForMesh", "summary": "" }, { "name": "createEngineMesh", "kind": "constant", "signature": "createEngineMesh", "summary": "" }, { "name": "createSkyboxGeometry", "kind": "constant", "signature": "createSkyboxGeometry", "summary": "" }, { "name": "createCubeGeometry", "kind": "constant", "signature": "createCubeGeometry", "summary": "" }, { "name": "createGroundGeometry", "kind": "constant", "signature": "createGroundGeometry", "summary": "" }, { "name": "createPlaneGeometry", "kind": "constant", "signature": "createPlaneGeometry", "summary": "" }, { "name": "createSphereGeometry", "kind": "constant", "signature": "createSphereGeometry", "summary": "" }, { "name": "createCylinderGeometry", "kind": "constant", "signature": "createCylinderGeometry", "summary": "" }, { "name": "createShaderLoader", "kind": "constant", "signature": "createShaderLoader", "summary": "" }, { "name": "createStandardRoomRenderer", "kind": "constant", "signature": "createStandardRoomRenderer", "summary": "" }, { "name": "createVoxelWorldRenderer", "kind": "constant", "signature": "createVoxelWorldRenderer", "summary": "" }, { "name": "updateVoxelWorldFrameUniforms", "kind": "constant", "signature": "updateVoxelWorldFrameUniforms", "summary": "" }, { "name": "updateStandardLights", "kind": "constant", "signature": "updateStandardLights", "summary": "" }, { "name": "updateStandardUniforms", "kind": "constant", "signature": "updateStandardUniforms", "summary": "" }, { "name": "createStandardEntityRenderResources", "kind": "constant", "signature": "createStandardEntityRenderResources", "summary": "" }, { "name": "createSmokeVolumeRenderer", "kind": "constant", "signature": "createSmokeVolumeRenderer", "summary": "" }, { "name": "createParticleBillboardRenderer", "kind": "constant", "signature": "createParticleBillboardRenderer", "summary": "" }, { "name": "createParticleBillboardDataBindGroup", "kind": "constant", "signature": "createParticleBillboardDataBindGroup", "summary": "" }, { "name": "setParticleBillboardParams", "kind": "constant", "signature": "setParticleBillboardParams", "summary": "" }, { "name": "createParticleQualityManager", "kind": "constant", "signature": "createParticleQualityManager", "summary": "" }, { "name": "PARTICLE_QUALITY_PRESETS", "kind": "constant", "signature": "PARTICLE_QUALITY_PRESETS", "summary": "" }, { "name": "IndexedClusterCuller", "kind": "re-export", "signature": "IndexedClusterCuller", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "ToolsImports", "path": "engine/reference/ToolsImports.md", "source": "engine/ToolsImports.js", "import": "/engine/ToolsImports.js", "sourceHash": "6e3c6ea002d569dbe64cf7168a7d15ce5837389c39bbcb37e0cb5bd4f94b6bfa", "summary": "", "exports": [ { "name": "ToolsInspector", "kind": "constant", "signature": "ToolsInspector", "summary": "" }, { "name": "ToolsSpawn", "kind": "constant", "signature": "ToolsSpawn", "summary": "" }, { "name": "ToolsGhost", "kind": "constant", "signature": "ToolsGhost", "summary": "" }, { "name": "ToolsPicking", "kind": "constant", "signature": "ToolsPicking", "summary": "" }, { "name": "ToolsScreenRay", "kind": "constant", "signature": "ToolsScreenRay", "summary": "" }, { "name": "ROOM_PICKING_LIMITS", "kind": "constant", "signature": "ROOM_PICKING_LIMITS", "summary": "" }, { "name": "pickingRayReport", "kind": "constant", "signature": "pickingRayReport", "summary": "" }, { "name": "roomPickingOptionsReport", "kind": "constant", "signature": "roomPickingOptionsReport", "summary": "" }, { "name": "entityPickingOptionsReport", "kind": "constant", "signature": "entityPickingOptionsReport", "summary": "" }, { "name": "SCREEN_RAY_LIMITS", "kind": "constant", "signature": "SCREEN_RAY_LIMITS", "summary": "" }, { "name": "screenPickInputReport", "kind": "constant", "signature": "screenPickInputReport", "summary": "" }, { "name": "screenCameraBasisReport", "kind": "constant", "signature": "screenCameraBasisReport", "summary": "" }, { "name": "screenCameraStateReport", "kind": "constant", "signature": "screenCameraStateReport", "summary": "" }, { "name": "ToolsCamera", "kind": "constant", "signature": "ToolsCamera", "summary": "" }, { "name": "ToolsGrab", "kind": "constant", "signature": "ToolsGrab", "summary": "" }, { "name": "ToolsPhysicsScenes", "kind": "constant", "signature": "ToolsPhysicsScenes", "summary": "" }, { "name": "ToolsRigging", "kind": "constant", "signature": "ToolsRigging", "summary": "" }, { "name": "ToolsAnimation", "kind": "constant", "signature": "ToolsAnimation", "summary": "" }, { "name": "attachInspectorPanel", "kind": "constant", "signature": "attachInspectorPanel", "summary": "" }, { "name": "spawnPhysicsObjectAtPosition", "kind": "constant", "signature": "spawnPhysicsObjectAtPosition", "summary": "" }, { "name": "getGhostPreviewInfo", "kind": "constant", "signature": "getGhostPreviewInfo", "summary": "" }, { "name": "createGhostSelectionState", "kind": "constant", "signature": "createGhostSelectionState", "summary": "" }, { "name": "addGhostToSelection", "kind": "constant", "signature": "addGhostToSelection", "summary": "" }, { "name": "setActiveGhostInSelection", "kind": "constant", "signature": "setActiveGhostInSelection", "summary": "" }, { "name": "setActiveGhostBasePosition", "kind": "constant", "signature": "setActiveGhostBasePosition", "summary": "" }, { "name": "setActiveGhostOffset", "kind": "constant", "signature": "setActiveGhostOffset", "summary": "" }, { "name": "getGhostWorldPosition", "kind": "constant", "signature": "getGhostWorldPosition", "summary": "" }, { "name": "getActiveGhost", "kind": "constant", "signature": "getActiveGhost", "summary": "" }, { "name": "getActiveGhostWorldPosition", "kind": "constant", "signature": "getActiveGhostWorldPosition", "summary": "" }, { "name": "pickRoomSurfaceFromRay", "kind": "constant", "signature": "pickRoomSurfaceFromRay", "summary": "" }, { "name": "pickEntityFromRay", "kind": "constant", "signature": "pickEntityFromRay", "summary": "" }, { "name": "getPickRayForCanvasFromScreen", "kind": "constant", "signature": "getPickRayForCanvasFromScreen", "summary": "" }, { "name": "updateStandardCamera", "kind": "constant", "signature": "updateStandardCamera", "summary": "" }, { "name": "getStandardCameraEyeBasis", "kind": "constant", "signature": "getStandardCameraEyeBasis", "summary": "" }, { "name": "STANDARD_CAMERA_LIMITS", "kind": "constant", "signature": "STANDARD_CAMERA_LIMITS", "summary": "" }, { "name": "standardCameraStateReport", "kind": "constant", "signature": "standardCameraStateReport", "summary": "" }, { "name": "standardCameraOptionsReport", "kind": "constant", "signature": "standardCameraOptionsReport", "summary": "" }, { "name": "standardCameraUpdateReport", "kind": "constant", "signature": "standardCameraUpdateReport", "summary": "" }, { "name": "standardCameraKeysReport", "kind": "constant", "signature": "standardCameraKeysReport", "summary": "" }, { "name": "standardCameraMovementResponseReport", "kind": "constant", "signature": "standardCameraMovementResponseReport", "summary": "" }, { "name": "standardCameraZoomReport", "kind": "constant", "signature": "standardCameraZoomReport", "summary": "" }, { "name": "standardCameraBoomReport", "kind": "constant", "signature": "standardCameraBoomReport", "summary": "" }, { "name": "standardCameraFocusReport", "kind": "constant", "signature": "standardCameraFocusReport", "summary": "" }, { "name": "standardCameraFocusTransitionReport", "kind": "constant", "signature": "standardCameraFocusTransitionReport", "summary": "" }, { "name": "standardCameraSphereFitReport", "kind": "constant", "signature": "standardCameraSphereFitReport", "summary": "" }, { "name": "standardCameraBoundsReport", "kind": "constant", "signature": "standardCameraBoundsReport", "summary": "" }, { "name": "standardCameraBoundsFocusReport", "kind": "constant", "signature": "standardCameraBoundsFocusReport", "summary": "" }, { "name": "standardCameraMovementIntentReport", "kind": "constant", "signature": "standardCameraMovementIntentReport", "summary": "" }, { "name": "createGrabState", "kind": "constant", "signature": "createGrabState", "summary": "" }, { "name": "startGrabCandidate", "kind": "constant", "signature": "startGrabCandidate", "summary": "" }, { "name": "cancelGrabCandidate", "kind": "constant", "signature": "cancelGrabCandidate", "summary": "" }, { "name": "releaseGrabbed", "kind": "constant", "signature": "releaseGrabbed", "summary": "" }, { "name": "configurePhysicsSandboxScene", "kind": "constant", "signature": "configurePhysicsSandboxScene", "summary": "" }, { "name": "buildSourceSurfaceBVH", "kind": "constant", "signature": "buildSourceSurfaceBVH", "summary": "" }, { "name": "estimateAlignmentICP", "kind": "constant", "signature": "estimateAlignmentICP", "summary": "" }, { "name": "transferSkinWeightsCPU", "kind": "constant", "signature": "transferSkinWeightsCPU", "summary": "" }, { "name": "transferSkinWeightsGPU", "kind": "constant", "signature": "transferSkinWeightsGPU", "summary": "" }, { "name": "SkinWeightTransferGPU", "kind": "constant", "signature": "SkinWeightTransferGPU", "summary": "" }, { "name": "parseFBXAscii", "kind": "constant", "signature": "parseFBXAscii", "summary": "" }, { "name": "buildMixamoSkeletonFromFBX", "kind": "constant", "signature": "buildMixamoSkeletonFromFBX", "summary": "" }, { "name": "sampleMixamoFBXAnimationClip", "kind": "constant", "signature": "sampleMixamoFBXAnimationClip", "summary": "" }, { "name": "loadMixamoFBXAscii", "kind": "constant", "signature": "loadMixamoFBXAscii", "summary": "" }, { "name": "findSkeletonJointIndexByName", "kind": "constant", "signature": "findSkeletonJointIndexByName", "summary": "" }, { "name": "computeClipLocalMatricesAtFrame", "kind": "constant", "signature": "computeClipLocalMatricesAtFrame", "summary": "" }, { "name": "computeClipGlobalMatricesAtFrame", "kind": "constant", "signature": "computeClipGlobalMatricesAtFrame", "summary": "" }, { "name": "extractRootTranslationTrack", "kind": "constant", "signature": "extractRootTranslationTrack", "summary": "" }, { "name": "extractRootMotion", "kind": "constant", "signature": "extractRootMotion", "summary": "" }, { "name": "buildTeacherJointPositionDataset", "kind": "constant", "signature": "buildTeacherJointPositionDataset", "summary": "" }, { "name": "attachPhysicsSandboxInspector", "kind": "re-export", "signature": "attachPhysicsSandboxInspector", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "animation/index", "path": "engine/reference/animation/index.md", "source": "engine/animation/index.js", "import": "/engine/animation/index.js", "sourceHash": "2b2418c8c52d0bd67acd1a22e3f6658cbc6b7115101383aab4be30550cdba945", "summary": "", "exports": [], "subsystem": "engine" }, { "schemaVersion": 1, "title": "animation/learning/FbxMotionExtractor", "path": "engine/reference/animation/learning/FbxMotionExtractor.md", "source": "engine/animation/learning/FbxMotionExtractor.js", "import": "/engine/animation/learning/FbxMotionExtractor.js", "sourceHash": "ca2eb5b9b2f21aadf374bf8cff0a32cab8f3193d24217d3f775eace806153834", "summary": "", "exports": [ { "name": "extractMotionClipFromFbxAscii", "kind": "function", "signature": "extractMotionClipFromFbxAscii(text, options = {})", "summary": "" }, { "name": "extractMotionDatasetFromFbxAsciiEntries", "kind": "function", "signature": "extractMotionDatasetFromFbxAsciiEntries(entries, options = {})", "summary": "" }, { "name": "extractMotionDatasetFromFbxFiles", "kind": "function", "signature": "async extractMotionDatasetFromFbxFiles(files, options = {})", "summary": "" }, { "name": "extractMotionDatasetFromFbxDirectoryHandle", "kind": "function", "signature": "async extractMotionDatasetFromFbxDirectoryHandle(dirHandle, options = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "animation/learning/GltfMotionExtractor", "path": "engine/reference/animation/learning/GltfMotionExtractor.md", "source": "engine/animation/learning/GltfMotionExtractor.js", "import": "/engine/animation/learning/GltfMotionExtractor.js", "sourceHash": "6a43763f7c966d4c825678cba2a37bb81636905f047966f68ec069a6bb8dbacd", "summary": "", "exports": [ { "name": "extractMotionDatasetFromGltf", "kind": "function", "signature": "extractMotionDatasetFromGltf(gltf, options = {})", "summary": "" }, { "name": "extractMotionClipFromGltf", "kind": "function", "signature": "extractMotionClipFromGltf(gltf, animationIndex = 0, options = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "animation/learning/MotionClip", "path": "engine/reference/animation/learning/MotionClip.md", "source": "engine/animation/learning/MotionClip.js", "import": "/engine/animation/learning/MotionClip.js", "sourceHash": "4a7962568bb34c96d7325c6e5faad14bb6882f889bfb3f50b0e7e4e31d6b946e", "summary": "", "exports": [ { "name": "MotionClip", "kind": "class", "signature": "class MotionClip", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "animation/learning/MotionDataset", "path": "engine/reference/animation/learning/MotionDataset.md", "source": "engine/animation/learning/MotionDataset.js", "import": "/engine/animation/learning/MotionDataset.js", "sourceHash": "30624d36dbb13d2b4c2dcb507f67915c076ad04bf5f5171037dc98662a9620f9", "summary": "", "exports": [ { "name": "MotionDataset", "kind": "class", "signature": "class MotionDataset", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "animation/learning/MotionFeatures", "path": "engine/reference/animation/learning/MotionFeatures.md", "source": "engine/animation/learning/MotionFeatures.js", "import": "/engine/animation/learning/MotionFeatures.js", "sourceHash": "d56aed9f4496c2a70aa38b0744eb5ae47e8f7c3497b380b70634de9b1bea8946", "summary": "", "exports": [ { "name": "buildJointPositionDataset", "kind": "function", "signature": "buildJointPositionDataset(clip, options = {})", "summary": "" }, { "name": "buildMotionFeatureIndex", "kind": "function", "signature": "buildMotionFeatureIndex(dataset, options = {})", "summary": "" }, { "name": "fillRagdollFeature", "kind": "function", "signature": "fillRagdollFeature(ragdoll, boneIndices, out, options = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "animation/learning/MotionMatcher", "path": "engine/reference/animation/learning/MotionMatcher.md", "source": "engine/animation/learning/MotionMatcher.js", "import": "/engine/animation/learning/MotionMatcher.js", "sourceHash": "ad9575d3bcf1cc16f915ec88aca49e1ab104dc6aa1fa1c230502942dcfc860e2", "summary": "", "exports": [ { "name": "MotionMatcher", "kind": "class", "signature": "class MotionMatcher", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "animation/learning/SkeletonHierarchy", "path": "engine/reference/animation/learning/SkeletonHierarchy.md", "source": "engine/animation/learning/SkeletonHierarchy.js", "import": "/engine/animation/learning/SkeletonHierarchy.js", "sourceHash": "07eb01ad4cec4324262e68fc5d369d133cb66a700cdbffb31f1685d6328c4b1e", "summary": "", "exports": [ { "name": "SkeletonHierarchy", "kind": "class", "signature": "class SkeletonHierarchy", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "animation/learning/index", "path": "engine/reference/animation/learning/index.md", "source": "engine/animation/learning/index.js", "import": "/engine/animation/learning/index.js", "sourceHash": "df2275b655b63429e63d936d5d5b2709d71e3af9864906686bd94665f5f8b7a0", "summary": "", "exports": [ { "name": "AnimationLearning", "kind": "constant", "signature": "AnimationLearning", "summary": "" }, { "name": "MotionClip", "kind": "re-export", "signature": "MotionClip", "summary": "" }, { "name": "MotionDataset", "kind": "re-export", "signature": "MotionDataset", "summary": "" }, { "name": "MotionMatcher", "kind": "re-export", "signature": "MotionMatcher", "summary": "" }, { "name": "SkeletonHierarchy", "kind": "re-export", "signature": "SkeletonHierarchy", "summary": "" }, { "name": "buildJointPositionDataset", "kind": "re-export", "signature": "buildJointPositionDataset", "summary": "" }, { "name": "buildMotionFeatureIndex", "kind": "re-export", "signature": "buildMotionFeatureIndex", "summary": "" }, { "name": "extractMotionClipFromFbxAscii", "kind": "re-export", "signature": "extractMotionClipFromFbxAscii", "summary": "" }, { "name": "extractMotionClipFromGltf", "kind": "re-export", "signature": "extractMotionClipFromGltf", "summary": "" }, { "name": "extractMotionDatasetFromFbxAsciiEntries", "kind": "re-export", "signature": "extractMotionDatasetFromFbxAsciiEntries", "summary": "" }, { "name": "extractMotionDatasetFromFbxDirectoryHandle", "kind": "re-export", "signature": "extractMotionDatasetFromFbxDirectoryHandle", "summary": "" }, { "name": "extractMotionDatasetFromFbxFiles", "kind": "re-export", "signature": "extractMotionDatasetFromFbxFiles", "summary": "" }, { "name": "extractMotionDatasetFromGltf", "kind": "re-export", "signature": "extractMotionDatasetFromGltf", "summary": "" }, { "name": "fillRagdollFeature", "kind": "re-export", "signature": "fillRagdollFeature", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/AssetCache", "path": "engine/reference/assets/AssetCache.md", "source": "engine/assets/AssetCache.js", "import": "/engine/assets/AssetCache.js", "sourceHash": "700860a49d88a6109b03a826e70ecdc7d18c26e3950c3471e5ef15692768e5c9", "summary": "engine/assets/AssetCache.js — local engine cache (spec §3, cache://). Converted artifacts (engine binaries, preview meshes, thumbnails, colliders, SDFs, material packs) are cached under cache:// keyed by content hash so a re-import of the same source is instant. The primary backend is the Origin Private File System (OPFS) — origin-private and optimized for file access; an in-memory Map backs environments without OPFS (Node tests, locked-down contexts) so the rest of the runtime is backend-agnostic.", "exports": [ { "name": "AssetCache", "kind": "class", "signature": "class AssetCache", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/AssetDeduper", "path": "engine/reference/assets/AssetDeduper.md", "source": "engine/assets/AssetDeduper.js", "import": "/engine/assets/AssetDeduper.js", "sourceHash": "9d8bc22ec241e7ae3637d79abc0f32d087f0fdd0ce9a39a9ebbcaf405f89bbfc", "summary": "engine/assets/AssetDeduper.js — content-hash dedup (spec §3). Assets are deduplicated by source content hash. We separate source / mesh / material hashes so that the dedup rules can distinguish exact duplicates from variants and conflicts: same source hash = same source asset (exact duplicate) same name + different hash = version/conflict same mesh hash + diff material = variant same texture hash = shared texture Hashing prefers Web Crypto SHA-256; in a non-secure context it falls back to a deterministic FNV-1a stamp (clearly tagged so callers know it isn't crypto).", "exports": [ { "name": "assetDeduperFallbackHash", "kind": "function", "signature": "assetDeduperFallbackHash(data)", "summary": "" }, { "name": "hashContent", "kind": "function", "signature": "async hashContent(data)", "summary": "Content hash of arbitrary data. Returns 'sha256:' (secure) or 'fnv1a:' (fallback). Async because Web Crypto digest is async." }, { "name": "classify", "kind": "function", "signature": "classify(candidate, records)", "summary": "Classify a candidate against the existing records." }, { "name": "DEDUP", "kind": "constant", "signature": "DEDUP", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/AssetRecord", "path": "engine/reference/assets/AssetRecord.md", "source": "engine/assets/AssetRecord.js", "import": "/engine/assets/AssetRecord.js", "sourceHash": "ae8548acb69b9c38101f96a2451c4439ff7072708c9d422fee73faa5cb1697d0", "summary": "engine/assets/AssetRecord.js — the registry's record for one source asset. The asset registry (not the filesystem) is the source of truth. Each record tracks the source content hash, a primary virtual path, redundant backup paths, the set of converted engine artifacts, and license metadata. Records are deduplicated by source hash; variants/conflicts are linked, never merged blindly (see AssetDeduper / AssetRegistry).", "exports": [ { "name": "createAssetRecord", "kind": "function", "signature": "createAssetRecord(init = {})", "summary": "Create an asset record." }, { "name": "createLicenseBlock", "kind": "function", "signature": "createLicenseBlock(init = {})", "summary": "License metadata is mandatory before import (unknown is allowed but flagged). Marketplace assets are licensed, not sold — track it and warn on restricted." }, { "name": "licenseNeedsReview", "kind": "function", "signature": "licenseNeedsReview(license)", "summary": "True if the license is unknown or explicitly disallows engine conversion." }, { "name": "ASSET_TYPES", "kind": "constant", "signature": "ASSET_TYPES", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/AssetRegistry", "path": "engine/reference/assets/AssetRegistry.md", "source": "engine/assets/AssetRegistry.js", "import": "/engine/assets/AssetRegistry.js", "sourceHash": "53ee2abb9003fa79df6f7a8fc163bfcf1d13a8ae199d2400109ea9ef58444206", "summary": "engine/assets/AssetRegistry.js — the source of truth (spec §3, rule 3). The registry (not the filesystem) owns asset identity. Sources are deduplicated by content hash; the registry links exact duplicates, variants, and conflicts rather than merging them blindly. Registering an already-known source returns the canonical record (idempotent), so re-importing the same file never produces a second asset.", "exports": [ { "name": "AssetRegistry", "kind": "class", "signature": "class AssetRegistry", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/AssetResolver", "path": "engine/reference/assets/AssetResolver.md", "source": "engine/assets/AssetResolver.js", "import": "/engine/assets/AssetResolver.js", "sourceHash": "71434beddaf555a895ce7cfc2fbfd032dc2be9bd87a70595e5dd5b43007bca51", "summary": "engine/assets/AssetResolver.js — virtual-path resolution + backup repair (spec §3, rule 5). Files move, browser permissions expire, cloud mirrors lag. The resolver maps a scheme:// path to a concrete backend and, when reading a registered asset, tries the primary then each backup, verifying by content hash. If a backup matches the expected hash it repairs the primary; if a candidate's hash differs it is flagged a conflict (never silently accepted).", "exports": [ { "name": "AssetResolver", "kind": "class", "signature": "class AssetResolver", "summary": "A backend is { async read(path) -> Uint8Array|null, async write?(path, bytes) }. Schemes without a registered backend simply fail to resolve (caller falls back)." }, { "name": "backendFromCache", "kind": "function", "signature": "backendFromCache(cache)", "summary": "Adapt an AssetCache instance to a resolver backend (cache:// scheme)." }, { "name": "makeFetchBackend", "kind": "function", "signature": "makeFetchBackend(base)", "summary": "A read-only backend that fetches relative to a base URL (asset://, cloud://)." }, { "name": "makeMemoryBackend", "kind": "function", "signature": "makeMemoryBackend(initial = {})", "summary": "A simple in-memory backend (temp:// drag-drop, user:// session mounts)." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/CanonicalSpace", "path": "engine/reference/assets/CanonicalSpace.md", "source": "engine/assets/CanonicalSpace.js", "import": "/engine/assets/CanonicalSpace.js", "sourceHash": "4d32f0a2c6fbf749f08abeeb4f8b0d6166ac6706c45d93406ce44ca3b1a8cc1c", "summary": "engine/assets/CanonicalSpace.js — the engine's canonical coordinate frame. Y = up, Z = forward, X = side (right), unit = meter, origin = logical root. Source files come from Blender/Maya/Max/CAD/Unity/Unreal/etc. with inconsistent axes, scale, and origin. We never trust source orientation and never rewrite it destructively — instead we compute a non-destructive axis correction (a quaternion + uniform scale) that maps the declared source frame into this canonical frame, and store it on the model's ImportTransform.", "exports": [ { "name": "axisVector", "kind": "function", "signature": "axisVector(token)", "summary": "Resolve an axis token ('+Y', '-Z', …) to a unit vector." }, { "name": "axisCorrectionQuat", "kind": "function", "signature": "axisCorrectionQuat(upAxis = '+Y', forwardAxis = '+Z')", "summary": "Quaternion (xyzw) that rotates a vector from a source frame (declared by its up + forward axes) into the canonical Y-up / Z-forward frame." }, { "name": "mat3ToQuat", "kind": "function", "signature": "mat3ToQuat(m)", "summary": "Convert a row-major 3x3 rotation matrix to a quaternion (xyzw)." }, { "name": "rotateVecByQuat", "kind": "function", "signature": "rotateVecByQuat(v, q)", "summary": "Rotate a 3-vector by a quaternion (xyzw)." }, { "name": "unitScaleToMeters", "kind": "function", "signature": "unitScaleToMeters(unit)", "summary": "" }, { "name": "CANONICAL", "kind": "constant", "signature": "CANONICAL", "summary": "" }, { "name": "UNIT_TO_METERS", "kind": "constant", "signature": "UNIT_TO_METERS", "summary": "Common unit guesses for formats that don't carry units (e.g. STL). Returns a scale factor to convert the source unit to meters. These are *guesses* — the editor exposes an override per import." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/EngineModel", "path": "engine/reference/assets/EngineModel.md", "source": "engine/assets/EngineModel.js", "import": "/engine/assets/EngineModel.js", "sourceHash": "b7af5e3efddc8d291cb2069460b22c9fcef1319b6cd30097dca52c8b10ee8201", "summary": "engine/assets/EngineModel.js — the unified runtime object. Core rule of the ingestion runtime: a model file is raw evidence, not the runtime object. The importer parses a source file into an EngineModel, which keeps every layer explicitly separate (source ≠ visual mesh ≠ material ≠ collider ≠ SDF ≠ skeleton ≠ animation ≠ runtime rig ≠ render surface). Layers that have not been built yet are explicitly null/empty — never faked — so the editor can show exactly what was detected vs generated. Corrections (axis/scale/origin, material fixes, rig edits) live in metadata as an ImportTransform / import profile and are NEVER baked destructively into the source: the original imported look must always be recoverable.", "exports": [ { "name": "createEngineModel", "kind": "function", "signature": "createEngineModel(init = {})", "summary": "Create an empty EngineModel with every layer present but unbuilt." }, { "name": "createImportTransform", "kind": "function", "signature": "createImportTransform(init = {})", "summary": "A non-destructive correction applied at runtime (never baked into source). Confidence drives the auto-apply / review / preview / neutral policy." }, { "name": "createEngineNode", "kind": "function", "signature": "createEngineNode(init = {})", "summary": "A node in the preserved source hierarchy (transforms kept as-authored)." }, { "name": "createEngineMesh", "kind": "function", "signature": "createEngineMesh(init = {})", "summary": "A mesh = a set of primitives (submeshes), each with its own material." }, { "name": "createEnginePrimitive", "kind": "function", "signature": "createEnginePrimitive(init = {})", "summary": "A primitive/submesh: geometry + a single material binding." }, { "name": "layerStatus", "kind": "function", "signature": "layerStatus(model)", "summary": "Report which layers are built (non-empty) vs explicitly unbuilt." }, { "name": "ENGINE_MODEL_LAYERS", "kind": "constant", "signature": "ENGINE_MODEL_LAYERS", "summary": "Canonical layer list — used by the editor to show built vs unbuilt layers." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/LicenseTracker", "path": "engine/reference/assets/LicenseTracker.md", "source": "engine/assets/LicenseTracker.js", "import": "/engine/assets/LicenseTracker.js", "sourceHash": "513338d08c844774cb8ef324bb5dad544a377208d3f41db4d6264925e1a8dd83", "summary": "engine/assets/LicenseTracker.js — license metadata + import gate (spec §21). License metadata is mandatory before import. Marketplace assets are licensed, not sold, and portability varies. The hard rules: only import assets the user owns or is licensed to use; never rip copyrighted game assets; never bypass DRM; store license metadata; warn on unknown/restricted licenses. This gate is advisory by default (warn) and can be set strict (block) per project.", "exports": [ { "name": "LicenseTracker", "kind": "class", "signature": "class LicenseTracker", "summary": "" }, { "name": "GATE", "kind": "constant", "signature": "GATE", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/geometry/PrincipalAxes", "path": "engine/reference/assets/geometry/PrincipalAxes.md", "source": "engine/assets/geometry/PrincipalAxes.js", "import": "/engine/assets/geometry/PrincipalAxes.js", "sourceHash": "398bad06d2d3026c86be0c9e4e0faf52184dcd19bd24cecf297a28e8c81555be", "summary": "engine/assets/geometry/PrincipalAxes.js — Principal Component Analysis of an EngineModel node's geometry. Small, dependency-free, GPU-free, and reusable: any engine system can ask for the natural axes of a mesh (oriented bounds, alignment, the axle of a wheel disc, the long axis of a barrel, etc.). PCA finds the orthogonal axes of greatest → least variance of the vertex cloud. A disc/cylinder is thin along its axle, so its axle is the axis of LEAST variance — orientation- and mirror-proof, unlike axis-aligned guesses.", "exports": [ { "name": "eigSym3", "kind": "function", "signature": "eigSym3(m)", "summary": "Jacobi eigen-decomposition of a symmetric 3×3 (row-major length-9 array)." }, { "name": "principalAxes", "kind": "function", "signature": "principalAxes(model, nodeId, opts = {})", "summary": "PCA of a node's mesh-local vertex cloud." }, { "name": "leastVarianceAxis", "kind": "function", "signature": "leastVarianceAxis(model, nodeId, opts = {})", "summary": "Convenience: the axis of LEAST variance (e.g. a wheel/disc axle), or null." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/humanoid/BoneMapper", "path": "engine/reference/assets/humanoid/BoneMapper.md", "source": "engine/assets/humanoid/BoneMapper.js", "import": "/engine/assets/humanoid/BoneMapper.js", "sourceHash": "6917a9903e9a9314b36c226271149b75cfcb898a0b7e19f966a770431b9307ea", "summary": "engine/assets/humanoid/BoneMapper.js — map a source skeleton's bones onto the canonical humanoid slots (HumanoidRig) by NAME first (Mixamo / VRM / generic rig conventions), then hierarchy for the spine chain. Every mapping is a hint; ambiguous/extra bones are reported as `unmapped` and missing required slots as `missing` so the editor can correct (rule 62). Pure + GPU-free (gate-testable).", "exports": [ { "name": "mapBones", "kind": "function", "signature": "mapBones(model, opts = {})", "summary": "Map a model's skeleton to canonical humanoid bones." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/humanoid/FingerGenerator", "path": "engine/reference/assets/humanoid/FingerGenerator.md", "source": "engine/assets/humanoid/FingerGenerator.js", "import": "/engine/assets/humanoid/FingerGenerator.js", "sourceHash": "cb943cae4105ba41aea90d9fb6808c107bf4d07f8cc7589307b2a7b7339bf110", "summary": "engine/assets/humanoid/FingerGenerator.js — synthesize finger bones from a hand mesh when the source skeleton has none (the browser-friendly geometric approach: detect open-hand fingertip \"lobes\", not ML). Method: 1. Build a hand frame from the wrist→fingertip direction; the lateral spread axis (fingers fan out) and palm normal (thinnest) come from 2-D PCA of the vertices in the plane perpendicular to forward. 2. Take the far band of vertices (toward the tips) and cluster them along the lateral axis — each cluster is one finger lobe. 3. Label the shortest extreme lobe as the thumb; order the rest index→pinky. 4. Emit a short straight bone chain (proximal→intermediate→distal→tip) per finger. If fewer than four lobes separate (a closed fist / low-poly hand), report `detected:false` so the caller falls back to a single paddle. Pure geometry, GPU-free, deterministic → unit-testable.", "exports": [ { "name": "generateFingers", "kind": "function", "signature": "generateFingers(vertices, opts = {})", "summary": "Generate finger bones from hand vertices." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/humanoid/FingerMapper", "path": "engine/reference/assets/humanoid/FingerMapper.md", "source": "engine/assets/humanoid/FingerMapper.js", "import": "/engine/assets/humanoid/FingerMapper.js", "sourceHash": "77accd50503ad68da9e1bc0e4914685b3416701d076ca12b15d41d86fa17e081", "summary": "engine/assets/humanoid/FingerMapper.js — detect EXISTING finger bones under a hand node by name (Mixamo \"LeftHandIndex1..3\", VRM \"J_Bip_L_Index_Proximal\", generic \"index_01\"), grouping them into canonical fingers with palm→tip joint order. Used before procedural generation: if the artist rigged fingers, keep them; only synthesize when none are found.", "exports": [ { "name": "mapFingers", "kind": "function", "signature": "mapFingers(model, handNodeId)", "summary": "Map existing finger bones under a hand node." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/humanoid/HandRig", "path": "engine/reference/assets/humanoid/HandRig.md", "source": "engine/assets/humanoid/HandRig.js", "import": "/engine/assets/humanoid/HandRig.js", "sourceHash": "37eab586ed8a836c4cf5578fccb8c468fc736c1eb4e51df40e6f3cecea1bf400", "summary": "engine/assets/humanoid/HandRig.js — hand + finger rig schema (spec §12). A hand is a wrist + up to five fingers, each a short bone chain. Fingers come from one of three sources: the source skeleton's named bones (`skeleton`), procedurally GENERATED from the hand mesh when the skeleton has none (`generated`), or a single paddle bone when the hand is a closed fist / too low-poly (`paddle`).", "exports": [ { "name": "createFinger", "kind": "function", "signature": "createFinger(init = {})", "summary": "" }, { "name": "createHandRig", "kind": "function", "signature": "createHandRig(init = {})", "summary": "" }, { "name": "FINGERS", "kind": "constant", "signature": "FINGERS", "summary": "" }, { "name": "FINGER_JOINTS", "kind": "constant", "signature": "FINGER_JOINTS", "summary": "" }, { "name": "HAND_SOURCE", "kind": "constant", "signature": "HAND_SOURCE", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/humanoid/HandRigBuilder", "path": "engine/reference/assets/humanoid/HandRigBuilder.md", "source": "engine/assets/humanoid/HandRigBuilder.js", "import": "/engine/assets/humanoid/HandRigBuilder.js", "sourceHash": "662dcceb30f7d3aa441e94819fb50c4d63357181ff00fdcafd53e5b443e2ff6f", "summary": "engine/assets/humanoid/HandRigBuilder.js — build a hand rig for each hand of a humanoid. Priority: (1) use named finger bones if the skeleton has them; else (2) PROBE the hand mesh (vertices skinned to the hand joint) and GENERATE finger bones geometrically; else (3) a single paddle. Wrist + forward come from the humanoid rig (hand world position, and the lowerArm→hand direction).", "exports": [ { "name": "extractHandVertices", "kind": "function", "signature": "extractHandVertices(model, handNodeId, thresh = 0.4, pose = null)", "summary": "Vertices skinned (weight ≥ thresh) to the hand joint, in node-hierarchy SCENE space (so they match the wrist + the rendered mesh). `pose` is a node→world map." }, { "name": "buildHandRig", "kind": "function", "signature": "buildHandRig(model, opts = {})", "summary": "Build a single hand rig." }, { "name": "buildHands", "kind": "function", "signature": "buildHands(model, opts = {})", "summary": "Build both hands for a model that already has a humanoid rig; attaches them at model.rigs.hand = { left, right } and humanoidRig.hands." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/humanoid/HumanoidRig", "path": "engine/reference/assets/humanoid/HumanoidRig.md", "source": "engine/assets/humanoid/HumanoidRig.js", "import": "/engine/assets/humanoid/HumanoidRig.js", "sourceHash": "6cb50cb963fa46d4cafdfd1540bc25186158e8df7239412f404a4fff78c00308", "summary": "engine/assets/humanoid/HumanoidRig.js — canonical humanoid bone slots + rig schema (spec §12). A humanoid is NOT its skeleton: it's a mapping from the source skeleton's bones onto a canonical slot set (Unity Mecanim / VRM style) plus rest-pose + correction metadata, so animation can retarget and physics can build a ragdoll regardless of how the artist named or oriented the rig. Every mapping is a HINT with confidence; unmapped/ambiguous bones go to the editor.", "exports": [ { "name": "createHumanoidRig", "kind": "function", "signature": "createHumanoidRig(init = {})", "summary": "Create a humanoid rig descriptor." }, { "name": "boneSide", "kind": "function", "signature": "boneSide(slot)", "summary": "Is a canonical slot a left/right limb (vs a center/spine bone)?" }, { "name": "mirrorBone", "kind": "function", "signature": "mirrorBone(slot)", "summary": "The mirrored slot for a left/right bone (e.g. leftHand ↔ rightHand), or null." }, { "name": "HUMANOID_BONES", "kind": "constant", "signature": "HUMANOID_BONES", "summary": "" }, { "name": "REQUIRED_BONES", "kind": "constant", "signature": "REQUIRED_BONES", "summary": "" }, { "name": "BODY_SIDE", "kind": "constant", "signature": "BODY_SIDE", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/humanoid/HumanoidRigBuilder", "path": "engine/reference/assets/humanoid/HumanoidRigBuilder.md", "source": "engine/assets/humanoid/HumanoidRigBuilder.js", "import": "/engine/assets/humanoid/HumanoidRigBuilder.js", "sourceHash": "2d667b0a0db64ef0e209cc484e292e3f5f4481497985dcb8992048790a4d084a", "summary": "engine/assets/humanoid/HumanoidRigBuilder.js — assemble a HumanoidRig from a model's skeleton (spec §12). Maps bones (BoneMapper), snapshots the rest pose, classifies the pose (T vs A) from the arm direction, and flags needsCorrection when required bones are missing — never guessing past the evidence. The rig is the retarget/ragdoll target: it references the source nodes, it does not bake.", "exports": [ { "name": "buildHumanoidRig", "kind": "function", "signature": "buildHumanoidRig(model, opts = {})", "summary": "Build a humanoid rig and attach it at model.rigs.humanoid." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/humanoid/SkeletonHeal", "path": "engine/reference/assets/humanoid/SkeletonHeal.md", "source": "engine/assets/humanoid/SkeletonHeal.js", "import": "/engine/assets/humanoid/SkeletonHeal.js", "sourceHash": "b4a8f4ae556d703b1d48d143f2032116e53092cf0ccb41bf74426ded124a8d08", "summary": "engine/assets/humanoid/SkeletonHeal.js — anatomy-aware, NON-DESTRUCTIVE skeleton repair. When a rig is missing or mislabels core bones, infer them from anatomy (the same heuristics auto-riggers use): • Pelvis = the point between the two hip joints (and the retarget root must be the pelvis, NOT a ground/root-motion bone — so a \"Root\"/Armature bone at the floor is replaced by the leg-derived pelvis). • Missing spine / chest / neck are interpolated along the hips→head chain. • A missing left/right limb is MIRRORED from the present side across the body's sagittal plane (auto-mirror). Inferred joints are written to `rig.synthesized` (slot → position) — the source model is never modified. `humanoidBonePosition()` returns the real joint if it exists, else the synthesized one.", "exports": [ { "name": "humanoidBonePosition", "kind": "function", "signature": "humanoidBonePosition(rig, slot, pose)", "summary": "Real or synthesized world position for a canonical slot (or null)." }, { "name": "healHumanoid", "kind": "function", "signature": "healHumanoid(model, rig, pose)", "summary": "Repair a humanoid rig in place (non-destructively): fills `rig.synthesized` with inferred joints and `rig.healed` with a list of what was repaired." }, { "name": "analyzeSymmetry", "kind": "function", "signature": "analyzeSymmetry(model, pose)", "summary": "Find the skeleton's plane of bilateral symmetry." }, { "name": "healSkeleton", "kind": "function", "signature": "healSkeleton(model, pose)", "summary": "Heal a generic skeleton by mirroring limbs that exist on only one side." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/humanoid/SkinPose", "path": "engine/reference/assets/humanoid/SkinPose.md", "source": "engine/assets/humanoid/SkinPose.js", "import": "/engine/assets/humanoid/SkinPose.js", "sourceHash": "db2735cd134348a9c124fd7543a73c5441908aff54084bd836788ab902046bbc", "summary": "engine/assets/humanoid/SkinPose.js — scene-space skeleton pose used by rig overlays + hand probing. IMPORTANT (verified with scripts/probe_skeleton.py across real rigs): the correct space for placing the skeleton so it lands on the RENDERED mesh is the NODE-HIERARCHY world, because the importer/renderer draw the (unskinned) mesh through that same node hierarchy + importTransform. `inverse(IBM)` instead lives in the armature-local / unscaled space (e.g. hips ≈ 0.03 while the node-hierarchy hips ≈ 2.77 with a ×100 mesh-node scale), so using it for the overlay either collapses the skeleton (missing node scale) or double-rotates it (re-applying the armature transform). We therefore use the node hierarchy here; the IBMs are still imported and available (invert4) for true-bind / retarget work later.", "exports": [ { "name": "invert4", "kind": "function", "signature": "invert4(m)", "summary": "Invert a column-major 4×4 (returns a new Float32Array, or null if singular)." }, { "name": "buildBindPose", "kind": "function", "signature": "buildBindPose(model)", "summary": "Scene-space pose for every node = the node-hierarchy world (TRS composed down the tree). This is exactly the space the renderer draws the mesh in, so the skeleton overlay + hand probing align with the mesh for any export." }, { "name": "jointPosition", "kind": "function", "signature": "jointPosition(pose, nodeId)", "summary": "World position of a node in a pose map (or null)." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/import/Detectors", "path": "engine/reference/assets/import/Detectors.md", "source": "engine/assets/import/Detectors.js", "import": "/engine/assets/import/Detectors.js", "sourceHash": "9b741dc0e21f679cac3184b6622df3360d4709c9849b0c5ad45acdcd2503cd99", "summary": "engine/assets/import/Detectors.js — hierarchy, part, and semantic detection (spec §6). These produce hints, never assertions: every detection carries a confidence and is editor-correctable. Detection by name is the cheap first pass; geometry-based detection (cylinders → wheels, symmetry, etc.) is layered in by the phase that needs it (vehicles, humanoids, weapons).", "exports": [ { "name": "detectHierarchy", "kind": "function", "signature": "detectHierarchy(model)", "summary": "Summarize the preserved source hierarchy." }, { "name": "detectParts", "kind": "function", "signature": "detectParts(model)", "summary": "Detect semantic parts by node name. Populates model.detectedParts." }, { "name": "detectSemanticDomain", "kind": "function", "signature": "detectSemanticDomain(model)", "summary": "Roll detected parts up to a guessed runtime domain (vehicle/humanoid/weapon)." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/import/FormatDetector", "path": "engine/reference/assets/import/FormatDetector.md", "source": "engine/assets/import/FormatDetector.js", "import": "/engine/assets/import/FormatDetector.js", "sourceHash": "69a346175700b26dc908881d942a3dd16b9bb8482ae85dd55c710699878ccc52", "summary": "engine/assets/import/FormatDetector.js — detect format by extension + magic bytes (spec §5). Never trust the filename alone: the magic-byte sniff wins when it disagrees with the extension, and a confidence is reported so the pipeline can fall back to the editor when unsure.", "exports": [ { "name": "sniffMagic", "kind": "function", "signature": "sniffMagic(head)", "summary": "Sniff a format from a leading byte slice. Returns a format token or null. Pass at least the first 16 bytes for reliable results." }, { "name": "classOf", "kind": "function", "signature": "classOf(format)", "summary": "" }, { "name": "detectFormat", "kind": "function", "signature": "detectFormat(name, head = null)", "summary": "Detect a file's format from its name and (optional) leading bytes." }, { "name": "FORMAT_CLASS", "kind": "constant", "signature": "FORMAT_CLASS", "summary": "" }, { "name": "BRIDGE_FORMATS", "kind": "re-export", "signature": "BRIDGE_FORMATS", "summary": "" }, { "name": "IMAGE_FORMATS", "kind": "re-export", "signature": "IMAGE_FORMATS", "summary": "" }, { "name": "NATIVE_FORMATS", "kind": "re-export", "signature": "NATIVE_FORMATS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/import/GltfSceneImporter", "path": "engine/reference/assets/import/GltfSceneImporter.md", "source": "engine/assets/import/GltfSceneImporter.js", "import": "/engine/assets/import/GltfSceneImporter.js", "sourceHash": "0c194246b9ce63e769ff713a13070fb778c24ef61d86631f952ad4cedd6c7cc4", "summary": "engine/assets/import/GltfSceneImporter.js — full glTF/GLB scene → EngineModel. glTF is the preferred runtime delivery format (nodes, meshes, materials, skins, animations, buffers, textures). This importer parses the whole scene graph — not just motion — reusing the engine's accessor toolkit (core/math/MeshAttributeMath) to decode vertex/index data exactly. Materials and textures are preserved as raw blocks here and normalized in Phase 2; the original look must always be recoverable.", "exports": [ { "name": "parseGlb", "kind": "function", "signature": "parseGlb(bytes)", "summary": "Parse a binary GLB into { json, bin }." }, { "name": "decodeGltfDataUri", "kind": "function", "signature": "decodeGltfDataUri(uri)", "summary": "" }, { "name": "gltfExternalUriReport", "kind": "function", "signature": "gltfExternalUriReport(uri)", "summary": "" }, { "name": "gltfExternalResourceReferences", "kind": "function", "signature": "gltfExternalResourceReferences(json)", "summary": "" }, { "name": "packageLooseGltfFiles", "kind": "function", "signature": "async packageLooseGltfFiles(inputFiles)", "summary": "" }, { "name": "extractGltfMaterialPayload", "kind": "function", "signature": "extractGltfMaterialPayload(json, buffers = [], externalImages = null)", "summary": "Extract the recoverable glTF material/texture payload from already-resolved buffers. This is shared by the full asset pipeline and the editor mesh importer so both paths normalize exactly the same source records." }, { "name": "importGltf", "kind": "function", "signature": "async importGltf(data, opts = {})", "summary": "Import a glTF/GLB into an EngineModel." }, { "name": "GLTF_EXTERNAL_RESOURCE_LIMITS", "kind": "constant", "signature": "GLTF_EXTERNAL_RESOURCE_LIMITS", "summary": "" }, { "name": "GLTF_COMPONENT_TYPES", "kind": "re-export", "signature": "GLTF_COMPONENT_TYPES", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/import/GpuUploader", "path": "engine/reference/assets/import/GpuUploader.md", "source": "engine/assets/import/GpuUploader.js", "import": "/engine/assets/import/GpuUploader.js", "sourceHash": "69a206c0426cd6429d8481247b59aa1de99f8a6cd7f1e8dab37dac6a0ec868da", "summary": "engine/assets/import/GpuUploader.js — upload EngineModel primitives to the GPU. Parsing is GPU-free; this is the separate, device-driven step (spec §9: upload GPU buffers incrementally). Each primitive is interleaved into a standard [position(3), normal(3), uv(2)] vertex layout (generating flat normals when a source lacks them) plus an optional index buffer, so the importer/viewer and the engine renderer can draw it with one shared layout. Buffers are recorded on `primitive.gpu`; `model.gpuReady` flips true when all primitives upload.", "exports": [ { "name": "standardVertexLayout", "kind": "function", "signature": "standardVertexLayout()", "summary": "The WebGPU vertex buffer layout matching interleaveStandard()." }, { "name": "interleaveStandard", "kind": "function", "signature": "interleaveStandard(primitive)", "summary": "Interleave a primitive's attributes into the standard layout." }, { "name": "uploadPrimitive", "kind": "function", "signature": "uploadPrimitive(device, primitive)", "summary": "Upload one primitive to the GPU. Records `primitive.gpu`." }, { "name": "uploadModel", "kind": "function", "signature": "uploadModel(device, model)", "summary": "Upload every primitive in a model. Returns the number uploaded." }, { "name": "releaseModelGpu", "kind": "function", "signature": "releaseModelGpu(model)", "summary": "Free GPU buffers held by a model's primitives." }, { "name": "STANDARD_STRIDE_FLOATS", "kind": "constant", "signature": "STANDARD_STRIDE_FLOATS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/import/ImportPipeline", "path": "engine/reference/assets/import/ImportPipeline.md", "source": "engine/assets/import/ImportPipeline.js", "import": "/engine/assets/import/ImportPipeline.js", "sourceHash": "a4c0ab1a8b0a21a9f9b358d7101384e6b8dda16622f3be1b8117040760d9b6ac", "summary": "engine/assets/import/ImportPipeline.js — orchestrates the ingestion flow (spec §5 pipeline): detect → license-gate → parse → normalize orientation → detect hierarchy/parts/domain → deduplicate/register. GPU upload is a separate explicit step (GpuUploader) because parsing must stay GPU-free and worker-able.", "exports": [ { "name": "parseToModel", "kind": "function", "signature": "async parseToModel(format, data, opts = {})", "summary": "Parse raw bytes of a known format into an EngineModel (no GPU, no registry)." }, { "name": "importFile", "kind": "function", "signature": "async importFile(args)", "summary": "Full import of a single file." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/import/ObjImporter", "path": "engine/reference/assets/import/ObjImporter.md", "source": "engine/assets/import/ObjImporter.js", "import": "/engine/assets/import/ObjImporter.js", "sourceHash": "6be5b53cfeab30b8a2a9b6cc8422e76d7fbfe12ac0e99c3634ebda576daca872", "summary": "engine/assets/import/ObjImporter.js — Wavefront OBJ (+ optional MTL) → EngineModel. OBJ is static geometry + simple material references. We preserve groups/objects and per-face material assignment by splitting into one primitive per material group. Polygons are triangulated (fan). MTL parsing is light (names + a few PBR-ish factors) and the full material decode happens in Phase 2.", "exports": [ { "name": "parseMtl", "kind": "function", "signature": "parseMtl(text)", "summary": "Parse a minimal MTL into a map of name → material descriptor." }, { "name": "importObj", "kind": "function", "signature": "importObj(data, opts = {})", "summary": "Import OBJ text/bytes into an EngineModel." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/import/OrientationResolver", "path": "engine/reference/assets/import/OrientationResolver.md", "source": "engine/assets/import/OrientationResolver.js", "import": "/engine/assets/import/OrientationResolver.js", "sourceHash": "32197f5fccdd200a1e646256b0d6dba37aaf1187fd510f4961cf6e57bd908ba9", "summary": "engine/assets/import/OrientationResolver.js — axis/scale/origin inference (spec §6). Never trust source orientation; never bake corrections into source. We infer a non-destructive ImportTransform (axis correction quat + scale + origin) with a confidence, and a policy decides whether to auto-apply, mark reviewable, preview only, or stay neutral and require manual correction.", "exports": [ { "name": "classifyConfidence", "kind": "function", "signature": "classifyConfidence(c)", "summary": "" }, { "name": "resolveOrientation", "kind": "function", "signature": "resolveOrientation(model, opts = {})", "summary": "Infer an ImportTransform for a model." }, { "name": "CONFIDENCE_POLICY", "kind": "constant", "signature": "CONFIDENCE_POLICY", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/import/PlyImporter", "path": "engine/reference/assets/import/PlyImporter.md", "source": "engine/assets/import/PlyImporter.js", "import": "/engine/assets/import/PlyImporter.js", "sourceHash": "fb4d0d16eb083ffa8719149edee418193468036aee354f44f1c89467f9b3a52f", "summary": "engine/assets/import/PlyImporter.js — Stanford PLY (ASCII + binary LE) → EngineModel. PLY is a point/mesh utility format. We read the vertex element (position + optional normal/color) and the face element (triangulated), producing one indexed primitive. Big-endian binary is uncommon for web assets and is not supported here (the editor can flag it).", "exports": [ { "name": "importPly", "kind": "function", "signature": "importPly(data, opts = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/import/StlImporter", "path": "engine/reference/assets/import/StlImporter.md", "source": "engine/assets/import/StlImporter.js", "import": "/engine/assets/import/StlImporter.js", "sourceHash": "55daa8dd205faf69683e87d0dc96577878c25179078be68e8f180427da5c8054", "summary": "engine/assets/import/StlImporter.js — STL (binary + ASCII) → EngineModel. STL is CAD/printable part geometry: triangles only, no materials, no hierarchy, no declared units. We import geometry faithfully and leave the unit guess to the OrientationResolver / editor. Output is a single non-indexed primitive with per-vertex positions and face normals.", "exports": [ { "name": "importStl", "kind": "function", "signature": "importStl(data, opts = {})", "summary": "Import STL bytes or text into an EngineModel." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/index", "path": "engine/reference/assets/index.md", "source": "engine/assets/index.js", "import": "/engine/assets/index.js", "sourceHash": "72b007a62a505f281986f10e4ff2fad818edffcf12299481e69f310c0af65846", "summary": "engine/assets/index.js — Global Asset Ingestion Runtime barrel. Turns any source file into an EngineModel and a usable simulation object: decode → normalize → deduplicate → preserve hierarchy/materials/animations → generate colliders/SDF/rigs/surfaces → cache → spawn. Build status: [x] Phase 0 foundations (EngineModel, AssetRecord, vpath, canonical space) [x] Phase 1 asset core (dedup, cache/OPFS, registry, resolver, importers) [x] Phase 2 materials & textures (decode, bindings, segments, variants) [x] Phase 3 vehicles (wheel/chassis detect, rig builder, suspension/tire/sync) [x] Render reusable model rendering (shader/pipeline, GPU drawables, wheel-spin, ModelRenderer) + geometry PCA — shared by demos, editor, and runtime so importing/viewing assets is one call. [ ] Phase 4 render surfaces [ ] Phase 5 humanoids, hands & weapons", "exports": [ { "name": "ALPHA_MODE", "kind": "re-export", "signature": "ALPHA_MODE", "summary": "" }, { "name": "ASSET_TYPES", "kind": "re-export", "signature": "ASSET_TYPES", "summary": "" }, { "name": "AssetCache", "kind": "re-export", "signature": "AssetCache", "summary": "" }, { "name": "AssetRegistry", "kind": "re-export", "signature": "AssetRegistry", "summary": "" }, { "name": "AssetResolver", "kind": "re-export", "signature": "AssetResolver", "summary": "" }, { "name": "BODY_SIDE", "kind": "re-export", "signature": "BODY_SIDE", "summary": "" }, { "name": "BRIDGE_FORMATS", "kind": "re-export", "signature": "BRIDGE_FORMATS", "summary": "" }, { "name": "CANONICAL", "kind": "re-export", "signature": "CANONICAL", "summary": "" }, { "name": "COLOR_SPACE", "kind": "re-export", "signature": "COLOR_SPACE", "summary": "" }, { "name": "CONFIDENCE_POLICY", "kind": "re-export", "signature": "CONFIDENCE_POLICY", "summary": "" }, { "name": "DEDUP", "kind": "re-export", "signature": "DEDUP", "summary": "" }, { "name": "DRIVETRAIN", "kind": "re-export", "signature": "DRIVETRAIN", "summary": "" }, { "name": "ENGINE_MODEL_LAYERS", "kind": "re-export", "signature": "ENGINE_MODEL_LAYERS", "summary": "" }, { "name": "FINGERS", "kind": "re-export", "signature": "FINGERS", "summary": "" }, { "name": "FINGER_JOINTS", "kind": "re-export", "signature": "FINGER_JOINTS", "summary": "" }, { "name": "FORMAT_CLASS", "kind": "re-export", "signature": "FORMAT_CLASS", "summary": "" }, { "name": "GATE", "kind": "re-export", "signature": "GATE", "summary": "" }, { "name": "HAND_SOURCE", "kind": "re-export", "signature": "HAND_SOURCE", "summary": "" }, { "name": "HUMANOID_BONES", "kind": "re-export", "signature": "HUMANOID_BONES", "summary": "" }, { "name": "IMAGE_FORMATS", "kind": "re-export", "signature": "IMAGE_FORMATS", "summary": "" }, { "name": "LIT_MODEL_SHADER", "kind": "re-export", "signature": "LIT_MODEL_SHADER", "summary": "" }, { "name": "LicenseTracker", "kind": "re-export", "signature": "LicenseTracker", "summary": "" }, { "name": "MODEL_UNIFORM_BYTES", "kind": "re-export", "signature": "MODEL_UNIFORM_BYTES", "summary": "" }, { "name": "MODEL_UNIFORM_FLOATS", "kind": "re-export", "signature": "MODEL_UNIFORM_FLOATS", "summary": "" }, { "name": "MOVING_PART", "kind": "re-export", "signature": "MOVING_PART", "summary": "" }, { "name": "NATIVE_FORMATS", "kind": "re-export", "signature": "NATIVE_FORMATS", "summary": "" }, { "name": "REQUIRED_BONES", "kind": "re-export", "signature": "REQUIRED_BONES", "summary": "" }, { "name": "REQUIRED_SOCKETS", "kind": "re-export", "signature": "REQUIRED_SOCKETS", "summary": "" }, { "name": "SCULPTURE_COURT_BACKDROP_SHADER", "kind": "re-export", "signature": "SCULPTURE_COURT_BACKDROP_SHADER", "summary": "" }, { "name": "SCULPTURE_COURT_MODEL_SHADER", "kind": "re-export", "signature": "SCULPTURE_COURT_MODEL_SHADER", "summary": "" }, { "name": "SEGMENT_MODE", "kind": "re-export", "signature": "SEGMENT_MODE", "summary": "" }, { "name": "STANDARD_STRIDE_FLOATS", "kind": "re-export", "signature": "STANDARD_STRIDE_FLOATS", "summary": "" }, { "name": "TEXTURE_SLOTS", "kind": "re-export", "signature": "TEXTURE_SLOTS", "summary": "" }, { "name": "TEXTURE_USAGE", "kind": "re-export", "signature": "TEXTURE_USAGE", "summary": "" }, { "name": "UNIT_TO_METERS", "kind": "re-export", "signature": "UNIT_TO_METERS", "summary": "" }, { "name": "VPATH_SCHEMES", "kind": "re-export", "signature": "VPATH_SCHEMES", "summary": "" }, { "name": "WEAPON_EVENT", "kind": "re-export", "signature": "WEAPON_EVENT", "summary": "" }, { "name": "WEAPON_INPUT", "kind": "re-export", "signature": "WEAPON_INPUT", "summary": "" }, { "name": "WEAPON_SOCKET", "kind": "re-export", "signature": "WEAPON_SOCKET", "summary": "" }, { "name": "WEAPON_STATE", "kind": "re-export", "signature": "WEAPON_STATE", "summary": "" }, { "name": "WEAPON_TYPE", "kind": "re-export", "signature": "WEAPON_TYPE", "summary": "" }, { "name": "WHEEL_PHYSICS_MODE", "kind": "re-export", "signature": "WHEEL_PHYSICS_MODE", "summary": "" }, { "name": "WORKFLOW", "kind": "re-export", "signature": "WORKFLOW", "summary": "" }, { "name": "advanceSpin", "kind": "re-export", "signature": "advanceSpin", "summary": "" }, { "name": "analyzeSymmetry", "kind": "re-export", "signature": "analyzeSymmetry", "summary": "" }, { "name": "approximateToMetallicRoughness", "kind": "re-export", "signature": "approximateToMetallicRoughness", "summary": "" }, { "name": "axisCorrectionQuat", "kind": "re-export", "signature": "axisCorrectionQuat", "summary": "" }, { "name": "axisVector", "kind": "re-export", "signature": "axisVector", "summary": "" }, { "name": "backendFromCache", "kind": "re-export", "signature": "backendFromCache", "summary": "" }, { "name": "bakeSegment", "kind": "re-export", "signature": "bakeSegment", "summary": "" }, { "name": "bakeSkinnedMeshes", "kind": "re-export", "signature": "bakeSkinnedMeshes", "summary": "" }, { "name": "boneSide", "kind": "re-export", "signature": "boneSide", "summary": "" }, { "name": "buildBindPose", "kind": "re-export", "signature": "buildBindPose", "summary": "" }, { "name": "buildHandRig", "kind": "re-export", "signature": "buildHandRig", "summary": "" }, { "name": "buildHands", "kind": "re-export", "signature": "buildHands", "summary": "" }, { "name": "buildHumanoidRig", "kind": "re-export", "signature": "buildHumanoidRig", "summary": "" }, { "name": "buildModelDrawables", "kind": "re-export", "signature": "buildModelDrawables", "summary": "" }, { "name": "buildSurfaceBindings", "kind": "re-export", "signature": "buildSurfaceBindings", "summary": "" }, { "name": "buildVehicleRig", "kind": "re-export", "signature": "buildVehicleRig", "summary": "" }, { "name": "buildWeaponRig", "kind": "re-export", "signature": "buildWeaponRig", "summary": "" }, { "name": "buildWheelSpinMap", "kind": "re-export", "signature": "buildWheelSpinMap", "summary": "" }, { "name": "cachePathFor", "kind": "re-export", "signature": "cachePathFor", "summary": "" }, { "name": "classOf", "kind": "re-export", "signature": "classOf", "summary": "" }, { "name": "classify", "kind": "re-export", "signature": "classify", "summary": "" }, { "name": "classifyConfidence", "kind": "re-export", "signature": "classifyConfidence", "summary": "" }, { "name": "computeWorldMatrices", "kind": "re-export", "signature": "computeWorldMatrices", "summary": "" }, { "name": "createAssetRecord", "kind": "re-export", "signature": "createAssetRecord", "summary": "" }, { "name": "createDefaultSampler", "kind": "re-export", "signature": "createDefaultSampler", "summary": "" }, { "name": "createEngineMaterial", "kind": "re-export", "signature": "createEngineMaterial", "summary": "" }, { "name": "createEngineMesh", "kind": "re-export", "signature": "createEngineMesh", "summary": "" }, { "name": "createEngineModel", "kind": "re-export", "signature": "createEngineModel", "summary": "" }, { "name": "createEngineNode", "kind": "re-export", "signature": "createEngineNode", "summary": "" }, { "name": "createEnginePrimitive", "kind": "re-export", "signature": "createEnginePrimitive", "summary": "" }, { "name": "createFinger", "kind": "re-export", "signature": "createFinger", "summary": "" }, { "name": "createHandRig", "kind": "re-export", "signature": "createHandRig", "summary": "" }, { "name": "createHumanoidRig", "kind": "re-export", "signature": "createHumanoidRig", "summary": "" }, { "name": "createImportTransform", "kind": "re-export", "signature": "createImportTransform", "summary": "" }, { "name": "createLicenseBlock", "kind": "re-export", "signature": "createLicenseBlock", "summary": "" }, { "name": "createMaterialVariant", "kind": "re-export", "signature": "createMaterialVariant", "summary": "" }, { "name": "createModelPipeline", "kind": "re-export", "signature": "createModelPipeline", "summary": "" }, { "name": "createModelRenderer", "kind": "re-export", "signature": "createModelRenderer", "summary": "" }, { "name": "createSegmentView", "kind": "re-export", "signature": "createSegmentView", "summary": "" }, { "name": "createSuspension", "kind": "re-export", "signature": "createSuspension", "summary": "" }, { "name": "createTextureBinding", "kind": "re-export", "signature": "createTextureBinding", "summary": "" }, { "name": "createTimelinePlayer", "kind": "re-export", "signature": "createTimelinePlayer", "summary": "" }, { "name": "createTireProfile", "kind": "re-export", "signature": "createTireProfile", "summary": "" }, { "name": "createVehicleAsset", "kind": "re-export", "signature": "createVehicleAsset", "summary": "" }, { "name": "createWeaponAction", "kind": "re-export", "signature": "createWeaponAction", "summary": "" }, { "name": "createWeaponRig", "kind": "re-export", "signature": "createWeaponRig", "summary": "" }, { "name": "createWeaponStateMachine", "kind": "re-export", "signature": "createWeaponStateMachine", "summary": "" }, { "name": "createWheelSlot", "kind": "re-export", "signature": "createWheelSlot", "summary": "" }, { "name": "createWhiteTexture", "kind": "re-export", "signature": "createWhiteTexture", "summary": "" }, { "name": "decodeAllTextures", "kind": "re-export", "signature": "decodeAllTextures", "summary": "" }, { "name": "decodeTexture", "kind": "re-export", "signature": "decodeTexture", "summary": "" }, { "name": "defaultChannelMap", "kind": "re-export", "signature": "defaultChannelMap", "summary": "" }, { "name": "defaultFireAction", "kind": "re-export", "signature": "defaultFireAction", "summary": "" }, { "name": "defaultReloadAction", "kind": "re-export", "signature": "defaultReloadAction", "summary": "" }, { "name": "detectChassis", "kind": "re-export", "signature": "detectChassis", "summary": "" }, { "name": "detectFormat", "kind": "re-export", "signature": "detectFormat", "summary": "" }, { "name": "detectHierarchy", "kind": "re-export", "signature": "detectHierarchy", "summary": "" }, { "name": "detectParts", "kind": "re-export", "signature": "detectParts", "summary": "" }, { "name": "detectSemanticDomain", "kind": "re-export", "signature": "detectSemanticDomain", "summary": "" }, { "name": "detectWeapon", "kind": "re-export", "signature": "detectWeapon", "summary": "" }, { "name": "detectWheels", "kind": "re-export", "signature": "detectWheels", "summary": "" }, { "name": "eigSym3", "kind": "re-export", "signature": "eigSym3", "summary": "" }, { "name": "eventsBetween", "kind": "re-export", "signature": "eventsBetween", "summary": "" }, { "name": "extractHandVertices", "kind": "re-export", "signature": "extractHandVertices", "summary": "" }, { "name": "frameBounds", "kind": "re-export", "signature": "frameBounds", "summary": "" }, { "name": "freeRollAngularVelocity", "kind": "re-export", "signature": "freeRollAngularVelocity", "summary": "" }, { "name": "generateFingers", "kind": "re-export", "signature": "generateFingers", "summary": "" }, { "name": "hasTextureTransform", "kind": "re-export", "signature": "hasTextureTransform", "summary": "" }, { "name": "hashContent", "kind": "re-export", "signature": "hashContent", "summary": "" }, { "name": "healHumanoid", "kind": "re-export", "signature": "healHumanoid", "summary": "" }, { "name": "healSkeleton", "kind": "re-export", "signature": "healSkeleton", "summary": "" }, { "name": "humanoidBonePosition", "kind": "re-export", "signature": "humanoidBonePosition", "summary": "" }, { "name": "importFile", "kind": "re-export", "signature": "importFile", "summary": "" }, { "name": "importGltf", "kind": "re-export", "signature": "importGltf", "summary": "" }, { "name": "importMaterials", "kind": "re-export", "signature": "importMaterials", "summary": "" }, { "name": "importMatrixOf", "kind": "re-export", "signature": "importMatrixOf", "summary": "" }, { "name": "importObj", "kind": "re-export", "signature": "importObj", "summary": "" }, { "name": "importPly", "kind": "re-export", "signature": "importPly", "summary": "" }, { "name": "importStl", "kind": "re-export", "signature": "importStl", "summary": "" }, { "name": "interleaveStandard", "kind": "re-export", "signature": "interleaveStandard", "summary": "" }, { "name": "invert4", "kind": "re-export", "signature": "invert4", "summary": "" }, { "name": "isVPath", "kind": "re-export", "signature": "isVPath", "summary": "" }, { "name": "jointPosition", "kind": "re-export", "signature": "jointPosition", "summary": "" }, { "name": "layerStatus", "kind": "re-export", "signature": "layerStatus", "summary": "" }, { "name": "leastVarianceAxis", "kind": "re-export", "signature": "leastVarianceAxis", "summary": "" }, { "name": "licenseNeedsReview", "kind": "re-export", "signature": "licenseNeedsReview", "summary": "" }, { "name": "longitudinalSlip", "kind": "re-export", "signature": "longitudinalSlip", "summary": "" }, { "name": "makeFetchBackend", "kind": "re-export", "signature": "makeFetchBackend", "summary": "" }, { "name": "makeGpuTexture", "kind": "re-export", "signature": "makeGpuTexture", "summary": "" }, { "name": "makeMemoryBackend", "kind": "re-export", "signature": "makeMemoryBackend", "summary": "" }, { "name": "makeVPath", "kind": "re-export", "signature": "makeVPath", "summary": "" }, { "name": "mapBones", "kind": "re-export", "signature": "mapBones", "summary": "" }, { "name": "mapFingers", "kind": "re-export", "signature": "mapFingers", "summary": "" }, { "name": "mat3ToQuat", "kind": "re-export", "signature": "mat3ToQuat", "summary": "" }, { "name": "mirrorBone", "kind": "re-export", "signature": "mirrorBone", "summary": "" }, { "name": "normalizeSegments", "kind": "re-export", "signature": "normalizeSegments", "summary": "" }, { "name": "normalizeTextures", "kind": "re-export", "signature": "normalizeTextures", "summary": "" }, { "name": "parseGlb", "kind": "re-export", "signature": "parseGlb", "summary": "" }, { "name": "parseMtl", "kind": "re-export", "signature": "parseMtl", "summary": "" }, { "name": "parseToModel", "kind": "re-export", "signature": "parseToModel", "summary": "" }, { "name": "parseVPath", "kind": "re-export", "signature": "parseVPath", "summary": "" }, { "name": "pivotSpin", "kind": "re-export", "signature": "pivotSpin", "summary": "" }, { "name": "primitiveColor", "kind": "re-export", "signature": "primitiveColor", "summary": "" }, { "name": "principalAxes", "kind": "re-export", "signature": "principalAxes", "summary": "" }, { "name": "releaseDrawables", "kind": "re-export", "signature": "releaseDrawables", "summary": "" }, { "name": "releaseModelGpu", "kind": "re-export", "signature": "releaseModelGpu", "summary": "" }, { "name": "resolveOrientation", "kind": "re-export", "signature": "resolveOrientation", "summary": "" }, { "name": "restoreOriginal", "kind": "re-export", "signature": "restoreOriginal", "summary": "" }, { "name": "rollAngle", "kind": "re-export", "signature": "rollAngle", "summary": "" }, { "name": "rotAxis", "kind": "re-export", "signature": "rotAxis", "summary": "" }, { "name": "rotateVecByQuat", "kind": "re-export", "signature": "rotateVecByQuat", "summary": "" }, { "name": "sniffMagic", "kind": "re-export", "signature": "sniffMagic", "summary": "" }, { "name": "standardVertexLayout", "kind": "re-export", "signature": "standardVertexLayout", "summary": "" }, { "name": "suspensionForce", "kind": "re-export", "signature": "suspensionForce", "summary": "" }, { "name": "tireForce", "kind": "re-export", "signature": "tireForce", "summary": "" }, { "name": "unitScaleToMeters", "kind": "re-export", "signature": "unitScaleToMeters", "summary": "" }, { "name": "uploadModel", "kind": "re-export", "signature": "uploadModel", "summary": "" }, { "name": "uploadModelTextures", "kind": "re-export", "signature": "uploadModelTextures", "summary": "" }, { "name": "uploadPrimitive", "kind": "re-export", "signature": "uploadPrimitive", "summary": "" }, { "name": "vehicleComposeTRS", "kind": "re-export", "signature": "vehicleComposeTRS", "summary": "" }, { "name": "vehicleTransformPoint", "kind": "re-export", "signature": "vehicleTransformPoint", "summary": "" }, { "name": "visualWheelMatrix", "kind": "re-export", "signature": "visualWheelMatrix", "summary": "" }, { "name": "vpathBasename", "kind": "re-export", "signature": "vpathBasename", "summary": "" }, { "name": "vpathExtension", "kind": "re-export", "signature": "vpathExtension", "summary": "" }, { "name": "withScheme", "kind": "re-export", "signature": "withScheme", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/material/EngineMaterial", "path": "engine/reference/assets/material/EngineMaterial.md", "source": "engine/assets/material/EngineMaterial.js", "import": "/engine/assets/material/EngineMaterial.js", "sourceHash": "5263a4543010e12caf42252671ca0f259cc28a9ed32ac3643a6e2c6303b0c729", "summary": "engine/assets/material/EngineMaterial.js — normalized material + texture binding schemas (spec §7). Materials are decoded, not guessed. Textures bind to surfaces (not loose images); UV sets, sampler wrap/filter, and texture transforms must survive import; packed channels are read exactly. The raw source material is always preserved on `.original` so the imported look stays recoverable even after engine normalization or shader-model approximation.", "exports": [ { "name": "defaultChannelMap", "kind": "function", "signature": "defaultChannelMap(slot)", "summary": "glTF default packing: metallic=B, roughness=G, occlusion=R." }, { "name": "createEngineMaterial", "kind": "function", "signature": "createEngineMaterial(init = {})", "summary": "Create a normalized engine material." }, { "name": "createTextureBinding", "kind": "function", "signature": "createTextureBinding(init = {})", "summary": "Create a texture binding (a texture bound to a material slot on a surface)." }, { "name": "hasTextureTransform", "kind": "function", "signature": "hasTextureTransform(binding)", "summary": "Has this binding a non-identity UV transform (KHR_texture_transform)?" }, { "name": "WORKFLOW", "kind": "constant", "signature": "WORKFLOW", "summary": "" }, { "name": "ALPHA_MODE", "kind": "constant", "signature": "ALPHA_MODE", "summary": "" }, { "name": "TEXTURE_SLOTS", "kind": "constant", "signature": "TEXTURE_SLOTS", "summary": "" }, { "name": "COLOR_SPACE", "kind": "constant", "signature": "COLOR_SPACE", "summary": "" }, { "name": "TEXTURE_USAGE", "kind": "constant", "signature": "TEXTURE_USAGE", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/material/MaterialImport", "path": "engine/reference/assets/material/MaterialImport.md", "source": "engine/assets/material/MaterialImport.js", "import": "/engine/assets/material/MaterialImport.js", "sourceHash": "da7e38b82758c500023db3f6794903b0966414587abe40c284879193041c1f18", "summary": "engine/assets/material/MaterialImport.js — decode source materials into the normalized EngineMaterial (spec §7). Materials are decoded exactly, never guessed: UV sets, sampler wrap/filter, and KHR_texture_transform survive; packed channels are read per the format (metadata wins over filename). The raw material is preserved on `.original` so the imported look stays recoverable.", "exports": [ { "name": "importMaterials", "kind": "function", "signature": "importMaterials(model)", "summary": "Decode every material in a model into EngineMaterial in place. Idempotent: a material already carrying `.original` is left untouched." }, { "name": "ALPHA_MODE", "kind": "re-export", "signature": "ALPHA_MODE", "summary": "" }, { "name": "WORKFLOW", "kind": "re-export", "signature": "WORKFLOW", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/material/MaterialVariant", "path": "engine/reference/assets/material/MaterialVariant.md", "source": "engine/assets/material/MaterialVariant.js", "import": "/engine/assets/material/MaterialVariant.js", "sourceHash": "7afaca740fffc5347263d83dbe15e44a96075b1161ab797aea87e2db18e66bc8", "summary": "engine/assets/material/MaterialVariant.js — variants + shader-model fallback (spec §7). Imported materials won't always match the engine shader model, so we normalize into EngineMaterial, can generate a metallic-roughness fallback approximation when needed, and always keep the original recoverable. Variants (e.g. a re-tinted body panel) share the source material and only narrow/adjust.", "exports": [ { "name": "createMaterialVariant", "kind": "function", "signature": "createMaterialVariant(base, overrides = {})", "summary": "Create a material variant that overrides a few fields of a base material while preserving the original (recoverable) and recording the variant lineage." }, { "name": "approximateToMetallicRoughness", "kind": "function", "signature": "approximateToMetallicRoughness(material)", "summary": "Approximate a non-metallic-roughness material as metallic-roughness for the engine's PBR shader. The original is preserved so the imported look can always be restored. This is a deliberate, labelled approximation — not an exact port." }, { "name": "restoreOriginal", "kind": "function", "signature": "restoreOriginal(material)", "summary": "Restore the original imported material descriptor (the raw source block)." }, { "name": "COLOR_SPACE", "kind": "re-export", "signature": "COLOR_SPACE", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/material/SegmentView", "path": "engine/reference/assets/material/SegmentView.md", "source": "engine/assets/material/SegmentView.js", "import": "/engine/assets/material/SegmentView.js", "sourceHash": "59cbce841d98a50317470dee357ebac013ec5ed1bd41acf8df4aa181150912f5", "summary": "engine/assets/material/SegmentView.js — non-destructive segmentation (spec §8). We need modular breaking (swap tires, detach doors, tint glass, split a magazine) WITHOUT destroying the source. A SegmentView references original primitive ids / index ranges / materials — it never copies or rewrites geometry. A physical split is only baked later, on export or when a detachable part is actually created. This keeps skeletons, UVs, and morph targets intact.", "exports": [ { "name": "createSegmentView", "kind": "function", "signature": "createSegmentView(model, mode = SEGMENT_MODE.MATERIAL)", "summary": "Create a non-destructive segment view of a model." }, { "name": "bakeSegment", "kind": "function", "signature": "bakeSegment(model, segmentView, segmentKey)", "summary": "Bake a single segment into a standalone EngineModel-like payload (only when a detachable part is actually needed — e.g. export). Geometry is copied here, the source model is left untouched." }, { "name": "SEGMENT_MODE", "kind": "constant", "signature": "SEGMENT_MODE", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/material/SurfaceBinding", "path": "engine/reference/assets/material/SurfaceBinding.md", "source": "engine/assets/material/SurfaceBinding.js", "import": "/engine/assets/material/SurfaceBinding.js", "sourceHash": "8ec083e0428da712dafe8880c3bd63a03e1f76acb70d34b05d1424212db7feb4", "summary": "engine/assets/material/SurfaceBinding.js — bind materials to surfaces (spec §7). Material assignment happens at the primitive/submesh level, not per-image. A SurfaceBinding records exactly which node/mesh/primitive a material covers, which UV set it uses, and (when known) the semantic part — so segmentation and editing can target real surfaces and bindings survive non-destructive splits.", "exports": [ { "name": "buildSurfaceBindings", "kind": "function", "signature": "buildSurfaceBindings(model)", "summary": "Build surface bindings for a model (material ↔ primitive). Populates model.surfaceBindings and returns them." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/material/TextureImport", "path": "engine/reference/assets/material/TextureImport.md", "source": "engine/assets/material/TextureImport.js", "import": "/engine/assets/material/TextureImport.js", "sourceHash": "69b4d12fac4a38ef129660fef6d7f2eab09611c7f10ca8102fc9cd01cbc6b544", "summary": "engine/assets/material/TextureImport.js — normalize textures + decode pixels (spec §7). A texture's colour space and usage are inferred from the material slots that bind it (sRGB for colour/emissive, linear for data/normal/ORM), so the same image used as colour vs data is handled correctly. Pixel decode is a separate, browser-only step (createImageBitmap) kept out of parsing. KTX2/ Basis stay compressed here and are routed by TextureManager to the existing native upload or registered decoder/transcoder hook path.", "exports": [ { "name": "normalizeTextures", "kind": "function", "signature": "normalizeTextures(model)", "summary": "Infer per-texture colour space + usage from the decoded material bindings, and normalize model.textures into self-describing EngineTexture records. Requires importMaterials() to have run first (so bindings exist)." }, { "name": "decodeTexture", "kind": "function", "signature": "async decodeTexture(tex)", "summary": "Decode a normalized texture's pixels to an ImageBitmap (browser only). Returns the bitmap (also cached on the texture) or null when undecodable (no bytes, external uri, or a compressed format with no transcoder)." }, { "name": "decodeAllTextures", "kind": "function", "signature": "async decodeAllTextures(model)", "summary": "Decode every decodable texture in a model. Returns the count decoded." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/material/composite/CompositeMaterialContracts", "path": "engine/reference/assets/material/composite/CompositeMaterialContracts.md", "source": "engine/assets/material/composite/CompositeMaterialContracts.js", "import": "/engine/assets/material/composite/CompositeMaterialContracts.js", "sourceHash": "76f00592a36bbf5ad2ac8534c0489ff44bd96f0f7bcd26817281bfacd381b0ea", "summary": "Strict, app-neutral contracts for immutable composite material data.", "exports": [ { "name": "isPlainCompositeMaterialObject", "kind": "function", "signature": "isPlainCompositeMaterialObject(value)", "summary": "" }, { "name": "validateCompositeMaterialFacets", "kind": "function", "signature": "validateCompositeMaterialFacets(value, path = '$.facets')", "summary": "" }, { "name": "validateCompositeMaterialProvenance", "kind": "function", "signature": "validateCompositeMaterialProvenance({ facets, sources, fieldSources }, path = '$')", "summary": "" }, { "name": "validateEngineCompositeMaterialResource", "kind": "function", "signature": "validateEngineCompositeMaterialResource(value, path = '$')", "summary": "Validate a complete built-in catalog resource. Returns the input unchanged." }, { "name": "ENGINE_COMPOSITE_MATERIAL_SCHEMA", "kind": "constant", "signature": "ENGINE_COMPOSITE_MATERIAL_SCHEMA", "summary": "" }, { "name": "ENGINE_COMPOSITE_MATERIAL_VERSION", "kind": "constant", "signature": "ENGINE_COMPOSITE_MATERIAL_VERSION", "summary": "" }, { "name": "COMPOSITE_MATERIAL_FACETS", "kind": "constant", "signature": "COMPOSITE_MATERIAL_FACETS", "summary": "" }, { "name": "COMPOSITE_MATERIAL_FACET_FIELDS", "kind": "constant", "signature": "COMPOSITE_MATERIAL_FACET_FIELDS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/material/composite/EngineCompositeMaterialCatalog", "path": "engine/reference/assets/material/composite/EngineCompositeMaterialCatalog.md", "source": "engine/assets/material/composite/EngineCompositeMaterialCatalog.js", "import": "/engine/assets/material/composite/EngineCompositeMaterialCatalog.js", "sourceHash": "6f53168c9843e015d4bfdd7fefe369109990f9b40187e0a20a867b5caf53202f", "summary": "Browser-native JSON loader. Callers may inject an equivalent fetch boundary.", "exports": [ { "name": "EngineCompositeMaterialCatalog", "kind": "class", "signature": "class EngineCompositeMaterialCatalog", "summary": "" }, { "name": "loadEngineCompositeMaterialCatalog", "kind": "function", "signature": "async loadEngineCompositeMaterialCatalog({ fetchImpl = globalThis.fetch, urls = ENGINE_COMPOSITE_MATERIAL_RESOURCE_URLS, } = {})", "summary": "Browser-native JSON loader. Callers may inject an equivalent fetch boundary." }, { "name": "ENGINE_COMPOSITE_MATERIAL_RESOURCE_URLS", "kind": "constant", "signature": "ENGINE_COMPOSITE_MATERIAL_RESOURCE_URLS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/material/composite/index", "path": "engine/reference/assets/material/composite/index.md", "source": "engine/assets/material/composite/index.js", "import": "/engine/assets/material/composite/index.js", "sourceHash": "2ceda7202ea6cdeadd439ee7f876432743481f80d5633533339ed0e0e9b34c8a", "summary": "", "exports": [], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/render/ModelGpu", "path": "engine/reference/assets/render/ModelGpu.md", "source": "engine/assets/render/ModelGpu.js", "import": "/engine/assets/render/ModelGpu.js", "sourceHash": "44186713557f036c993cb9325b5a3461167457943f8d587cd3c06390fdd0e74e", "summary": "engine/assets/render/ModelGpu.js — reusable GPU-side helpers to turn an uploaded EngineModel into drawable items. Small, composable, and shared by the importer/viewer, the editor, and the runtime so nobody re-implements texture upload, per-primitive bind groups, world-matrix flattening, or bounds framing. Pairs with ModelShader (uniform block) and GpuUploader (vertex layout). Pure data in → GPU objects out; callers own the render pass and camera.", "exports": [ { "name": "createDefaultSampler", "kind": "function", "signature": "createDefaultSampler(device)", "summary": "A linear, repeating sampler — a sane default for model albedo." }, { "name": "createWhiteTexture", "kind": "function", "signature": "createWhiteTexture(device)", "summary": "A 1×1 white texture so untextured primitives sample white (albedo = color)." }, { "name": "makeGpuTexture", "kind": "function", "signature": "makeGpuTexture(device, bitmap, srgb)", "summary": "Upload one decoded bitmap to a GPU texture (sRGB for colour, linear for data)." }, { "name": "uploadModelTextures", "kind": "function", "signature": "async uploadModelTextures(device, model)", "summary": "Decode + upload every embedded texture in a model." }, { "name": "primitiveColor", "kind": "function", "signature": "primitiveColor(model, prim)", "summary": "Deterministic fallback colour for a primitive lacking a baseColorFactor." }, { "name": "buildModelDrawables", "kind": "function", "signature": "buildModelDrawables(device, model, opts)", "summary": "Build drawable items for an uploaded model: one per primitive, each with its world draw matrix, uniform buffer, bind group, fallback colour, and (optional) wheel-spin descriptor keyed by node id." }, { "name": "bakeSkinnedMeshes", "kind": "function", "signature": "bakeSkinnedMeshes(model)", "summary": "CPU-skin every skinned mesh to its DEFAULT pose so the static viewer draws the mesh wrapped around the node-hierarchy skeleton (per the glTF rule that a skinned mesh's own node transform is ignored). For each skinned vertex: v' = Σ wⱼ · (jointNodeWorld(j) · inverseBindMatrix(j)) · v (scene space) Positions/normals are replaced in place (original kept on `_bindPosition`) and the primitive is flagged `_skinnedBaked`. No-op without skins/IBMs. GPU-free." }, { "name": "releaseDrawables", "kind": "function", "signature": "releaseDrawables(items)", "summary": "Free per-item uniform buffers built by buildModelDrawables." }, { "name": "frameBounds", "kind": "function", "signature": "frameBounds(items)", "summary": "World-space bounds of a set of drawables, for camera framing." }, { "name": "importMatrixOf", "kind": "function", "signature": "importMatrixOf(model)", "summary": "Compose the standard import-correction matrix from a model's importTransform." }, { "name": "nodeLocalMatrix", "kind": "re-export", "signature": "nodeLocalMatrix", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/render/ModelRenderer", "path": "engine/reference/assets/render/ModelRenderer.md", "source": "engine/assets/render/ModelRenderer.js", "import": "/engine/assets/render/ModelRenderer.js", "sourceHash": "c6a36dd5b5da0e229d6e60e1e4b8f1c70c3130a51aeb0a2f8b098418e9445f29", "summary": "engine/assets/render/ModelRenderer.js — the batteries-included way to draw an EngineModel. It composes the small render modules (ModelShader + ModelGpu) and the vehicle wheel-spin helper, applying sensible DEFAULTS so any engine system can go from \"I have an EngineModel\" to \"it's on screen\" in two calls: const r = createModelRenderer(device, { format }); await r.setModel(model, { wheelSpin: true, rig }); // upload + drawables per frame: r.render(pass, { mvp, eye, distance }); The caller still owns the render pass + camera (so it slots into any pipeline); the renderer owns the model's GPU lifetime and offers a depth-texture + camera- framing convenience. Override the shader/format/cull via opts when needed.", "exports": [ { "name": "createModelRenderer", "kind": "function", "signature": "createModelRenderer(device, opts = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/render/ModelShader", "path": "engine/reference/assets/render/ModelShader.md", "source": "engine/assets/render/ModelShader.js", "import": "/engine/assets/render/ModelShader.js", "sourceHash": "b1420623bb52cc09c9245fb726251b7f616554f3d45f9032474717a8cc637a36", "summary": "engine/assets/render/ModelShader.js — the default lit WGSL shader + pipeline for drawing an EngineModel's standard-layout primitives. Small and overridable: any engine system can grab LIT_MODEL_SHADER for a sensible default, or pass its own WGSL to createModelPipeline. The shader pairs with standardVertexLayout() (pos3 + nrm3 + uv2) and the 160-byte uniform block written by ModelGpu.", "exports": [ { "name": "createModelPipeline", "kind": "function", "signature": "createModelPipeline(device, opts = {})", "summary": "Build the render pipeline for EngineModel primitives." }, { "name": "MODEL_UNIFORM_BYTES", "kind": "constant", "signature": "MODEL_UNIFORM_BYTES", "summary": "" }, { "name": "MODEL_UNIFORM_FLOATS", "kind": "constant", "signature": "MODEL_UNIFORM_FLOATS", "summary": "" }, { "name": "LIT_MODEL_SHADER", "kind": "constant", "signature": "LIT_MODEL_SHADER", "summary": "A neutral physically-plausible lit shader with albedo floor + additive rim." }, { "name": "SCULPTURE_COURT_MODEL_SHADER", "kind": "constant", "signature": "SCULPTURE_COURT_MODEL_SHADER", "summary": "Gallery raster lighting derived from the Astral Sculpture Court studies: warm broad key, restrained green-cyan fill, cool portal rim, park/studio environment response, Khronos PBR Neutral, and stable one-LSB dithering. It deliberately preserves the default renderer bind/uniform contract." }, { "name": "SCULPTURE_COURT_BACKDROP_SHADER", "kind": "constant", "signature": "SCULPTURE_COURT_BACKDROP_SHADER", "summary": "Full-screen gallery/park environment paired with the sculpture shader." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/BodyTemplateExport", "path": "engine/reference/assets/rig/BodyTemplateExport.md", "source": "engine/assets/rig/BodyTemplateExport.js", "import": "/engine/assets/rig/BodyTemplateExport.js", "sourceHash": "1d06fcadb655308eef0a6e35413bc074674226b481d6d412aa8888696d8cc96e", "summary": "engine/assets/rig/BodyTemplateExport.js — turn a generated `CharacterPhysicsAsset` into a starting-point `life.body.v1`-shaped body template JSON (the schema `Life/data/bodies/*.json` + `engine/assets/rig/active-body/BodyAssembler.js` consume). This mirrors how every mainstream engine handles the generated-vs-hand-authored split (Unreal's Physics Asset auto-generate, Unity's Ragdoll Wizard, Godot's \"Create Physical Skeleton\"): the generator produces a complete, valid STARTING POINT for skeleton/joint/collision structure — never silently re-applied over hand-tuned data afterward. A dev generates this once for a new creature/character variant, saves it as a plain JSON file, and hand-tunes gameplay-only concerns on top (anatomy/organs, ligaments, muscle model, strength/mass presets) that have no generator and are intentionally hand-authored. This is the \"easy for devs to achieve anything\" on-ramp: zero-authoring skeleton for a new body, full hand-tuning power afterward.", "exports": [ { "name": "characterPhysicsAssetToBodyTemplate", "kind": "function", "signature": "characterPhysicsAssetToBodyTemplate(asset, opts = {})", "summary": "Convert a `CharacterPhysicsAsset` (from `createCharacterPhysicsAsset()`) into a `life.body.v1` body template — a ready-to-save JSON starting point for a new creature/character variant. Only the skeleton/joint/collision structure is generated; `anatomy`/`ligaments`/`muscleModel`/`presets` are left as explicit, clearly-commented empty stubs since no generator authors those — every mainstream engine's ragdoll generator stops at the same boundary." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/CharacterPhysicsAsset", "path": "engine/reference/assets/rig/CharacterPhysicsAsset.md", "source": "engine/assets/rig/CharacterPhysicsAsset.js", "import": "/engine/assets/rig/CharacterPhysicsAsset.js", "sourceHash": "4ed8411eaa0e53054ff4c5471d47644968e21da0eb4e4a556dfb0d2228c66ccf", "summary": "engine/assets/rig/CharacterPhysicsAsset.js — the single generated packaging layer for a character's physics structure. This is NOT a new generator: it wraps `buildRagdoll()` (RagdollBuilder.js) + `buildJointLimits()` (JointLimits.js) and repackages their output into one serializable schema that every consumer (ActiveRigController/PhysX, RagdollSim, RagdollSkinning, Life's BodyAssembler, RealmForge's compilers, legacy PBDRagdoll wrapper) can read instead of inventing its own bone/joint shape. GPU-free + deterministic. Schema fields: skeletonFingerprint, boneMap, bodyDefs, jointDefs, jointLimits, massProfile, collisionFilters, driveProfiles, skinningOffsets, particleCageDef (reserved for the future flesh-cage system), validationReport.", "exports": [ { "name": "computeSkeletonFingerprint", "kind": "function", "signature": "computeSkeletonFingerprint(bodyDefs)", "summary": "Stable fingerprint for a bone topology — same skeleton shape (names + parent links, order-independent per bone but position-stable) hashes the same way twice. Used to detect when a cached CharacterPhysicsAsset can be reused vs. must be rebuilt." }, { "name": "createCharacterPhysicsAsset", "kind": "function", "signature": "createCharacterPhysicsAsset(model, opts = {})", "summary": "Build a `CharacterPhysicsAsset` for a model. Humanoid path when a humanoid rig is present, otherwise generic topology — identical branch selection to `buildRagdoll()`, which this function delegates to." }, { "name": "validateCharacterPhysicsAsset", "kind": "function", "signature": "validateCharacterPhysicsAsset(asset)", "summary": "Validate a CharacterPhysicsAsset's internal consistency (indices resolve, joint types known, mass/limit values finite). Follows the same `{ ok, errors, warnings, counts }` pattern as Life's `BodySpecValidator.js`, adapted to this schema's shape." }, { "name": "CHARACTER_PHYSICS_ASSET_SCHEMA_VERSION", "kind": "constant", "signature": "CHARACTER_PHYSICS_ASSET_SCHEMA_VERSION", "summary": "" }, { "name": "inferDriveType", "kind": "re-export", "signature": "inferDriveType", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/JointLimits", "path": "engine/reference/assets/rig/JointLimits.md", "source": "engine/assets/rig/JointLimits.js", "import": "/engine/assets/rig/JointLimits.js", "sourceHash": "819bd4dca674bea5ddf92ad8d79541ce11cac04ec5c02ed31ff5cefc0d03f49f", "summary": "engine/assets/rig/JointLimits.js — automatically derive per-joint movement limits (range of motion) from a model, the way Life's BodyAssembler does it: every joint gets a TYPE (ball / hinge / saddle / twist / root) plus a swing cone + twist limit (degrees → radians), and hinge joints get a bend AXIS taken from the bind-pose geometry (perpendicular to the parent→joint→child bend plane). Two paths: • humanoid — role-based anatomical profile keyed by canonical bone slots. • generic — topology inference (children count + segment straightness) so spiders, dogs, cats, birds, etc. get sensible limits with no template: hub/limb-root joints → ball, straight mid-limb segments → hinge, leaves → fixed. GPU-free + deterministic → gate-testable.", "exports": [ { "name": "hingeAxis", "kind": "function", "signature": "hingeAxis(parentPos, jointPos, childPos)", "summary": "Hinge bend axis = normal of the parent→joint→child plane (the axis a knee/elbow actually bends about). Falls back to a perpendicular of the bone direction." }, { "name": "deriveJointType", "kind": "function", "signature": "deriveJointType(prof)", "summary": "Joint type carried by an anatomical profile (ball/hinge/saddle/twist/root)." }, { "name": "deriveSwingCone", "kind": "function", "signature": "deriveSwingCone(prof)", "summary": "Swing-cone half-angle (degrees) carried by a profile." }, { "name": "deriveHingeLimit", "kind": "function", "signature": "deriveHingeLimit(prof)", "summary": "Hinge bend-range (degrees). By Life's hinge convention this value is carried in the profile's `twist` field (a hinge drives one axis), so this is semantically distinct from `deriveTwistLimit` even though both read the same underlying number for a hinge profile." }, { "name": "deriveTwistLimit", "kind": "function", "signature": "deriveTwistLimit(prof)", "summary": "Twist limit (degrees) for a non-hinge (ball/saddle/twist) profile." }, { "name": "mirrorLeftRightLimits", "kind": "function", "signature": "mirrorLeftRightLimits(leftLimit, rightLimit)", "summary": "Verify (and defensively enforce) left/right symmetry between two derived limits — swing/twist degrees must match (anatomy is bilaterally symmetric); axes are expected to differ (mirrored bind-pose geometry) and are left untouched. Explicit, testable version of the symmetry `profileFor()` already guarantees implicitly by stripping the left/right prefix before profile lookup." }, { "name": "inferDriveType", "kind": "function", "signature": "inferDriveType(name = '')", "summary": "Infer a coarse drive role (neck/shoulder/elbow/wrist/spineUpper/pelvis/hip/ knee/ankle/toe/default) from a bone/slot name via string matching. Shared so RagdollBuilder, CharacterPhysicsAsset, and future adapters don't each reimplement this heuristic independently." }, { "name": "deriveHumanoidJointLimits", "kind": "function", "signature": "deriveHumanoidJointLimits(model, pose)", "summary": "Derive joint limits for a humanoid rig." }, { "name": "deriveSkeletonJointLimits", "kind": "function", "signature": "deriveSkeletonJointLimits(model, pose)", "summary": "Derive joint limits for ANY skeleton by topology + geometry (spiders, dogs, cats, birds…). No names required." }, { "name": "validJointTypeSet", "kind": "function", "signature": "validJointTypeSet()", "summary": "The set of valid joint-type strings (`root`/`ball`/`hinge`/`saddle`/`twist`/ `fixed`) as a `Set`, for membership checks — single source of truth so a validator never hand-declares its own copy that can silently drift from `JOINT_TYPE` (this is exactly how `CharacterPhysicsAsset.js` and Life's `BodySpecValidator.js` used to each keep their own disconnected copy)." }, { "name": "validateBoneTopology", "kind": "function", "signature": "validateBoneTopology(bones)", "summary": "Shared bone-topology structural validation — the literally-duplicated core every ragdoll/body validator needs (bone id uniqueness, parent-reference resolution), extracted once so `CharacterPhysicsAsset.validateCharacterPhysicsAsset` and Life's `BodySpecValidator.validateBodyTemplate` can never silently drift apart on these checks again. Each caller still owns its own shape-specific checks (mass/position for CharacterPhysicsAsset; anatomy/ligaments/skeleton extensions for Life)." }, { "name": "countTypes", "kind": "function", "signature": "countTypes(limits)", "summary": "Count joint types in a limit map (for inspectors/gates)." }, { "name": "buildJointLimits", "kind": "function", "signature": "buildJointLimits(model, opts = {})", "summary": "Auto-derive and attach joint limits to a model. Humanoid path when a humanoid rig is present, otherwise generic topology inference." }, { "name": "JOINT_TYPE", "kind": "constant", "signature": "JOINT_TYPE", "summary": "" }, { "name": "deriveBendDirection", "kind": "constant", "signature": "deriveBendDirection", "summary": "Alias for `hingeAxis` — the joint bend-direction deriver, named for the generic \"derive*\" family used by RagdollBuilder/CharacterPhysicsAsset." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/RagdollBuilder", "path": "engine/reference/assets/rig/RagdollBuilder.md", "source": "engine/assets/rig/RagdollBuilder.js", "import": "/engine/assets/rig/RagdollBuilder.js", "sourceHash": "3219bdafb093ddd462650abca51bc7748628095090a714c9b82280a633174cbc", "summary": "engine/assets/rig/RagdollBuilder.js — turn a detected skeleton + auto-derived joint limits into a RAGDOLL descriptor: one capsule body per bone (sized from the bone length, mass from its volume) plus a constrained joint to its parent using the JointLimits type + swing/twist + bend axis. Pure data (no physics engine here) so it can drive `sim/physics/PBDRagdoll` / articulations or the editor's ragdoll. Works for humanoids (canonical bones, incl. healed ones) and for any creature via generic topology. GPU-free + deterministic.", "exports": [ { "name": "radiusRatio", "kind": "function", "signature": "radiusRatio(slot)", "summary": "" }, { "name": "buildHumanoidRagdoll", "kind": "function", "signature": "buildHumanoidRagdoll(model, rig, pose, opts = {})", "summary": "Build a ragdoll from a humanoid rig (canonical bones, including healed ones)." }, { "name": "buildGenericRagdoll", "kind": "function", "signature": "buildGenericRagdoll(model, pose, opts = {})", "summary": "Build a ragdoll from any skeleton by generic topology (spiders, dogs, …)." }, { "name": "buildRagdoll", "kind": "function", "signature": "buildRagdoll(model, opts = {})", "summary": "Build a ragdoll for a model and attach it at model.rigs.ragdoll. Humanoid path when a humanoid rig is present, otherwise generic topology." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/RagdollSim", "path": "engine/reference/assets/rig/RagdollSim.md", "source": "engine/assets/rig/RagdollSim.js", "import": "/engine/assets/rig/RagdollSim.js", "sourceHash": "ba132a2e83b14009e3b87c7ed76badd6e5235926dab036135d4fe07990219f54", "summary": "engine/assets/rig/RagdollSim.js — a tiny, GENERIC Verlet/PBD ragdoll runtime that simulates ANY ragdoll descriptor from RagdollBuilder (humanoid, creature, healed/mirrored limbs). Each bone joint is a particle; each bone is a distance constraint to its parent (Jakobsen \"Advanced Character Physics\"). Gravity + ground + a few constraint iterations give a stable, believable flop with no dependency on a fixed humanoid template. Pure JS / deterministic / GPU-free.", "exports": [ { "name": "createRagdollSim", "kind": "function", "signature": "createRagdollSim(ragdoll, opts = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/RagdollSkinning", "path": "engine/reference/assets/rig/RagdollSkinning.md", "source": "engine/assets/rig/RagdollSkinning.js", "import": "/engine/assets/rig/RagdollSkinning.js", "sourceHash": "9be76ff7d4c494127670641cef62879a6e58a2c8df98363482c8bb5b370af5fe", "summary": "engine/assets/rig/RagdollSkinning.js — make the live MESH follow a ragdoll. The ragdoll sim (RagdollSim) only moves joint POSITIONS. To deform the skinned mesh with it we need a per-joint world transform. We build a ragdoll over the model's actual SKIN JOINTS (1:1 with the skin's joint slots, so vertex skin weights index straight into it) and, each frame, derive a per-bone rotation from the rest→current bone direction. Skinning is then the standard linear blend in SCENE space (the renderer applies importMatrix afterwards): v' = Σ wⱼ · ( Rⱼ · (v − bindPosⱼ) + curPosⱼ ) At the bind pose Rⱼ=I and curPos=bindPos, so v'=v (the baked mesh). This needs no inverse-bind matrices because jointBindWorld·IBM = I per joint. Pure JS.", "exports": [ { "name": "buildSkinnedRagdoll", "kind": "function", "signature": "buildSkinnedRagdoll(model, opts = {})", "summary": "Build a ragdoll over a model's skin joints (1:1 with skin slot indices) and a sim for it. Joint limits come from the humanoid rig where mapped, else generic topology. Returns null when the model has no skin to drive." }, { "name": "ragdollBoneFrames", "kind": "function", "signature": "ragdollBoneFrames(state)", "summary": "Per-bone frames for the current sim state: rotation (3×3 row-major), current position, and bind position. Bones with no child inherit their parent's rotation (so leaf verts swing with the limb)." }, { "name": "skinPrimitiveInterleaved", "kind": "function", "signature": "skinPrimitiveInterleaved(prim, frames, jointCount, outInterleaved)", "summary": "Linear-blend skin a primitive into a standard interleaved [pos3,nrm3,uv2] buffer (UVs at o+6/o+7 are left untouched). Writes scene-space positions so the renderer's importMatrix lands them correctly. Mutates + returns `outInterleaved`." }, { "name": "logSkinnedRagdoll", "kind": "function", "signature": "logSkinnedRagdoll(state, logFn)", "summary": "One-time STATIC report of a built ragdoll: every joint's type + auto-detected limits, and the full constraint breakdown (bone sticks, hub bracing, ROM, signed hinges, swing cones). Prints rich console.tables when available; always returns a one-line summary string (also handed to `logFn` for the in-app console)." }, { "name": "ragdollDebugStats", "kind": "function", "signature": "ragdollDebugStats(state)", "summary": "LIVE per-frame measurement: each hinge's current bend, each cone's current swing, and each ROM constraint's grandparent distance — all vs their limits, with an `ok` flag. Use it to PROVE the limits hold during simulation (and to spot violations)." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/ActiveBodyFallbackReport", "path": "engine/reference/assets/rig/active-body/ActiveBodyFallbackReport.md", "source": "engine/assets/rig/active-body/ActiveBodyFallbackReport.js", "import": "/engine/assets/rig/active-body/ActiveBodyFallbackReport.js", "sourceHash": "ef39b05df9c3da010ba3d8e74cda5a24939a294606394fbb186a14c62b6d3f75", "summary": "", "exports": [ { "name": "getActiveBodyFallbackReport", "kind": "function", "signature": "getActiveBodyFallbackReport(gpu = null)", "summary": "" }, { "name": "isActiveBodyFallbackReportOk", "kind": "function", "signature": "isActiveBodyFallbackReportOk(report)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/ActiveBodyPerformanceBudgets", "path": "engine/reference/assets/rig/active-body/ActiveBodyPerformanceBudgets.md", "source": "engine/assets/rig/active-body/ActiveBodyPerformanceBudgets.js", "import": "/engine/assets/rig/active-body/ActiveBodyPerformanceBudgets.js", "sourceHash": "3a407693a4d638e03264838e2dc1dff7f408b90033a6b84862168604789c078e", "summary": "", "exports": [ { "name": "getActiveBodyPerformanceBudgetReport", "kind": "function", "signature": "getActiveBodyPerformanceBudgetReport(bodyCount = 0, measurements = {})", "summary": "" }, { "name": "ACTIVE_BODY_PERFORMANCE_BUDGETS", "kind": "constant", "signature": "ACTIVE_BODY_PERFORMANCE_BUDGETS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/ActiveBodyRigBuilder", "path": "engine/reference/assets/rig/active-body/ActiveBodyRigBuilder.md", "source": "engine/assets/rig/active-body/ActiveBodyRigBuilder.js", "import": "/engine/assets/rig/active-body/ActiveBodyRigBuilder.js", "sourceHash": "351fc559a428de447b5d1fe7be25cbec2ddd29e6c502602571a5547ce2cd682c", "summary": "HumanoidRigBuilder — Builds a physics-ready humanoid rig (skeleton, bodies, joints, mass profile, drive profile) from entity phenotype data. Produces a StickmanRagdoll-compatible component that ActiveBodySystem can spawn as a PhysX articulation via the engine's ActiveRigController. Moved from editor/people-preview/PeoplePhenotypeRig.js into the game simulation layer so any game entity can have an active body.", "exports": [ { "name": "buildHumanoidRig", "kind": "function", "signature": "buildHumanoidRig(config)", "summary": "Build a complete humanoid rig from entity data." }, { "name": "buildActiveBodyPayload", "kind": "function", "signature": "buildActiveBodyPayload(config, worldPosition = [0, 0, 0])", "summary": "Build a spawn-ready payload for ActiveBodySystem." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/ActiveBodySimulationTiers", "path": "engine/reference/assets/rig/active-body/ActiveBodySimulationTiers.md", "source": "engine/assets/rig/active-body/ActiveBodySimulationTiers.js", "import": "/engine/assets/rig/active-body/ActiveBodySimulationTiers.js", "sourceHash": "72bfa79a52952a11c5945d8777811a8e8b218c34ae09d8dbf4885400d96d1b76", "summary": "", "exports": [ { "name": "classifyActiveBodySimulationTier", "kind": "function", "signature": "classifyActiveBodySimulationTier(input = {})", "summary": "" }, { "name": "buildActiveBodySimulationTierReport", "kind": "function", "signature": "buildActiveBodySimulationTierReport(bodies = [], observer = {})", "summary": "" }, { "name": "estimateActiveBodyImportance", "kind": "function", "signature": "estimateActiveBodyImportance(body = {})", "summary": "" }, { "name": "ACTIVE_BODY_SIMULATION_TIERS", "kind": "constant", "signature": "ACTIVE_BODY_SIMULATION_TIERS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/ActiveBodySystem", "path": "engine/reference/assets/rig/active-body/ActiveBodySystem.md", "source": "engine/assets/rig/active-body/ActiveBodySystem.js", "import": "/engine/assets/rig/active-body/ActiveBodySystem.js", "sourceHash": "dc2f6aafc210a72158a2ffd494413d8d619d31907bc92d48cdcf51784100bfd3", "summary": "", "exports": [ { "name": "ActiveBodySystem", "kind": "class", "signature": "class ActiveBodySystem", "summary": "" }, { "name": "BONE_NAMES", "kind": "re-export", "signature": "BONE_NAMES", "summary": "" }, { "name": "buildDirectionDiagnostics", "kind": "re-export", "signature": "buildDirectionDiagnostics", "summary": "" }, { "name": "clamp01", "kind": "re-export", "signature": "clamp01", "summary": "" }, { "name": "clampSigned", "kind": "re-export", "signature": "clampSigned", "summary": "" }, { "name": "computeSignedAngleOnHorizontal", "kind": "re-export", "signature": "computeSignedAngleOnHorizontal", "summary": "" }, { "name": "copyFunctionalSensorAnchor", "kind": "re-export", "signature": "copyFunctionalSensorAnchor", "summary": "" }, { "name": "estimateAverageFatigue", "kind": "re-export", "signature": "estimateAverageFatigue", "summary": "" }, { "name": "groundYFromFoot", "kind": "re-export", "signature": "groundYFromFoot", "summary": "" }, { "name": "makeBalanceState", "kind": "re-export", "signature": "makeBalanceState", "summary": "" }, { "name": "normalizePhase01", "kind": "re-export", "signature": "normalizePhase01", "summary": "" }, { "name": "normalizeRadians", "kind": "re-export", "signature": "normalizeRadians", "summary": "" }, { "name": "organStatusColor", "kind": "re-export", "signature": "organStatusColor", "summary": "" }, { "name": "percentSignal", "kind": "re-export", "signature": "percentSignal", "summary": "" }, { "name": "radiansToDebugDegrees", "kind": "re-export", "signature": "radiansToDebugDegrees", "summary": "" }, { "name": "resolveFunctionalSensorAnchors", "kind": "re-export", "signature": "resolveFunctionalSensorAnchors", "summary": "" }, { "name": "round4", "kind": "re-export", "signature": "round4", "summary": "" }, { "name": "setParticleVelocity", "kind": "re-export", "signature": "setParticleVelocity", "summary": "" }, { "name": "signedAngularDelta", "kind": "re-export", "signature": "signedAngularDelta", "summary": "" }, { "name": "slewRadians", "kind": "re-export", "signature": "slewRadians", "summary": "" }, { "name": "supportCenter", "kind": "re-export", "signature": "supportCenter", "summary": "" }, { "name": "unitSignal", "kind": "re-export", "signature": "unitSignal", "summary": "" }, { "name": "unitSignalDefault", "kind": "re-export", "signature": "unitSignalDefault", "summary": "" }, { "name": "yawDeg", "kind": "re-export", "signature": "yawDeg", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/AnimalLocomotion", "path": "engine/reference/assets/rig/active-body/AnimalLocomotion.md", "source": "engine/assets/rig/active-body/AnimalLocomotion.js", "import": "/engine/assets/rig/active-body/AnimalLocomotion.js", "sourceHash": "fb5c208dbf693335ac9010b4ecc9677ec5b351a04e7467e6997c62628b17ef83", "summary": "engine/assets/rig/active-body/AnimalLocomotion.js — extracted from ActiveBodySystem.js (Ragdoll Stack Consolidation Roadmap, Phase 7). Owns the animal (quadruped/ arachnid) active-body path: anatomy spec generation, PBD ragdoll assembly, per-frame locomotion (gait, leg targets, tail, neural residual blending), and animal-only debug tracing. Every function here takes its dependencies as explicit parameters (ragdoll/entry/skeleton/dt/...) — none of them close over ActiveBodySystem module state, so this extraction is a pure move, not a redesign. Shared helpers (contact telemetry, balance, small math/format utils) stay in ActiveBodySystem.js and are imported back here; the reverse (the handful of names ActiveBodySystem.js still calls into, e.g. stepAnimalActiveBody) are exported from here.", "exports": [ { "name": "createAnimalAnatomySpec", "kind": "function", "signature": "createAnimalAnatomySpec(skeleton)", "summary": "" }, { "name": "createQuadrupedAnatomySpec", "kind": "function", "signature": "createQuadrupedAnatomySpec(skeleton)", "summary": "" }, { "name": "createArachnidAnatomySpec", "kind": "function", "signature": "createArachnidAnatomySpec(skeleton)", "summary": "" }, { "name": "createAnimalBrainProfile", "kind": "function", "signature": "createAnimalBrainProfile(skeleton, options = {}, entityId = 'animal')", "summary": "" }, { "name": "cloneAnimalSkeleton", "kind": "function", "signature": "cloneAnimalSkeleton(skeleton)", "summary": "" }, { "name": "animalVerticalScaleFor", "kind": "function", "signature": "animalVerticalScaleFor(skeleton, scale = 1)", "summary": "" }, { "name": "animalPoseVerticalScale", "kind": "function", "signature": "animalPoseVerticalScale(entry)", "summary": "" }, { "name": "animalLocalToWorldPosition", "kind": "function", "signature": "animalLocalToWorldPosition(origin, yaw, scale, local, verticalScale = scale)", "summary": "" }, { "name": "createAnimalPbdRagdoll", "kind": "function", "signature": "createAnimalPbdRagdoll(skeleton, worldPosition, options = {})", "summary": "" }, { "name": "animalParentConstraintStiffness", "kind": "function", "signature": "animalParentConstraintStiffness(bone, parent, skeleton)", "summary": "" }, { "name": "animalLegSpanConstraintStiffness", "kind": "function", "signature": "animalLegSpanConstraintStiffness(skeleton)", "summary": "" }, { "name": "computeAnimalStructuralLimits", "kind": "function", "signature": "computeAnimalStructuralLimits(skeleton, boneMap)", "summary": "" }, { "name": "animalBoneMass", "kind": "function", "signature": "animalBoneMass(bone, skeleton)", "summary": "" }, { "name": "animalBoneRadius", "kind": "function", "signature": "animalBoneRadius(bone, skeleton, scale)", "summary": "" }, { "name": "stepAnimalActiveBody", "kind": "function", "signature": "stepAnimalActiveBody(entry, dt, groundY = 0, sensors = null)", "summary": "" }, { "name": "resolveAnimalMotion", "kind": "function", "signature": "resolveAnimalMotion(entry, root)", "summary": "" }, { "name": "animalGaitPhaseAdvance", "kind": "function", "signature": "animalGaitPhaseAdvance(entry, motion, dt)", "summary": "" }, { "name": "animalGaitDriveSpeed", "kind": "function", "signature": "animalGaitDriveSpeed(entry, motion)", "summary": "" }, { "name": "animalIntendedSpeedScale", "kind": "function", "signature": "animalIntendedSpeedScale(entry, motion)", "summary": "" }, { "name": "animalMotionForwardVector", "kind": "function", "signature": "animalMotionForwardVector(entry, motion)", "summary": "" }, { "name": "animalRootForwardVelocityDot", "kind": "function", "signature": "animalRootForwardVelocityDot(entry, motion)", "summary": "" }, { "name": "animalShouldReplantLegsForDirection", "kind": "function", "signature": "animalShouldReplantLegsForDirection(entry, motion, moving)", "summary": "" }, { "name": "isAnimalDebugTarget", "kind": "function", "signature": "isAnimalDebugTarget(entry)", "summary": "" }, { "name": "logAnimalActiveBodyTrace", "kind": "function", "signature": "logAnimalActiveBodyTrace(entry, frame, groundY = 0)", "summary": "" }, { "name": "animalDebugBodyAxis", "kind": "function", "signature": "animalDebugBodyAxis(entry)", "summary": "" }, { "name": "animalDebugWorstBoneSpeed", "kind": "function", "signature": "animalDebugWorstBoneSpeed(entry)", "summary": "" }, { "name": "formatAnimalNeuralDebug", "kind": "function", "signature": "formatAnimalNeuralDebug(entry)", "summary": "" }, { "name": "formatAnimalDirectionDebug", "kind": "function", "signature": "formatAnimalDirectionDebug(entry)", "summary": "" }, { "name": "formatAnimalLegDebug", "kind": "function", "signature": "formatAnimalLegDebug(entry, groundY = 0)", "summary": "" }, { "name": "formatAnimalTailDebug", "kind": "function", "signature": "formatAnimalTailDebug(entry, groundY = 0)", "summary": "" }, { "name": "animalLegDebugLabel", "kind": "function", "signature": "animalLegDebugLabel(descriptor)", "summary": "" }, { "name": "signedAnimalYawDeltaDegrees", "kind": "function", "signature": "signedAnimalYawDeltaDegrees(a, b)", "summary": "" }, { "name": "applyAnimalPoseDrive", "kind": "function", "signature": "applyAnimalPoseDrive(entry, dt, groundY, motion)", "summary": "" }, { "name": "computeAnimalLegTargets", "kind": "function", "signature": "computeAnimalLegTargets(entry, root, rootLocal, groundY, motion, basis)", "summary": "" }, { "name": "applyAnimalNeuralMotor", "kind": "function", "signature": "applyAnimalNeuralMotor(entry, legTargets, tailTargets, motion, groundY, dt)", "summary": "" }, { "name": "animalNeuralTierCap", "kind": "function", "signature": "animalNeuralTierCap(tier)", "summary": "" }, { "name": "animalBodyVerticality", "kind": "function", "signature": "animalBodyVerticality(entry, groundY = 0)", "summary": "" }, { "name": "animalNeuralReward", "kind": "function", "signature": "animalNeuralReward(entry, motion, currentV, targetV, coreV)", "summary": "" }, { "name": "animalNeuralBonesByName", "kind": "function", "signature": "animalNeuralBonesByName(entry)", "summary": "" }, { "name": "animalNeuralTargetAliases", "kind": "function", "signature": "animalNeuralTargetAliases(entry, legTargets, tailTargets)", "summary": "" }, { "name": "applyAnimalNeuralLegOffsets", "kind": "function", "signature": "applyAnimalNeuralLegOffsets(entry, legTargets, offsets, weight)", "summary": "" }, { "name": "animalNeuralOffsetScale", "kind": "function", "signature": "animalNeuralOffsetScale(entry, footPlanted)", "summary": "" }, { "name": "addAnimalNeuralOffset", "kind": "function", "signature": "addAnimalNeuralOffset(target, offsets, alias, weight, footPlanted)", "summary": "" }, { "name": "computeAnimalTailTargets", "kind": "function", "signature": "computeAnimalTailTargets(entry, root, rootLocal, groundY, motion, basis, dt)", "summary": "" }, { "name": "resolveAnimalTailAffect", "kind": "function", "signature": "resolveAnimalTailAffect(entry, motion)", "summary": "" }, { "name": "animalTailSpecies", "kind": "function", "signature": "animalTailSpecies(entry, packet = null)", "summary": "" }, { "name": "animalTailDriveScale", "kind": "function", "signature": "animalTailDriveScale(entry)", "summary": "" }, { "name": "animalTailCarryProfile", "kind": "function", "signature": "animalTailCarryProfile(species)", "summary": "" }, { "name": "animalRootTargetY", "kind": "function", "signature": "animalRootTargetY(entry, groundY = 0)", "summary": "" }, { "name": "animalLowestSupportFootLocalY", "kind": "function", "signature": "animalLowestSupportFootLocalY(entry)", "summary": "" }, { "name": "animalSupportRoot", "kind": "function", "signature": "animalSupportRoot(entry, root, groundY, motion, basis)", "summary": "" }, { "name": "animalRootVerticalDriveWeight", "kind": "function", "signature": "animalRootVerticalDriveWeight(entry)", "summary": "" }, { "name": "animalBodyPostureOffset", "kind": "function", "signature": "animalBodyPostureOffset(entry, role, basis)", "summary": "" }, { "name": "animalStrideLength", "kind": "function", "signature": "animalStrideLength(entry, speedScale)", "summary": "" }, { "name": "animalStrideDriveScale", "kind": "function", "signature": "animalStrideDriveScale(entry)", "summary": "" }, { "name": "animalSwingLateralSweep", "kind": "function", "signature": "animalSwingLateralSweep(entry, descriptor, lift, swingAhead)", "summary": "" }, { "name": "animalSwingLiftHeight", "kind": "function", "signature": "animalSwingLiftHeight(entry)", "summary": "" }, { "name": "animalPoseDriveGains", "kind": "function", "signature": "animalPoseDriveGains(role, id, bodyType)", "summary": "" }, { "name": "animalRestWorld", "kind": "function", "signature": "animalRestWorld(root, rootLocal, local, scale, basis, verticalScale = scale)", "summary": "" }, { "name": "animalLegPhase", "kind": "function", "signature": "animalLegPhase(entry, descriptor, legCount, speedScale = null)", "summary": "" }, { "name": "animalDutyFactor", "kind": "function", "signature": "animalDutyFactor(entry, legCount, speedScale)", "summary": "" }, { "name": "animalStanceRollback", "kind": "function", "signature": "animalStanceRollback(entry, speedScale)", "summary": "" }, { "name": "applyAnimalLegChainTargets", "kind": "function", "signature": "applyAnimalLegChainTargets(entry, targets, info, descriptor, root, bodyRootLocal, footTarget, lift, swing, basis)", "summary": "" }, { "name": "animalCurrentSpeedScale", "kind": "function", "signature": "animalCurrentSpeedScale(entry)", "summary": "" }, { "name": "animalStanceRootPush", "kind": "function", "signature": "animalStanceRootPush(entry, descriptor, speedScale)", "summary": "" }, { "name": "animalLegShapeWeight", "kind": "function", "signature": "animalLegShapeWeight(entry, descriptor, swing)", "summary": "" }, { "name": "animalLegJointPulse", "kind": "function", "signature": "animalLegJointPulse(entry, descriptor, jointIndex, chainLength, lift, swing, basis)", "summary": "" }, { "name": "animalStructuralPasses", "kind": "function", "signature": "animalStructuralPasses(entry)", "summary": "" }, { "name": "clampAnimalBoneVelocities", "kind": "function", "signature": "clampAnimalBoneVelocities(entry, dt)", "summary": "" }, { "name": "enforceAnimalGroundContact", "kind": "function", "signature": "enforceAnimalGroundContact(entry, groundY, dt = 1/60, sensors = null)", "summary": "" }, { "name": "enforceAnimalPlantedFootContacts", "kind": "function", "signature": "enforceAnimalPlantedFootContacts(entry, groundY, dt = 1/60, sensors = null, motion = null)", "summary": "" }, { "name": "animalPlantedFootHold", "kind": "function", "signature": "animalPlantedFootHold(entry, moving)", "summary": "" }, { "name": "animalPlantedFootDamping", "kind": "function", "signature": "animalPlantedFootDamping(entry, moving)", "summary": "" }, { "name": "applyAnimalNoIntentSettleBrake", "kind": "function", "signature": "applyAnimalNoIntentSettleBrake(entry, dt = 1/60, motion = null)", "summary": "" }, { "name": "applyAnimalWrongWayBrake", "kind": "function", "signature": "applyAnimalWrongWayBrake(entry, dt = 1/60, motion = null)", "summary": "" }, { "name": "computeAnimalBalance", "kind": "function", "signature": "computeAnimalBalance(entry, groundY = 0)", "summary": "" }, { "name": "ANIMAL_DEBUG_ENTITY_IDS", "kind": "constant", "signature": "ANIMAL_DEBUG_ENTITY_IDS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/BalanceMotor", "path": "engine/reference/assets/rig/active-body/BalanceMotor.md", "source": "engine/assets/rig/active-body/BalanceMotor.js", "import": "/engine/assets/rig/active-body/BalanceMotor.js", "sourceHash": "652a9b091371c3ef28082744735ab6c60c84070ecef3dd7b870b942b4590fbff", "summary": "engine/assets/rig/active-body/BalanceMotor.js — extracted from ActiveBodySystem.js (Ragdoll Stack Consolidation Roadmap, Phase 7). Owns humanoid COM-based balance (Winter mass fractions) and the idle/locomotion/stumble/fallen/ getup/ko state machine that reads it. Kept as one module per the Phase 7 pre-work findings — the state machine and balance computation are tightly entangled (updateState reads balance.error/groundedFeet every frame) and splitting them would just add a needless import hop.", "exports": [ { "name": "computeBalance", "kind": "function", "signature": "computeBalance(ragdoll)", "summary": "" }, { "name": "makeBalanceState", "kind": "function", "signature": "makeBalanceState(entry, balance)", "summary": "" }, { "name": "toBalanceControllerState", "kind": "function", "signature": "toBalanceControllerState(state)", "summary": "" }, { "name": "copyBalanceState", "kind": "function", "signature": "copyBalanceState(balance)", "summary": "" }, { "name": "updateState", "kind": "function", "signature": "updateState(entry, balance, dt)", "summary": "" }, { "name": "snapshotGetupOrientation", "kind": "function", "signature": "snapshotGetupOrientation(entry)", "summary": "" }, { "name": "MASS_FRACTIONS", "kind": "constant", "signature": "MASS_FRACTIONS", "summary": "" }, { "name": "STUMBLE_THRESHOLD", "kind": "constant", "signature": "STUMBLE_THRESHOLD", "summary": "" }, { "name": "FALL_THRESHOLD", "kind": "constant", "signature": "FALL_THRESHOLD", "summary": "" }, { "name": "LOCOMOTION_STUMBLE_THRESHOLD", "kind": "constant", "signature": "LOCOMOTION_STUMBLE_THRESHOLD", "summary": "" }, { "name": "LOCOMOTION_STUMBLE_TIME", "kind": "constant", "signature": "LOCOMOTION_STUMBLE_TIME", "summary": "" }, { "name": "STUMBLE_FALL_TIME", "kind": "constant", "signature": "STUMBLE_FALL_TIME", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/BodyAssembler", "path": "engine/reference/assets/rig/active-body/BodyAssembler.md", "source": "engine/assets/rig/active-body/BodyAssembler.js", "import": "/engine/assets/rig/active-body/BodyAssembler.js", "sourceHash": "ef5c9931a4c2f892f1908492c6ce109c9d3399b83afce9dc8ca97245f3d34cf2", "summary": "BodyAssembler — Data-driven ragdoll spec from body template + part catalog. Reads: - data/bodies/humanoid_default.json (bone hierarchy + collision rules) - data/parts/construction_volumes/*.json (per-part collision metadata) Produces a `RagdollSpec` consumable by ActiveBodySystem: { bones: [{ id, parent, partId, side, joint, collision, mass }, ...] ignorePairs: Set<\"a|b\"> // bone-pair keys for self-collision exclusion ignoreGroupsActive: Set<\"groupA|groupB\"> joints: { ball: {...}, hinge: {...}, ... } drives: { ball: {...}, hinge: {...}, ... } anatomy: { thorax, organs, collisionShells } skeletonExtensions: { mode, spineSegments, structuralBones } } This is the single source of truth for ragdoll structure. Edit the JSON files to change the body without touching code.", "exports": [ { "name": "loadBodyTemplate", "kind": "function", "signature": "async loadBodyTemplate(url = '/data/bodies/humanoid_default.json')", "summary": "Load the humanoid body template (cached after first call)." }, { "name": "assembleBody", "kind": "function", "signature": "assembleBody(template, partCatalog, options = {})", "summary": "Build a ragdoll spec from a body template + part catalog." }, { "name": "shouldBonesCollide", "kind": "function", "signature": "shouldBonesCollide(spec, boneA, boneB, isActive)", "summary": "Test if two bones should collide given a ragdoll spec." }, { "name": "getFootBones", "kind": "function", "signature": "getFootBones(spec)", "summary": "Get bone IDs that are foot contacts (for ground sensing / balance)." }, { "name": "getBone", "kind": "function", "signature": "getBone(spec, id)", "summary": "Get a bone by id." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/BodyPoses", "path": "engine/reference/assets/rig/active-body/BodyPoses.md", "source": "engine/assets/rig/active-body/BodyPoses.js", "import": "/engine/assets/rig/active-body/BodyPoses.js", "sourceHash": "6ccaef6560d326634fe50249a9de24d0717a93b8f2059559d61887543d9b1a1f", "summary": "BodyPoses — Data-driven pose library + biomechanical motor controller. ══════════════════════════════════════════════════════════════════════ POSE DATA ══════════════════════════════════════════════════════════════════════ Poses live in /data/poses/*.json. Each has: id, referenceHeight, rootBone, facing, bones{name:[x,y,z]}, rotations{name:[x,y,z,w]} verticality (0..100) — used by the blend space Sequences live in /data/sequences/*.json and chain poses, though the NEW verticality system (see getPoseAtVerticality) supersedes discrete sequence-time for getup — bodies blend continuously between adjacent rungs of the verticality ladder: 0 ── 15 ── 25 ── 35 ── 45 ── 50 ── (>50 reserved) prone pushup quad kneel half stand tiptoe/jump/reach kneel The ladder is based on the clinical Postural Verticality Scale (PVS) used in stroke rehab, cross-referenced with the Gross Motor Function Measure (GMFM) and standard 1D animation blend trees. ══════════════════════════════════════════════════════════════════════ MOTOR: applyKinematicBlend — FOUR STACKED LAYERS ══════════════════════════════════════════════════════════════════════ For each bone we apply, in order: 1. SOFT POSITION NUDGE (kinematic lerp, small % per frame) Guarantees pose convergence even when forces can't. 2. VELOCITY-CLAMPED PURSUIT (capped at muscleSpeed m/s) Close to target = slower approach (ease-in). Far = full speed. 3. MASS-SCALED PD FORCE (the one that actually does work) Kp = m · ω² Kd = 2 · m · ω · ζ (ζ = dampingRatio) F = Kp·(target - pos) - Kd·velocity Mass-scaled means a 20 kg pelvis and a 0.5 kg hand have the SAME natural frequency. Like real biological muscle — body parts reach their targets on the same time scale regardless of weight. 4. MUSCLE-TONE GRAVITY COMPENSATION (postural) Bones above knee-height get 75% of their weight canceled so posture holds without the motor doing all the lifting. Real humans use passive muscle tone; we model the same. + FORCE RISE-TIME FILTER (on the final force) Real muscles can't change force instantly. Rate-of-force- development (RFD) is 800-1500 N/s for untrained adults. Per-bone multipliers: thighs 0.7× (slow recruitment, biggest muscles), hands 1.4× (fast, small motor units). From EMG studies. + ERROR-GATED DAMPING (near target) Within 5 cm of target, velocity is damped 30% per frame. Kills steady-state jitter where the PD motor fights imperceptible position deltas. Doesn't affect in-flight motion. ══════════════════════════════════════════════════════════════════════ BIOMECHANICAL CALIBRATION (do not \"fix\" these without reading!) ══════════════════════════════════════════════════════════════════════ forcePerKg = 15 × g — untrained adult (not Olympic athlete) peak quad ≈ 15g × 8kg = 1176 N (realistic) maxForce = 1500 N — absolute cap (big muscle groups) forceRiseRate = 1200 N/s — typical RFD. Bumping this to 3000 makes bodies feel robotic (athlete-level). omega = 6-9 rad/s — muscle response frequency (postural 5-7, voluntary 8-12). Above 12 = twitchy. dampingRatio = 0.7 — slight overshoot (natural muscle feel). 1.0 = critical, 1.2+ = sluggish/locked. gravityTone = 0.75 — 75% of bone weight canceled via feedforward for bones above toneYThreshold. Human postural muscles do this automatically. ══════════════════════════════════════════════════════════════════════", "exports": [ { "name": "normalizePose", "kind": "function", "signature": "normalizePose(data)", "summary": "" }, { "name": "loadPose", "kind": "function", "signature": "async loadPose(id)", "summary": "Load a single pose by id. Cached after first fetch. URL matches the BodyAssembler pattern (`/data/...`) since the server roots `Life/data/` as `/data/`." }, { "name": "loadSequence", "kind": "function", "signature": "async loadSequence(id)", "summary": "Load a sequence and pre-load all poses referenced by its phases." }, { "name": "preloadStandardPoses", "kind": "function", "signature": "async preloadStandardPoses()", "summary": "" }, { "name": "bracketWalkCyclePhase", "kind": "function", "signature": "bracketWalkCyclePhase(gaitPhase)", "summary": "Map gait phase (rad) to two adjacent walk-cycle poses and blend factor." }, { "name": "getWalkCycleWorldTargets", "kind": "function", "signature": "getWalkCycleWorldTargets(gaitPhase, measurements, anchor, yaw)", "summary": "" }, { "name": "getWalkCycleWorldPoseTargets", "kind": "function", "signature": "getWalkCycleWorldPoseTargets(gaitPhase, measurements, anchor, yaw)", "summary": "" }, { "name": "blendPositionTargetMaps", "kind": "function", "signature": "blendPositionTargetMaps(base, overlay, t)", "summary": "Linear blend of bone world positions (stand + walk-cycle additive layer)." }, { "name": "blendWorldPoseTargets", "kind": "function", "signature": "blendWorldPoseTargets(base, overlay, t)", "summary": "" }, { "name": "getPoseBoneWorldPosition", "kind": "function", "signature": "getPoseBoneWorldPosition(pose, boneId, measurements, anchor, yaw)", "summary": "Compute the world-space target position of a single bone for a given pose. Applies scale (measurements.height / pose.referenceHeight), yaw rotation around +Y (body facing direction), and translation to anchor." }, { "name": "getPoseBoneLocalPosition", "kind": "function", "signature": "getPoseBoneLocalPosition(pose, boneId)", "summary": "" }, { "name": "getPoseBoneLocalRotation", "kind": "function", "signature": "getPoseBoneLocalRotation(pose, boneId)", "summary": "" }, { "name": "getPoseBoneWorldRotation", "kind": "function", "signature": "getPoseBoneWorldRotation(pose, boneId, yaw)", "summary": "" }, { "name": "getPoseWorldTargets", "kind": "function", "signature": "getPoseWorldTargets(pose, measurements, anchor, yaw)", "summary": "Compute all target positions for a pose, keyed by bone id." }, { "name": "getPoseWorldPoseTargets", "kind": "function", "signature": "getPoseWorldPoseTargets(pose, measurements, anchor, yaw)", "summary": "" }, { "name": "interpolatePoses", "kind": "function", "signature": "interpolatePoses(poseA, poseB, t, measurements, anchor, yaw)", "summary": "Interpolate between two poses. Returns a target-position map for all bones that exist in both. Useful for smooth phase transitions within a sequence." }, { "name": "interpolatePoseTargets", "kind": "function", "signature": "interpolatePoseTargets(poseA, poseB, t, measurements, anchor, yaw)", "summary": "" }, { "name": "applyKinematicBlend", "kind": "function", "signature": "applyKinematicBlend(ragdoll, targets, blendRate = 0.04, options = {})", "summary": "Hybrid muscle-motor blend — mixes kinematic pose delivery with PD-force behavior to produce realistic active-ragdoll motion that FEELS muscular rather than teleport-y. Four layers stacked per bone: 1. SOFT POSITION NUDGE — small kinematic lerp (2-4% per frame). Guarantees pose delivery; prevents drift from constraints/collisions. 2. VELOCITY-CLAMPED PURSUIT — computes a desired velocity toward the target and caps it at a \"muscle speed\" limit. Far bones move at max speed; close bones slow down (ease-in on arrival). 3. PD STABILIZATION — small spring-damper toward target adds subtle inertia/settling that pure position lerp lacks. Uses applyForce so gravity/collisions/distance constraints still dominate. 4. MUSCLE-TONE GRAVITY COMP — above-ground bones get 70% gravity cancellation (like real postural muscles keeping you upright). Per-bone activation timing: big postural muscles (pelvis, thighs, chest) lead; smaller bones (hands, head) follow. Creates the \"stage-by-stage effort\" look real people have when getting up." }, { "name": "applyMotorToTargets", "kind": "function", "signature": "applyMotorToTargets(ragdoll, targets, options = {})", "summary": "Apply PD (proportional-derivative) motor FORCES to drive the ragdoll toward a target pose. This is the proper active-ragdoll approach used in DeepMimic / NaturalMotion Euphoria / Karl Sims creatures: F = Kp * (target_pos - pos) - Kd * velocity Forces are applied via `solver.applyForce()` BEFORE the physics step so they get integrated as acceleration through the Verlet solver. The body rises by physically PUSHING against the ground (via collision friction on its hands/feet) — not by teleporting particles to target positions. Key properties: - Mass matters: Kp scales per bone mass so acceleration is consistent. - Kd damps overshoot and oscillation (critical damping formula below). - Gravity, collisions, and distance constraints ALL still act normally. - Momentum is preserved — no teleportation. PHASE RAMP: `phaseBoost` multiplier scales stiffness over the phase duration so the motor grows stronger as the body approaches the pose. ADAPTIVE GAIN: bones far from target get a proportional force boost — the \"ramp muscle output until it works\" behavior. Still applied through PD force, not position teleport. MAX FORCE CAP: prevents instability from runaway forces at large errors." }, { "name": "getSequenceState", "kind": "function", "signature": "getSequenceState(sequence, elapsed)", "summary": "Run one tick of a sequence. Returns progress info so the caller can decide when the sequence completes or what phase is active." }, { "name": "getCachedPose", "kind": "function", "signature": "getCachedPose(id)", "summary": "Read a cached pose without loading. Returns null if not loaded." }, { "name": "getVerticalityLadder", "kind": "function", "signature": "getVerticalityLadder()", "summary": "Return a sorted ladder of {verticality, pose} for every cached pose that declares one. Sorted ascending by score." }, { "name": "bracketVerticality", "kind": "function", "signature": "bracketVerticality(v, ladder = null)", "summary": "Find the two adjacent rungs bracketing verticality `v`, plus the interpolation factor between them. Returns { lower, upper, t } where t ∈ [0,1]; t=0 means exactly lower. If v is below min or above max, clamps to end and t=0 or 1." }, { "name": "getPoseAtVerticality", "kind": "function", "signature": "getPoseAtVerticality(v, measurements, anchor, yaw)", "summary": "Get world-space bone targets for an arbitrary verticality score. Blends between the two adjacent ladder poses, so the caller never has to know which discrete pose is \"current\" — just \"how vertical\"." }, { "name": "getPoseTargetsAtVerticality", "kind": "function", "signature": "getPoseTargetsAtVerticality(v, measurements, anchor, yaw)", "summary": "" }, { "name": "measureBodyVerticality", "kind": "function", "signature": "measureBodyVerticality(ragdoll)", "summary": "Measure the current body's verticality from live physics state. Uses pelvis height as fraction of the stand-pose pelvis height, mapped onto the scale so stand = 50. Below stand scales linearly; above stand (for future jumping/reaching) grows proportionally." }, { "name": "getCachedSequence", "kind": "function", "signature": "getCachedSequence(id)", "summary": "Read a cached sequence without loading. Returns null if not loaded." }, { "name": "getSequenceDuration", "kind": "function", "signature": "getSequenceDuration(sequence)", "summary": "Compute total duration of a sequence in seconds." }, { "name": "WALK_CYCLE_POSE_IDS", "kind": "constant", "signature": "WALK_CYCLE_POSE_IDS", "summary": "Warm-cache everything we need for the active controller. Loads both prone (face-down) and supine (face-up) getup sequences so the controller can pick the right one based on the body's orientation when it decides to stand up." }, { "name": "WALK_CYCLE_PHASE_OFFSET", "kind": "constant", "signature": "WALK_CYCLE_PHASE_OFFSET", "summary": "Align CPG gait phase (φ=0 toe-off) with walk_cycle_q* heel-strike keys." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/BodyRhythms", "path": "engine/reference/assets/rig/active-body/BodyRhythms.md", "source": "engine/assets/rig/active-body/BodyRhythms.js", "import": "/engine/assets/rig/active-body/BodyRhythms.js", "sourceHash": "121018efc0b9fbc25ff8a7bfaf493049723ea2556702701476cd70a991d0570d", "summary": "BodyRhythms — Coupled phase oscillators that generate body rhythms. ══════════════════════════════════════════════════════════════════════ WHAT THIS IS ══════════════════════════════════════════════════════════════════════ Every living body has SYNCHRONIZED internal oscillators: - HEART ~1.0-1.5 Hz resting (60-90 bpm) - BREATH ~0.2-0.3 Hz resting (12-18 breaths/min) - GAIT_L ~1.0 Hz walking cadence (left leg) - GAIT_R ~1.0 Hz antiphase to left (π offset) - ARM_L counter-swings with RIGHT leg (inphase with GAIT_R) - ARM_R counter-swings with LEFT leg (inphase with GAIT_L) These are the output of CENTRAL PATTERN GENERATORS (CPGs) — spinal neural circuits that don't need brain input to produce rhythm. They sync via Kuramoto-like coupling so all the oscillators lock into phase-locked relationships automatically. Engine provides the math (engine/core/math/MathOscillator.js): stepKuramotoPhases — Euler step for coupled oscillator network phaseCoherence — measure of synchrony (0=chaos, 1=lockstep) stepKuramotoDriven — with external forcing (metronome, music, etc) ══════════════════════════════════════════════════════════════════════ USES IN THE ACTIVE BODY SYSTEM ══════════════════════════════════════════════════════════════════════ 1. NN OBSERVATION INPUT The NN sees sin/cos of key phases, so it knows WHERE in the gait cycle the body is. This lets it learn rhythmic actions — step forward on left foot during gait_L peak, etc. 2. POSE MODULATION (future) When intent = walk, leg targets can be modulated by gait phase to produce a stepping motion automatically. 3. VISIBLE RHYTHM (future) Chest rises with breath, head bobs with heart, body sways with gait — alive-looking NPCs even when standing still. 4. DRUG/DISEASE EFFECTS Arrhythmia = desynchronized heart. Panic = tachycardia (faster heart + breath). Paralysis = no gait coupling. Loss of coherence (order parameter drops) indicates systemic failure. ══════════════════════════════════════════════════════════════════════ COUPLING MATRIX (who synchronizes with whom, how strongly) ══════════════════════════════════════════════════════════════════════ HEART BREATH GAIT_L GAIT_R ARM_L ARM_R HEART - 0.3 0 0 0 0 BREATH 0.3 - 0.1 0.1 0 0 GAIT_L 0 0.1 - -1.0 0 1.0 (antiphase L↔R, counter with arms) GAIT_R 0 0.1 -1.0 - 1.0 0 ARM_L 0 0 0 1.0 - -1.0 ARM_R 0 0 1.0 0 -1.0 - Positive weight = inphase pull (synchronize), negative = antiphase. Kuramoto coupling term: sin(phase_j - phase_i) × weight.", "exports": [ { "name": "createRhythmState", "kind": "function", "signature": "createRhythmState(rng = Math.random)", "summary": "Create a new rhythm state for a body. Initial phases are seeded from a per-entity RNG so different bodies aren't in lockstep (a crowd of NPCs should look like independent individuals, not a marching band)." }, { "name": "stepRhythms", "kind": "function", "signature": "stepRhythms(state, dt, opts = {})", "summary": "Advance the rhythm state by dt seconds using the Kuramoto model. Modulates natural frequencies based on body state: - walking intent → gait and arms non-zero - high adrenaline → faster heart and breath - high fatigue → slightly elevated heart, faster breath" }, { "name": "rhythmSample", "kind": "function", "signature": "rhythmSample(state, rhythmIdx)", "summary": "Return sin/cos of a rhythm phase — what the NN sees. sin/cos pair is the standard representation of a circular variable for neural networks (avoids wraparound discontinuity at 2π)." }, { "name": "shatterRhythm", "kind": "function", "signature": "shatterRhythm(state, severity = 0.5, rng = Math.random)", "summary": "Desynchronize rhythms (simulate arrhythmia / panic breakdown). Adds random noise to phases and reduces coupling strength." }, { "name": "restoreRhythm", "kind": "function", "signature": "restoreRhythm(state)", "summary": "Re-establish healthy coupling after disruption (recovery)." }, { "name": "RHYTHM", "kind": "constant", "signature": "RHYTHM", "summary": "" }, { "name": "NUM_RHYTHMS", "kind": "constant", "signature": "NUM_RHYTHMS", "summary": "" }, { "name": "kuramotoOrderParameter", "kind": "re-export", "signature": "kuramotoOrderParameter", "summary": "" }, { "name": "phaseCoherence", "kind": "re-export", "signature": "phaseCoherence", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/BodySpecValidator", "path": "engine/reference/assets/rig/active-body/BodySpecValidator.md", "source": "engine/assets/rig/active-body/BodySpecValidator.js", "import": "/engine/assets/rig/active-body/BodySpecValidator.js", "sourceHash": "9b89f455778c4f08b4c70b1291d4839d6ab8bd523e833ed1750b2ed05512acff", "summary": "", "exports": [ { "name": "validateBodyTemplate", "kind": "function", "signature": "validateBodyTemplate(template)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/BrainProfile", "path": "engine/reference/assets/rig/active-body/BrainProfile.md", "source": "engine/assets/rig/active-body/BrainProfile.js", "import": "/engine/assets/rig/active-body/BrainProfile.js", "sourceHash": "a14878af2d5e21c16bc92dd2827d2b47b7b100a6d10ddf39f72d38257499e190", "summary": "engine/assets/rig/active-body/BrainProfile.js — extracted from ActiveBodySystem.js (Ragdoll Stack Consolidation Roadmap, Phase 7). Owns humanoid brain-profile creation/loading (NN tier, motor profile key resolution, lazy brain-file load) and the trust/anatomy/brain readback helpers consumed by getReadback().", "exports": [ { "name": "createHumanoidBrainProfile", "kind": "function", "signature": "createHumanoidBrainProfile(entityId, options = {})", "summary": "" }, { "name": "neuralTierAuthorityCap", "kind": "function", "signature": "neuralTierAuthorityCap(tier)", "summary": "" }, { "name": "estimateNeuralMotorTrust", "kind": "function", "signature": "estimateNeuralMotorTrust(motor, options = {})", "summary": "" }, { "name": "getBrainReadback", "kind": "function", "signature": "getBrainReadback(entry)", "summary": "" }, { "name": "getAnatomyReadback", "kind": "function", "signature": "getAnatomyReadback(entry)", "summary": "" }, { "name": "applyBodySpecMetadata", "kind": "function", "signature": "applyBodySpecMetadata(entry, bodySpec)", "summary": "" }, { "name": "ensureBrainLoaded", "kind": "function", "signature": "ensureBrainLoaded(entry)", "summary": "" }, { "name": "defaultMotorProfileKey", "kind": "function", "signature": "defaultMotorProfileKey(entityId, preset, tier)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/ContactTelemetry", "path": "engine/reference/assets/rig/active-body/ContactTelemetry.md", "source": "engine/assets/rig/active-body/ContactTelemetry.js", "import": "/engine/assets/rig/active-body/ContactTelemetry.js", "sourceHash": "fddfe8a3344fad9001683b7a25ae10ca2e894199220228872bbdf2ad45301967", "summary": "engine/assets/rig/active-body/ContactTelemetry.js — extracted from ActiveBodySystem.js (Ragdoll Stack Consolidation Roadmap, Phase 7). Owns ground-contact resolution (Coulomb friction), per-bone/per-foot/per-sensor-anchor contact telemetry (humanoid AND animal — buildContactTelemetry dispatches to buildAnimalContactTelemetry internally so both paths share one entry point), and the contact-related debug overlay builders. Every function here takes its dependencies as explicit parameters, matching the same extraction pattern as AnimalLocomotion.js.", "exports": [ { "name": "enforceGroundContact", "kind": "function", "signature": "enforceGroundContact(ragdoll, groundY, dt = 1/60, sensors = null)", "summary": "" }, { "name": "clampSurfaceFriction", "kind": "function", "signature": "clampSurfaceFriction(value)", "summary": "" }, { "name": "buildContactTelemetry", "kind": "function", "signature": "buildContactTelemetry(entry, groundY = 0, sensors = null)", "summary": "" }, { "name": "buildAnimalContactTelemetry", "kind": "function", "signature": "buildAnimalContactTelemetry(entry, groundY = 0, sensors = null)", "summary": "" }, { "name": "buildBoneContactRecord", "kind": "function", "signature": "buildBoneContactRecord(entry, spec, p, groundY, sensors)", "summary": "" }, { "name": "buildSensorAnchorTelemetry", "kind": "function", "signature": "buildSensorAnchorTelemetry(entry, groundY = 0, sensors = null)", "summary": "" }, { "name": "buildSensorAnchorRecord", "kind": "function", "signature": "buildSensorAnchorRecord(entry, anchor, groundY, sensors)", "summary": "" }, { "name": "approximateSensorAnchorPoint", "kind": "function", "signature": "approximateSensorAnchorPoint(entry, anchor, driver, reference = null)", "summary": "" }, { "name": "makeSensorAnchorBasis", "kind": "function", "signature": "makeSensorAnchorBasis(entry, anchor, driver, reference = null)", "summary": "" }, { "name": "isFootAnchor", "kind": "function", "signature": "isFootAnchor(anchor)", "summary": "" }, { "name": "isHandAnchor", "kind": "function", "signature": "isHandAnchor(anchor)", "summary": "" }, { "name": "anchorContactPatch", "kind": "function", "signature": "anchorContactPatch(anchor)", "summary": "" }, { "name": "readContactSurface", "kind": "function", "signature": "readContactSurface(sensors, x, z)", "summary": "" }, { "name": "buildFootContactDerived", "kind": "function", "signature": "buildFootContactDerived(entry, side, record)", "summary": "" }, { "name": "copyContactTelemetry", "kind": "function", "signature": "copyContactTelemetry(contactTelemetry)", "summary": "" }, { "name": "copySensorAnchorTelemetry", "kind": "function", "signature": "copySensorAnchorTelemetry(sensorAnchors)", "summary": "" }, { "name": "copyContactRecord", "kind": "function", "signature": "copyContactRecord(record)", "summary": "" }, { "name": "makeContactOverlay", "kind": "function", "signature": "makeContactOverlay(contactTelemetry)", "summary": "" }, { "name": "makeContactFootOverlay", "kind": "function", "signature": "makeContactFootOverlay(record)", "summary": "" }, { "name": "contactOverlayColor", "kind": "function", "signature": "contactOverlayColor(record)", "summary": "" }, { "name": "logContactTrace", "kind": "function", "signature": "logContactTrace(entry)", "summary": "" }, { "name": "formatFootContactTrace", "kind": "function", "signature": "formatFootContactTrace(record)", "summary": "" }, { "name": "scaledAnimalContactWindow", "kind": "function", "signature": "scaledAnimalContactWindow(entry, base)", "summary": "" }, { "name": "FOOT_PARTICLE_SOLE_HEIGHT", "kind": "constant", "signature": "FOOT_PARTICLE_SOLE_HEIGHT", "summary": "" }, { "name": "FOOT_PARTICLE_CONTACT_HEIGHT", "kind": "constant", "signature": "FOOT_PARTICLE_CONTACT_HEIGHT", "summary": "" }, { "name": "CONTACT_SENSOR_BONES", "kind": "constant", "signature": "CONTACT_SENSOR_BONES", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/DebugOverlay", "path": "engine/reference/assets/rig/active-body/DebugOverlay.md", "source": "engine/assets/rig/active-body/DebugOverlay.js", "import": "/engine/assets/rig/active-body/DebugOverlay.js", "sourceHash": "b4d26f1ab15130b1c02d45728e7b886b3caa32f23be0aae8228d8837b7b42beb", "summary": "engine/assets/rig/active-body/DebugOverlay.js — extracted from ActiveBodySystem.js (Ragdoll Stack Consolidation Roadmap, Phase 7). Owns pure display/readback helpers: overlay toggle resolution and the make*Overlay builders consumed by ActiveBodySystem.getDebugOverlay()/getReadback(). Deliberately excludes buildMotorAuthorityMap — despite being overlay-adjacent, it's also consumed by live simulation (applyFootReflexTarget/applyBraceProtection Targets), so it stays with the reflex/motor-authority code, not here.", "exports": [ { "name": "makeOverlayToggleMap", "kind": "function", "signature": "makeOverlayToggleMap(source = null, fallback = DEFAULT_ACTIVE_BODY_OVERLAY_TOGGLES)", "summary": "" }, { "name": "resolveOverlayToggle", "kind": "function", "signature": "resolveOverlayToggle(value, fallback)", "summary": "" }, { "name": "makeComOverlay", "kind": "function", "signature": "makeComOverlay(balance)", "summary": "" }, { "name": "makeSupportOverlay", "kind": "function", "signature": "makeSupportOverlay(entry)", "summary": "" }, { "name": "getSupportFootBoneIds", "kind": "function", "signature": "getSupportFootBoneIds(entry)", "summary": "" }, { "name": "makeFatigueOverlay", "kind": "function", "signature": "makeFatigueOverlay(entry)", "summary": "" }, { "name": "makeOrganStatusOverlay", "kind": "function", "signature": "makeOrganStatusOverlay(entry)", "summary": "" }, { "name": "makePoseTargetOverlay", "kind": "function", "signature": "makePoseTargetOverlay(entry)", "summary": "" }, { "name": "makeJointErrorOverlay", "kind": "function", "signature": "makeJointErrorOverlay(entry)", "summary": "" }, { "name": "copyRotationTargetSummary", "kind": "function", "signature": "copyRotationTargetSummary(rotationTargets)", "summary": "" }, { "name": "copyRotationResidualSummary", "kind": "function", "signature": "copyRotationResidualSummary(residuals)", "summary": "" }, { "name": "copyReflexState", "kind": "function", "signature": "copyReflexState(reflexState)", "summary": "" }, { "name": "copyMotorAuthorityMap", "kind": "function", "signature": "copyMotorAuthorityMap(map)", "summary": "" }, { "name": "DEFAULT_ACTIVE_BODY_OVERLAY_TOGGLES", "kind": "constant", "signature": "DEFAULT_ACTIVE_BODY_OVERLAY_TOGGLES", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/DirectionDiagnostics", "path": "engine/reference/assets/rig/active-body/DirectionDiagnostics.md", "source": "engine/assets/rig/active-body/DirectionDiagnostics.js", "import": "/engine/assets/rig/active-body/DirectionDiagnostics.js", "sourceHash": "b6133ceccfc7030eb57c84b1011f9b406580352c6cf4e0eaefd7c30559fd8bcc", "summary": "engine/assets/rig/active-body/DirectionDiagnostics.js — extracted from ActiveBodySystem.js (Ragdoll Stack Consolidation Roadmap, Phase 7). Owns per-frame pelvis-displacement direction tracking (updateDirectionMotion) and the direction/facing diagnostics readback consumed by getDirectionDiagnostics()/getReadback() and the orientation-audit debug logging (still in ActiveBodySystem.js).", "exports": [ { "name": "updateDirectionMotion", "kind": "function", "signature": "updateDirectionMotion(entry, dt)", "summary": "" }, { "name": "buildDirectionDiagnostics", "kind": "function", "signature": "buildDirectionDiagnostics(entry)", "summary": "" }, { "name": "resolveIntentDirection", "kind": "function", "signature": "resolveIntentDirection(entry, pelvis)", "summary": "" }, { "name": "normalize2", "kind": "function", "signature": "normalize2(v)", "summary": "" }, { "name": "dot2", "kind": "function", "signature": "dot2(a, b)", "summary": "" }, { "name": "classifyDirectionStatus", "kind": "function", "signature": "classifyDirectionStatus(intentDotVelocity, speed)", "summary": "" }, { "name": "boneNameForParticle", "kind": "function", "signature": "boneNameForParticle(ragdoll, particle)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/MotionPriorTraining", "path": "engine/reference/assets/rig/active-body/MotionPriorTraining.md", "source": "engine/assets/rig/active-body/MotionPriorTraining.js", "import": "/engine/assets/rig/active-body/MotionPriorTraining.js", "sourceHash": "20ca80ab20cdc4f3f0fab1672da622ac831bdc7a014ae8ab260db863724cf238", "summary": "", "exports": [ { "name": "createAniMotionPriorState", "kind": "function", "signature": "createAniMotionPriorState()", "summary": "" }, { "name": "getAniMotionPriorReport", "kind": "function", "signature": "getAniMotionPriorReport(state)", "summary": "" }, { "name": "loadAniMotionPrior", "kind": "function", "signature": "async loadAniMotionPrior(state, options = {})", "summary": "" }, { "name": "mixAniMotionTeacher", "kind": "function", "signature": "mixAniMotionTeacher(teacher, state, entry, ragdoll, bonesByName, intent = null, options = {})", "summary": "" }, { "name": "normalizeAniMotionIndexEnvelope", "kind": "function", "signature": "normalizeAniMotionIndexEnvelope(input)", "summary": "" }, { "name": "createAi4AnimationMotionClipFromJson", "kind": "function", "signature": "createAi4AnimationMotionClipFromJson(json, fileName)", "summary": "" }, { "name": "ANI_MOTION_INDEX_FORMAT", "kind": "constant", "signature": "ANI_MOTION_INDEX_FORMAT", "summary": "" }, { "name": "ANI_MOTION_MANIFEST_FORMAT", "kind": "constant", "signature": "ANI_MOTION_MANIFEST_FORMAT", "summary": "" }, { "name": "ANI_MOTION_JSON_FORMAT", "kind": "constant", "signature": "ANI_MOTION_JSON_FORMAT", "summary": "" }, { "name": "ANI_MOTION_HTTP_SCHEMA_VERSION", "kind": "constant", "signature": "ANI_MOTION_HTTP_SCHEMA_VERSION", "summary": "" }, { "name": "ANI_MOTION_HTTP_READ_VERSIONS", "kind": "constant", "signature": "ANI_MOTION_HTTP_READ_VERSIONS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/NeuralMotor", "path": "engine/reference/assets/rig/active-body/NeuralMotor.md", "source": "engine/assets/rig/active-body/NeuralMotor.js", "import": "/engine/assets/rig/active-body/NeuralMotor.js", "sourceHash": "754f47de710bb4fc1226e9b57f095d16fdb2127bf792012f99507876b4008322", "summary": "NeuralMotor — per-entity self-training MLP for active-ragdoll control. ══════════════════════════════════════════════════════════════════════ WHAT THIS IS (read first) ══════════════════════════════════════════════════════════════════════ The NN adds position RESIDUAL offsets (±8cm per bone) on top of the kinematic verticality pose targets. It is NOT a force generator. The force that actually lifts the body comes from the PD motor in BodyPoses.js, which uses the (NN-refined) targets. This is called \"residual policy learning\" — same approach used by DReCon (Ubisoft, 2020) and DeepMimic. The NN learns the RESIDUAL between hand-authored poses and what the body actually needs. targets_kinematic (from verticality blend) + NN_residual (from this file, trained online) = targets_final → PD motor tracks targets_final with realistic muscle force ══════════════════════════════════════════════════════════════════════ TRAINING ALGORITHM: AWR (Advantage-Weighted Regression) ══════════════════════════════════════════════════════════════════════ Every frame: 1. Compute REWARD from body state (pose match, upright, stable, goal progress — see computeReward). 2. Maintain an EMA baseline of reward. 3. Advantage = reward - baseline. 4. Gradient weight = clamp(exp(β·advantage), 0.25, 3). 5. Teacher = what the kinematic controller would nudge this frame. 6. Loss = awrWeight × MSE(NN_output, teacher). 7. One SGD step per frame. Effect: NN imitates the teacher MORE in above-average states and LESS in below-average. This turns behavior cloning into a proper RL method. We don't need full PPO with rollout buffers — training is online and stable because the teacher is always available. STABILITY GATE: training is skipped when the body is thrashing (core velocity > 24 m/s or head below pelvis). Chaotic frames produce noise teacher signals that would corrupt the NN. ══════════════════════════════════════════════════════════════════════ BRAIN TIERS ══════════════════════════════════════════════════════════════════════ tiny (default NPCs): 43→64→64→60 ≈ 41 KB small (named NPCs): 43→128→128→60 ≈ 130 KB medium (player default):43→256→256→256→60 ≈ 1.2 MB large (player upgrade):43→512→1024→1024→60 ≈ 6.6 MB huge (endgame cap): 43→768→1024³→60 ≈ 10 MB (Input dim 43 = 36 body state + 4 intent one-hot + 3 goal vector.) 10 MB hard cap per brain (enforced at serialize-time). Upgrades via Net2Net weight transplant (upgradeBrain) — preserves learned behavior, new neurons start near-zero and learn later. ══════════════════════════════════════════════════════════════════════ DETERMINISM ══════════════════════════════════════════════════════════════════════ Per-entity seeded PRNG (engine's mulberry32 + FNV-1a string hash of entity id). Same id always produces the same initial brain. Different ids (player, npc_parent, thief_jin) diverge immediately into unique \"personalities\". Drug/seizure/tremor effects also use the per-entity RNG, so effects are reproducible per body. ══════════════════════════════════════════════════════════════════════ NEUROMODIFIERS (drugs, disease, damage) ══════════════════════════════════════════════════════════════════════ The forward pass accepts five perturbations applied to hidden-layer activations, grounded in real pharmacology: noise — Gaussian σ (alcohol → loss of coordination) dropout — random activation kill (seizure / KO) scale — output multiplier (paralytic=0, stimulant=1.4) tremor — coherent sinusoidal (Parkinsonian 4-6 Hz) delay — observation buffer lag (concussion) seizureAmp — random spikes in activations See NeuroModifiers.js for preset profiles. ══════════════════════════════════════════════════════════════════════ No external ML library — pure JS, uses engine/core/math/MathRandom.js for shared PRNG utilities. Runs on CPU at 60 Hz for ~20 bodies on a laptop. Training cost ~0.3ms per body per frame (tiny tier).", "exports": [ { "name": "tierFromIntelligence", "kind": "function", "signature": "tierFromIntelligence(score, magical = false)", "summary": "Map an intelligence score to the appropriate tier name. Magical tiers (IQ > 100) only return when `magical=true` — otherwise the character is capped at the highest mortal tier (huge)." }, { "name": "nextTier", "kind": "function", "signature": "nextTier(currentTier)", "summary": "Get the next tier above the current one, or null if already at top." }, { "name": "createNeuralMotor", "kind": "function", "signature": "createNeuralMotor(tier = DEFAULT_TIER, seedSource = null)", "summary": "Create a NeuralMotor. If `seedSource` is given (typically the entity id string), initialization uses a deterministic PRNG — the same id always produces the same starting brain. Different ids get different brains (different \"personalities\") via string hashing." }, { "name": "buildObservation", "kind": "function", "signature": "buildObservation(ragdoll, bonesByName, currentV, targetV, intent = null, rhythms = null, sensors = null)", "summary": "Build the observation vector. Dimensions [21..23] originally held a static gravity vector placeholder — we've REPURPOSED these for CPG RHYTHM signals, which give the NN an internal time-base for rhythmic motor actions (walking, breathing): [0..2] pelvis position (x,y,z) [3..5] pelvis velocity [6..8] chest - pelvis (spine vector) [9..11] shoulder axis (rShoulder - lShoulder) [12..14] COM - pelvis [15] verticality (0..1, normalized to /50) [16] verticality gap (target - current, normalized) [17..20] foot contacts (lFoot y, rFoot y, lFoot vy, rFoot vy) [21] sin(gait_L phase) ← CPG: left-leg step cycle [22] cos(gait_L phase) [23] sin(breath phase) ← CPG: breathing cycle [24..35] left/right hand/knee positions relative to pelvis [36..39] intent one-hot (stand/walk/duck/act) [40] target verticality / 50 (goal normalized) [41..42] target direction (xz, world-space, for walk/act) [43..46] terrain (height below / ahead / slope / lateral) — see OBS_SIZE comment [47..50] social (nearest-agent rel xz + rel vxz) [51..54] high-level motor intent (guard/brace/attack/recover) [55..77] tactile/proprioception block The sin/cos encoding of phase is standard NN representation for circular variables (avoids wraparound discontinuity at 2π)." }, { "name": "neuralMotorForward", "kind": "function", "signature": "neuralMotorForward(motor, obs, time = 0, options = null)", "summary": "Forward pass through the network with neuromodifier effects applied. Returns per-bone Δxyz offsets (in ragdoll name order)." }, { "name": "getNeuralInferenceBackendReport", "kind": "function", "signature": "getNeuralInferenceBackendReport(bodyCount = 0, gpu = null)", "summary": "" }, { "name": "computeReward", "kind": "function", "signature": "computeReward(ragdoll, bonesByName, poseTargets, intent)", "summary": "Compute a scalar reward for the current body state. Real DeepMimic-style reward function — additive terms with sensible weights. All terms ∈ [0, 1] so total ≤ sum of weights (~5). poseMatch — mean bone distance to pose target (closer = higher) upright — head Y above pelvis Y, normalized (no face-plant) stable — low velocity = higher (not thrashing) goalProgress — state-dependent (verticality match, walk speed, etc) Returns: reward ∈ [0, ~5] approximately; scale to [0, 1] with r/5 for AWR weight" }, { "name": "trainNeuralMotor", "kind": "function", "signature": "trainNeuralMotor(motor, obs, teacherOffsets, reward = null, opts = {})", "summary": "Advantage-Weighted Regression (AWR) training step. Standard behavior cloning: minimize MSE(NN_out, teacher) AWR: minimize reward_weight * MSE(NN_out, teacher) Effect: NN imitates the teacher ONLY when the state is good (high reward). Bad states contribute ~0 gradient. This implicitly learns which actions lead to high reward — a form of reinforcement learning without full PPO machinery. Used in shipping games (DReCon) and research (AWR, RWR)." }, { "name": "getNeuralMotorDebugReport", "kind": "function", "signature": "getNeuralMotorDebugReport(motor)", "summary": "" }, { "name": "applyNeuralOffsets", "kind": "function", "signature": "applyNeuralOffsets(offsets, targets)", "summary": "Apply motor output as per-bone target offsets. Call AFTER the kinematic blend has computed its targets; the NN adds corrective deltas." }, { "name": "computeTeacherSignal", "kind": "function", "signature": "computeTeacherSignal(kinematicTargets, ragdoll, bonesByName, rate = 0.15)", "summary": "Compute the \"teacher signal\" — the delta the kinematic controller would apply this frame. For DAgger training, this is what the NN tries to predict. Simple formula: (kinematic_target - actual_position) × rate." }, { "name": "serializeMotor", "kind": "function", "signature": "serializeMotor(motor)", "summary": "Serialize a NeuralMotor to a compact JSON-safe object. Weights are packed as base64-encoded Float32 bytes. Enforces 10 MB per-brain cap. Layout: { magic, version, tier, hiddens[], bytes (base64), framesTrained, lossEMA }" }, { "name": "deserializeMotor", "kind": "function", "signature": "deserializeMotor(motor, data, options = {})", "summary": "Load serialized brain data into an existing motor (replaces weights). Rebuilds layer chain if hiddens differ. Returns true on success." }, { "name": "analyzeMotorStorage", "kind": "function", "signature": "analyzeMotorStorage(motor, packedBytes = null)", "summary": "" }, { "name": "saveBrain", "kind": "function", "signature": "async saveBrain(id, motor)", "summary": "Save a brain under `id`. Enforces 10 MB per-brain cap." }, { "name": "loadBrain", "kind": "function", "signature": "async loadBrain(id)", "summary": "Load a brain by id. Returns serialized data or null." }, { "name": "deleteBrain", "kind": "function", "signature": "async deleteBrain(id)", "summary": "Delete a brain." }, { "name": "listBrains", "kind": "function", "signature": "async listBrains()", "summary": "List all saved brain ids with their sizes." }, { "name": "exportBrainAsJson", "kind": "function", "signature": "exportBrainAsJson(motor)", "summary": "Export a brain as a downloadable JSON file (base64 inside). Useful for sharing trained brains between players." }, { "name": "exportBrainAsCompressedJson", "kind": "function", "signature": "async exportBrainAsCompressedJson(motor)", "summary": "" }, { "name": "importBrainFromJson", "kind": "function", "signature": "importBrainFromJson(motor, jsonStr)", "summary": "Import a JSON string (from exportBrainAsJson) into a motor." }, { "name": "importBrainFromJsonAsync", "kind": "function", "signature": "async importBrainFromJsonAsync(motor, jsonStr)", "summary": "" }, { "name": "upgradeBrain", "kind": "function", "signature": "upgradeBrain(motor, newTier)", "summary": "Upgrade a motor to a bigger tier. Weight matrices are transplanted so the pre-upgrade behavior is preserved; new neurons start with near-zero influence and gradually learn new behaviors. Returns true if upgraded, false if target tier isn't actually bigger." }, { "name": "getUpgradeOptions", "kind": "function", "signature": "getUpgradeOptions(currentTier)", "summary": "Check which tiers an entity can upgrade to (tier order: tiny→small→medium→large→huge)." }, { "name": "BRAIN_TIERS", "kind": "constant", "signature": "BRAIN_TIERS", "summary": "" }, { "name": "TIER_LADDER", "kind": "constant", "signature": "TIER_LADDER", "summary": "" }, { "name": "MAGICAL_TIERS", "kind": "constant", "signature": "MAGICAL_TIERS", "summary": "" }, { "name": "INTELLIGENCE_TIERS", "kind": "constant", "signature": "INTELLIGENCE_TIERS", "summary": "" }, { "name": "MAX_BRAIN_BYTES", "kind": "constant", "signature": "MAX_BRAIN_BYTES", "summary": "" }, { "name": "WARN_BRAIN_BYTES", "kind": "constant", "signature": "WARN_BRAIN_BYTES", "summary": "" }, { "name": "MAX_PLAYER_SLOTS", "kind": "constant", "signature": "MAX_PLAYER_SLOTS", "summary": "" }, { "name": "STATE_INTENTS", "kind": "constant", "signature": "STATE_INTENTS", "summary": "" }, { "name": "NUM_INTENTS", "kind": "constant", "signature": "NUM_INTENTS", "summary": "" }, { "name": "ACTION_SIZE", "kind": "re-export", "signature": "ACTION_SIZE", "summary": "" }, { "name": "BONE_ORDER", "kind": "re-export", "signature": "BONE_ORDER", "summary": "" }, { "name": "OBS_SIZE", "kind": "re-export", "signature": "OBS_SIZE", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/NeuralResidualController", "path": "engine/reference/assets/rig/active-body/NeuralResidualController.md", "source": "engine/assets/rig/active-body/NeuralResidualController.js", "import": "/engine/assets/rig/active-body/NeuralResidualController.js", "sourceHash": "fe1dcf5e7ba692d548678bb06744070359634ca587c725af7b8114cab12321c7", "summary": "engine/assets/rig/active-body/NeuralResidualController.js — extracted from ActiveBodySystem.js (Ragdoll Stack Consolidation Roadmap, Phase 7). Owns the humanoid rotation-residual cluster: converting NN bone offsets into axis-angle residuals blended on top of kinematic rotation targets, and zeroing out idle-state NN drift on the horizontal (and, for a fixed set of upper-body bones, vertical) axes so a \"resting\" NN doesn't slowly walk the pose off-target. Pure functions — callers (the pose-target pipeline, still in ActiveBodySystem.js) own all the surrounding per-frame state.", "exports": [ { "name": "dampIdleNeuralOffsets", "kind": "function", "signature": "dampIdleNeuralOffsets(offsets)", "summary": "" }, { "name": "extractRotationTargets", "kind": "function", "signature": "extractRotationTargets(poseTargets)", "summary": "" }, { "name": "computeNeuralRotationResidualHints", "kind": "function", "signature": "computeNeuralRotationResidualHints(rotationTargets, poseState, neuralOffsets = null, weight = 1)", "summary": "" }, { "name": "neuralOffsetToAxisAngle", "kind": "function", "signature": "neuralOffsetToAxisAngle(neuralOffsets, boneId, weight = 1)", "summary": "" }, { "name": "IDLE_NEURAL_VERTICAL_BLOCK_BONES", "kind": "constant", "signature": "IDLE_NEURAL_VERTICAL_BLOCK_BONES", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/NeuroModifiers", "path": "engine/reference/assets/rig/active-body/NeuroModifiers.md", "source": "engine/assets/rig/active-body/NeuroModifiers.js", "import": "/engine/assets/rig/active-body/NeuroModifiers.js", "sourceHash": "a77dd92362a606bd2d59ed2f3821b4ad91a3a897ab4cda04d26e2487caa30ac9", "summary": "NeuroModifiers — preset effect profiles that corrupt the NeuralMotor's forward pass to produce realistic neurological symptoms. Each profile mutates the `motor.modifiers` bag on a NeuralMotor instance. Multiple effects stack by summing noise/dropout and multiplying scale. Grounded in real pharmacology/neurology: - alcohol: inhibits GABA → activation noise + slow reaction (delay) - paralytic: blocks ACh at NMJ → output scale → 0 (limp) - stimulant: excess catecholamines → amplified output, jitter - tranq: dopamine block → output scale 0.4, delay 3 - poison: neural death → growing dropout + decreasing scale - seizure: hypersynchronous discharge → huge activation spikes - tremor: basal-ganglia dysfn (Parkinson) → coherent 4-6 Hz oscillation", "exports": [ { "name": "applyNeuroProfile", "kind": "function", "signature": "applyNeuroProfile(motor, profileName)", "summary": "Apply a preset profile to a NeuralMotor (replaces current modifiers)." }, { "name": "rampNeuroProfile", "kind": "function", "signature": "rampNeuroProfile(motor, profileName, t)", "summary": "Blend toward a profile over time — e.g. poison progression. `t` ∈ [0,1] is how far along the progression is." }, { "name": "clearNeuroModifiers", "kind": "function", "signature": "clearNeuroModifiers(motor)", "summary": "Reset all neuromodifiers to healthy." }, { "name": "applyNeuroJerks", "kind": "function", "signature": "applyNeuroJerks(ragdoll, motor, time, dt)", "summary": "Apply neuromodifier effects DIRECTLY to the ragdoll bones, bypassing the NN. Needed because the NN only runs during `getup` state; seizures etc. should be visible in ANY state (idle, fallen, walking). This is the physical manifestation of motor-cortex corruption: tremor → coherent sinusoidal force (Parkinsonian shake) seizureAmp → random large impulses (tonic-clonic thrashing) noise → Gaussian jitter on force (alcohol wobble) scale → global force multiplier (paralytic = 0 → body goes limp) Scales with bone mass so effects feel right (heavy pelvis thrashes harder than hand). Called each frame in the main update loop." }, { "name": "NEURO_PROFILES", "kind": "constant", "signature": "NEURO_PROFILES", "summary": "NeuroModifiers — preset effect profiles that corrupt the NeuralMotor's forward pass to produce realistic neurological symptoms. Each profile mutates the `motor.modifiers` bag on a NeuralMotor instance. Multiple effects stack by summing noise/dropout and multiplying scale. Grounded in real pharmacology/neurology: - alcohol: inhibits GABA → activation noise + slow reaction (delay) - paralytic: blocks ACh at NMJ → output scale → 0 (limp) - stimulant: excess catecholamines → amplified output, jitter - tranq: dopamine block → output scale 0.4, delay 3 - poison: neural death → growing dropout + decreasing scale - seizure: hypersynchronous discharge → huge activation spikes - tremor: basal-ganglia dysfn (Parkinson) → coherent 4-6 Hz oscillation" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/OrientationAudit", "path": "engine/reference/assets/rig/active-body/OrientationAudit.md", "source": "engine/assets/rig/active-body/OrientationAudit.js", "import": "/engine/assets/rig/active-body/OrientationAudit.js", "sourceHash": "d757e89e70564ee44da99e3e9999a90d76b1b5fac75f567f017c1adc23146f95", "summary": "engine/assets/rig/active-body/OrientationAudit.js — extracted from ActiveBodySystem.js (Ragdoll Stack Consolidation Roadmap, Phase 7). Owns pure console.log debug tracing: per-frame locomotion-target deltas, the body-vs-particle-vs-facing orientation audit, and the authored-pose directional-consistency self-check (knees/elbows/toes/belly orientation). Distinct from DebugOverlay.js's structured readback data — this is developer-console tracing only, no return values consumed by callers.", "exports": [ { "name": "logLocomotionTargetTrace", "kind": "function", "signature": "logLocomotionTargetTrace(entry, ragdoll, targets, meta)", "summary": "" }, { "name": "logOrientationAudit", "kind": "function", "signature": "logOrientationAudit(entry, ragdoll)", "summary": "" }, { "name": "logFinalDirectionAudit", "kind": "function", "signature": "logFinalDirectionAudit(entry)", "summary": "" }, { "name": "lHandDelta", "kind": "function", "signature": "lHandDelta(yaw, bfX, bfZ)", "summary": "" }, { "name": "auditAllPoses", "kind": "function", "signature": "auditAllPoses()", "summary": "" }, { "name": "auditPose", "kind": "function", "signature": "auditPose(pose)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/PhysicsMotor", "path": "engine/reference/assets/rig/active-body/PhysicsMotor.md", "source": "engine/assets/rig/active-body/PhysicsMotor.js", "import": "/engine/assets/rig/active-body/PhysicsMotor.js", "sourceHash": "cf857e1668d16cbc09c776cc9492c6dce8a3c9de4dbbef11b2714b151520981f", "summary": "engine/assets/rig/active-body/PhysicsMotor.js — extracted from ActiveBodySystem.js (Ragdoll Stack Consolidation Roadmap, Phase 7). Owns the pure physics-application layer for the humanoid Verlet/PBD ragdoll: initial walking-skeleton kinematic pose construction, pelvis anchoring, per-bone joint-torque drive, and hinge-limit computation/enforcement + compliance scaling. Separate concern from pose-TARGET computation (still in ActiveBodySystem.js) — this module only turns targets/limits into forces applied to the ragdoll's particles.", "exports": [ { "name": "buildWalkingSkeleton", "kind": "function", "signature": "buildWalkingSkeleton(anchor, nav, m)", "summary": "" }, { "name": "setRagdollPose", "kind": "function", "signature": "setRagdollPose(ragdoll, anchor, m, options = {})", "summary": "" }, { "name": "currentPelvisPosition", "kind": "function", "signature": "currentPelvisPosition(ragdoll)", "summary": "" }, { "name": "applyPelvisAnchor", "kind": "function", "signature": "applyPelvisAnchor(ragdoll, skeleton, dt)", "summary": "" }, { "name": "applyJointTorques", "kind": "function", "signature": "applyJointTorques(ragdoll, skeleton, dt, state, driveByBone = null)", "summary": "" }, { "name": "computeHingeLimits", "kind": "function", "signature": "computeHingeLimits(ragdoll, m, jointLimitsByBone = null)", "summary": "" }, { "name": "applyHingeLimits", "kind": "function", "signature": "applyHingeLimits(limits)", "summary": "" }, { "name": "complianceStrength", "kind": "function", "signature": "complianceStrength(jointLimitsByBone)", "summary": "" }, { "name": "complianceStrengthFor", "kind": "function", "signature": "complianceStrengthFor(jointLimitsByBone, names, fallback = 1)", "summary": "" }, { "name": "jointSwingScaleFor", "kind": "function", "signature": "jointSwingScaleFor(jointLimitsByBone, names, defaultSwingDeg)", "summary": "" }, { "name": "jointTwistScaleFor", "kind": "function", "signature": "jointTwistScaleFor(jointLimitsByBone, names, defaultTwistDeg)", "summary": "" }, { "name": "JOINT_STIFFNESS", "kind": "constant", "signature": "JOINT_STIFFNESS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/PoseAuthority", "path": "engine/reference/assets/rig/active-body/PoseAuthority.md", "source": "engine/assets/rig/active-body/PoseAuthority.js", "import": "/engine/assets/rig/active-body/PoseAuthority.js", "sourceHash": "20aa316053b6aa08d91e1a16c3092bff57fce0304131ef23c077a7fd24e34987", "summary": "engine/assets/rig/active-body/PoseAuthority.js — extracted from ActiveBodySystem.js (Ragdoll Stack Consolidation Roadmap, Phase 7). This is the hardest and last Phase 7 cluster: the humanoid standing/getup pose-target pipeline — applyStandingController (kinematic pose blending, walk-cycle overlay, balance correction, rhythm/breathing modulation, contact reflexes, brace protection, NN residual blending, training) and applyGetupController (orientation-aware rise sequencing), plus every helper they call (limb/shoulder/head stabilization, reflex classification, motor-authority mapping, pose-state resolution). Deliberately NOT split further — these helpers are tightly entangled with the two controller functions and with each other; see the Phase 7 pre-work notes in the roadmap doc.", "exports": [ { "name": "coupleShoulderGirdleTargets", "kind": "function", "signature": "coupleShoulderGirdleTargets(entry, ragdoll, targets, yaw)", "summary": "" }, { "name": "getBodySideAxis", "kind": "function", "signature": "getBodySideAxis(entry, ragdoll, yaw = null, preferYaw = false)", "summary": "" }, { "name": "clampTargetToSide", "kind": "function", "signature": "clampTargetToSide(targets, name, base, side, minSide, isLeft, strength = 1)", "summary": "" }, { "name": "alignFootToeTargets", "kind": "function", "signature": "alignFootToeTargets(entry, targets, yaw, leftLegIsSwing = false, rightLegIsSwing = false, isWalking = false)", "summary": "" }, { "name": "clampLimbSideTargets", "kind": "function", "signature": "clampLimbSideTargets(entry, ragdoll, targets, yaw = null)", "summary": "" }, { "name": "stabilizeLimbSideFrame", "kind": "function", "signature": "stabilizeLimbSideFrame(entry, ragdoll, dt)", "summary": "" }, { "name": "stabilizeShoulderGirdleFrame", "kind": "function", "signature": "stabilizeShoulderGirdleFrame(entry, ragdoll)", "summary": "" }, { "name": "dampRelativeVelocity", "kind": "function", "signature": "dampRelativeVelocity(child, parent, keep, dt)", "summary": "" }, { "name": "stabilizeHeadNeckFrame", "kind": "function", "signature": "stabilizeHeadNeckFrame(entry, ragdoll, dt)", "summary": "" }, { "name": "hasActiveMoveIntent", "kind": "function", "signature": "hasActiveMoveIntent(entry)", "summary": "" }, { "name": "applyGroundedNoIntentSettleBrake", "kind": "function", "signature": "applyGroundedNoIntentSettleBrake(entry, ragdoll, dt)", "summary": "" }, { "name": "applyBalanceCorrectionToTargets", "kind": "function", "signature": "applyBalanceCorrectionToTargets(targets, balanceState, weight = 1)", "summary": "" }, { "name": "applyRhythmPoseModulation", "kind": "function", "signature": "applyRhythmPoseModulation(targets, rhythms, weight = 1, fatigue = 0)", "summary": "" }, { "name": "makeReflexState", "kind": "function", "signature": "makeReflexState()", "summary": "" }, { "name": "applyContactReflexTargets", "kind": "function", "signature": "applyContactReflexTargets(entry, ragdoll, targets, options = {})", "summary": "" }, { "name": "classifyReflexMode", "kind": "function", "signature": "classifyReflexMode(entry, options)", "summary": "" }, { "name": "reflexConfidence", "kind": "function", "signature": "reflexConfidence(contactTelemetry, mode, leftTrust, rightTrust)", "summary": "" }, { "name": "buildMotorAuthorityMap", "kind": "function", "signature": "buildMotorAuthorityMap(entry, contactTelemetry)", "summary": "" }, { "name": "applyFootReflexTarget", "kind": "function", "signature": "applyFootReflexTarget(entry, targets, record, options)", "summary": "" }, { "name": "applyBraceProtectionTargets", "kind": "function", "signature": "applyBraceProtectionTargets(contactTelemetry, targets, options)", "summary": "" }, { "name": "resolveActivePoseState", "kind": "function", "signature": "resolveActivePoseState(entry)", "summary": "" }, { "name": "makePoseStateMeta", "kind": "function", "signature": "makePoseStateMeta(stateId)", "summary": "" }, { "name": "applyStandingController", "kind": "function", "signature": "applyStandingController(ragdoll, entry, dt)", "summary": "" }, { "name": "_bonesByName", "kind": "function", "signature": "_bonesByName(ragdoll)", "summary": "" }, { "name": "applyGetupController", "kind": "function", "signature": "applyGetupController(ragdoll, entry, dt)", "summary": "" }, { "name": "getBoneRadius", "kind": "function", "signature": "getBoneRadius(boneId, m)", "summary": "" }, { "name": "stateToString", "kind": "function", "signature": "stateToString(state)", "summary": "" }, { "name": "WALK_HORIZONTAL_SCALE_BY_BONE", "kind": "constant", "signature": "WALK_HORIZONTAL_SCALE_BY_BONE", "summary": "" }, { "name": "WALK_HORIZONTAL_DAMPING_SCALE_BY_BONE", "kind": "constant", "signature": "WALK_HORIZONTAL_DAMPING_SCALE_BY_BONE", "summary": "" }, { "name": "IDLE_HORIZONTAL_SCALE_BY_BONE", "kind": "constant", "signature": "IDLE_HORIZONTAL_SCALE_BY_BONE", "summary": "" }, { "name": "IDLE_HORIZONTAL_DAMPING_SCALE_BY_BONE", "kind": "constant", "signature": "IDLE_HORIZONTAL_DAMPING_SCALE_BY_BONE", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/UniversalLegScheduler", "path": "engine/reference/assets/rig/active-body/UniversalLegScheduler.md", "source": "engine/assets/rig/active-body/UniversalLegScheduler.js", "import": "/engine/assets/rig/active-body/UniversalLegScheduler.js", "sourceHash": "6ec7aa4e3c3db39543b7b9e9b493e84c081c39aef12d69178f923d4d344ec31c", "summary": "engine/assets/rig/active-body/UniversalLegScheduler.js — extracted from ActiveBodySystem.js (Ragdoll Stack Consolidation Roadmap, Phase 7). Owns N-legged support-polygon analysis and gait-preset recommendation for the generic/readback-only \"universal leg scheduler\" — the leg discovery, phase, and support-polygon math shared conceptually with the animal gait system, but exposed here purely as debug/readback (ActiveBodySystem's getReadback() is the only call site; it does not drive live pose targets).", "exports": [ { "name": "makeUniversalLegSchedulerReadback", "kind": "function", "signature": "makeUniversalLegSchedulerReadback(entry, contactTelemetry)", "summary": "" }, { "name": "discoverUniversalLegs", "kind": "function", "signature": "discoverUniversalLegs(entry)", "summary": "" }, { "name": "normalizeUniversalLegDescriptors", "kind": "function", "signature": "normalizeUniversalLegDescriptors(descriptors, entry, allowMetadataOnly = true)", "summary": "" }, { "name": "defaultUniversalLegRhythmIndex", "kind": "function", "signature": "defaultUniversalLegRhythmIndex(descriptor)", "summary": "" }, { "name": "makeUniversalLegReadback", "kind": "function", "signature": "makeUniversalLegReadback(entry, leg, contactTelemetry)", "summary": "" }, { "name": "makeUniversalSupportAnalysis", "kind": "function", "signature": "makeUniversalSupportAnalysis(entry, legs)", "summary": "" }, { "name": "universalLegState", "kind": "function", "signature": "universalLegState(contact, swingAmount)", "summary": "" }, { "name": "getUniversalLegPhase", "kind": "function", "signature": "getUniversalLegPhase(entry, leg)", "summary": "" }, { "name": "supportModeFor", "kind": "function", "signature": "supportModeFor(pointCount, legCount)", "summary": "" }, { "name": "supportComMargin", "kind": "function", "signature": "supportComMargin(com, points)", "summary": "" }, { "name": "recoveryDirection", "kind": "function", "signature": "recoveryDirection(com, center)", "summary": "" }, { "name": "signedPolygonMargin2D", "kind": "function", "signature": "signedPolygonMargin2D(point, polygon)", "summary": "" }, { "name": "pointInPolygon2D", "kind": "function", "signature": "pointInPolygon2D(point, polygon)", "summary": "" }, { "name": "distancePointToSegment2D", "kind": "function", "signature": "distancePointToSegment2D(point, a, b)", "summary": "" }, { "name": "distance2D", "kind": "function", "signature": "distance2D(a, b)", "summary": "" }, { "name": "particlePoint", "kind": "function", "signature": "particlePoint(entry, boneName)", "summary": "" }, { "name": "hasBone", "kind": "function", "signature": "hasBone(entry, boneName)", "summary": "" }, { "name": "recommendUniversalGaitPreset", "kind": "function", "signature": "recommendUniversalGaitPreset(entry, legCount)", "summary": "" }, { "name": "copyUniversalGaitPresets", "kind": "function", "signature": "copyUniversalGaitPresets(legCount)", "summary": "" }, { "name": "copyUniversalGaitPresetMap", "kind": "function", "signature": "copyUniversalGaitPresetMap()", "summary": "" }, { "name": "makeGenericOddLegWavePreset", "kind": "function", "signature": "makeGenericOddLegWavePreset(legCount)", "summary": "" }, { "name": "UNIVERSAL_GAIT_PRESETS", "kind": "constant", "signature": "UNIVERSAL_GAIT_PRESETS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/anatomy/BioelectricSignals", "path": "engine/reference/assets/rig/active-body/anatomy/BioelectricSignals.md", "source": "engine/assets/rig/active-body/anatomy/BioelectricSignals.js", "import": "/engine/assets/rig/active-body/anatomy/BioelectricSignals.js", "sourceHash": "61797b795d584da214afec1b25e0bd58f7fde93d342a10c406d7546f50e583f8", "summary": "", "exports": [ { "name": "createBioelectricSignalState", "kind": "function", "signature": "createBioelectricSignalState()", "summary": "" }, { "name": "stepBioelectricSignals", "kind": "function", "signature": "stepBioelectricSignals(state, inputs = {}, dt = 0)", "summary": "" }, { "name": "getBioelectricSignalReadback", "kind": "function", "signature": "getBioelectricSignalReadback(state)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/anatomy/BreathingBodyCoupling", "path": "engine/reference/assets/rig/active-body/anatomy/BreathingBodyCoupling.md", "source": "engine/assets/rig/active-body/anatomy/BreathingBodyCoupling.js", "import": "/engine/assets/rig/active-body/anatomy/BreathingBodyCoupling.js", "sourceHash": "46522ef6b4ff5ed2a3acd567e1acaaeb34f3955a8d9ec84706b4cd4aafe48a92", "summary": "", "exports": [ { "name": "getBreathingBodyCouplingReadback", "kind": "function", "signature": "getBreathingBodyCouplingReadback(diaphragm = null, rhythms = null)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/anatomy/CirculatorySystem", "path": "engine/reference/assets/rig/active-body/anatomy/CirculatorySystem.md", "source": "engine/assets/rig/active-body/anatomy/CirculatorySystem.js", "import": "/engine/assets/rig/active-body/anatomy/CirculatorySystem.js", "sourceHash": "3a48443b0fde9fe6798c124e204a89919e5647a08f327f4b4d3774943d6c7757", "summary": "", "exports": [ { "name": "createCirculatoryState", "kind": "function", "signature": "createCirculatoryState()", "summary": "" }, { "name": "stepCirculation", "kind": "function", "signature": "stepCirculation(state, inputs = {}, dt = 0)", "summary": "" }, { "name": "getCirculatoryReadback", "kind": "function", "signature": "getCirculatoryReadback(state)", "summary": "" }, { "name": "getCirculationGraphReadback", "kind": "function", "signature": "getCirculationGraphReadback(state)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/anatomy/DiaphragmSystem", "path": "engine/reference/assets/rig/active-body/anatomy/DiaphragmSystem.md", "source": "engine/assets/rig/active-body/anatomy/DiaphragmSystem.js", "import": "/engine/assets/rig/active-body/anatomy/DiaphragmSystem.js", "sourceHash": "0db0ed59c44426ea5ed69947470eeaa284cc8a46f9ae6047db717a8af912d8ec", "summary": "", "exports": [ { "name": "createDiaphragmState", "kind": "function", "signature": "createDiaphragmState(anatomy = null)", "summary": "" }, { "name": "stepDiaphragm", "kind": "function", "signature": "stepDiaphragm(state, rhythms = null, dt = 0)", "summary": "" }, { "name": "getDiaphragmReadback", "kind": "function", "signature": "getDiaphragmReadback(state)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/anatomy/NervousSystem", "path": "engine/reference/assets/rig/active-body/anatomy/NervousSystem.md", "source": "engine/assets/rig/active-body/anatomy/NervousSystem.js", "import": "/engine/assets/rig/active-body/anatomy/NervousSystem.js", "sourceHash": "87c053a072fbf4c61c0774e0b2691a08945ccbaa7078cec74e1a2039d5e40e5f", "summary": "", "exports": [ { "name": "createNervousSystemState", "kind": "function", "signature": "createNervousSystemState()", "summary": "" }, { "name": "stepNervousSystem", "kind": "function", "signature": "stepNervousSystem(state, inputs = {}, dt = 0)", "summary": "" }, { "name": "getNervousSystemReadback", "kind": "function", "signature": "getNervousSystemReadback(state)", "summary": "" }, { "name": "getNerveGraphReadback", "kind": "function", "signature": "getNerveGraphReadback(state)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/anatomy/OrganDamageSystem", "path": "engine/reference/assets/rig/active-body/anatomy/OrganDamageSystem.md", "source": "engine/assets/rig/active-body/anatomy/OrganDamageSystem.js", "import": "/engine/assets/rig/active-body/anatomy/OrganDamageSystem.js", "sourceHash": "d966140a921de055dc49c061d895728a05fbde0a55bd68492a69488ebb70f4f7", "summary": "", "exports": [ { "name": "createOrganDamageState", "kind": "function", "signature": "createOrganDamageState()", "summary": "" }, { "name": "applyOrganDamage", "kind": "function", "signature": "applyOrganDamage(state, organs, target, amount, options = {})", "summary": "" }, { "name": "stepOrganDamage", "kind": "function", "signature": "stepOrganDamage(state, organs, inputs = {}, dt = 0)", "summary": "" }, { "name": "getOrganDamageReadback", "kind": "function", "signature": "getOrganDamageReadback(state)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/anatomy/OrganSystem", "path": "engine/reference/assets/rig/active-body/anatomy/OrganSystem.md", "source": "engine/assets/rig/active-body/anatomy/OrganSystem.js", "import": "/engine/assets/rig/active-body/anatomy/OrganSystem.js", "sourceHash": "4e1b03b28a3094b80f377571e87a40d239efe596e0954418d4b6a4380b8542f9", "summary": "", "exports": [ { "name": "createOrganState", "kind": "function", "signature": "createOrganState(anatomy = null, attachments = null)", "summary": "" }, { "name": "getOrganReadback", "kind": "function", "signature": "getOrganReadback(organs)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/anatomy/PBPKSystem", "path": "engine/reference/assets/rig/active-body/anatomy/PBPKSystem.md", "source": "engine/assets/rig/active-body/anatomy/PBPKSystem.js", "import": "/engine/assets/rig/active-body/anatomy/PBPKSystem.js", "sourceHash": "61dd070c8f412c089b00f2be106c6e3894e6f06786aa9aa9629be82d9da5c638", "summary": "", "exports": [ { "name": "createPBPKState", "kind": "function", "signature": "createPBPKState()", "summary": "" }, { "name": "addPBPKDose", "kind": "function", "signature": "addPBPKDose(state, substanceId, amount, options = {})", "summary": "" }, { "name": "stepPBPK", "kind": "function", "signature": "stepPBPK(state, inputs = {}, dt = 0)", "summary": "" }, { "name": "getPBPKReadback", "kind": "function", "signature": "getPBPKReadback(state)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/anatomy/SoftTissueSystem", "path": "engine/reference/assets/rig/active-body/anatomy/SoftTissueSystem.md", "source": "engine/assets/rig/active-body/anatomy/SoftTissueSystem.js", "import": "/engine/assets/rig/active-body/anatomy/SoftTissueSystem.js", "sourceHash": "b8e9554b27f3a970a7b3ca7fe065387da8487914c2a3498218f380f81bd44761", "summary": "", "exports": [ { "name": "createSoftTissueState", "kind": "function", "signature": "createSoftTissueState(anatomy = null)", "summary": "" }, { "name": "stepSoftTissue", "kind": "function", "signature": "stepSoftTissue(state, inputs = {}, dt = 0)", "summary": "" }, { "name": "getSoftTissueReadback", "kind": "function", "signature": "getSoftTissueReadback(state)", "summary": "" }, { "name": "sampleSoftTissueBoneMotion", "kind": "function", "signature": "sampleSoftTissueBoneMotion(ragdoll = null)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/anatomy/VitalSigns", "path": "engine/reference/assets/rig/active-body/anatomy/VitalSigns.md", "source": "engine/assets/rig/active-body/anatomy/VitalSigns.js", "import": "/engine/assets/rig/active-body/anatomy/VitalSigns.js", "sourceHash": "ebbe7e8ce0a1f373c30c10d2cfc5432910d89e3694ed05673b638a9ce2d9d4d9", "summary": "", "exports": [ { "name": "createVitalSignsState", "kind": "function", "signature": "createVitalSignsState()", "summary": "" }, { "name": "stepVitalSigns", "kind": "function", "signature": "stepVitalSigns(state, inputs = {}, dt = 0)", "summary": "" }, { "name": "getVitalSignsReadback", "kind": "function", "signature": "getVitalSignsReadback(state)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/active-body/anatomy/index", "path": "engine/reference/assets/rig/active-body/anatomy/index.md", "source": "engine/assets/rig/active-body/anatomy/index.js", "import": "/engine/assets/rig/active-body/anatomy/index.js", "sourceHash": "91f6bf23500772b0a1250ca2d2cd83a7756d7e77302a50fd41155c496e782d4b", "summary": "engine/assets/rig/active-body/anatomy/index.js — anatomy subsystem barrel. Every other subsystem in the engine exposes a barrel (`voxel/index.js`, `sim/ai/index.js`, `gameplay/perception/index.js`); the anatomy modules did not, which is part of why they were unreachable from any compiled bundle. This is purely additive — no module below is modified, and nothing that already imports these files by path is affected. The subsystem models a body as interacting physiological systems rather than a hit-point total: - `OrganSystem` per-organ integrity, perfusion, oxygenation, function - `OrganDamageSystem` wounds by mechanism, bleeding, hypoxia, shock - `CirculatorySystem` cardiac output, per-limb and per-organ blood flow - `NervousSystem` spinal cord, 16 peripheral regions, motor authority, and per-region motor/sensory/touch/pain channels - `VitalSigns` heart rate, respiration, blood pressure, SpO2 - `DiaphragmSystem` breathing drive and rib/sternum coupling - `BreathingBodyCoupling` breathing translated into bone pose offsets - `SoftTissueSystem` mass-spring tissue displacement and strain - `PBPKSystem` multi-compartment pharmacokinetics for any substance - `BioelectricSignals` low-level signal propagation", "exports": [], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/rig/index", "path": "engine/reference/assets/rig/index.md", "source": "engine/assets/rig/index.js", "import": "/engine/assets/rig/index.js", "sourceHash": "6e52ae51a35af1202bed06c804bcbd9b5d23a577c3912a3ccd615b01f3eb2dfe", "summary": "Stable public rig surface for raw modules, Engine.Rig, and bundled PE.Rig. The named groups preserve each source module's boundary while the flat functions keep the existing engine/assets API available without adapters.", "exports": [ { "name": "JointLimits", "kind": "constant", "signature": "JointLimits", "summary": "Stable public rig surface for raw modules, Engine.Rig, and bundled PE.Rig. The named groups preserve each source module's boundary while the flat functions keep the existing engine/assets API available without adapters." }, { "name": "RagdollBuilder", "kind": "constant", "signature": "RagdollBuilder", "summary": "" }, { "name": "RagdollSim", "kind": "constant", "signature": "RagdollSim", "summary": "" }, { "name": "RagdollSkinning", "kind": "constant", "signature": "RagdollSkinning", "summary": "" }, { "name": "CharacterPhysicsAsset", "kind": "constant", "signature": "CharacterPhysicsAsset", "summary": "" }, { "name": "BodyTemplateExport", "kind": "constant", "signature": "BodyTemplateExport", "summary": "" }, { "name": "Rig", "kind": "constant", "signature": "Rig", "summary": "" }, { "name": "CHARACTER_PHYSICS_ASSET_SCHEMA_VERSION", "kind": "re-export", "signature": "CHARACTER_PHYSICS_ASSET_SCHEMA_VERSION", "summary": "" }, { "name": "JOINT_TYPE", "kind": "re-export", "signature": "JOINT_TYPE", "summary": "" }, { "name": "buildGenericRagdoll", "kind": "re-export", "signature": "buildGenericRagdoll", "summary": "" }, { "name": "buildHumanoidRagdoll", "kind": "re-export", "signature": "buildHumanoidRagdoll", "summary": "" }, { "name": "buildJointLimits", "kind": "re-export", "signature": "buildJointLimits", "summary": "" }, { "name": "buildRagdoll", "kind": "re-export", "signature": "buildRagdoll", "summary": "" }, { "name": "buildSkinnedRagdoll", "kind": "re-export", "signature": "buildSkinnedRagdoll", "summary": "" }, { "name": "characterPhysicsAssetToBodyTemplate", "kind": "re-export", "signature": "characterPhysicsAssetToBodyTemplate", "summary": "" }, { "name": "computeSkeletonFingerprint", "kind": "re-export", "signature": "computeSkeletonFingerprint", "summary": "" }, { "name": "countTypes", "kind": "re-export", "signature": "countTypes", "summary": "" }, { "name": "createCharacterPhysicsAsset", "kind": "re-export", "signature": "createCharacterPhysicsAsset", "summary": "" }, { "name": "createRagdollSim", "kind": "re-export", "signature": "createRagdollSim", "summary": "" }, { "name": "deriveBendDirection", "kind": "re-export", "signature": "deriveBendDirection", "summary": "" }, { "name": "deriveHingeLimit", "kind": "re-export", "signature": "deriveHingeLimit", "summary": "" }, { "name": "deriveHumanoidJointLimits", "kind": "re-export", "signature": "deriveHumanoidJointLimits", "summary": "" }, { "name": "deriveJointType", "kind": "re-export", "signature": "deriveJointType", "summary": "" }, { "name": "deriveSkeletonJointLimits", "kind": "re-export", "signature": "deriveSkeletonJointLimits", "summary": "" }, { "name": "deriveSwingCone", "kind": "re-export", "signature": "deriveSwingCone", "summary": "" }, { "name": "deriveTwistLimit", "kind": "re-export", "signature": "deriveTwistLimit", "summary": "" }, { "name": "hingeAxis", "kind": "re-export", "signature": "hingeAxis", "summary": "" }, { "name": "inferDriveType", "kind": "re-export", "signature": "inferDriveType", "summary": "" }, { "name": "logSkinnedRagdoll", "kind": "re-export", "signature": "logSkinnedRagdoll", "summary": "" }, { "name": "mirrorLeftRightLimits", "kind": "re-export", "signature": "mirrorLeftRightLimits", "summary": "" }, { "name": "radiusRatio", "kind": "re-export", "signature": "radiusRatio", "summary": "" }, { "name": "ragdollBoneFrames", "kind": "re-export", "signature": "ragdollBoneFrames", "summary": "" }, { "name": "ragdollDebugStats", "kind": "re-export", "signature": "ragdollDebugStats", "summary": "" }, { "name": "skinPrimitiveInterleaved", "kind": "re-export", "signature": "skinPrimitiveInterleaved", "summary": "" }, { "name": "validJointTypeSet", "kind": "re-export", "signature": "validJointTypeSet", "summary": "" }, { "name": "validateBoneTopology", "kind": "re-export", "signature": "validateBoneTopology", "summary": "" }, { "name": "validateCharacterPhysicsAsset", "kind": "re-export", "signature": "validateCharacterPhysicsAsset", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/vehicle/ChassisDetector", "path": "engine/reference/assets/vehicle/ChassisDetector.md", "source": "engine/assets/vehicle/ChassisDetector.js", "import": "/engine/assets/vehicle/ChassisDetector.js", "sourceHash": "742a859046945478eb2e322a0c673ac52e3acd82014e03d02892abc5554b42cd", "summary": "engine/assets/vehicle/ChassisDetector.js — identify the chassis + body parts (spec §11). The chassis is the largest non-wheel mesh; remaining meshes are categorized by name (glass/lights/doors) so segmentation and material edits (tint glass, emissive headlights, detach doors) can target them.", "exports": [ { "name": "detectChassis", "kind": "function", "signature": "detectChassis(model, wheelNodeIds = [])", "summary": "Identify chassis + body part nodes, excluding the given wheel node ids." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/vehicle/VehicleMath", "path": "engine/reference/assets/vehicle/VehicleMath.md", "source": "engine/assets/vehicle/VehicleMath.js", "import": "/engine/assets/vehicle/VehicleMath.js", "sourceHash": "1d45737d4a68487d4ebc3ee5e0179f41a482accbb25f3a00b191459187305d33", "summary": "engine/assets/vehicle/VehicleMath.js — minimal column-major 4x4 + quaternion helpers for vehicle rig assembly and the visual wheel transform chain. Kept local and dependency-free so the vehicle layer is self-contained and the math stays deterministic (and gate-testable without the renderer).", "exports": [ { "name": "identity", "kind": "function", "signature": "identity()", "summary": "" }, { "name": "multiply", "kind": "function", "signature": "multiply(a, b)", "summary": "Column-major multiply: out = a * b." }, { "name": "composeTRS", "kind": "function", "signature": "composeTRS(t = [0, 0, 0], q = [0, 0, 0, 1], s = 1)", "summary": "Compose a TRS matrix (scale may be a number or [x,y,z])." }, { "name": "quatFromAxisAngle", "kind": "function", "signature": "quatFromAxisAngle(axis, angle)", "summary": "Quaternion (xyzw) from an axis + angle (radians)." }, { "name": "quatMul", "kind": "function", "signature": "quatMul(a, b)", "summary": "Hamilton product a*b (xyzw)." }, { "name": "transformPoint", "kind": "function", "signature": "transformPoint(m, p)", "summary": "Transform a point (vec3) by a column-major 4x4." }, { "name": "nodeLocalMatrix", "kind": "function", "signature": "nodeLocalMatrix(node)", "summary": "Local transform of a node (matrix override or TRS)." }, { "name": "computeWorldMatrices", "kind": "function", "signature": "computeWorldMatrices(model)", "summary": "World matrices for every node, accumulating the parent chain. Returns a Map(nodeId → Float32Array(16))." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/vehicle/VehicleRigBuilder", "path": "engine/reference/assets/vehicle/VehicleRigBuilder.md", "source": "engine/assets/vehicle/VehicleRigBuilder.js", "import": "/engine/assets/vehicle/VehicleRigBuilder.js", "sourceHash": "8ae5808e9db0c4398735978f0ef4a470d7b5c2cf2471ac2263d9243d573b326a", "summary": "engine/assets/vehicle/VehicleRigBuilder.js — assemble a VehicleAsset (spec §11). Vehicles are rigged, not merely loaded. This turns detected wheels + chassis into explicit runtime data: WheelSlots (with suspension/tire/drivetrain), front-axle steering, a compound-collider descriptor for the chassis (built via the engine's ConvexDecomposition on demand), and a confidence. Detection failures (e.g. wheels merged into the body) flag needsCorrection rather than guessing — the editor exposes every decision (rule 62).", "exports": [ { "name": "buildVehicleRig", "kind": "function", "signature": "buildVehicleRig(model, opts = {})", "summary": "Build a vehicle rig for a model and attach it at model.rigs.vehicle." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/vehicle/WheelDetector", "path": "engine/reference/assets/vehicle/WheelDetector.md", "source": "engine/assets/vehicle/WheelDetector.js", "import": "/engine/assets/vehicle/WheelDetector.js", "sourceHash": "0a28f7df6d11591d8f3f1ba60d0a1193ccc36f056e2ed8ee0189fdaf361c20b3", "summary": "engine/assets/vehicle/WheelDetector.js — find wheels (spec §11). Detection chain (cheap → expensive), each a HINT with a confidence, never an assertion: name match → cylinder geometry → symmetry / low-corner position → (editor correction). Wheels that are merged into the body mesh won't be found here and fall through to the editor (see VehicleRigBuilder.needsCorrection).", "exports": [ { "name": "detectWheels", "kind": "function", "signature": "detectWheels(model, opts = {})", "summary": "Detect wheel candidates in a model." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/vehicle/WheelPhysics", "path": "engine/reference/assets/vehicle/WheelPhysics.md", "source": "engine/assets/vehicle/WheelPhysics.js", "import": "/engine/assets/vehicle/WheelPhysics.js", "sourceHash": "d9c654cdd156c548ed3635a3b794c4a83b3a2587facfd90b338f45486179b343", "summary": "engine/assets/vehicle/WheelPhysics.js — suspension, tire slip, and the visual wheel transform chain (spec §11). Deterministic CPU model used for the inspector/demo and gates; production deployments route the same WheelSlot data into the engine's GPUVehicle. Wheel visuals FOLLOW physics state: chassisWorld · socket · suspension · steer · spin · meshCorrection.", "exports": [ { "name": "suspensionForce", "kind": "function", "signature": "suspensionForce({ restLength, currentLength, stiffness, damping, compressionVelocity = 0 })", "summary": "Suspension spring + damper force. compression = restLength - currentLength springForce = stiffness * compression damperForce = damping * compressionVelocity normalLoad = max(0, springForce + damperForce)" }, { "name": "tireForce", "kind": "function", "signature": "tireForce(slip, normalLoad, grip, slipStiffness = 12)", "summary": "A slip-based tire force (Pacejka-lite): linear near zero slip, saturating at the friction limit `normalLoad * grip`. `slipStiffness` shapes the knee." }, { "name": "longitudinalSlip", "kind": "function", "signature": "longitudinalSlip(wheelAngularVel, radius, groundSpeed)", "summary": "Longitudinal slip ratio from wheel surface speed vs ground speed." }, { "name": "freeRollAngularVelocity", "kind": "function", "signature": "freeRollAngularVelocity(groundSpeed, radius)", "summary": "Free-rolling angular velocity (rad/s) for a given ground speed." }, { "name": "visualWheelMatrix", "kind": "function", "signature": "visualWheelMatrix(chassisWorld, slot, state = {})", "summary": "Compose the visual world matrix for a wheel from chassis world + slot + state." }, { "name": "advanceSpin", "kind": "function", "signature": "advanceSpin(spinAngle, groundSpeed, radius, dt)", "summary": "Advance a wheel's spin angle from a ground speed (visual integration)." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/vehicle/WheelSlot", "path": "engine/reference/assets/vehicle/WheelSlot.md", "source": "engine/assets/vehicle/WheelSlot.js", "import": "/engine/assets/vehicle/WheelSlot.js", "sourceHash": "1bc4ed1f7983abd720d317bc82fd6eeac2657fdfc4cc027f4247c674c05de034", "summary": "engine/assets/vehicle/WheelSlot.js — vehicle rig schemas (spec §11). A vehicle is NOT a mesh: it's a visual model + chassis collider + wheel slots + suspension + tire model + drivetrain. Wheel runtime data is explicit and separate from the visible wheel mesh (matching Jolt/Unity wheel colliders), so visuals follow physics rather than the other way around.", "exports": [ { "name": "createWheelSlot", "kind": "function", "signature": "createWheelSlot(init = {})", "summary": "A wheel slot: the runtime data for one wheel, decoupled from its visual mesh." }, { "name": "createSuspension", "kind": "function", "signature": "createSuspension(init = {})", "summary": "" }, { "name": "createTireProfile", "kind": "function", "signature": "createTireProfile(init = {})", "summary": "" }, { "name": "createVehicleAsset", "kind": "function", "signature": "createVehicleAsset(init = {})", "summary": "The assembled vehicle rig produced by VehicleRigBuilder. It references the model's nodes/meshes and carries explicit runtime data; it can drive the engine's GPUVehicle physics or the CPU WheelPhysics fallback." }, { "name": "DRIVETRAIN", "kind": "constant", "signature": "DRIVETRAIN", "summary": "" }, { "name": "WHEEL_PHYSICS_MODE", "kind": "constant", "signature": "WHEEL_PHYSICS_MODE", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/vehicle/WheelSpinVisual", "path": "engine/reference/assets/vehicle/WheelSpinVisual.md", "source": "engine/assets/vehicle/WheelSpinVisual.js", "import": "/engine/assets/vehicle/WheelSpinVisual.js", "sourceHash": "1dbf87409513016dd0b22c6afec003812002217d6e1a45a81f12e9760776db8d", "summary": "engine/assets/vehicle/WheelSpinVisual.js — visual wheel-spin transforms for a rigged vehicle. Separated from physics (WheelPhysics) and detection so the importer/viewer, the editor preview, and the runtime can all reuse one correct implementation. Approach (matches Unity `transform.Rotate(..,Space.Self)` / Godot `rotate_object_local`): the spin is built in the wheel's MESH-LOCAL space from the detector's per-wheel hub (`localPivot`) and axle (`axleAxisLocal`), then the node hierarchy + import correction carry it to the right world position and orientation automatically (the renderer does `draw = baseDraw · spin_local`). This avoids transforming the axle into world space, PCA axis ambiguity on low-poly wheels, and pivot guessing — the failure modes of a world-space spin. The only world-space step is a per-wheel SIGN so mirrored wheels roll the same way; the axle vector itself stays the exact per-wheel local axis.", "exports": [ { "name": "rotAxis", "kind": "function", "signature": "rotAxis(axis, angle)", "summary": "Column-major rotation about an arbitrary (unit-normalized) axis." }, { "name": "pivotSpin", "kind": "function", "signature": "pivotSpin(pivot, axis, angle)", "summary": "Spin about an axis through a pivot: T(pivot) · R(axis,angle) · T(-pivot)." }, { "name": "buildWheelSpinMap", "kind": "function", "signature": "buildWheelSpinMap(model, importMatrix, rig)", "summary": "Build a per-wheel spin descriptor map for a rigged model. Each entry carries the wheel's MESH-LOCAL pivot + axle (so the renderer applies the spin in local space: `draw = baseDraw · pivotSpin(pivot, axle, angle)`). The local axle is pre-signed so every wheel rolls the same visual direction. Steerable wheels also carry their local steer axis so the renderer can yaw them with input." }, { "name": "rollAngle", "kind": "function", "signature": "rollAngle(distance, radius)", "summary": "Spin angle (radians) for a wheel that has rolled `distance` metres." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/vpath", "path": "engine/reference/assets/vpath.md", "source": "engine/assets/vpath.js", "import": "/engine/assets/vpath.js", "sourceHash": "4f5897a9052fa17fdabd4412f6122b7aa1f8e81ca7315656205ccc879420d756", "summary": "engine/assets/vpath.js — virtual path system. Users never manage raw filesystem paths. Everything addresses through a scheme://path virtual path. The resolver (AssetResolver) maps a virtual path to a concrete backend handle; this module only parses/normalizes/builds them. asset:// project asset library user:// user-selected local folder (File System Access) cache:// OPFS / local engine cache cloud:// optional remote mirror temp:// transient drag-drop import surface:// live render surface (no backing file)", "exports": [ { "name": "parseVPath", "kind": "function", "signature": "parseVPath(vpath)", "summary": "Parse a virtual path into { scheme, path, segments }." }, { "name": "isVPath", "kind": "function", "signature": "isVPath(vpath)", "summary": "" }, { "name": "makeVPath", "kind": "function", "signature": "makeVPath(scheme, ...parts)", "summary": "Build a virtual path from a scheme + path parts." }, { "name": "normalizeSegments", "kind": "function", "signature": "normalizeSegments(path)", "summary": "Collapse duplicate/empty separators and strip leading/trailing slashes." }, { "name": "withScheme", "kind": "function", "signature": "withScheme(vpath, scheme)", "summary": "Swap the scheme of a virtual path, keeping the same path (e.g. for backups)." }, { "name": "vpathBasename", "kind": "function", "signature": "vpathBasename(vpath)", "summary": "The basename (last segment) and extension of a virtual path." }, { "name": "vpathExtension", "kind": "function", "signature": "vpathExtension(vpath)", "summary": "" }, { "name": "cachePathFor", "kind": "function", "signature": "cachePathFor(kind, sourceHash, ext)", "summary": "Standard cache path for a converted artifact, keyed by content hash." }, { "name": "VPATH_SCHEMES", "kind": "constant", "signature": "VPATH_SCHEMES", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/weapon/WeaponRig", "path": "engine/reference/assets/weapon/WeaponRig.md", "source": "engine/assets/weapon/WeaponRig.js", "import": "/engine/assets/weapon/WeaponRig.js", "sourceHash": "12c66e75b48142d53b006fba9493966f81413c1502d5207dc3b1cf4d11d615fb", "summary": "engine/assets/weapon/WeaponRig.js — canonical weapon socket/part schema (spec §13). A weapon is a model + sockets (muzzle/chamber/grips/sight/…) + moving parts (slide/bolt/hammer/…) + a fire/reload timeline + a state machine. This is a GAME ABSTRACTION: sockets/timings are gameplay anchors, not real-firearm data. Every detection is a hint with confidence; ambiguous nodes go to the editor.", "exports": [ { "name": "createWeaponRig", "kind": "function", "signature": "createWeaponRig(init = {})", "summary": "Create a weapon rig descriptor." }, { "name": "WEAPON_SOCKET", "kind": "constant", "signature": "WEAPON_SOCKET", "summary": "" }, { "name": "MOVING_PART", "kind": "constant", "signature": "MOVING_PART", "summary": "" }, { "name": "WEAPON_TYPE", "kind": "constant", "signature": "WEAPON_TYPE", "summary": "" }, { "name": "REQUIRED_SOCKETS", "kind": "constant", "signature": "REQUIRED_SOCKETS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/weapon/WeaponRigBuilder", "path": "engine/reference/assets/weapon/WeaponRigBuilder.md", "source": "engine/assets/weapon/WeaponRigBuilder.js", "import": "/engine/assets/weapon/WeaponRigBuilder.js", "sourceHash": "10b7eea5d7c0f6964a6f32f673b2dc924c69d9b9cbc589d5e1ccfaf707f43300", "summary": "engine/assets/weapon/WeaponRigBuilder.js — assemble a WeaponRig from a model: detect sockets + moving parts + forward/muzzle, attach default fire/reload timelines and a state machine seed, and flag needsCorrection when required sockets are missing. Attaches at model.rigs.weapon. GAME ABSTRACTION ONLY.", "exports": [ { "name": "buildWeaponRig", "kind": "function", "signature": "buildWeaponRig(model, opts = {})", "summary": "Build a weapon rig and attach it at model.rigs.weapon." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/weapon/WeaponSocketDetector", "path": "engine/reference/assets/weapon/WeaponSocketDetector.md", "source": "engine/assets/weapon/WeaponSocketDetector.js", "import": "/engine/assets/weapon/WeaponSocketDetector.js", "sourceHash": "fbe8b094e5ae632d425e3f79a464052701f7ee9bb1a00ce56945f4bd2d9e5aea", "summary": "engine/assets/weapon/WeaponSocketDetector.js — find weapon sockets + moving parts by NAME (priority-ordered patterns) and resolve the forward/aim axis + muzzle by geometry (a firearm is long along the barrel; the muzzle is the front-most node along that axis). Hints + confidence; ambiguous → editor. GAME ABSTRACTION ONLY — no real-firearm dimensions or ballistics here.", "exports": [ { "name": "detectWeapon", "kind": "function", "signature": "detectWeapon(model)", "summary": "Detect weapon sockets, moving parts, forward axis, and muzzle." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/weapon/WeaponStateMachine", "path": "engine/reference/assets/weapon/WeaponStateMachine.md", "source": "engine/assets/weapon/WeaponStateMachine.js", "import": "/engine/assets/weapon/WeaponStateMachine.js", "sourceHash": "7dab2b294914eaedd3b9ca3be42f82e58f0f36bd5d6fd0cfbd205ac8b2754c1e", "summary": "engine/assets/weapon/WeaponStateMachine.js — a small, deterministic weapon state machine: idle ⇄ firing ⇄ empty, with reloading. It models a magazine + a chambered round (total = ammo + chambered) and auto-cycles a fresh round after each shot, so dry-fire, last-round, and reload-from-empty all behave correctly. GAME ABSTRACTION ONLY — no real-firearm mechanism is modelled.", "exports": [ { "name": "createWeaponStateMachine", "kind": "function", "signature": "createWeaponStateMachine(init = {})", "summary": "" }, { "name": "WEAPON_STATE", "kind": "constant", "signature": "WEAPON_STATE", "summary": "" }, { "name": "WEAPON_INPUT", "kind": "constant", "signature": "WEAPON_INPUT", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "assets/weapon/WeaponTimeline", "path": "engine/reference/assets/weapon/WeaponTimeline.md", "source": "engine/assets/weapon/WeaponTimeline.js", "import": "/engine/assets/weapon/WeaponTimeline.js", "sourceHash": "2899e4d083d03a272dce26c7759d17305eaf80e81b0fa63b4a0dcc368fcd9902", "summary": "engine/assets/weapon/WeaponTimeline.js — keyframed event tracks for weapon actions (fire, reload). An action is an ordered list of { t, type, payload } events over a duration; `eventsBetween` returns events crossed in a time step so the host fires them exactly once (deterministic, frame-rate independent). GAME ABSTRACTION — timings are gameplay anchors, not real mechanisms.", "exports": [ { "name": "createWeaponAction", "kind": "function", "signature": "createWeaponAction(init = {})", "summary": "Create a single action timeline (e.g. one shot, or a reload)." }, { "name": "defaultFireAction", "kind": "function", "signature": "defaultFireAction(duration = 0.12)", "summary": "A default semi-auto fire action (normalized 0..duration seconds)." }, { "name": "defaultReloadAction", "kind": "function", "signature": "defaultReloadAction(duration = 2.0)", "summary": "A default reload action." }, { "name": "eventsBetween", "kind": "function", "signature": "eventsBetween(action, t0, t1)", "summary": "Events whose time t lies in (t0, t1]. Use with an advancing playhead so each event fires exactly once regardless of frame rate." }, { "name": "createTimelinePlayer", "kind": "function", "signature": "createTimelinePlayer(action)", "summary": "A small play-once cursor over an action." }, { "name": "WEAPON_EVENT", "kind": "constant", "signature": "WEAPON_EVENT", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/SpatialAudioEnvironment", "path": "engine/reference/audio/SpatialAudioEnvironment.md", "source": "engine/audio/SpatialAudioEnvironment.js", "import": "/engine/audio/SpatialAudioEnvironment.js", "sourceHash": "9d17ad3179968712a771f5e4b29bd6020940bc5e7a9fc9b4b82e86c01c8536fa", "summary": "SpatialAudioEnvironment.js - Advanced Spatial Audio Processing Industry-grade environment audio: material absorption, ground reflection, environment zones (underwater/cave/outdoor), diffraction, and dynamic reverb. Research basis: - FMOD/Wwise material absorption coefficients (ISO 354 standard) - Image-source method for early reflections (Allen & Berkley 1979) - Underwater acoustics: 300Hz LPF + extended reverb (Wikipedia/Navy research) - Diffraction: UTD edge diffraction approximation (Kouyoumjian & Pathak 1974) - Ground reflection: single-bounce mirror source below floor plane All processing uses Web Audio API nodes (BiquadFilter, Gain, Delay, Convolver). Zero external dependencies.", "exports": [ { "name": "createSpatialEnvironment", "kind": "function", "signature": "createSpatialEnvironment(ctx, config = {})", "summary": "Create the spatial audio environment system. Attaches to an existing AudioContext and provides environment processing." }, { "name": "setEnvironmentRaycast", "kind": "function", "signature": "setEnvironmentRaycast(env, fn)", "summary": "Set the raycast function for environment probing. Function signature: (origin: [x,y,z], direction: [x,y,z], maxDist: number) => { hit, distance, position, normal, entityId } | null" }, { "name": "setEntityMaterialLookup", "kind": "function", "signature": "setEntityMaterialLookup(env, fn)", "summary": "Set the entity material lookup function. Function signature: (entityId) => 'stone' | 'wood' | 'metal' | etc." }, { "name": "setWaterSurfaceY", "kind": "function", "signature": "setWaterSurfaceY(env, y)", "summary": "Set the water surface Y level. Listener below this = underwater. Pass null to disable underwater detection." }, { "name": "updateEnvironment", "kind": "function", "signature": "updateEnvironment(env, listenerPos, listenerFwd)", "summary": "Update the environment system each frame. Detects environment zone, updates ground reflection, handles underwater." }, { "name": "computeOcclusion", "kind": "function", "signature": "computeOcclusion(env, srcPos)", "summary": "Compute material-aware occlusion between a source and the listener. Returns { factor: 0-1, lpfMult: 0-1 } where factor affects volume, lpfMult affects high-frequency content (material filtering)." }, { "name": "computeDiffraction", "kind": "function", "signature": "computeDiffraction(env, srcPos)", "summary": "Compute diffraction factor for partially occluded sources. Casts multiple rays slightly offset from the direct path. If some rays get through, the sound is partially diffracted (not fully blocked)." }, { "name": "computeFullOcclusion", "kind": "function", "signature": "computeFullOcclusion(env, srcPos)", "summary": "Compute full spatial occlusion for a sound source. Combines material-based occlusion with edge diffraction. Returns 0-1 where 0 = fully blocked, 1 = clear." }, { "name": "getEnvironmentIR", "kind": "function", "signature": "getEnvironmentIR(env, zoneName)", "summary": "Generate a procedural impulse response for a given environment. Cached per environment to avoid regeneration." }, { "name": "connectToBridge", "kind": "function", "signature": "connectToBridge(env, bridge)", "summary": "Connect the environment system's master filters into the audio bridge's output chain. Call once after both bridge and environment are created. Inserts: bridge.masterGain → env.masterHPF → env.masterLPF → ctx.destination Also connects ground reflection send from bridge.compressor." }, { "name": "getMaterialAbsorption", "kind": "function", "signature": "getMaterialAbsorption(materialKey)", "summary": "Get absorption data for a material key." }, { "name": "getEnvironmentPresets", "kind": "function", "signature": "getEnvironmentPresets()", "summary": "Get all available environment presets." }, { "name": "forceEnvironmentZone", "kind": "function", "signature": "forceEnvironmentZone(env, zoneName)", "summary": "Force a specific environment zone (overrides auto-detection). Pass null to re-enable auto-detection." }, { "name": "getEnvironmentStats", "kind": "function", "signature": "getEnvironmentStats(env)", "summary": "Get current environment stats." }, { "name": "destroySpatialEnvironment", "kind": "function", "signature": "destroySpatialEnvironment(env)", "summary": "Destroy the environment system and release all audio nodes." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/bridge/CharacterAudioBridge", "path": "engine/reference/audio/bridge/CharacterAudioBridge.md", "source": "engine/audio/bridge/CharacterAudioBridge.js", "import": "/engine/audio/bridge/CharacterAudioBridge.js", "sourceHash": "faeb41ced2018fdc8cd0190e0a117d84bb57b8501253a09408ed4541de7ac0a7", "summary": "CharacterAudioBridge.js - Character Movement → Audio Events Triggers footsteps, jumps, lands, and body foley based on character movement state (velocity, grounded, etc).", "exports": [ { "name": "createCharacterAudioBridge", "kind": "function", "signature": "createCharacterAudioBridge(config = {})", "summary": "Create a character movement audio bridge." }, { "name": "tickCharacterAudio", "kind": "function", "signature": "tickCharacterAudio(bridge, audioEngine, entityId, state, dt)", "summary": "Tick the character audio bridge for a single character. Call once per frame per character entity." }, { "name": "removeCharacter", "kind": "function", "signature": "removeCharacter(bridge, entityId)", "summary": "Clean up character state when entity is destroyed." }, { "name": "destroyCharacterAudioBridge", "kind": "function", "signature": "destroyCharacterAudioBridge(bridge)", "summary": "Destroy the character audio bridge and clean up all state." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/bridge/DestructionAudioBridge", "path": "engine/reference/audio/bridge/DestructionAudioBridge.md", "source": "engine/audio/bridge/DestructionAudioBridge.js", "import": "/engine/audio/bridge/DestructionAudioBridge.js", "sourceHash": "6b537bf9e7f8068842094c2b507970b3786d72a65150c66d997bb7c0ebfc16c8", "summary": "DestructionAudioBridge.js - Destruction Events → Audio Hooks into VoronoiFracture, UnifiedDamageSystem, SeismicSystem, and ShockPropagation to trigger shattering, crumbling, rumble, and explosion sounds.", "exports": [ { "name": "createDestructionAudioBridge", "kind": "function", "signature": "createDestructionAudioBridge(config = {})", "summary": "Create a destruction audio bridge." }, { "name": "processDamageAudioEvent", "kind": "function", "signature": "processDamageAudioEvent(bridge, event, currentTime)", "summary": "Process a damage event." }, { "name": "processFractureAudioEvent", "kind": "function", "signature": "processFractureAudioEvent(bridge, event, currentTime)", "summary": "Process a fracture event (Voronoi fracture)." }, { "name": "processSeismicAudioEvent", "kind": "function", "signature": "processSeismicAudioEvent(bridge, event, currentTime)", "summary": "Process a seismic event (earthquake rumble)." }, { "name": "flushDestructionAudio", "kind": "function", "signature": "flushDestructionAudio(bridge)", "summary": "Flush pending destruction audio events." }, { "name": "setDestructionAudioListenerPos", "kind": "function", "signature": "setDestructionAudioListenerPos(bridge, pos)", "summary": "Update listener position." }, { "name": "destroyDestructionAudioBridge", "kind": "function", "signature": "destroyDestructionAudioBridge(bridge)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/bridge/EmitterAmbientBridge", "path": "engine/reference/audio/bridge/EmitterAmbientBridge.md", "source": "engine/audio/bridge/EmitterAmbientBridge.js", "import": "/engine/audio/bridge/EmitterAmbientBridge.js", "sourceHash": "f87cc0433101804b597cb6e28e01d5620b415026904dcfb6cb3162ffdf4c6668", "summary": "EmitterAmbientBridge.js - Active Emitters → Continuous Ambient Loops When a substance emitter is active and has an ambientLoop defined, this bridge manages a looping spatial audio source at the emitter position. Sources are created when emitters start and removed when they stop.", "exports": [ { "name": "createEmitterAmbientBridge", "kind": "function", "signature": "createEmitterAmbientBridge(config = {})", "summary": "Create an emitter ambient bridge." }, { "name": "syncEmitterAmbients", "kind": "function", "signature": "syncEmitterAmbients(bridge, emitters)", "summary": "Sync active emitters with ambient audio loops. Call each frame with the current list of active emitters." }, { "name": "registerEmitterLoop", "kind": "function", "signature": "registerEmitterLoop(bridge, emitterId, sourceId, substanceId, position)", "summary": "Register that a loop was started (store sourceId)." }, { "name": "stopAllEmitterAmbients", "kind": "function", "signature": "stopAllEmitterAmbients(bridge)", "summary": "Stop all active ambient loops." }, { "name": "destroyEmitterAmbientBridge", "kind": "function", "signature": "destroyEmitterAmbientBridge(bridge)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/bridge/FluidAudioBridge", "path": "engine/reference/audio/bridge/FluidAudioBridge.md", "source": "engine/audio/bridge/FluidAudioBridge.js", "import": "/engine/audio/bridge/FluidAudioBridge.js", "sourceHash": "26cfc36459e286d87f27857e771f93a162b4872968f13bcfa1cd9cc9fa3d1aca", "summary": "FluidAudioBridge.js - Fluid Events → Audio Hooks into fluid simulation (splashes, phase changes) and triggers appropriate audio events.", "exports": [ { "name": "createFluidAudioBridge", "kind": "function", "signature": "createFluidAudioBridge(config = {})", "summary": "Create a fluid audio bridge." }, { "name": "processFluidSplash", "kind": "function", "signature": "processFluidSplash(bridge, position, magnitude, currentTime)", "summary": "Process a fluid splash event." }, { "name": "processPhaseChangeAudio", "kind": "function", "signature": "processPhaseChangeAudio(bridge, phaseType, position, magnitude, currentTime)", "summary": "Process a phase change event." }, { "name": "flushFluidAudio", "kind": "function", "signature": "flushFluidAudio(bridge)", "summary": "Flush pending fluid audio events." }, { "name": "setFluidAudioListenerPos", "kind": "function", "signature": "setFluidAudioListenerPos(bridge, pos)", "summary": "Update listener position." }, { "name": "destroyFluidAudioBridge", "kind": "function", "signature": "destroyFluidAudioBridge(bridge)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/bridge/PhysicsAudioBridge", "path": "engine/reference/audio/bridge/PhysicsAudioBridge.md", "source": "engine/audio/bridge/PhysicsAudioBridge.js", "import": "/engine/audio/bridge/PhysicsAudioBridge.js", "sourceHash": "735e1df8d20e76dd61f54d2759e1032a42c8cf70b78cc806b80ce3efb1bcb71e", "summary": "PhysicsAudioBridge.js - Physics Collision → Audio Events Hooks into physics contact callbacks (PhysX/PBD) and triggers material-aware impact sounds via the AudioEngine.", "exports": [ { "name": "createPhysicsAudioBridge", "kind": "function", "signature": "createPhysicsAudioBridge(config = {})", "summary": "Create a physics audio bridge." }, { "name": "processPhysicsContact", "kind": "function", "signature": "processPhysicsContact(bridge, contact, currentTime)", "summary": "Process a physics contact event." }, { "name": "flushPhysicsAudio", "kind": "function", "signature": "flushPhysicsAudio(bridge)", "summary": "Flush pending physics audio events." }, { "name": "setPhysicsAudioListenerPos", "kind": "function", "signature": "setPhysicsAudioListenerPos(bridge, pos)", "summary": "Update listener position." }, { "name": "destroyPhysicsAudioBridge", "kind": "function", "signature": "destroyPhysicsAudioBridge(bridge)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/bridge/SpellAudioBridge", "path": "engine/reference/audio/bridge/SpellAudioBridge.md", "source": "engine/audio/bridge/SpellAudioBridge.js", "import": "/engine/audio/bridge/SpellAudioBridge.js", "sourceHash": "80dd6a4fec88ec956e67f9252b14ee662f354f8576bbc91e38f34c78605900db", "summary": "SpellAudioBridge.js - Spell Cast → Audio Events Resolves soundHint strings from SpellGenerator and SpellElementMixer into AudioEngine trigger calls.", "exports": [ { "name": "createSpellAudioBridge", "kind": "function", "signature": "createSpellAudioBridge(config = {})", "summary": "Create a spell audio bridge." }, { "name": "buildSpellAudioTrigger", "kind": "function", "signature": "buildSpellAudioTrigger(bridge, spell, position, currentTime)", "summary": "Build audio trigger config from a spell cast." }, { "name": "buildSoundHintTrigger", "kind": "function", "signature": "buildSoundHintTrigger(bridge, soundHint, position, currentTime)", "summary": "Build audio trigger from a raw soundHint string." }, { "name": "destroySpellAudioBridge", "kind": "function", "signature": "destroySpellAudioBridge(bridge)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/bridge/SubstanceAudioResolver", "path": "engine/reference/audio/bridge/SubstanceAudioResolver.md", "source": "engine/audio/bridge/SubstanceAudioResolver.js", "import": "/engine/audio/bridge/SubstanceAudioResolver.js", "sourceHash": "fc713974b4cee46b4a5db9312cca40eba034b2de50c983132b920a70cbcfd5ef", "summary": "SubstanceAudioResolver.js - Resolve substance key → audio config Maps substance IDs to audio event configurations, supporting both sample-based fallback and procedural patch references.", "exports": [ { "name": "resolveSubstanceAudio", "kind": "function", "signature": "resolveSubstanceAudio(substanceId)", "summary": "Resolve a substance key to its audio configuration." }, { "name": "getSubstanceImpactSound", "kind": "function", "signature": "getSubstanceImpactSound(substanceId)", "summary": "Get the impact sound event ID for a substance." }, { "name": "getSubstanceAmbientLoop", "kind": "function", "signature": "getSubstanceAmbientLoop(substanceId)", "summary": "Get the ambient loop event ID for a substance." }, { "name": "getSubstanceCollisionSound", "kind": "function", "signature": "getSubstanceCollisionSound(substanceId)", "summary": "Get the collision sound event ID for a substance." }, { "name": "getSubstanceProceduralPatch", "kind": "function", "signature": "getSubstanceProceduralPatch(substanceId)", "summary": "Get procedural patch ID for a substance (if defined)." }, { "name": "getSubstanceParamMap", "kind": "function", "signature": "getSubstanceParamMap(substanceId)", "summary": "Get parameter mapping for procedural synthesis. Maps emitter params → synth params." }, { "name": "getSubstanceAudioDefaults", "kind": "function", "signature": "getSubstanceAudioDefaults(substanceId)", "summary": "Get normalized default procedural params for a substance." }, { "name": "applySubstanceParamMap", "kind": "function", "signature": "applySubstanceParamMap(substanceId, params = {}, mapOverrides = null)", "summary": "Apply a substance paramMap to source params. Supports runtime map override keys: _map__scale / _map__offset." }, { "name": "buildSubstancePreviewParams", "kind": "function", "signature": "buildSubstancePreviewParams(substanceId, overrides = {}, sourceParams = {})", "summary": "Build preview/runtime-friendly patch params with shared defaults + paramMap transform." }, { "name": "buildSubstanceTriggerConfig", "kind": "function", "signature": "buildSubstanceTriggerConfig(substanceId, eventType, params = {})", "summary": "Build a complete audio trigger config from substance + event params." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/bridge/WeatherAudioBridge", "path": "engine/reference/audio/bridge/WeatherAudioBridge.md", "source": "engine/audio/bridge/WeatherAudioBridge.js", "import": "/engine/audio/bridge/WeatherAudioBridge.js", "sourceHash": "783378b26ae984f3d69b7267cca1273be421eac7a0a985b89396c60a698bbab0", "summary": "WeatherAudioBridge.js - Weather/Time → Ambient Audio Crossfades ambient audio loops based on WorldTime day/night cycle, seasons, and weather conditions.", "exports": [ { "name": "createWeatherAudioBridge", "kind": "function", "signature": "createWeatherAudioBridge(config = {})", "summary": "Create a weather audio bridge." }, { "name": "tickWeatherAudio", "kind": "function", "signature": "tickWeatherAudio(bridge, worldTime, weather, currentTime)", "summary": "Tick weather audio — check time of day and weather, crossfade ambients." }, { "name": "destroyWeatherAudioBridge", "kind": "function", "signature": "destroyWeatherAudioBridge(bridge)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/bridge/index", "path": "engine/reference/audio/bridge/index.md", "source": "engine/audio/bridge/index.js", "import": "/engine/audio/bridge/index.js", "sourceHash": "43a17939bffb0af449fd66b5484939e7b89405a2169c18056798e694bad806c1", "summary": "engine/audio/bridge/index.js — Barrel export for audio bridges.", "exports": [ { "name": "buildSoundHintTrigger", "kind": "re-export", "signature": "buildSoundHintTrigger", "summary": "" }, { "name": "buildSpellAudioTrigger", "kind": "re-export", "signature": "buildSpellAudioTrigger", "summary": "" }, { "name": "buildSubstanceTriggerConfig", "kind": "re-export", "signature": "buildSubstanceTriggerConfig", "summary": "" }, { "name": "createCharacterAudioBridge", "kind": "re-export", "signature": "createCharacterAudioBridge", "summary": "" }, { "name": "createDestructionAudioBridge", "kind": "re-export", "signature": "createDestructionAudioBridge", "summary": "" }, { "name": "createEmitterAmbientBridge", "kind": "re-export", "signature": "createEmitterAmbientBridge", "summary": "" }, { "name": "createFluidAudioBridge", "kind": "re-export", "signature": "createFluidAudioBridge", "summary": "" }, { "name": "createPhysicsAudioBridge", "kind": "re-export", "signature": "createPhysicsAudioBridge", "summary": "" }, { "name": "createSpellAudioBridge", "kind": "re-export", "signature": "createSpellAudioBridge", "summary": "" }, { "name": "createWeatherAudioBridge", "kind": "re-export", "signature": "createWeatherAudioBridge", "summary": "" }, { "name": "destroyCharacterAudioBridge", "kind": "re-export", "signature": "destroyCharacterAudioBridge", "summary": "" }, { "name": "destroyDestructionAudioBridge", "kind": "re-export", "signature": "destroyDestructionAudioBridge", "summary": "" }, { "name": "destroyEmitterAmbientBridge", "kind": "re-export", "signature": "destroyEmitterAmbientBridge", "summary": "" }, { "name": "destroyFluidAudioBridge", "kind": "re-export", "signature": "destroyFluidAudioBridge", "summary": "" }, { "name": "destroyPhysicsAudioBridge", "kind": "re-export", "signature": "destroyPhysicsAudioBridge", "summary": "" }, { "name": "destroySpellAudioBridge", "kind": "re-export", "signature": "destroySpellAudioBridge", "summary": "" }, { "name": "destroyWeatherAudioBridge", "kind": "re-export", "signature": "destroyWeatherAudioBridge", "summary": "" }, { "name": "flushDestructionAudio", "kind": "re-export", "signature": "flushDestructionAudio", "summary": "" }, { "name": "flushFluidAudio", "kind": "re-export", "signature": "flushFluidAudio", "summary": "" }, { "name": "flushPhysicsAudio", "kind": "re-export", "signature": "flushPhysicsAudio", "summary": "" }, { "name": "getSubstanceAmbientLoop", "kind": "re-export", "signature": "getSubstanceAmbientLoop", "summary": "" }, { "name": "getSubstanceCollisionSound", "kind": "re-export", "signature": "getSubstanceCollisionSound", "summary": "" }, { "name": "getSubstanceImpactSound", "kind": "re-export", "signature": "getSubstanceImpactSound", "summary": "" }, { "name": "getSubstanceParamMap", "kind": "re-export", "signature": "getSubstanceParamMap", "summary": "" }, { "name": "getSubstanceProceduralPatch", "kind": "re-export", "signature": "getSubstanceProceduralPatch", "summary": "" }, { "name": "processDamageAudioEvent", "kind": "re-export", "signature": "processDamageAudioEvent", "summary": "" }, { "name": "processFluidSplash", "kind": "re-export", "signature": "processFluidSplash", "summary": "" }, { "name": "processFractureAudioEvent", "kind": "re-export", "signature": "processFractureAudioEvent", "summary": "" }, { "name": "processPhaseChangeAudio", "kind": "re-export", "signature": "processPhaseChangeAudio", "summary": "" }, { "name": "processPhysicsContact", "kind": "re-export", "signature": "processPhysicsContact", "summary": "" }, { "name": "processSeismicAudioEvent", "kind": "re-export", "signature": "processSeismicAudioEvent", "summary": "" }, { "name": "registerEmitterLoop", "kind": "re-export", "signature": "registerEmitterLoop", "summary": "" }, { "name": "removeCharacter", "kind": "re-export", "signature": "removeCharacter", "summary": "" }, { "name": "resolveSubstanceAudio", "kind": "re-export", "signature": "resolveSubstanceAudio", "summary": "" }, { "name": "setDestructionAudioListenerPos", "kind": "re-export", "signature": "setDestructionAudioListenerPos", "summary": "" }, { "name": "setFluidAudioListenerPos", "kind": "re-export", "signature": "setFluidAudioListenerPos", "summary": "" }, { "name": "setPhysicsAudioListenerPos", "kind": "re-export", "signature": "setPhysicsAudioListenerPos", "summary": "" }, { "name": "stopAllEmitterAmbients", "kind": "re-export", "signature": "stopAllEmitterAmbients", "summary": "" }, { "name": "syncEmitterAmbients", "kind": "re-export", "signature": "syncEmitterAmbients", "summary": "" }, { "name": "tickCharacterAudio", "kind": "re-export", "signature": "tickCharacterAudio", "summary": "" }, { "name": "tickWeatherAudio", "kind": "re-export", "signature": "tickWeatherAudio", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/core/AudioAssetManager", "path": "engine/reference/audio/core/AudioAssetManager.md", "source": "engine/audio/core/AudioAssetManager.js", "import": "/engine/audio/core/AudioAssetManager.js", "sourceHash": "38fe6ee6917396b3ee8e0094a5f25c8015372af52da3e9205347d3387c83fc0a", "summary": "AudioAssetManager.js - Audio Asset Loading & Caching Fetches, decodes, and caches AudioBuffers. Supports pooling and streaming for large files (music).", "exports": [ { "name": "createAudioAssetManager", "kind": "function", "signature": "createAudioAssetManager(context)", "summary": "Create an audio asset manager." }, { "name": "loadAudioAsset", "kind": "function", "signature": "async loadAudioAsset(manager, path)", "summary": "Load and decode an audio file. Returns cached buffer if already loaded." }, { "name": "preloadAudioAssets", "kind": "function", "signature": "async preloadAudioAssets(manager, paths)", "summary": "Preload multiple audio assets." }, { "name": "registerAudioBuffer", "kind": "function", "signature": "registerAudioBuffer(manager, path, buffer)", "summary": "Register a pre-decoded AudioBuffer directly." }, { "name": "getAudioBuffer", "kind": "function", "signature": "getAudioBuffer(manager, path)", "summary": "Get a cached buffer (synchronous)." }, { "name": "hasAudioBuffer", "kind": "function", "signature": "hasAudioBuffer(manager, path)", "summary": "Check if a buffer is cached." }, { "name": "unloadAudioAsset", "kind": "function", "signature": "unloadAudioAsset(manager, path)", "summary": "Remove a cached buffer." }, { "name": "clearAudioCache", "kind": "function", "signature": "clearAudioCache(manager)", "summary": "Clear all cached buffers." }, { "name": "setAudioBaseUrl", "kind": "function", "signature": "setAudioBaseUrl(manager, url)", "summary": "Set base URL for relative asset paths." }, { "name": "destroyAudioAssetManager", "kind": "function", "signature": "destroyAudioAssetManager(manager)", "summary": "Destroy the asset manager and clear all caches." }, { "name": "_origCreate", "kind": "re-export", "signature": "_origCreate", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/core/AudioBus", "path": "engine/reference/audio/core/AudioBus.md", "source": "engine/audio/core/AudioBus.js", "import": "/engine/audio/core/AudioBus.js", "sourceHash": "a21f721057e287f7058767604cd58b05e396865461c4de6d239e68e0dc0a86b7", "summary": "AudioBus.js - Audio Category Bus A bus is a GainNode chain representing an audio category (sfx, music, ambient, voice, ui). Supports volume, mute, solo, and ducking (automatic volume reduction when another bus plays).", "exports": [ { "name": "createAudioBus", "kind": "function", "signature": "createAudioBus(context, destination, config = {})", "summary": "Create an audio bus." }, { "name": "setBusVolume", "kind": "function", "signature": "setBusVolume(bus, volume, currentTime)", "summary": "Set bus volume." }, { "name": "setBusMute", "kind": "function", "signature": "setBusMute(bus, muted)", "summary": "Mute/unmute the bus." }, { "name": "setBusDuck", "kind": "function", "signature": "setBusDuck(bus, amount)", "summary": "Set duck amount (used for automatic ducking, e.g. voice ducks music)." }, { "name": "getBusOutput", "kind": "function", "signature": "getBusOutput(bus)", "summary": "Get the bus's output node (for sources to connect to)." }, { "name": "destroyAudioBus", "kind": "function", "signature": "destroyAudioBus(bus)", "summary": "Destroy a bus and disconnect it." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/core/AudioConcurrency", "path": "engine/reference/audio/core/AudioConcurrency.md", "source": "engine/audio/core/AudioConcurrency.js", "import": "/engine/audio/core/AudioConcurrency.js", "sourceHash": "296812ede59c58d3a8aaae34f7780f32e2aec1662a387b1a81a3c45d1fa309c8", "summary": "AudioConcurrency.js - Voice Management & Stealing Manages the maximum number of concurrent voices. When the limit is reached, uses priority-based voice stealing (quietest, oldest, or farthest).", "exports": [ { "name": "createAudioConcurrency", "kind": "function", "signature": "createAudioConcurrency(config = {})", "summary": "Create a concurrency manager." }, { "name": "tickConcurrency", "kind": "function", "signature": "tickConcurrency(concurrency, activeSources, time)", "summary": "Tick concurrency — steal voices if over limit." }, { "name": "canAddVoice", "kind": "function", "signature": "canAddVoice(concurrency, activeSources, newPriority)", "summary": "Check if a new voice can be added, or which voice to steal." }, { "name": "destroyAudioConcurrency", "kind": "function", "signature": "destroyAudioConcurrency(concurrency)", "summary": "Destroy concurrency manager." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/core/AudioDoppler", "path": "engine/reference/audio/core/AudioDoppler.md", "source": "engine/audio/core/AudioDoppler.js", "import": "/engine/audio/core/AudioDoppler.js", "sourceHash": "3b6295268c33090d7148300099c326d5114797226a2df3d71475c16b0238126c", "summary": "AudioDoppler.js - Doppler Effect Manually computes pitch shift from radial velocity between source and listener. Web Audio's built-in Doppler was removed from the spec, so we implement it ourselves. Doppler ratio = (speedOfSound + listenerRadialVelocity) / (speedOfSound + sourceRadialVelocity)", "exports": [ { "name": "createAudioDoppler", "kind": "function", "signature": "createAudioDoppler(config = {})", "summary": "Create a Doppler processor." }, { "name": "tickDoppler", "kind": "function", "signature": "tickDoppler(doppler, activeSources, listenerPos, listenerVel)", "summary": "Tick Doppler — adjust pitch of all spatial sources based on relative velocity." }, { "name": "destroyAudioDoppler", "kind": "function", "signature": "destroyAudioDoppler(doppler)", "summary": "Destroy Doppler processor." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/core/AudioEngine", "path": "engine/reference/audio/core/AudioEngine.md", "source": "engine/audio/core/AudioEngine.js", "import": "/engine/audio/core/AudioEngine.js", "sourceHash": "0455e0b457e5b4d8678e4d24ca33b62fb14761f92dcb4e6d32f588c15a730661", "summary": "AudioEngine.js - Core Audio Engine Central audio system for the engine. Manages AudioContext lifecycle, master gain, tick loop, and coordinates all audio subsystems. Usage: const engine = createAudioEngine({ maxVoices: 64 }); await initAudioEngine(engine); // In main loop: tickAudioEngine(engine, dt); // Cleanup: destroyAudioEngine(engine);", "exports": [ { "name": "createAudioEngine", "kind": "function", "signature": "createAudioEngine(config = {})", "summary": "Create an audio engine instance." }, { "name": "initAudioEngine", "kind": "function", "signature": "async initAudioEngine(engine)", "summary": "Initialize the audio engine. Creates AudioContext and all subsystems. Must be called after a user gesture (click/tap) to comply with autoplay policy." }, { "name": "resumeAudioEngine", "kind": "function", "signature": "async resumeAudioEngine(engine)", "summary": "Ensure the AudioContext is resumed (call after user gesture)." }, { "name": "tickAudioEngine", "kind": "function", "signature": "tickAudioEngine(engine, dt)", "summary": "Tick the audio engine. Updates active sources, cleans up finished ones." }, { "name": "triggerAudioEvent", "kind": "function", "signature": "triggerAudioEvent(engine, eventId, options = {})", "summary": "Trigger an audio event by ID." }, { "name": "playSound", "kind": "function", "signature": "playSound(engine, eventId, options = {})", "summary": "Backward-compatible alias used by older bridge code." }, { "name": "playBuffer", "kind": "function", "signature": "playBuffer(engine, buffer, options = {})", "summary": "Play a buffer directly (bypasses event resolution)." }, { "name": "stopSource", "kind": "function", "signature": "stopSource(engine, sourceId, fadeOut = 0.05)", "summary": "Stop a specific source by ID." }, { "name": "stopAllSources", "kind": "function", "signature": "stopAllSources(engine, fadeOut = 0.1)", "summary": "Stop all active sources." }, { "name": "registerAudioEvent", "kind": "function", "signature": "registerAudioEvent(engine, eventId, descriptor)", "summary": "Register an audio event descriptor." }, { "name": "unregisterAudioEvent", "kind": "function", "signature": "unregisterAudioEvent(engine, eventId)", "summary": "Unregister an audio event." }, { "name": "setMasterVolume", "kind": "function", "signature": "setMasterVolume(engine, volume)", "summary": "Set master volume." }, { "name": "setBusVolumeByName", "kind": "function", "signature": "setBusVolumeByName(engine, busName, volume)", "summary": "Set volume for a specific bus." }, { "name": "destroyAudioEngine", "kind": "function", "signature": "destroyAudioEngine(engine)", "summary": "Destroy the audio engine and release all resources." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/core/AudioEvent", "path": "engine/reference/audio/core/AudioEvent.md", "source": "engine/audio/core/AudioEvent.js", "import": "/engine/audio/core/AudioEvent.js", "sourceHash": "18b63dee437451122e88de88571fd6309b803b71a51f3280e4ddacaf8c778fa9", "summary": "AudioEvent.js - Audio Event Descriptors Defines how audio events are resolved: one-shots, random containers, sequences, and loops. An event maps an ID to concrete playback params. Event descriptor format: { type: 'oneshot' | 'random' | 'sequence' | 'loop', sounds: ['path1.ogg', 'path2.ogg'], // Pool of sounds volume: [0.8, 1.0], // Random range or fixed value pitch: [0.9, 1.1], // Random range or fixed value bus: 'sfx', // Target bus priority: 0, // Voice stealing priority cooldown: 0, // Min seconds between triggers maxInstances: 0, // Max simultaneous (0 = unlimited) }", "exports": [ { "name": "resolveAudioEvent", "kind": "function", "signature": "resolveAudioEvent(event, eventId, options, time)", "summary": "Resolve an audio event descriptor to concrete play parameters." }, { "name": "createAudioEventDescriptor", "kind": "function", "signature": "createAudioEventDescriptor(config = {})", "summary": "Create an audio event descriptor." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/core/AudioListener", "path": "engine/reference/audio/core/AudioListener.md", "source": "engine/audio/core/AudioListener.js", "import": "/engine/audio/core/AudioListener.js", "sourceHash": "7d354373c91c1c5d7da4b316e5864eb6c3df65f741f4b77d08826e18144e6855", "summary": "AudioListener.js - 3D Audio Listener Wraps the Web Audio API AudioListener, syncing camera position, orientation, and velocity for accurate 3D spatialization.", "exports": [ { "name": "createAudioListener", "kind": "function", "signature": "createAudioListener(context)", "summary": "Create an audio listener wrapper." }, { "name": "updateAudioListener", "kind": "function", "signature": "updateAudioListener(listener, position, forward, up, dt)", "summary": "Update listener position, orientation, and velocity. Call once per frame with camera data." }, { "name": "getListenerPosition", "kind": "function", "signature": "getListenerPosition(listener)", "summary": "Get the listener's current position." }, { "name": "getListenerVelocity", "kind": "function", "signature": "getListenerVelocity(listener)", "summary": "Get the listener's current velocity." }, { "name": "destroyAudioListener", "kind": "function", "signature": "destroyAudioListener(listener)", "summary": "Destroy the listener wrapper." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/core/AudioOcclusion", "path": "engine/reference/audio/core/AudioOcclusion.md", "source": "engine/audio/core/AudioOcclusion.js", "import": "/engine/audio/core/AudioOcclusion.js", "sourceHash": "84e29371a45c10d42fd9f26529566765d4a0533a5ef94d97105c8a4bb94569fb", "summary": "AudioOcclusion.js - Sound Occlusion via Raycasting Casts a ray from each active source to the listener. If the ray intersects occluders (walls, objects), applies lowpass filter + volume attenuation to simulate sound being blocked/muffled. Uses simple AABB intersection for performance. Can be upgraded to use the engine's physics raycasts (PhysX/PBD) for higher fidelity.", "exports": [ { "name": "createAudioOcclusion", "kind": "function", "signature": "createAudioOcclusion(config = {})", "summary": "Create an occlusion system." }, { "name": "addOccluder", "kind": "function", "signature": "addOccluder(occlusion, min, max, transmission = 0.2)", "summary": "Add an AABB occluder." }, { "name": "removeOccluder", "kind": "function", "signature": "removeOccluder(occlusion, index)", "summary": "Remove an occluder by index." }, { "name": "clearOccluders", "kind": "function", "signature": "clearOccluders(occlusion)", "summary": "Clear all occluders." }, { "name": "tickOcclusion", "kind": "function", "signature": "tickOcclusion(occlusion, activeSources, listenerPos, context, dt)", "summary": "Tick occlusion: check sources against occluders and apply filters." }, { "name": "destroyAudioOcclusion", "kind": "function", "signature": "destroyAudioOcclusion(occlusion)", "summary": "Destroy occlusion system." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/core/AudioReverbZone", "path": "engine/reference/audio/core/AudioReverbZone.md", "source": "engine/audio/core/AudioReverbZone.js", "import": "/engine/audio/core/AudioReverbZone.js", "sourceHash": "6f50ecb4b37f0dfcd16df0fd38cbcff9ee6b356aff9d6613b109f8daff9d48da", "summary": "Create a reverb zone system.", "exports": [ { "name": "createReverbZoneSystem", "kind": "function", "signature": "createReverbZoneSystem(context, destination)", "summary": "Create a reverb zone system." }, { "name": "addReverbZone", "kind": "function", "signature": "addReverbZone(system, config = {})", "summary": "Add a reverb zone." }, { "name": "removeReverbZone", "kind": "function", "signature": "removeReverbZone(system, index)", "summary": "Remove a reverb zone." }, { "name": "tickReverbZones", "kind": "function", "signature": "tickReverbZones(system, listenerPos)", "summary": "Tick reverb zones — blend based on listener position." }, { "name": "connectSourceToReverb", "kind": "function", "signature": "connectSourceToReverb(system, source, sendLevel = 0.3)", "summary": "Connect a source to the reverb system's convolver (send)." }, { "name": "destroyReverbZoneSystem", "kind": "function", "signature": "destroyReverbZoneSystem(system)", "summary": "Destroy reverb zone system." }, { "name": "REVERB_PRESETS", "kind": "constant", "signature": "REVERB_PRESETS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/core/AudioSource", "path": "engine/reference/audio/core/AudioSource.md", "source": "engine/audio/core/AudioSource.js", "import": "/engine/audio/core/AudioSource.js", "sourceHash": "79f188697e20356be5026adeac4afc043613a60d6e2e201414b17f0d0825f7be", "summary": "AudioSource.js - 3D Sound Emitter Wraps a BufferSourceNode + PannerNode (HRTF) + GainNode chain. Represents a single playing sound in 3D space.", "exports": [ { "name": "createAudioSource", "kind": "function", "signature": "createAudioSource(context, config = {})", "summary": "Create and start an audio source." }, { "name": "tickAudioSource", "kind": "function", "signature": "tickAudioSource(source, dt)", "summary": "Tick a source (per-frame update)." }, { "name": "setSourcePosition", "kind": "function", "signature": "setSourcePosition(source, position)", "summary": "Update source 3D position explicitly." }, { "name": "setSourceVolume", "kind": "function", "signature": "setSourceVolume(source, volume)", "summary": "Set source volume." }, { "name": "setSourcePitch", "kind": "function", "signature": "setSourcePitch(source, pitch)", "summary": "Set source pitch/playback rate." }, { "name": "stopAudioSource", "kind": "function", "signature": "stopAudioSource(source, fadeOut = 0.05)", "summary": "Stop a source with optional fade-out." }, { "name": "isSourceDone", "kind": "function", "signature": "isSourceDone(source)", "summary": "Check if source is finished playing." }, { "name": "getSourceEffectiveVolume", "kind": "function", "signature": "getSourceEffectiveVolume(source)", "summary": "Get effective volume (volume × occlusion)." }, { "name": "destroyAudioSource", "kind": "function", "signature": "destroyAudioSource(source)", "summary": "Destroy a source and disconnect all nodes." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/core/FootstepEvents", "path": "engine/reference/audio/core/FootstepEvents.md", "source": "engine/audio/core/FootstepEvents.js", "import": "/engine/audio/core/FootstepEvents.js", "sourceHash": "7a955a1924b3bda009cc7120c0e483f056ae0202ebe0d74203c6390fb4ec5483", "summary": "FootstepEvents.js - Footstep Audio Event Registration Registers all footstep and land audio events with the AudioEngine. Called during engine initialization.", "exports": [ { "name": "registerFootstepEvents", "kind": "function", "signature": "registerFootstepEvents(audioEngine)", "summary": "Register all footstep audio events with the AudioEngine. Should be called once during engine initialization." }, { "name": "unregisterFootstepEvents", "kind": "function", "signature": "unregisterFootstepEvents(audioEngine)", "summary": "Unregister all footstep events (for cleanup)." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/core/FootstepMaterials", "path": "engine/reference/audio/core/FootstepMaterials.md", "source": "engine/audio/core/FootstepMaterials.js", "import": "/engine/audio/core/FootstepMaterials.js", "sourceHash": "279bc841de0f173a8cf65ed0929bf7706d2f8a5bdef2c2bfb5083573ebf8c0e9", "summary": "FootstepMaterials.js - Footstep Material Taxonomy & Mapping Defines acoustic materials for footsteps (distinct from physics materials) and provides mapping from physics/voxel materials to footstep materials.", "exports": [ { "name": "resolveFootstepMaterial", "kind": "function", "signature": "resolveFootstepMaterial(material)", "summary": "Resolve a physics material ID to a footstep material key." }, { "name": "getFootstepConfig", "kind": "function", "signature": "getFootstepConfig(materialKey)", "summary": "Get footstep material config." }, { "name": "getAllFootstepMaterials", "kind": "function", "signature": "getAllFootstepMaterials()", "summary": "Get all footstep material keys." }, { "name": "FOOTSTEP_MATERIALS", "kind": "constant", "signature": "FOOTSTEP_MATERIALS", "summary": "Footstep material configurations. Each defines the procedural patch to use and number of variants." }, { "name": "PHYSICS_TO_FOOTSTEP", "kind": "constant", "signature": "PHYSICS_TO_FOOTSTEP", "summary": "Map physics material IDs to footstep materials. Physics materials are from PhysicsAudioBridge.js MATERIAL_TO_SUBSTANCE." }, { "name": "VOXEL_TO_FOOTSTEP", "kind": "constant", "signature": "VOXEL_TO_FOOTSTEP", "summary": "Map voxel/terrain material strings to footstep materials. Used when querying terrain directly." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/core/index", "path": "engine/reference/audio/core/index.md", "source": "engine/audio/core/index.js", "import": "/engine/audio/core/index.js", "sourceHash": "cd7a0a62955a9370419f0dec2a1cd3e60cf904fe0d12698ff5906cb63157a11e", "summary": "engine/audio/core/index.js — Barrel export for core audio engine.", "exports": [ { "name": "FOOTSTEP_MATERIALS", "kind": "re-export", "signature": "FOOTSTEP_MATERIALS", "summary": "" }, { "name": "PHYSICS_TO_FOOTSTEP", "kind": "re-export", "signature": "PHYSICS_TO_FOOTSTEP", "summary": "" }, { "name": "REVERB_PRESETS", "kind": "re-export", "signature": "REVERB_PRESETS", "summary": "" }, { "name": "VOXEL_TO_FOOTSTEP", "kind": "re-export", "signature": "VOXEL_TO_FOOTSTEP", "summary": "" }, { "name": "addOccluder", "kind": "re-export", "signature": "addOccluder", "summary": "" }, { "name": "addReverbZone", "kind": "re-export", "signature": "addReverbZone", "summary": "" }, { "name": "canAddVoice", "kind": "re-export", "signature": "canAddVoice", "summary": "" }, { "name": "clearAudioCache", "kind": "re-export", "signature": "clearAudioCache", "summary": "" }, { "name": "clearOccluders", "kind": "re-export", "signature": "clearOccluders", "summary": "" }, { "name": "connectSourceToReverb", "kind": "re-export", "signature": "connectSourceToReverb", "summary": "" }, { "name": "createAudioAssetManager", "kind": "re-export", "signature": "createAudioAssetManager", "summary": "" }, { "name": "createAudioBus", "kind": "re-export", "signature": "createAudioBus", "summary": "" }, { "name": "createAudioConcurrency", "kind": "re-export", "signature": "createAudioConcurrency", "summary": "" }, { "name": "createAudioDoppler", "kind": "re-export", "signature": "createAudioDoppler", "summary": "" }, { "name": "createAudioEngine", "kind": "re-export", "signature": "createAudioEngine", "summary": "" }, { "name": "createAudioEventDescriptor", "kind": "re-export", "signature": "createAudioEventDescriptor", "summary": "" }, { "name": "createAudioListener", "kind": "re-export", "signature": "createAudioListener", "summary": "" }, { "name": "createAudioOcclusion", "kind": "re-export", "signature": "createAudioOcclusion", "summary": "" }, { "name": "createAudioSource", "kind": "re-export", "signature": "createAudioSource", "summary": "" }, { "name": "createReverbZoneSystem", "kind": "re-export", "signature": "createReverbZoneSystem", "summary": "" }, { "name": "destroyAudioAssetManager", "kind": "re-export", "signature": "destroyAudioAssetManager", "summary": "" }, { "name": "destroyAudioBus", "kind": "re-export", "signature": "destroyAudioBus", "summary": "" }, { "name": "destroyAudioConcurrency", "kind": "re-export", "signature": "destroyAudioConcurrency", "summary": "" }, { "name": "destroyAudioDoppler", "kind": "re-export", "signature": "destroyAudioDoppler", "summary": "" }, { "name": "destroyAudioEngine", "kind": "re-export", "signature": "destroyAudioEngine", "summary": "" }, { "name": "destroyAudioListener", "kind": "re-export", "signature": "destroyAudioListener", "summary": "" }, { "name": "destroyAudioOcclusion", "kind": "re-export", "signature": "destroyAudioOcclusion", "summary": "" }, { "name": "destroyAudioSource", "kind": "re-export", "signature": "destroyAudioSource", "summary": "" }, { "name": "destroyReverbZoneSystem", "kind": "re-export", "signature": "destroyReverbZoneSystem", "summary": "" }, { "name": "getAllFootstepMaterials", "kind": "re-export", "signature": "getAllFootstepMaterials", "summary": "" }, { "name": "getAudioBuffer", "kind": "re-export", "signature": "getAudioBuffer", "summary": "" }, { "name": "getBusOutput", "kind": "re-export", "signature": "getBusOutput", "summary": "" }, { "name": "getFootstepConfig", "kind": "re-export", "signature": "getFootstepConfig", "summary": "" }, { "name": "getListenerPosition", "kind": "re-export", "signature": "getListenerPosition", "summary": "" }, { "name": "getListenerVelocity", "kind": "re-export", "signature": "getListenerVelocity", "summary": "" }, { "name": "getSourceEffectiveVolume", "kind": "re-export", "signature": "getSourceEffectiveVolume", "summary": "" }, { "name": "hasAudioBuffer", "kind": "re-export", "signature": "hasAudioBuffer", "summary": "" }, { "name": "initAudioEngine", "kind": "re-export", "signature": "initAudioEngine", "summary": "" }, { "name": "isSourceDone", "kind": "re-export", "signature": "isSourceDone", "summary": "" }, { "name": "loadAudioAsset", "kind": "re-export", "signature": "loadAudioAsset", "summary": "" }, { "name": "playBuffer", "kind": "re-export", "signature": "playBuffer", "summary": "" }, { "name": "playSound", "kind": "re-export", "signature": "playSound", "summary": "" }, { "name": "preloadAudioAssets", "kind": "re-export", "signature": "preloadAudioAssets", "summary": "" }, { "name": "registerAudioBuffer", "kind": "re-export", "signature": "registerAudioBuffer", "summary": "" }, { "name": "registerAudioEvent", "kind": "re-export", "signature": "registerAudioEvent", "summary": "" }, { "name": "registerFootstepEvents", "kind": "re-export", "signature": "registerFootstepEvents", "summary": "" }, { "name": "removeOccluder", "kind": "re-export", "signature": "removeOccluder", "summary": "" }, { "name": "removeReverbZone", "kind": "re-export", "signature": "removeReverbZone", "summary": "" }, { "name": "resolveAudioEvent", "kind": "re-export", "signature": "resolveAudioEvent", "summary": "" }, { "name": "resolveFootstepMaterial", "kind": "re-export", "signature": "resolveFootstepMaterial", "summary": "" }, { "name": "resumeAudioEngine", "kind": "re-export", "signature": "resumeAudioEngine", "summary": "" }, { "name": "setAudioBaseUrl", "kind": "re-export", "signature": "setAudioBaseUrl", "summary": "" }, { "name": "setBusDuck", "kind": "re-export", "signature": "setBusDuck", "summary": "" }, { "name": "setBusMute", "kind": "re-export", "signature": "setBusMute", "summary": "" }, { "name": "setBusVolume", "kind": "re-export", "signature": "setBusVolume", "summary": "" }, { "name": "setBusVolumeByName", "kind": "re-export", "signature": "setBusVolumeByName", "summary": "" }, { "name": "setMasterVolume", "kind": "re-export", "signature": "setMasterVolume", "summary": "" }, { "name": "setSourcePitch", "kind": "re-export", "signature": "setSourcePitch", "summary": "" }, { "name": "setSourcePosition", "kind": "re-export", "signature": "setSourcePosition", "summary": "" }, { "name": "setSourceVolume", "kind": "re-export", "signature": "setSourceVolume", "summary": "" }, { "name": "stopAllSources", "kind": "re-export", "signature": "stopAllSources", "summary": "" }, { "name": "stopAudioSource", "kind": "re-export", "signature": "stopAudioSource", "summary": "" }, { "name": "stopSource", "kind": "re-export", "signature": "stopSource", "summary": "" }, { "name": "tickAudioEngine", "kind": "re-export", "signature": "tickAudioEngine", "summary": "" }, { "name": "tickAudioSource", "kind": "re-export", "signature": "tickAudioSource", "summary": "" }, { "name": "tickConcurrency", "kind": "re-export", "signature": "tickConcurrency", "summary": "" }, { "name": "tickDoppler", "kind": "re-export", "signature": "tickDoppler", "summary": "" }, { "name": "tickOcclusion", "kind": "re-export", "signature": "tickOcclusion", "summary": "" }, { "name": "tickReverbZones", "kind": "re-export", "signature": "tickReverbZones", "summary": "" }, { "name": "triggerAudioEvent", "kind": "re-export", "signature": "triggerAudioEvent", "summary": "" }, { "name": "unloadAudioAsset", "kind": "re-export", "signature": "unloadAudioAsset", "summary": "" }, { "name": "unregisterAudioEvent", "kind": "re-export", "signature": "unregisterAudioEvent", "summary": "" }, { "name": "unregisterFootstepEvents", "kind": "re-export", "signature": "unregisterFootstepEvents", "summary": "" }, { "name": "updateAudioListener", "kind": "re-export", "signature": "updateAudioListener", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/index", "path": "engine/reference/audio/index.md", "source": "engine/audio/index.js", "import": "/engine/audio/index.js", "sourceHash": "3a9da152ea1a90b39ef4fcf78e0de55f830d2d6d67b7f46f8223fbf3ba0d0080", "summary": "engine/audio/index.js — Top-level barrel export for the complete audio system. Exports: Core engine, Spatial pipeline, Bridges, Synth kernel, Sound atoms, Physics models.", "exports": [ { "name": "MAX_EMITTERS", "kind": "re-export", "signature": "MAX_EMITTERS", "summary": "" }, { "name": "PARAMS_PER_EMITTER", "kind": "re-export", "signature": "PARAMS_PER_EMITTER", "summary": "" }, { "name": "PARAM_LAYOUT", "kind": "re-export", "signature": "PARAM_LAYOUT", "summary": "" }, { "name": "TOTAL_FLOAT_COUNT", "kind": "re-export", "signature": "TOTAL_FLOAT_COUNT", "summary": "" }, { "name": "clearAllEmitterStats", "kind": "re-export", "signature": "clearAllEmitterStats", "summary": "" }, { "name": "clearEmitterStats", "kind": "re-export", "signature": "clearEmitterStats", "summary": "" }, { "name": "createCombustionPatch", "kind": "re-export", "signature": "createCombustionPatch", "summary": "" }, { "name": "createCrackleAtomPatch", "kind": "re-export", "signature": "createCrackleAtomPatch", "summary": "" }, { "name": "createDropAtomPatch", "kind": "re-export", "signature": "createDropAtomPatch", "summary": "" }, { "name": "createFluidPatch", "kind": "re-export", "signature": "createFluidPatch", "summary": "" }, { "name": "createHissAtomPatch", "kind": "re-export", "signature": "createHissAtomPatch", "summary": "" }, { "name": "createModalImpactPatch", "kind": "re-export", "signature": "createModalImpactPatch", "summary": "" }, { "name": "createRumbleAtomPatch", "kind": "re-export", "signature": "createRumbleAtomPatch", "summary": "" }, { "name": "createSharedParamBuffer", "kind": "re-export", "signature": "createSharedParamBuffer", "summary": "" }, { "name": "createWeatherPatch", "kind": "re-export", "signature": "createWeatherPatch", "summary": "" }, { "name": "createWhooshAtomPatch", "kind": "re-export", "signature": "createWhooshAtomPatch", "summary": "" }, { "name": "createWindPatch", "kind": "re-export", "signature": "createWindPatch", "summary": "" }, { "name": "getModalMaterials", "kind": "re-export", "signature": "getModalMaterials", "summary": "" }, { "name": "getModalPreset", "kind": "re-export", "signature": "getModalPreset", "summary": "" }, { "name": "readEmitterParam", "kind": "re-export", "signature": "readEmitterParam", "summary": "" }, { "name": "writeEmitterStats", "kind": "re-export", "signature": "writeEmitterStats", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/BodyFoleyPatches", "path": "engine/reference/audio/synth/BodyFoleyPatches.md", "source": "engine/audio/synth/BodyFoleyPatches.js", "import": "/engine/audio/synth/BodyFoleyPatches.js", "sourceHash": "44ecb543510169eb6ce1d49710583c861e044fec2d1da32c36e68585c1b37597", "summary": "Jump effort sound — short vocal grunt (bandpassed noise + formant)", "exports": [ { "name": "body_jump_effort", "kind": "function", "signature": "body_jump_effort(ctx, dest, p)", "summary": "Jump effort sound — short vocal grunt (bandpassed noise + formant)" }, { "name": "body_slide", "kind": "function", "signature": "body_slide(ctx, dest, p)", "summary": "Slide friction sound — continuous lowpass swept noise" }, { "name": "body_cloth", "kind": "function", "signature": "body_cloth(ctx, dest, p)", "summary": "Cloth rustle — short high-freq noise burst" }, { "name": "body_breath_light", "kind": "function", "signature": "body_breath_light(ctx, dest, p)", "summary": "Light breathing — soft airy noise with bandpass" }, { "name": "body_breath_heavy", "kind": "function", "signature": "body_breath_heavy(ctx, dest, p)", "summary": "Heavy breathing — louder breath with low-end rumble" }, { "name": "BODY_FOLEY_PATCHES", "kind": "constant", "signature": "BODY_FOLEY_PATCHES", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/FootstepPatches", "path": "engine/reference/audio/synth/FootstepPatches.md", "source": "engine/audio/synth/FootstepPatches.js", "import": "/engine/audio/synth/FootstepPatches.js", "sourceHash": "aee0f7394cadde2be30a8bfaee8bbe20fd64726a9dce58e04517da4f732f9fd0", "summary": "FootstepPatches.js - Procedural Footstep Sound Generators Generates material-specific footstep sounds procedurally using Web Audio API. Each patch creates layered sounds (body impact + surface texture) with parameters for speed, weight, and pitch variation.", "exports": [ { "name": "footstep_dirt", "kind": "function", "signature": "footstep_dirt(ctx, dest, p)", "summary": "Dirt footstep — muffled thud + grain scatter" }, { "name": "footstep_grass", "kind": "function", "signature": "footstep_grass(ctx, dest, p)", "summary": "Grass footstep — soft rustle + muffled thud" }, { "name": "footstep_sand", "kind": "function", "signature": "footstep_sand(ctx, dest, p)", "summary": "Sand footstep — soft grain scatter + muffled impact" }, { "name": "footstep_gravel", "kind": "function", "signature": "footstep_gravel(ctx, dest, p)", "summary": "Gravel footstep — sharp scatter + rattle" }, { "name": "footstep_mud", "kind": "function", "signature": "footstep_mud(ctx, dest, p)", "summary": "Mud footstep — wet squelch + suction release" }, { "name": "footstep_snow", "kind": "function", "signature": "footstep_snow(ctx, dest, p)", "summary": "Snow footstep — soft crunch + squeak" }, { "name": "footstep_stone", "kind": "function", "signature": "footstep_stone(ctx, dest, p)", "summary": "Stone footstep — hard impact + high-freq crack" }, { "name": "footstep_concrete", "kind": "function", "signature": "footstep_concrete(ctx, dest, p)", "summary": "Concrete footstep — dull thud + mid-freq resonance" }, { "name": "footstep_marble", "kind": "function", "signature": "footstep_marble(ctx, dest, p)", "summary": "Marble footstep — bright click + ring" }, { "name": "footstep_brick", "kind": "function", "signature": "footstep_brick(ctx, dest, p)", "summary": "Brick footstep — textured impact + dust scatter" }, { "name": "footstep_wood_plank", "kind": "function", "signature": "footstep_wood_plank(ctx, dest, p)", "summary": "Wood plank footstep — resonant body + plank slap" }, { "name": "footstep_wood_creak", "kind": "function", "signature": "footstep_wood_creak(ctx, dest, p)", "summary": "Wood creak footstep — creaking friction + resonance" }, { "name": "footstep_metal_solid", "kind": "function", "signature": "footstep_metal_solid(ctx, dest, p)", "summary": "Metal solid footstep — clang + ring" }, { "name": "footstep_metal_grate", "kind": "function", "signature": "footstep_metal_grate(ctx, dest, p)", "summary": "Metal grate footstep — rattle + metallic ring" }, { "name": "footstep_water_shallow", "kind": "function", "signature": "footstep_water_shallow(ctx, dest, p)", "summary": "Water shallow footstep — splash + plop" }, { "name": "footstep_water_puddle", "kind": "function", "signature": "footstep_water_puddle(ctx, dest, p)", "summary": "Water puddle footstep — small splash" }, { "name": "footstep_leaves", "kind": "function", "signature": "footstep_leaves(ctx, dest, p)", "summary": "Leaves footstep — crunch + rustle" }, { "name": "footstep_glass", "kind": "function", "signature": "footstep_glass(ctx, dest, p)", "summary": "Glass footstep — delicate clink + shimmer" }, { "name": "footstep_ice", "kind": "function", "signature": "footstep_ice(ctx, dest, p)", "summary": "Ice footstep — crack + slide" }, { "name": "land_generic", "kind": "function", "signature": "land_generic(ctx, dest, p)", "summary": "Generic land sound — reuses footstep patch but with heavier weight/volume Can be used as a wrapper for any footstep material" }, { "name": "getFootstepPatch", "kind": "function", "signature": "getFootstepPatch(material)", "summary": "Get footstep patch function by material key." }, { "name": "FOOTSTEP_PATCHES", "kind": "constant", "signature": "FOOTSTEP_PATCHES", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/NodeRegistry", "path": "engine/reference/audio/synth/NodeRegistry.md", "source": "engine/audio/synth/NodeRegistry.js", "import": "/engine/audio/synth/NodeRegistry.js", "sourceHash": "6882e7630a9314ff81cf6368b193daa1ea90649951b50c96b23b6b365abf8eb6", "summary": "NodeRegistry.js — Unified Node Type Registry Single source of truth for mapping node type names to their Web Audio factory functions and worklet processor names. Usage: import { getNodeFactory, getRegisteredTypes } from './NodeRegistry.js'; const factory = getNodeFactory('Waveguide'); const node = factory(ctx, params, pitchRatio);", "exports": [ { "name": "getNodeFactory", "kind": "function", "signature": "getNodeFactory(type)", "summary": "Get the Web Audio factory function for a node type. Returns a function: (ctx, nodeDefinition, pitchRatio) => { output, input, sources }" }, { "name": "getRegisteredTypes", "kind": "function", "signature": "getRegisteredTypes()", "summary": "Get all registered type names." }, { "name": "getNodeCategory", "kind": "function", "signature": "getNodeCategory(type)", "summary": "Get the category for a node type." }, { "name": "hasWorkletProcessor", "kind": "function", "signature": "hasWorkletProcessor(type)", "summary": "Check if a type has a worklet processor implementation." }, { "name": "NODE_CATEGORIES", "kind": "constant", "signature": "NODE_CATEGORIES", "summary": "Node category definitions for organization/UI." }, { "name": "ALL_NODE_TYPES", "kind": "constant", "signature": "ALL_NODE_TYPES", "summary": "All registered node type names (flat list)." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/PatchCompiler", "path": "engine/reference/audio/synth/PatchCompiler.md", "source": "engine/audio/synth/PatchCompiler.js", "import": "/engine/audio/synth/PatchCompiler.js", "sourceHash": "663570e9e9b3543e9b0f9168b193f52ca26ccd39b166752ff1db22d52793f97f", "summary": "PatchCompiler.js - Compile Patch JSON → Execution Graph Parses a patch JSON descriptor, validates nodes and wires, performs topological sort, detects feedback loops, and outputs a compiled execution plan for PatchRunner.worklet.js.", "exports": [ { "name": "registerNodeType", "kind": "function", "signature": "registerNodeType(type, def)", "summary": "Register a node type for the compiler." }, { "name": "getNodeTypes", "kind": "function", "signature": "getNodeTypes()", "summary": "Get all registered node types." }, { "name": "compilePatch", "kind": "function", "signature": "compilePatch(patch)", "summary": "Compile a patch JSON into an execution plan." }, { "name": "validatePatch", "kind": "function", "signature": "validatePatch(patch)", "summary": "Validate a patch without fully compiling." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/PatchRunner.worklet", "path": "engine/reference/audio/synth/PatchRunner.worklet.md", "source": "engine/audio/synth/PatchRunner.worklet.js", "import": "/engine/audio/synth/PatchRunner.worklet.js", "sourceHash": "6e8edf6343ab3edecefe41874c6056dc422ec3b839f1b8681ce79c68e9c133ba", "summary": "PatchRunner.worklet.js - AudioWorkletProcessor Executes a compiled patch graph at sample rate (128 samples/block). Receives compiled plans via MessagePort, reads game params from SharedArrayBuffer, and outputs synthesized audio. Register with: audioContext.audioWorklet.addModule('PatchRunner.worklet.js')", "exports": [], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/ProceduralPatches", "path": "engine/reference/audio/synth/ProceduralPatches.md", "source": "engine/audio/synth/ProceduralPatches.js", "import": "/engine/audio/synth/ProceduralPatches.js", "sourceHash": "99019ac19beb5cd6099c25f60010903dfd9e0205356c578aacd8fd23812a4498", "summary": "ProceduralPatches.js - Real-time procedural sound patches for particle substances Each patch is a factory: (ctx, destination, params) => { stop(), update?(params) } ctx — AudioContext destination — AudioNode (pre-spatialized via PannerNode) params — { volume, pitch, speed, temperature, ... } Impact patches are one-shot (auto-stop). Ambient patches loop until stop() is called, and support update() for real-time modulation.", "exports": [ { "name": "impact_fluid", "kind": "function", "signature": "impact_fluid(ctx, dest, p)", "summary": "Water/fluid impact — velocity-driven splat/drip/splash. Sound design based on real water acoustics: - \"Plop\" body: fast sine pitch-sweep downward (Helmholtz cavity resonance). A water droplet traps an air bubble on impact; the bubble oscillates at a frequency that sweeps down as it grows. Duration ~15-40ms. - \"Spray\" transient: ultra-short highpass noise burst (<20ms) for the broadband crack of water hitting a surface. Only audible at higher speeds. - Bubble resonances: at high speed, 1-3 random short sine pips simulate secondary bubbles breaking the surface. Speed mapping: slow (< 1) → gentle drip: mostly plop body, minimal spray medium (1-4) → splat: plop + moderate spray fast (> 4) → full splash: plop + loud spray + bubble pips" }, { "name": "impact_metal", "kind": "function", "signature": "impact_metal(ctx, dest, p)", "summary": "Metal clang — multi-partial ring + noise transient" }, { "name": "impact_glass", "kind": "function", "signature": "impact_glass(ctx, dest, p)", "summary": "Glass clink — high FM harmonics, crystalline" }, { "name": "impact_stone", "kind": "function", "signature": "impact_stone(ctx, dest, p)", "summary": "Stone/debris thud — low filtered noise + crack + sub thump" }, { "name": "impact_wood", "kind": "function", "signature": "impact_wood(ctx, dest, p)", "summary": "Wood knock — multi-mode resonant body + knock transient" }, { "name": "impact_ice", "kind": "function", "signature": "impact_ice(ctx, dest, p)", "summary": "Ice crack — sharp noise + crystalline inharmonic pings" }, { "name": "impact_combustion", "kind": "function", "signature": "impact_combustion(ctx, dest, p)", "summary": "Fire/lava impact burst — noise burst + low boom + rumble tail" }, { "name": "impact_sand", "kind": "function", "signature": "impact_sand(ctx, dest, p)", "summary": "Sand soft impact — muffled body + grain scatter" }, { "name": "impact_drop", "kind": "function", "signature": "impact_drop(ctx, dest, p)", "summary": "Viscous liquid drop/drip — thicker plop than water, low resonance, no spray" }, { "name": "impact_hiss", "kind": "function", "signature": "impact_hiss(ctx, dest, p)", "summary": "Gas/vapor/granular hiss — soft broadband whoosh, not a hard impact" }, { "name": "impact_crackle", "kind": "function", "signature": "impact_crackle(ctx, dest, p)", "summary": "Spark/debris crackle — scattered hard micro-transients" }, { "name": "impact_electric", "kind": "function", "signature": "impact_electric(ctx, dest, p)", "summary": "Plasma/spark electric snap" }, { "name": "ambient_combustion", "kind": "function", "signature": "ambient_combustion(ctx, dest, p)", "summary": "Fire/lava crackling ambient — random noise bursts + low rumble" }, { "name": "ambient_fluid", "kind": "function", "signature": "ambient_fluid(ctx, dest, p)", "summary": "Viscous/fluid flow ambient — subtle high-freq trickle. Shared by water + viscous liquids through AMBIENT_PATCHES aliases." }, { "name": "ambient_electric", "kind": "function", "signature": "ambient_electric(ctx, dest, p)", "summary": "Plasma/electric buzz ambient — FM buzz + noise crackle" }, { "name": "ambient_wind", "kind": "function", "signature": "ambient_wind(ctx, dest, p)", "summary": "Smoke/steam/wind ambient — airy bandpass sweep" }, { "name": "getImpactPatch", "kind": "function", "signature": "getImpactPatch(key)", "summary": "Get the impact patch function for a substance key. If runtime overrides exist for this key, returns a wrapper that merges them." }, { "name": "getAmbientPatch", "kind": "function", "signature": "getAmbientPatch(key)", "summary": "Get the ambient patch function for a substance key. If runtime overrides exist for this key, returns a wrapper that merges them." }, { "name": "setPatchOverride", "kind": "function", "signature": "setPatchOverride(key, param, value)", "summary": "Set a param override for a material patch. These overrides are merged into patch params at call time." }, { "name": "setPatchOverrides", "kind": "function", "signature": "setPatchOverrides(key, overrides)", "summary": "Set all overrides for a material at once." }, { "name": "getPatchOverride", "kind": "function", "signature": "getPatchOverride(key)", "summary": "Get current overrides for a material." }, { "name": "clearPatchOverrides", "kind": "function", "signature": "clearPatchOverrides()", "summary": "Clear all runtime overrides (reset to defaults)." }, { "name": "getAllPatchKeys", "kind": "function", "signature": "getAllPatchKeys()", "summary": "Get all unique canonical material keys (de-duplicated patch function names). Returns objects with { key, type, patchFn } for both impact and ambient." }, { "name": "getAllMaterialAliases", "kind": "function", "signature": "getAllMaterialAliases()", "summary": "Get a flat list of all material alias keys (including duplicates)." }, { "name": "IMPACT_PATCHES", "kind": "constant", "signature": "IMPACT_PATCHES", "summary": "Map of proceduralPatch strings → impact patch functions" }, { "name": "AMBIENT_PATCHES", "kind": "constant", "signature": "AMBIENT_PATCHES", "summary": "Map of proceduralPatch strings → ambient patch functions" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/SfxGenerator", "path": "engine/reference/audio/synth/SfxGenerator.md", "source": "engine/audio/synth/SfxGenerator.js", "import": "/engine/audio/synth/SfxGenerator.js", "sourceHash": "3aa06ed5eec2acd85533c12646fe0d15b79b53d91636c4700be6541084c4adae", "summary": "SfxGenerator.js — Parametric Sound Effect Generator sfxr-inspired procedural SFX system. Every sound is defined by a compact parameter object — no samples needed. Renders to AudioBuffer or plays directly via Web Audio. Parameters cover: waveform, envelope, frequency sweep, vibrato, arpeggiation, duty cycle, retrigger, flanger, LP/HP filter, gain. Preset categories with randomize/mutate for instant sound creation: Pickup, Laser, Explosion, Powerup, Hit, Jump, Blip, Click, Error, Coin Usage: import { createSfxParams, randomizePreset, mutateSfx, renderSfx, playSfx } from './SfxGenerator.js'; const params = randomizePreset('laser'); const buffer = renderSfx(audioCtx, params); playSfx(audioCtx, buffer);", "exports": [ { "name": "createSfxParams", "kind": "function", "signature": "createSfxParams()", "summary": "Create a default SFX parameter set. All values normalized to sensible ranges." }, { "name": "randomizePreset", "kind": "function", "signature": "randomizePreset(preset)", "summary": "Generate a randomized SFX from a preset category." }, { "name": "randomizeFull", "kind": "function", "signature": "randomizeFull()", "summary": "Fully random SFX (no preset bias)." }, { "name": "mutateSfx", "kind": "function", "signature": "mutateSfx(params, amount = 0.05)", "summary": "Mutate an existing SFX params slightly (small random nudge to each param)." }, { "name": "getPresetNames", "kind": "function", "signature": "getPresetNames()", "summary": "Get list of available preset names." }, { "name": "renderSfx", "kind": "function", "signature": "renderSfx(ctx, params)", "summary": "Render an SFX to an AudioBuffer. This is a pure software synthesizer — runs offline, produces a buffer." }, { "name": "playSfx", "kind": "function", "signature": "playSfx(ctx, buffer, options = {})", "summary": "Play a rendered SFX buffer." }, { "name": "renderAndPlay", "kind": "function", "signature": "renderAndPlay(ctx, params, options = {})", "summary": "Render and immediately play an SFX." }, { "name": "encodeSfxParams", "kind": "function", "signature": "encodeSfxParams(params)", "summary": "Encode SFX params to a compact JSON string." }, { "name": "decodeSfxParams", "kind": "function", "signature": "decodeSfxParams(str)", "summary": "Decode SFX params from a JSON string." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/SharedParamBuffer", "path": "engine/reference/audio/synth/SharedParamBuffer.md", "source": "engine/audio/synth/SharedParamBuffer.js", "import": "/engine/audio/synth/SharedParamBuffer.js", "sourceHash": "9e32094f0ecc6dc49ab5c06a27b4709467a611d042e709920dcc24f7e5830273", "summary": "SharedParamBuffer.js - Game → AudioWorklet Parameter Streaming Allocates a SharedArrayBuffer for zero-copy, zero-latency parameter updates from the main game thread to the AudioWorklet synthesis thread. Layout: Float32Array where each slot maps to an exposed synth parameter. The main thread writes emitter aggregate stats each frame; the worklet reads them.", "exports": [ { "name": "createSharedParamBuffer", "kind": "function", "signature": "createSharedParamBuffer()", "summary": "Create a shared parameter buffer." }, { "name": "writeEmitterStats", "kind": "function", "signature": "writeEmitterStats(view, emitterIndex, stats)", "summary": "Write emitter aggregate stats to the shared buffer." }, { "name": "clearAllEmitterStats", "kind": "function", "signature": "clearAllEmitterStats(view)", "summary": "Clear all emitter stats (e.g. when emitters stop)." }, { "name": "clearEmitterStats", "kind": "function", "signature": "clearEmitterStats(view, emitterIndex)", "summary": "Clear stats for a specific emitter." }, { "name": "readEmitterParam", "kind": "function", "signature": "readEmitterParam(view, emitterIndex, paramIndex)", "summary": "Read a single param value from the shared buffer." }, { "name": "PARAM_LAYOUT", "kind": "constant", "signature": "PARAM_LAYOUT", "summary": "Standard parameter indices for emitter → synth streaming. Each active emitter gets one set of these slots." }, { "name": "PARAMS_PER_EMITTER", "kind": "constant", "signature": "PARAMS_PER_EMITTER", "summary": "" }, { "name": "MAX_EMITTERS", "kind": "constant", "signature": "MAX_EMITTERS", "summary": "" }, { "name": "TOTAL_FLOAT_COUNT", "kind": "constant", "signature": "TOTAL_FLOAT_COUNT", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/SoundBlender", "path": "engine/reference/audio/synth/SoundBlender.md", "source": "engine/audio/synth/SoundBlender.js", "import": "/engine/audio/synth/SoundBlender.js", "sourceHash": "05fc5a76d35f0d966a4ca68f1c4e953f7d5b884dfbeaddddbcdb0d6da527fe9b", "summary": "SoundBlender.js — Multi-Layer Sound Effect Mixer Blends 2-4 sound sources (AudioBuffers) with per-layer controls: - Volume, pitch shift, delay offset - Crossfade curves (linear, equal-power, cosine) - Random variation ranges per parameter - Trigger modes: simultaneous, sequential, random-pick, round-robin Produces infinite unique variations from a small set of source sounds. Usage: import { createBlendPreset, renderBlend, playBlend } from './SoundBlender.js'; const preset = createBlendPreset([buffer1, buffer2], { layers: [ { volume: 0.8, pitch: 1.0, delay: 0, volumeRandom: 0.1, pitchRandom: 0.05 }, { volume: 0.5, pitch: 1.2, delay: 0.05, volumeRandom: 0.2, pitchRandom: 0.1 } ], mode: 'simultaneous' }); playBlend(ctx, preset);", "exports": [ { "name": "createBlendPreset", "kind": "function", "signature": "createBlendPreset(buffers = [], config = {})", "summary": "Create a blend preset from source buffers and layer config." }, { "name": "addLayer", "kind": "function", "signature": "addLayer(preset, buffer, layerConfig = {})", "summary": "Add a layer to an existing preset." }, { "name": "removeLayer", "kind": "function", "signature": "removeLayer(preset, index)", "summary": "Remove a layer by index." }, { "name": "playBlend", "kind": "function", "signature": "playBlend(ctx, preset, options = {})", "summary": "Play a blend preset. Returns an object with stop() method." }, { "name": "renderBlend", "kind": "function", "signature": "async renderBlend(ctx, preset)", "summary": "Render a blend preset to a single AudioBuffer (offline)." }, { "name": "generateVariations", "kind": "function", "signature": "async generateVariations(ctx, preset, count = 10)", "summary": "Generate N unique variations of a blend preset. Each variation resolves random ranges differently." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/SoundSchema", "path": "engine/reference/audio/synth/SoundSchema.md", "source": "engine/audio/synth/SoundSchema.js", "import": "/engine/audio/synth/SoundSchema.js", "sourceHash": "9c5e67309f1f069f25bf97421a91d0eda50390734700a100cb92f5c1b25d482c", "summary": "SoundSchema.js — JSON Schema Definitions for All Sound Types Each schema defines every parameter with: type, min, max, step, default, label, description, unit, group Used by: - AudioNodeInspector: auto-generate UI controls from schema - VariationGenerator: derive ranges/limits automatically - Validation: validateParams() catches bad data on import/paste - Sound Palette: self-describing serialized entries Schema field types: 'float' → slider (min/max/step) 'int' → integer slider or number input 'enum' → dropdown (options array) 'bool' → toggle 'string' → text input 'array' → special handling per context", "exports": [ { "name": "getSchema", "kind": "function", "signature": "getSchema(type)", "summary": "Get a schema by type name." }, { "name": "getSchemaNames", "kind": "function", "signature": "getSchemaNames()", "summary": "Get all schema names." }, { "name": "validateParams", "kind": "function", "signature": "validateParams(params, schema)", "summary": "Validate a params object against a schema. Returns { valid, errors, sanitized }. - sanitized: a clean copy with missing keys filled from defaults and out-of-range values clamped. - errors: array of { key, message } for any issues found." }, { "name": "defaultsFromSchema", "kind": "function", "signature": "defaultsFromSchema(schema)", "summary": "Create default params from a schema." }, { "name": "variationRangesFromSchema", "kind": "function", "signature": "variationRangesFromSchema(schema, proportion = 0.1)", "summary": "Extract variation ranges from a schema (for VariationGenerator). Returns { ranges, limits } where: ranges[key] = (max - min) * proportion limits[key] = [min, max]" }, { "name": "getParamGroups", "kind": "function", "signature": "getParamGroups(schema)", "summary": "Get parameter groups from a schema (for UI grouping)." }, { "name": "SFX_SCHEMA", "kind": "constant", "signature": "SFX_SCHEMA", "summary": "" }, { "name": "FM_SCHEMA", "kind": "constant", "signature": "FM_SCHEMA", "summary": "" }, { "name": "KARPLUS_SCHEMA", "kind": "constant", "signature": "KARPLUS_SCHEMA", "summary": "" }, { "name": "GRANULAR_SCHEMA", "kind": "constant", "signature": "GRANULAR_SCHEMA", "summary": "" }, { "name": "OSCILLATOR_SCHEMA", "kind": "constant", "signature": "OSCILLATOR_SCHEMA", "summary": "" }, { "name": "NOISE_SCHEMA", "kind": "constant", "signature": "NOISE_SCHEMA", "summary": "" }, { "name": "IMPULSE_SCHEMA", "kind": "constant", "signature": "IMPULSE_SCHEMA", "summary": "" }, { "name": "MODAL_SCHEMA", "kind": "constant", "signature": "MODAL_SCHEMA", "summary": "" }, { "name": "WAVEGUIDE_SCHEMA", "kind": "constant", "signature": "WAVEGUIDE_SCHEMA", "summary": "" }, { "name": "SAMPLE_SCHEMA", "kind": "constant", "signature": "SAMPLE_SCHEMA", "summary": "" }, { "name": "FORMANT_SCHEMA", "kind": "constant", "signature": "FORMANT_SCHEMA", "summary": "" }, { "name": "BLEND_SCHEMA", "kind": "constant", "signature": "BLEND_SCHEMA", "summary": "" }, { "name": "BLEND_LAYER_SCHEMA", "kind": "constant", "signature": "BLEND_LAYER_SCHEMA", "summary": "" }, { "name": "SOUND_SCHEMAS", "kind": "constant", "signature": "SOUND_SCHEMAS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/SynthManager", "path": "engine/reference/audio/synth/SynthManager.md", "source": "engine/audio/synth/SynthManager.js", "import": "/engine/audio/synth/SynthManager.js", "sourceHash": "10574ebe84a1e8ab5f6681470aa3acb8b276b0bd170460e8a698e864c0c0d872", "summary": "SynthManager.js - Main-Thread Synthesis Orchestrator Manages AudioWorklet registration, patch instance lifecycle, parameter updates via MessagePort and SharedArrayBuffer.", "exports": [ { "name": "createSynthManager", "kind": "function", "signature": "createSynthManager(context, destination)", "summary": "Create a synth manager." }, { "name": "initSynthManager", "kind": "function", "signature": "async initSynthManager(manager, workletUrl)", "summary": "Initialize the synth manager — register the AudioWorklet." }, { "name": "registerPatch", "kind": "function", "signature": "registerPatch(manager, patchJson)", "summary": "Register a patch in the library (compile and cache)." }, { "name": "getPatch", "kind": "function", "signature": "getPatch(manager, patchId)", "summary": "Get a compiled patch plan." }, { "name": "createPatchInstance", "kind": "function", "signature": "createPatchInstance(manager, patchId, options = {})", "summary": "Create and start a patch instance (a playing synth voice)." }, { "name": "setInstanceParam", "kind": "function", "signature": "setInstanceParam(manager, instanceId, paramName, value)", "summary": "Set an exposed parameter on a running instance." }, { "name": "setInstanceVolume", "kind": "function", "signature": "setInstanceVolume(manager, instanceId, volume)", "summary": "Set volume on a running instance." }, { "name": "destroyPatchInstance", "kind": "function", "signature": "destroyPatchInstance(manager, instanceId, fadeOut = 0.05)", "summary": "Stop and destroy a patch instance." }, { "name": "destroyAllInstances", "kind": "function", "signature": "destroyAllInstances(manager)", "summary": "Stop all instances." }, { "name": "destroySynthManager", "kind": "function", "signature": "destroySynthManager(manager)", "summary": "Destroy the synth manager." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/VariationGenerator", "path": "engine/reference/audio/synth/VariationGenerator.md", "source": "engine/audio/synth/VariationGenerator.js", "import": "/engine/audio/synth/VariationGenerator.js", "sourceHash": "f3de018051ff20daaadcb62b160bc1ef0bbe8620a942ec45f3e3354b6a74247a", "summary": "VariationGenerator.js — Automatic Sound Variation System Takes any parametric sound definition and generates N unique variations by randomizing parameters within user-defined ranges. Works with: - SfxGenerator params - FM synthesis configs - Karplus-Strong configs - Any flat parameter object Also provides batch rendering to AudioBuffer arrays and a sound palette system for saving/loading favorites. Usage: import { createVariationConfig, generateVariations, renderVariationBatch } from './VariationGenerator.js'; const vc = createVariationConfig(baseParams, { startFrequency: 0.1, decayTime: 0.05 }); const variations = generateVariations(vc, 20); const buffers = await renderVariationBatch(ctx, variations, renderFn);", "exports": [ { "name": "createVariationConfig", "kind": "function", "signature": "createVariationConfig(baseParams, ranges = {}, options = {})", "summary": "Create a variation configuration." }, { "name": "createVariationConfigFromSchema", "kind": "function", "signature": "createVariationConfigFromSchema(baseParams, schema, proportion = 0.1, options = {})", "summary": "Create a variation config from a SoundSchema. Auto-derives ranges and limits from the schema definition." }, { "name": "lockParam", "kind": "function", "signature": "lockParam(vc, key)", "summary": "Lock a parameter so it won't be varied." }, { "name": "unlockParam", "kind": "function", "signature": "unlockParam(vc, key)", "summary": "Unlock a parameter for variation." }, { "name": "setRange", "kind": "function", "signature": "setRange(vc, key, range)", "summary": "Set the random range for a specific parameter." }, { "name": "setLimits", "kind": "function", "signature": "setLimits(vc, key, min, max)", "summary": "Set per-key min/max limits." }, { "name": "generateVariations", "kind": "function", "signature": "generateVariations(vc, count = 10)", "summary": "Generate N parameter variations from a variation config." }, { "name": "generateOneVariation", "kind": "function", "signature": "generateOneVariation(vc)", "summary": "Generate a single variation." }, { "name": "renderVariationBatch", "kind": "function", "signature": "renderVariationBatch(ctx, paramsList, renderFn)", "summary": "Render an array of parameter variations to AudioBuffers." }, { "name": "renderVariationBatchAsync", "kind": "function", "signature": "async renderVariationBatchAsync(ctx, paramsList, renderFn, onProgress = null)", "summary": "Render variations async (yields between each to avoid blocking)." }, { "name": "readSoundPaletteRecord", "kind": "function", "signature": "readSoundPaletteRecord(storage = globalThis.localStorage)", "summary": "" }, { "name": "writeSoundPaletteRecord", "kind": "function", "signature": "writeSoundPaletteRecord(palette, storage = globalThis.localStorage)", "summary": "" }, { "name": "createSoundPalette", "kind": "function", "signature": "createSoundPalette()", "summary": "Create a sound palette for organizing favorite sounds." }, { "name": "addToPalette", "kind": "function", "signature": "addToPalette(palette, entry)", "summary": "Add a sound to the palette." }, { "name": "removeFromPalette", "kind": "function", "signature": "removeFromPalette(palette, id)", "summary": "Remove a sound from the palette." }, { "name": "searchPalette", "kind": "function", "signature": "searchPalette(palette, query = {})", "summary": "Find sounds in the palette by category or tag." }, { "name": "savePalette", "kind": "function", "signature": "savePalette(palette, storage = globalThis.localStorage)", "summary": "Save palette to localStorage." }, { "name": "loadPalette", "kind": "function", "signature": "loadPalette(storage = globalThis.localStorage)", "summary": "Load palette from localStorage." }, { "name": "exportPalette", "kind": "function", "signature": "exportPalette(palette)", "summary": "Export palette as JSON string (for sharing/backup)." }, { "name": "importPalette", "kind": "function", "signature": "importPalette(json)", "summary": "Import palette from JSON string." }, { "name": "SOUND_PALETTE_SCHEMA", "kind": "constant", "signature": "SOUND_PALETTE_SCHEMA", "summary": "" }, { "name": "SOUND_PALETTE_SCHEMA_VERSION", "kind": "constant", "signature": "SOUND_PALETTE_SCHEMA_VERSION", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/WebAudioNodeFactory", "path": "engine/reference/audio/synth/WebAudioNodeFactory.md", "source": "engine/audio/synth/WebAudioNodeFactory.js", "import": "/engine/audio/synth/WebAudioNodeFactory.js", "sourceHash": "f4cbaa8d9c30bd5838947b6b56b5da0565a0de1599658b0958d54cdb38b86dcc", "summary": "WebAudioNodeFactory.js — Unified Web Audio Node Factory Central factory for creating main-thread Web Audio nodes from patch graph node definitions. Delegates to modular node files where possible. Used by AudioEditorPanel.js for preview playback. Usage: import { createWebAudioNode, buildVoice } from './WebAudioNodeFactory.js'; const node = createWebAudioNode(ctx, { type: 'Waveguide', params: {...} }, pitchRatio); const voice = buildVoice(ctx, patchJSON, pitchRatio);", "exports": [ { "name": "normalizeWaveShape", "kind": "function", "signature": "normalizeWaveShape(shape)", "summary": "Normalize oscillator wave shape names to Web Audio API values." }, { "name": "buildVoice", "kind": "function", "signature": "buildVoice(ctx, patch, pitchRatio = 1.0)", "summary": "Build a complete voice from a patch graph, scaling frequencies by pitchRatio." }, { "name": "createWebAudioNode", "kind": "function", "signature": "createWebAudioNode(ctx, node, pitchRatio = 1.0)", "summary": "Create a Web Audio node (or subgraph) for a given patch graph node definition. Returns { output, input, inputMap?, sources } or null." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/index", "path": "engine/reference/audio/synth/index.md", "source": "engine/audio/synth/index.js", "import": "/engine/audio/synth/index.js", "sourceHash": "b9f9d411d729e1b13fecc3b07ae68c364874ea1aee333ded63bf2559521d4de0", "summary": "engine/audio/synth/index.js — Barrel export for procedural synthesis engine.", "exports": [ { "name": "AMBIENT_PATCHES", "kind": "re-export", "signature": "AMBIENT_PATCHES", "summary": "" }, { "name": "BLEND_LAYER_SCHEMA", "kind": "re-export", "signature": "BLEND_LAYER_SCHEMA", "summary": "" }, { "name": "BLEND_SCHEMA", "kind": "re-export", "signature": "BLEND_SCHEMA", "summary": "" }, { "name": "FM_PRESETS", "kind": "re-export", "signature": "FM_PRESETS", "summary": "" }, { "name": "FM_SCHEMA", "kind": "re-export", "signature": "FM_SCHEMA", "summary": "" }, { "name": "FORMANT_PRESETS", "kind": "re-export", "signature": "FORMANT_PRESETS", "summary": "" }, { "name": "FORMANT_SCHEMA", "kind": "re-export", "signature": "FORMANT_SCHEMA", "summary": "" }, { "name": "GRANULAR_SCHEMA", "kind": "re-export", "signature": "GRANULAR_SCHEMA", "summary": "" }, { "name": "IMPACT_PATCHES", "kind": "re-export", "signature": "IMPACT_PATCHES", "summary": "" }, { "name": "KARPLUS_SCHEMA", "kind": "re-export", "signature": "KARPLUS_SCHEMA", "summary": "" }, { "name": "MATERIAL_OPTIONS", "kind": "re-export", "signature": "MATERIAL_OPTIONS", "summary": "" }, { "name": "MODAL_MATERIALS", "kind": "re-export", "signature": "MODAL_MATERIALS", "summary": "" }, { "name": "NOISE_COLOR_OPTIONS", "kind": "re-export", "signature": "NOISE_COLOR_OPTIONS", "summary": "" }, { "name": "SFX_SCHEMA", "kind": "re-export", "signature": "SFX_SCHEMA", "summary": "" }, { "name": "SOUND_SCHEMAS", "kind": "re-export", "signature": "SOUND_SCHEMAS", "summary": "" }, { "name": "WAVEGUIDE_MODE_OPTIONS", "kind": "re-export", "signature": "WAVEGUIDE_MODE_OPTIONS", "summary": "" }, { "name": "WAVEGUIDE_TERMINATIONS", "kind": "re-export", "signature": "WAVEGUIDE_TERMINATIONS", "summary": "" }, { "name": "addLayer", "kind": "re-export", "signature": "addLayer", "summary": "" }, { "name": "addToPalette", "kind": "re-export", "signature": "addToPalette", "summary": "" }, { "name": "ambient_combustion", "kind": "re-export", "signature": "ambient_combustion", "summary": "" }, { "name": "ambient_electric", "kind": "re-export", "signature": "ambient_electric", "summary": "" }, { "name": "ambient_fluid", "kind": "re-export", "signature": "ambient_fluid", "summary": "" }, { "name": "ambient_wind", "kind": "re-export", "signature": "ambient_wind", "summary": "" }, { "name": "buildVoice", "kind": "re-export", "signature": "buildVoice", "summary": "" }, { "name": "calculateModeAmplitudes", "kind": "re-export", "signature": "calculateModeAmplitudes", "summary": "" }, { "name": "calculateModeDecays", "kind": "re-export", "signature": "calculateModeDecays", "summary": "" }, { "name": "calculateModeFrequencies", "kind": "re-export", "signature": "calculateModeFrequencies", "summary": "" }, { "name": "compilePatch", "kind": "re-export", "signature": "compilePatch", "summary": "" }, { "name": "connectGranular", "kind": "re-export", "signature": "connectGranular", "summary": "" }, { "name": "createBlendPreset", "kind": "re-export", "signature": "createBlendPreset", "summary": "" }, { "name": "createFMPatch", "kind": "re-export", "signature": "createFMPatch", "summary": "" }, { "name": "createFormantFilter", "kind": "re-export", "signature": "createFormantFilter", "summary": "" }, { "name": "createFormantPatch", "kind": "re-export", "signature": "createFormantPatch", "summary": "" }, { "name": "createGranularEngine", "kind": "re-export", "signature": "createGranularEngine", "summary": "" }, { "name": "createGranularPatch", "kind": "re-export", "signature": "createGranularPatch", "summary": "" }, { "name": "createKarplusStrongPatch", "kind": "re-export", "signature": "createKarplusStrongPatch", "summary": "" }, { "name": "createModalBank", "kind": "re-export", "signature": "createModalBank", "summary": "" }, { "name": "createNoiseBuffer", "kind": "re-export", "signature": "createNoiseBuffer", "summary": "" }, { "name": "createNoiseSource", "kind": "re-export", "signature": "createNoiseSource", "summary": "" }, { "name": "createPatchInstance", "kind": "re-export", "signature": "createPatchInstance", "summary": "" }, { "name": "createSfxParams", "kind": "re-export", "signature": "createSfxParams", "summary": "" }, { "name": "createSoundPalette", "kind": "re-export", "signature": "createSoundPalette", "summary": "" }, { "name": "createStereoNoiseSource", "kind": "re-export", "signature": "createStereoNoiseSource", "summary": "" }, { "name": "createSynthManager", "kind": "re-export", "signature": "createSynthManager", "summary": "" }, { "name": "createVariationConfig", "kind": "re-export", "signature": "createVariationConfig", "summary": "" }, { "name": "createVariationConfigFromSchema", "kind": "re-export", "signature": "createVariationConfigFromSchema", "summary": "" }, { "name": "createWaveguide", "kind": "re-export", "signature": "createWaveguide", "summary": "" }, { "name": "createWebAudioNode", "kind": "re-export", "signature": "createWebAudioNode", "summary": "" }, { "name": "decodeSfxParams", "kind": "re-export", "signature": "decodeSfxParams", "summary": "" }, { "name": "defaultsFromSchema", "kind": "re-export", "signature": "defaultsFromSchema", "summary": "" }, { "name": "destroyAllInstances", "kind": "re-export", "signature": "destroyAllInstances", "summary": "" }, { "name": "destroyFormantFilter", "kind": "re-export", "signature": "destroyFormantFilter", "summary": "" }, { "name": "destroyGranular", "kind": "re-export", "signature": "destroyGranular", "summary": "" }, { "name": "destroyPatchInstance", "kind": "re-export", "signature": "destroyPatchInstance", "summary": "" }, { "name": "destroySynthManager", "kind": "re-export", "signature": "destroySynthManager", "summary": "" }, { "name": "encodeSfxParams", "kind": "re-export", "signature": "encodeSfxParams", "summary": "" }, { "name": "exportPalette", "kind": "re-export", "signature": "exportPalette", "summary": "" }, { "name": "generateBlendVariations", "kind": "re-export", "signature": "generateBlendVariations", "summary": "" }, { "name": "generateOneVariation", "kind": "re-export", "signature": "generateOneVariation", "summary": "" }, { "name": "generateVariations", "kind": "re-export", "signature": "generateVariations", "summary": "" }, { "name": "getAmbientPatch", "kind": "re-export", "signature": "getAmbientPatch", "summary": "" }, { "name": "getFMPresetNames", "kind": "re-export", "signature": "getFMPresetNames", "summary": "" }, { "name": "getFormantPresetNames", "kind": "re-export", "signature": "getFormantPresetNames", "summary": "" }, { "name": "getImpactPatch", "kind": "re-export", "signature": "getImpactPatch", "summary": "" }, { "name": "getNodeTypes", "kind": "re-export", "signature": "getNodeTypes", "summary": "" }, { "name": "getParamGroups", "kind": "re-export", "signature": "getParamGroups", "summary": "" }, { "name": "getPatch", "kind": "re-export", "signature": "getPatch", "summary": "" }, { "name": "getPresetNames", "kind": "re-export", "signature": "getPresetNames", "summary": "" }, { "name": "getSchema", "kind": "re-export", "signature": "getSchema", "summary": "" }, { "name": "getSchemaNames", "kind": "re-export", "signature": "getSchemaNames", "summary": "" }, { "name": "impact_combustion", "kind": "re-export", "signature": "impact_combustion", "summary": "" }, { "name": "impact_crackle", "kind": "re-export", "signature": "impact_crackle", "summary": "" }, { "name": "impact_drop", "kind": "re-export", "signature": "impact_drop", "summary": "" }, { "name": "impact_electric", "kind": "re-export", "signature": "impact_electric", "summary": "" }, { "name": "impact_fluid", "kind": "re-export", "signature": "impact_fluid", "summary": "" }, { "name": "impact_glass", "kind": "re-export", "signature": "impact_glass", "summary": "" }, { "name": "impact_hiss", "kind": "re-export", "signature": "impact_hiss", "summary": "" }, { "name": "impact_ice", "kind": "re-export", "signature": "impact_ice", "summary": "" }, { "name": "impact_metal", "kind": "re-export", "signature": "impact_metal", "summary": "" }, { "name": "impact_sand", "kind": "re-export", "signature": "impact_sand", "summary": "" }, { "name": "impact_stone", "kind": "re-export", "signature": "impact_stone", "summary": "" }, { "name": "impact_wood", "kind": "re-export", "signature": "impact_wood", "summary": "" }, { "name": "importPalette", "kind": "re-export", "signature": "importPalette", "summary": "" }, { "name": "initSynthManager", "kind": "re-export", "signature": "initSynthManager", "summary": "" }, { "name": "loadPalette", "kind": "re-export", "signature": "loadPalette", "summary": "" }, { "name": "lockParam", "kind": "re-export", "signature": "lockParam", "summary": "" }, { "name": "morphFormants", "kind": "re-export", "signature": "morphFormants", "summary": "" }, { "name": "mutateSfx", "kind": "re-export", "signature": "mutateSfx", "summary": "" }, { "name": "normalizeWaveShape", "kind": "re-export", "signature": "normalizeWaveShape", "summary": "" }, { "name": "playBlend", "kind": "re-export", "signature": "playBlend", "summary": "" }, { "name": "playFM", "kind": "re-export", "signature": "playFM", "summary": "" }, { "name": "playKarplusStrong", "kind": "re-export", "signature": "playKarplusStrong", "summary": "" }, { "name": "playSfx", "kind": "re-export", "signature": "playSfx", "summary": "" }, { "name": "randomizeFull", "kind": "re-export", "signature": "randomizeFull", "summary": "" }, { "name": "randomizePreset", "kind": "re-export", "signature": "randomizePreset", "summary": "" }, { "name": "registerNodeType", "kind": "re-export", "signature": "registerNodeType", "summary": "" }, { "name": "registerPatch", "kind": "re-export", "signature": "registerPatch", "summary": "" }, { "name": "removeFromPalette", "kind": "re-export", "signature": "removeFromPalette", "summary": "" }, { "name": "removeLayer", "kind": "re-export", "signature": "removeLayer", "summary": "" }, { "name": "renderAndPlay", "kind": "re-export", "signature": "renderAndPlay", "summary": "" }, { "name": "renderBlend", "kind": "re-export", "signature": "renderBlend", "summary": "" }, { "name": "renderFM", "kind": "re-export", "signature": "renderFM", "summary": "" }, { "name": "renderFM4", "kind": "re-export", "signature": "renderFM4", "summary": "" }, { "name": "renderKarplusStrong", "kind": "re-export", "signature": "renderKarplusStrong", "summary": "" }, { "name": "renderSfx", "kind": "re-export", "signature": "renderSfx", "summary": "" }, { "name": "renderVariationBatch", "kind": "re-export", "signature": "renderVariationBatch", "summary": "" }, { "name": "renderVariationBatchAsync", "kind": "re-export", "signature": "renderVariationBatchAsync", "summary": "" }, { "name": "renderWaveguide", "kind": "re-export", "signature": "renderWaveguide", "summary": "" }, { "name": "savePalette", "kind": "re-export", "signature": "savePalette", "summary": "" }, { "name": "searchPalette", "kind": "re-export", "signature": "searchPalette", "summary": "" }, { "name": "setFormantFrequencies", "kind": "re-export", "signature": "setFormantFrequencies", "summary": "" }, { "name": "setFormantMorphTime", "kind": "re-export", "signature": "setFormantMorphTime", "summary": "" }, { "name": "setFormantVowel", "kind": "re-export", "signature": "setFormantVowel", "summary": "" }, { "name": "setGranularBuffer", "kind": "re-export", "signature": "setGranularBuffer", "summary": "" }, { "name": "setGranularParam", "kind": "re-export", "signature": "setGranularParam", "summary": "" }, { "name": "setInstanceParam", "kind": "re-export", "signature": "setInstanceParam", "summary": "" }, { "name": "setInstanceVolume", "kind": "re-export", "signature": "setInstanceVolume", "summary": "" }, { "name": "setLimits", "kind": "re-export", "signature": "setLimits", "summary": "" }, { "name": "setRange", "kind": "re-export", "signature": "setRange", "summary": "" }, { "name": "startGranular", "kind": "re-export", "signature": "startGranular", "summary": "" }, { "name": "stopGranular", "kind": "re-export", "signature": "stopGranular", "summary": "" }, { "name": "unlockParam", "kind": "re-export", "signature": "unlockParam", "summary": "" }, { "name": "validateParams", "kind": "re-export", "signature": "validateParams", "summary": "" }, { "name": "validatePatch", "kind": "re-export", "signature": "validatePatch", "summary": "" }, { "name": "variationRangesFromSchema", "kind": "re-export", "signature": "variationRangesFromSchema", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/FMOperatorNode", "path": "engine/reference/audio/synth/nodes/FMOperatorNode.md", "source": "engine/audio/synth/nodes/FMOperatorNode.js", "import": "/engine/audio/synth/nodes/FMOperatorNode.js", "sourceHash": "5e02cc4384db8f9912f47c09ff49a2118b651d2933c1f004e06b4fa9dc3e3380", "summary": "FMOperatorNode.js — FM Synthesis Engine Frequency Modulation synthesis: one oscillator (modulator) modulates the frequency of another (carrier), producing complex harmonic and inharmonic timbres from simple parameters. Supports up to 4 operators in series/parallel configurations. Each operator has: frequency ratio, detune, envelope, feedback. Usage: import { renderFM, playFM, createFMPatch } from './FMOperatorNode.js'; const buffer = renderFM(audioCtx, { carrierFreq: 440, modRatio: 2, modDepth: 200 });", "exports": [ { "name": "renderFM", "kind": "function", "signature": "renderFM(ctx, config = {})", "summary": "Render 2-operator FM synthesis to an AudioBuffer." }, { "name": "renderFM4", "kind": "function", "signature": "renderFM4(ctx, config = {})", "summary": "Render a 4-operator FM stack. Operators are chained: op4 → op3 → op2 → op1 (carrier)." }, { "name": "playFM", "kind": "function", "signature": "playFM(ctx, config = {}, destination = null)", "summary": "Play FM synthesis directly." }, { "name": "getFMPresetNames", "kind": "function", "signature": "getFMPresetNames()", "summary": "Get list of FM preset names." }, { "name": "createFMPatch", "kind": "function", "signature": "createFMPatch(config = {})", "summary": "" }, { "name": "FM_PRESETS", "kind": "constant", "signature": "FM_PRESETS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/FormantFilterNode", "path": "engine/reference/audio/synth/nodes/FormantFilterNode.md", "source": "engine/audio/synth/nodes/FormantFilterNode.js", "import": "/engine/audio/synth/nodes/FormantFilterNode.js", "sourceHash": "4d7a1cf0c9bb2b2fac4618e2e03f88c06cc9cd66174de74ca7b0e2288af86cd3", "summary": "FormantFilterNode.js — Formant Filter for Vocal/Creature Sounds Parallel bank of bandpass filters tuned to vocal formant frequencies. Shapes any input signal into vowel-like resonances. Useful for: - Creature vocalizations - Vocal pads and textures - Talking/singing synthesis - Resonant environmental effects Includes presets for standard vowels (A, E, I, O, U) and creature sounds. Usage: import { createFormantFilter, setFormantVowel, destroyFormantFilter } from './FormantFilterNode.js'; const filter = createFormantFilter(audioCtx); sourceNode.connect(filter.input); filter.output.connect(audioCtx.destination); setFormantVowel(filter, 'A');", "exports": [ { "name": "createFormantFilter", "kind": "function", "signature": "createFormantFilter(ctx, config = {})", "summary": "Create a formant filter bank." }, { "name": "setFormantVowel", "kind": "function", "signature": "setFormantVowel(instance, vowelName)", "summary": "Set the formant filter to a vowel preset." }, { "name": "setFormantFrequencies", "kind": "function", "signature": "setFormantFrequencies(instance, frequencies, bandwidths, gains)", "summary": "Set formant frequencies directly (bypass presets)." }, { "name": "morphFormants", "kind": "function", "signature": "morphFormants(instance, vowelA, vowelB, blend)", "summary": "Morph between two vowel presets." }, { "name": "setFormantMorphTime", "kind": "function", "signature": "setFormantMorphTime(instance, seconds)", "summary": "Set morph time (transition speed)." }, { "name": "destroyFormantFilter", "kind": "function", "signature": "destroyFormantFilter(instance)", "summary": "Destroy the formant filter and release resources." }, { "name": "getFormantPresetNames", "kind": "function", "signature": "getFormantPresetNames()", "summary": "Get list of available formant preset names." }, { "name": "createFormantPatch", "kind": "function", "signature": "createFormantPatch(config = {})", "summary": "" }, { "name": "FORMANT_PRESETS", "kind": "constant", "signature": "FORMANT_PRESETS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/GranularNode", "path": "engine/reference/audio/synth/nodes/GranularNode.md", "source": "engine/audio/synth/nodes/GranularNode.js", "import": "/engine/audio/synth/nodes/GranularNode.js", "sourceHash": "7b036e675901f13c4bd96456012328da4861acdb7490fcb9e03113fcc6b35c82", "summary": "Create a granular synthesis engine.", "exports": [ { "name": "createGranularEngine", "kind": "function", "signature": "createGranularEngine(ctx, buffer, config = {})", "summary": "Create a granular synthesis engine." }, { "name": "startGranular", "kind": "function", "signature": "startGranular(engine)", "summary": "Start the granular engine — begins spawning grains." }, { "name": "stopGranular", "kind": "function", "signature": "stopGranular(engine, fadeTime = 0.1)", "summary": "Stop the granular engine." }, { "name": "setGranularParam", "kind": "function", "signature": "setGranularParam(engine, key, value)", "summary": "Set a granular parameter." }, { "name": "setGranularBuffer", "kind": "function", "signature": "setGranularBuffer(engine, buffer)", "summary": "Replace the source buffer." }, { "name": "connectGranular", "kind": "function", "signature": "connectGranular(engine, destination)", "summary": "Connect granular output to a destination." }, { "name": "destroyGranular", "kind": "function", "signature": "destroyGranular(engine)", "summary": "Destroy and clean up." }, { "name": "createGranularPatch", "kind": "function", "signature": "createGranularPatch(config = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/ImpulseNode", "path": "engine/reference/audio/synth/nodes/ImpulseNode.md", "source": "engine/audio/synth/nodes/ImpulseNode.js", "import": "/engine/audio/synth/nodes/ImpulseNode.js", "sourceHash": "40892fc4f69c88cfb764c0c7ba832e5d887d38d5ad00167e3fb486e33e58639b", "summary": "Create a real-time impulse generator engine.", "exports": [ { "name": "createImpulseEngine", "kind": "function", "signature": "createImpulseEngine(ctx, config = {})", "summary": "Create a real-time impulse generator engine." }, { "name": "generateImpulseBuffer", "kind": "function", "signature": "generateImpulseBuffer(ctx, config = {})", "summary": "Generate a single impulse as an AudioBuffer." }, { "name": "isValidImpulseShape", "kind": "function", "signature": "isValidImpulseShape(shape)", "summary": "" }, { "name": "IMPULSE_SHAPE_OPTIONS", "kind": "constant", "signature": "IMPULSE_SHAPE_OPTIONS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/KarplusStrongNode", "path": "engine/reference/audio/synth/nodes/KarplusStrongNode.md", "source": "engine/audio/synth/nodes/KarplusStrongNode.js", "import": "/engine/audio/synth/nodes/KarplusStrongNode.js", "sourceHash": "75e2adbd6933e2cc1d6f3214a759be3aa5dd0ab975449c67edd016857d60cbd3", "summary": "Render a Karplus-Strong plucked string to an AudioBuffer.", "exports": [ { "name": "renderKarplusStrong", "kind": "function", "signature": "renderKarplusStrong(ctx, config = {})", "summary": "Render a Karplus-Strong plucked string to an AudioBuffer." }, { "name": "playKarplusStrong", "kind": "function", "signature": "playKarplusStrong(ctx, config = {}, destination = null)", "summary": "Play a Karplus-Strong sound directly." }, { "name": "createKarplusStrongPatch", "kind": "function", "signature": "createKarplusStrongPatch(config = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/MidiInputNode", "path": "engine/reference/audio/synth/nodes/MidiInputNode.md", "source": "engine/audio/synth/nodes/MidiInputNode.js", "import": "/engine/audio/synth/nodes/MidiInputNode.js", "sourceHash": "91c2f10fe56bdfc7a619aa6b13369e6b5c9c0e60f601ac9f5d220d31a4473c63", "summary": "MidiInputNode.js — MIDI Input Integration Receives MIDI input from external controllers or DAW via Web MIDI API. Outputs gate, note, velocity, and CC signals for driving synth nodes. Usage: import { createMidiInput, requestMidiAccess } from './MidiInputNode.js'; await requestMidiAccess(); const midi = createMidiInput({ channel: 0 }); midi.onNoteOn = (note, velocity) => synth.noteOn(note, velocity);", "exports": [ { "name": "requestMidiAccess", "kind": "function", "signature": "async requestMidiAccess()", "summary": "Request MIDI access from the browser." }, { "name": "getMidiInputs", "kind": "function", "signature": "getMidiInputs()", "summary": "Get list of available MIDI inputs." }, { "name": "createMidiInput", "kind": "function", "signature": "createMidiInput(config = {})", "summary": "Create a MIDI input node that processes incoming MIDI messages." }, { "name": "createMidiCCMap", "kind": "function", "signature": "createMidiCCMap(config = {})", "summary": "Create a CC mapper that scales CC values to a target range." }, { "name": "VELOCITY_CURVES", "kind": "constant", "signature": "VELOCITY_CURVES", "summary": "" }, { "name": "CC_CURVES", "kind": "constant", "signature": "CC_CURVES", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/ModalBankNode", "path": "engine/reference/audio/synth/nodes/ModalBankNode.md", "source": "engine/audio/synth/nodes/ModalBankNode.js", "import": "/engine/audio/synth/nodes/ModalBankNode.js", "sourceHash": "ea9697ad3c596e07a4ad0d2b9ec811471bcc9fe934acf53888735705e4f2e812", "summary": "ModalBankNode.js — Modal Synthesis Engine Physical modeling using parallel resonant filters (modes). Each mode has frequency, amplitude, and decay characteristics. Material presets auto-calculate modes based on: - Stiff string formula (metal, piano strings) - Beam formula (wood, glass bars) - Circular membrane formula (drums) - Rectangular plate formula (bells, gongs) Usage: import { createModalBank, MODAL_MATERIALS } from './ModalBankNode.js'; const bank = createModalBank(audioCtx, { material: 'metal', frequency: 440 }); bank.excite(impulseBuffer);", "exports": [ { "name": "calculateModeFrequencies", "kind": "function", "signature": "calculateModeFrequencies(formula, f0, modeCount, inharmonicity = 0)", "summary": "Calculate modal frequencies based on material formula." }, { "name": "calculateModeAmplitudes", "kind": "function", "signature": "calculateModeAmplitudes(modeCount, strikePosition, brightness = 0.5)", "summary": "Calculate mode amplitudes based on strike position." }, { "name": "calculateModeDecays", "kind": "function", "signature": "calculateModeDecays(frequencies, baseDamping, highDamp, f0)", "summary": "Calculate mode decay times based on frequency and damping." }, { "name": "createModalBank", "kind": "function", "signature": "createModalBank(ctx, config = {})", "summary": "Create a modal bank synthesis engine." }, { "name": "isValidMaterial", "kind": "function", "signature": "isValidMaterial(material)", "summary": "" }, { "name": "MODAL_MATERIALS", "kind": "constant", "signature": "MODAL_MATERIALS", "summary": "" }, { "name": "MATERIAL_OPTIONS", "kind": "constant", "signature": "MATERIAL_OPTIONS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/NoiseGeneratorNode", "path": "engine/reference/audio/synth/nodes/NoiseGeneratorNode.md", "source": "engine/audio/synth/nodes/NoiseGeneratorNode.js", "import": "/engine/audio/synth/nodes/NoiseGeneratorNode.js", "sourceHash": "4a7c396435c6585fbc151f9ac5bbdd8b46794a30c00ed6e5ea9289333372084f", "summary": "Create a noise AudioBuffer of the specified color.", "exports": [ { "name": "createNoiseBuffer", "kind": "function", "signature": "createNoiseBuffer(ctx, color = 'white', duration = DEFAULT_DURATION, options = {})", "summary": "Create a noise AudioBuffer of the specified color." }, { "name": "createNoiseSource", "kind": "function", "signature": "createNoiseSource(ctx, color = 'white', options = {})", "summary": "Create a looping noise source node." }, { "name": "createStereoNoiseSource", "kind": "function", "signature": "createStereoNoiseSource(ctx, color = 'white', options = {})", "summary": "Create stereo noise with decorrelated channels." }, { "name": "isValidNoiseColor", "kind": "function", "signature": "isValidNoiseColor(color)", "summary": "" }, { "name": "NOISE_COLOR_OPTIONS", "kind": "constant", "signature": "NOISE_COLOR_OPTIONS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/OscillatorNode", "path": "engine/reference/audio/synth/nodes/OscillatorNode.md", "source": "engine/audio/synth/nodes/OscillatorNode.js", "import": "/engine/audio/synth/nodes/OscillatorNode.js", "sourceHash": "f42e82e7f1e13d3be8b1bb292847360c3fa481b115208f54dce43489c78fc81c", "summary": "OscillatorNode.js — Advanced Oscillator Synthesis Supports multiple waveform types beyond Web Audio defaults: - sine, square, sawtooth, triangle (native) - pulse (variable duty cycle via PeriodicWave) - supersaw (multiple detuned sawtooths) - custom (user-defined wavetable) Additional features: - Sub-oscillator (-1 or -2 octaves) - Unison/supersaw with configurable voice count and spread - Pulse width modulation Usage: import { createOscillator, createSupersawOscillator } from './OscillatorNode.js'; const osc = createOscillator(audioCtx, { shape: 'pulse', frequency: 440, pulseWidth: 0.3 }); osc.output.connect(destination); osc.start();", "exports": [ { "name": "createOscillator", "kind": "function", "signature": "createOscillator(ctx, config = {})", "summary": "Create an advanced oscillator node." }, { "name": "isValidShape", "kind": "function", "signature": "isValidShape(shape)", "summary": "" }, { "name": "WAVETABLE_PRESETS", "kind": "constant", "signature": "WAVETABLE_PRESETS", "summary": "" }, { "name": "OSCILLATOR_SHAPES", "kind": "constant", "signature": "OSCILLATOR_SHAPES", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/SamplePlayerNode", "path": "engine/reference/audio/synth/nodes/SamplePlayerNode.md", "source": "engine/audio/synth/nodes/SamplePlayerNode.js", "import": "/engine/audio/synth/nodes/SamplePlayerNode.js", "sourceHash": "0709ac24a85644f8eea02e3db6edff6fbaf2b78a8289e9354855d3f7125a27d0", "summary": "SamplePlayerNode.js — Advanced Sample Playback Enhanced sample player with: - Loop modes: forward, pingpong, reverse - Start/end points and loop regions - Crossfade looping for seamless loops - Built-in ADSR envelope - Pitch tracking from MIDI note Usage: import { createSamplePlayer } from './SamplePlayerNode.js'; const player = createSamplePlayer(audioCtx, buffer, { loop: true, loopMode: 'pingpong' }); player.trigger();", "exports": [ { "name": "createSamplePlayer", "kind": "function", "signature": "createSamplePlayer(ctx, buffer, config = {})", "summary": "Create an advanced sample player." }, { "name": "createCrossfadeLoopBuffer", "kind": "function", "signature": "createCrossfadeLoopBuffer(ctx, buffer, loopStart, loopEnd, crossfadeDuration)", "summary": "Create a crossfade loop buffer. Blends the end of the loop region back into the start for seamless looping." }, { "name": "isValidLoopMode", "kind": "function", "signature": "isValidLoopMode(mode)", "summary": "" }, { "name": "SAMPLE_LOOP_MODES", "kind": "constant", "signature": "SAMPLE_LOOP_MODES", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/SequencerNode", "path": "engine/reference/audio/synth/nodes/SequencerNode.md", "source": "engine/audio/synth/nodes/SequencerNode.js", "import": "/engine/audio/synth/nodes/SequencerNode.js", "sourceHash": "9c5a2e489bb2bffc4cf1844e43d26943529cca91a27de2ac97bfcb031513fb20", "summary": "Create a master clock with BPM and time signature.", "exports": [ { "name": "createClock", "kind": "function", "signature": "createClock(ctx, config = {})", "summary": "Create a master clock with BPM and time signature." }, { "name": "createStepSequencer", "kind": "function", "signature": "createStepSequencer(ctx, config = {})", "summary": "Create a step sequencer." }, { "name": "createArpeggiator", "kind": "function", "signature": "createArpeggiator(ctx, config = {})", "summary": "Create an arpeggiator." }, { "name": "SEQUENCER_RATES", "kind": "constant", "signature": "SEQUENCER_RATES", "summary": "" }, { "name": "ARPEGGIATOR_MODES", "kind": "constant", "signature": "ARPEGGIATOR_MODES", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/SynthesisTypes", "path": "engine/reference/audio/synth/nodes/SynthesisTypes.md", "source": "engine/audio/synth/nodes/SynthesisTypes.js", "import": "/engine/audio/synth/nodes/SynthesisTypes.js", "sourceHash": "da05fecb8e320bfb6c1fcc4fff5fc24b32b8887a6efcc86c2877749ea862fe52", "summary": "SynthesisTypes.js — Additional Synthesis Methods Extended synthesis techniques: - Additive: Harmonic/partial-based synthesis - Wavetable: Morphing wavetable oscillator - PhaseDistortion: CZ-style phase distortion - Subtractive: Classic subtractive synth voice Usage: import { createAdditiveSynth, createWavetableSynth } from './SynthesisTypes.js'; const add = createAdditiveSynth(audioCtx, { partialCount: 32 });", "exports": [ { "name": "createAdditiveSynth", "kind": "function", "signature": "createAdditiveSynth(ctx, config = {})", "summary": "Create an additive synthesizer." }, { "name": "createWavetableSynth", "kind": "function", "signature": "createWavetableSynth(ctx, config = {})", "summary": "Create a wavetable synthesizer." }, { "name": "createPhaseDistortionSynth", "kind": "function", "signature": "createPhaseDistortionSynth(ctx, config = {})", "summary": "Create a phase distortion synthesizer (CZ-style)." }, { "name": "createSubtractiveSynth", "kind": "function", "signature": "createSubtractiveSynth(ctx, config = {})", "summary": "Create a classic subtractive synthesizer voice." }, { "name": "WAVETABLE_NAMES", "kind": "constant", "signature": "WAVETABLE_NAMES", "summary": "" }, { "name": "PD_SHAPE_OPTIONS", "kind": "constant", "signature": "PD_SHAPE_OPTIONS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/WaveguideNode", "path": "engine/reference/audio/synth/nodes/WaveguideNode.md", "source": "engine/audio/synth/nodes/WaveguideNode.js", "import": "/engine/audio/synth/nodes/WaveguideNode.js", "sourceHash": "51e48dcfcf4da2762ba79faee3d3e9cb029dab4a9f70433894a64f400d276c22", "summary": "Render a waveguide to an AudioBuffer (offline).", "exports": [ { "name": "renderWaveguide", "kind": "function", "signature": "renderWaveguide(ctx, config = {})", "summary": "Render a waveguide to an AudioBuffer (offline)." }, { "name": "createWaveguide", "kind": "function", "signature": "createWaveguide(ctx, config = {})", "summary": "Create a real-time waveguide engine using Web Audio nodes. This is a simplified version using delay + filter + feedback." }, { "name": "isValidTermination", "kind": "function", "signature": "isValidTermination(term)", "summary": "" }, { "name": "isValidWaveguideMode", "kind": "function", "signature": "isValidWaveguideMode(mode)", "summary": "" }, { "name": "WAVEGUIDE_TERMINATIONS", "kind": "constant", "signature": "WAVEGUIDE_TERMINATIONS", "summary": "" }, { "name": "WAVEGUIDE_MODE_OPTIONS", "kind": "constant", "signature": "WAVEGUIDE_MODE_OPTIONS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/atoms/CrackleAtom", "path": "engine/reference/audio/synth/nodes/atoms/CrackleAtom.md", "source": "engine/audio/synth/nodes/atoms/CrackleAtom.js", "import": "/engine/audio/synth/nodes/atoms/CrackleAtom.js", "sourceHash": "095e6c744d5600c4ec8c6318f761855d95c1dcdac779920e3b0150282acdf7d2", "summary": "CrackleAtom.js - Crackle Sound Atom (Verron 2012) Pre-wired patch: Impulse → ModalBank (2-3 modes) → Envelope (AD) → Gain Driven by: emitRate → density, temperature → brightness Use case: fire crackle, ice crack, sparks", "exports": [ { "name": "createCrackleAtomPatch", "kind": "function", "signature": "createCrackleAtomPatch(config = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/atoms/DropAtom", "path": "engine/reference/audio/synth/nodes/atoms/DropAtom.md", "source": "engine/audio/synth/nodes/atoms/DropAtom.js", "import": "/engine/audio/synth/nodes/atoms/DropAtom.js", "sourceHash": "debbedfbbd6a5c8a70a54d1e50296481d7a28df0d3cb2e1c79d08a73912fef82", "summary": "DropAtom.js - Drop Sound Atom (Verron 2012) Pre-wired patch: Impulse → Resonator (single mode) → Envelope (AD) Driven by: mass → pitch, velocity → amplitude Use case: rain drops, drips, liquid impacts", "exports": [ { "name": "createDropAtomPatch", "kind": "function", "signature": "createDropAtomPatch(config = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/atoms/HissAtom", "path": "engine/reference/audio/synth/nodes/atoms/HissAtom.md", "source": "engine/audio/synth/nodes/atoms/HissAtom.js", "import": "/engine/audio/synth/nodes/atoms/HissAtom.js", "sourceHash": "ba4d9cddf94ee31cb9139cdbf0881235f589dbf3f0e374b1cc22543cf5c5e9f5", "summary": "HissAtom.js - Hiss Sound Atom (Verron 2012) Pre-wired patch: Noise(white) → HighPass → Gain Driven by: temperature → cutoff, emitRate → volume Use case: steam, gas escape, sizzle, continuous background", "exports": [ { "name": "createHissAtomPatch", "kind": "function", "signature": "createHissAtomPatch(config = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/atoms/RumbleAtom", "path": "engine/reference/audio/synth/nodes/atoms/RumbleAtom.md", "source": "engine/audio/synth/nodes/atoms/RumbleAtom.js", "import": "/engine/audio/synth/nodes/atoms/RumbleAtom.js", "sourceHash": "65c40aa8991a953377cb80faacbea2c8a00bdc52d36ee78f8990f4bf680ba667", "summary": "RumbleAtom.js - Rumble Sound Atom (Verron 2012) Pre-wired patch: BrownNoise → LowPass → Gain Driven by: size → cutoff, velocity → volume Use case: thunder, ground shake, lava, explosions", "exports": [ { "name": "createRumbleAtomPatch", "kind": "function", "signature": "createRumbleAtomPatch(config = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/atoms/WhooshAtom", "path": "engine/reference/audio/synth/nodes/atoms/WhooshAtom.md", "source": "engine/audio/synth/nodes/atoms/WhooshAtom.js", "import": "/engine/audio/synth/nodes/atoms/WhooshAtom.js", "sourceHash": "58c3b4a518711195742c5940983f5af9c5311009dfd8f88036c0616096f26ea0", "summary": "WhooshAtom.js - Whoosh Sound Atom (Verron 2012) Pre-wired patch: Noise → BandPass → Envelope → Gain Driven by: velocity → centerFreq, size → bandwidth Use case: wind, projectile flyby, movement", "exports": [ { "name": "createWhooshAtomPatch", "kind": "function", "signature": "createWhooshAtomPatch(config = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/instruments/InstrumentPresets", "path": "engine/reference/audio/synth/nodes/instruments/InstrumentPresets.md", "source": "engine/audio/synth/nodes/instruments/InstrumentPresets.js", "import": "/engine/audio/synth/nodes/instruments/InstrumentPresets.js", "sourceHash": "57b0fe3c47337a4c22c60521ea9eca9e094fcfb958b3d46905d394496f27c7d6", "summary": "Convert MIDI note number to frequency.", "exports": [ { "name": "midiToFreq", "kind": "function", "signature": "midiToFreq(note)", "summary": "Convert MIDI note number to frequency." }, { "name": "freqToMidi", "kind": "function", "signature": "freqToMidi(freq)", "summary": "Convert frequency to MIDI note number." }, { "name": "createPianoInstrument", "kind": "function", "signature": "createPianoInstrument(ctx, config = {})", "summary": "Create a piano instrument using Karplus-Strong + FM." }, { "name": "createStringsInstrument", "kind": "function", "signature": "createStringsInstrument(ctx, config = {})", "summary": "Create a string ensemble instrument." }, { "name": "createBrassInstrument", "kind": "function", "signature": "createBrassInstrument(ctx, config = {})", "summary": "Create a brass instrument with growl and brightness." }, { "name": "createPadSynth", "kind": "function", "signature": "createPadSynth(ctx, config = {})", "summary": "Create a lush pad synthesizer." }, { "name": "createLeadSynth", "kind": "function", "signature": "createLeadSynth(ctx, config = {})", "summary": "Create a mono lead synthesizer with glide." }, { "name": "createBassSynth", "kind": "function", "signature": "createBassSynth(ctx, config = {})", "summary": "Create a bass synthesizer." }, { "name": "createDrumSynth", "kind": "function", "signature": "createDrumSynth(ctx, config = {})", "summary": "Create an analog-style drum synthesizer." }, { "name": "INSTRUMENT_TYPES", "kind": "constant", "signature": "INSTRUMENT_TYPES", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/physics/CombustionModel", "path": "engine/reference/audio/synth/nodes/physics/CombustionModel.md", "source": "engine/audio/synth/nodes/physics/CombustionModel.js", "import": "/engine/audio/synth/nodes/physics/CombustionModel.js", "sourceHash": "398384d0a4233e471ef0d06ec954c06bcdc7c4c208f271b48f3bf43f57e28295", "summary": "CombustionModel.js - Fire/Combustion Synthesis Model Combines Crackle + Hiss + Rumble atoms mixed by intensity. Low intensity = gentle crackle. High intensity = roaring fire with rumble. Driven by: emitRate, temperature", "exports": [ { "name": "createCombustionPatch", "kind": "function", "signature": "createCombustionPatch(config = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/physics/FluidModel", "path": "engine/reference/audio/synth/nodes/physics/FluidModel.md", "source": "engine/audio/synth/nodes/physics/FluidModel.js", "import": "/engine/audio/synth/nodes/physics/FluidModel.js", "sourceHash": "abdd44e52e5c860f03160dc7ac18064d4f8dea3089e76bb5d442b9187b6a1a92", "summary": "FluidModel.js - Fluid/Water Synthesis Model Combines Drop atoms (splashes) + Hiss (flow) for liquid sounds. Driven by: emitRate, velocity, splash rate", "exports": [ { "name": "createFluidPatch", "kind": "function", "signature": "createFluidPatch(config = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/physics/ModalImpactModel", "path": "engine/reference/audio/synth/nodes/physics/ModalImpactModel.md", "source": "engine/audio/synth/nodes/physics/ModalImpactModel.js", "import": "/engine/audio/synth/nodes/physics/ModalImpactModel.js", "sourceHash": "af812c14dbffb28ffded2f1ad1712c42f45e741b11b89fc2c28bb7a4b325e28d", "summary": "ModalImpactModel.js - Material-Aware Impact Synthesis Excites a bank of resonators on collision. Material properties determine mode frequencies, Q factors, and decay times. Uses MATERIAL enum from SubstanceSchema for lookup. Based on Cook/Smith modal synthesis (Stanford CCRMA).", "exports": [ { "name": "getModalPreset", "kind": "function", "signature": "getModalPreset(material)", "summary": "Get modal preset for a material." }, { "name": "getModalMaterials", "kind": "function", "signature": "getModalMaterials()", "summary": "Get all available material names." }, { "name": "createModalImpactPatch", "kind": "function", "signature": "createModalImpactPatch(config = {})", "summary": "Generate a ModalImpact patch descriptor for a given material." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/physics/WeatherModel", "path": "engine/reference/audio/synth/nodes/physics/WeatherModel.md", "source": "engine/audio/synth/nodes/physics/WeatherModel.js", "import": "/engine/audio/synth/nodes/physics/WeatherModel.js", "sourceHash": "e30b6b2b02e2ecd2d3b2e374dff312e85a89beb4caadcab75fd25d1dcf9faeef", "summary": "WeatherModel.js - Weather Synthesis Model Rain (grain cloud of drops), hail, thunder (rumble). Driven by: weather type, intensity", "exports": [ { "name": "createWeatherPatch", "kind": "function", "signature": "createWeatherPatch(config = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "audio/synth/nodes/physics/WindModel", "path": "engine/reference/audio/synth/nodes/physics/WindModel.md", "source": "engine/audio/synth/nodes/physics/WindModel.js", "import": "/engine/audio/synth/nodes/physics/WindModel.js", "sourceHash": "936e813a13336c43c2e3ea9e75e5b82d1796a424820f133dcd64b5a7929ef75e", "summary": "WindModel.js - Wind Synthesis Model Combines Whoosh + Rumble, with gust modulation from WindSystem. Driven by: windSpeed, gustiness", "exports": [ { "name": "createWindPatch", "kind": "function", "signature": "createWindPatch(config = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabAnonymousRelay", "path": "engine/reference/collab/CollabAnonymousRelay.md", "source": "engine/collab/CollabAnonymousRelay.js", "import": "/engine/collab/CollabAnonymousRelay.js", "sourceHash": "81a67d05584f59af67db05b09dabe3785d52a3f70a721238212d2c7dcf4fe9b3", "summary": "CollabAnonymousRelay.js Anonymous peer mapping and routing for P2P collab channels. Inspired by Tor onion routing, I2P garlic routing, and AP3 pseudonymous overlays — adapted for real-time game networking where latency matters. Three layers of anonymity: 1. Pseudonymous IDs — each peer gets a random session token (anonId). All ops use anonIds instead of real selfIds. Peers never see each other's real identity. Different anonId each session prevents cross-session correlation. 2. TURN-only relay — forces iceTransportPolicy:'relay' so WebRTC ICE candidates never leak real IP addresses between peers. 3. Garlic encryption — each message payload is encrypted with the recipient's ECDH public key before being sent through the relay. The relay host can route messages (via anonId headers) but cannot read the encrypted payload. Only the intended recipient can decrypt. Architecture: - The host acts as an anonymizing relay (already in relay mode) - Peers send messages to the host with a destination anonId - The host maps anonId → realPeerId, forwards the message - The forwarded message has the sender's anonId (not real ID) - Result: no peer knows any other peer's real identity or IP Flow: 1. createAnonymousRelay() → relay state with self anonId 2. Host: registerPeer(realPeerId) → assigns anonId, stores mapping 3. Outgoing: sanitizeOp(op) → replaces peerId with anonId 4. Host routing: resolveAnonToReal(anonId) → realPeerId for delivery 5. Incoming: the op already has sender's anonId (safe to process) 6. Garlic: wrapGarlic(op, recipientEcdhPub) → encrypted payload 7. Garlic: unwrapGarlic(op, ownEcdhPrivate) → decrypted payload", "exports": [ { "name": "collabAnonTimestampReport", "kind": "function", "signature": "collabAnonTimestampReport(timestamp, nowMs = Date.now()", "summary": "" }, { "name": "collabAnonScoreReport", "kind": "function", "signature": "collabAnonScoreReport(scoreData, nowMs = Date.now()", "summary": "" }, { "name": "getAnonUsername", "kind": "function", "signature": "getAnonUsername(anonId)", "summary": "Generate an anonymous username from an anonId. Format: \"Anon-XXXX\" where XXXX is first 4 chars of the anonId." }, { "name": "createAnonymousRelay", "kind": "function", "signature": "createAnonymousRelay(config)", "summary": "Create an anonymous relay state." }, { "name": "registerAnonPeer", "kind": "function", "signature": "registerAnonPeer(relay, realPeerId, ecdhPublicKey)", "summary": "Register a peer and assign them an anonymous ID. On the host: stores both directions of the mapping. On non-host: only stores our own mapping (we know our own anonId)." }, { "name": "removeAnonPeer", "kind": "function", "signature": "removeAnonPeer(relay, realPeerId)", "summary": "Remove a peer from the anonymous mapping." }, { "name": "resolveRealToAnon", "kind": "function", "signature": "resolveRealToAnon(relay, realPeerId)", "summary": "Resolve a real peer ID to its anonymous ID." }, { "name": "resolveAnonToReal", "kind": "function", "signature": "resolveAnonToReal(relay, anonId)", "summary": "Resolve an anonymous ID back to the real peer ID. HOST ONLY — non-host peers cannot resolve other peers' anonIds." }, { "name": "resolveAnonUsername", "kind": "function", "signature": "resolveAnonUsername(relay, anonIdOrRealId)", "summary": "Get the anonymous username for a peer." }, { "name": "sanitizeOutgoingOp", "kind": "function", "signature": "sanitizeOutgoingOp(relay, op)", "summary": "Sanitize an outgoing op: replace all real peer IDs with anonymous IDs. This is called before broadcasting — peers only see anonIds." }, { "name": "deanonymizeIncomingOp", "kind": "function", "signature": "deanonymizeIncomingOp(relay, op)", "summary": "De-anonymize an incoming op: resolve anonIds back to real peer IDs. HOST ONLY — used for internal routing decisions. The forwarded copy to other peers keeps the anonIds intact." }, { "name": "reanonymizeForForward", "kind": "function", "signature": "reanonymizeForForward(relay, op, senderRealPeerId)", "summary": "Re-anonymize an op for forwarding to another peer. The host de-anonymizes for routing, then this re-anonymizes for delivery. This ensures the recipient only sees the sender's anonId." }, { "name": "wrapGarlic", "kind": "function", "signature": "async wrapGarlic(relay, op, recipientAnonId, ownEcdhPrivateKey)", "summary": "Wrap an op in garlic encryption for a specific recipient. The payload is encrypted with a shared key derived from our ECDH private key + the recipient's ECDH public key. The relay host can route (via 'to' field) but cannot read the encrypted payload." }, { "name": "unwrapGarlic", "kind": "function", "signature": "async unwrapGarlic(relay, garlicOp, ownEcdhPrivateKey)", "summary": "Unwrap a garlic-encrypted message using our ECDH private key." }, { "name": "buildAnonHello", "kind": "function", "signature": "buildAnonHello(relay, realHello)", "summary": "Build an anonymous hello payload. Replaces the real selfId/username with anonymous versions. The ECDH public key is still included (needed for garlic encryption) but it's an ephemeral session key, not tied to persistent identity." }, { "name": "processAnonHello", "kind": "function", "signature": "processAnonHello(relay, realPeerId, anonHello)", "summary": "Process an anonymous hello on the host side. The host needs to map the anonymous selfId to the real peer connection." }, { "name": "getAnonIceConfig", "kind": "function", "signature": "getAnonIceConfig(iceServers)", "summary": "Get ICE configuration for anonymous mode. Forces TURN-only relay to prevent IP address leakage." }, { "name": "sanitizePresence", "kind": "function", "signature": "sanitizePresence(relay, presenceEntry)", "summary": "Check if a peer list entry should be visible to other peers. In anonymous mode, strip real identifiers from presence data." }, { "name": "getAnonRelayStats", "kind": "function", "signature": "getAnonRelayStats(relay)", "summary": "Get anonymous relay stats for UI display." }, { "name": "isAnonEnabled", "kind": "function", "signature": "isAnonEnabled(relay)", "summary": "Check if anonymous mode is active on a relay." }, { "name": "generateSessionSeed", "kind": "function", "signature": "generateSessionSeed()", "summary": "Generate a session seed (host only). Shared with all peers so they can build their credential proof." }, { "name": "generateAnonSigningKey", "kind": "function", "signature": "async generateAnonSigningKey()", "summary": "Generate a fresh session ECDSA P-256 key pair for anonymous signing. This key is ephemeral — different every session, never persisted." }, { "name": "buildAnonCredential", "kind": "function", "signature": "async buildAnonCredential(persistentIdentity, sessionSeed)", "summary": "Build an anonymous credential: prove we're a legitimate peer by signing the sessionSeed with our persistent ECDSA key. The credential proves: \"I possess the private key for a registered identity\" without revealing WHICH identity (the credential is sent only to the host via E2E encrypted channel, and the host discards the mapping after verification)." }, { "name": "verifyAnonCredential", "kind": "function", "signature": "async verifyAnonCredential(persistentPubKeyRaw, sessionSeed, credential)", "summary": "Verify an anonymous credential (HOST ONLY). Confirms the credential was signed by the persistent key we know for this peer." }, { "name": "signAnonScoreReceipt", "kind": "function", "signature": "async signAnonScoreReceipt(sessionKeyPair, scoreData)", "summary": "Sign a score receipt with the anonymous session key. Uses the same canonical format as signScoreReceipt but with the session key. The anonId is used instead of the real selfId in the signed data." }, { "name": "verifyAnonScoreReceipt", "kind": "function", "signature": "async verifyAnonScoreReceipt(certifiedSessionKeys, scoreData, signature, signerPublicKey = null, nowMs = Date.now()", "summary": "Verify an anonymous score receipt against the list of certified session keys. Returns true if ANY certified session key validates the signature. This is the key anonymity property: verifier confirms the receipt is from a legitimate peer without learning WHICH peer." }, { "name": "anonRelayPayloadHash", "kind": "function", "signature": "async anonRelayPayloadHash(payloadStr)", "summary": "" }, { "name": "signAnonCriticalOp", "kind": "function", "signature": "async signAnonCriticalOp(sessionKeyPair, sessionPubKeyRaw, op, anonId)", "summary": "Sign a critical op with the anonymous session key. Same canonical format as signCriticalOp but uses session key + anonId." }, { "name": "verifyAnonCriticalOp", "kind": "function", "signature": "async verifyAnonCriticalOp(op, senderAnonId, certifiedSessionKeys, relay = null, nowMs = Date.now()", "summary": "Verify a critical op signed with an anonymous session key. Checks the signature against ALL certified session keys." }, { "name": "initAnonCredentials", "kind": "function", "signature": "initAnonCredentials(relay, sessionSeed, ownSessionKey)", "summary": "Initialize the anonymous credential state on the relay. Called after the relay is created and the host generates a session seed." }, { "name": "certifySessionKey", "kind": "function", "signature": "certifySessionKey(relay, sessionPubKeyRaw)", "summary": "Add a verified session public key to the certified list (HOST). Called after the host verifies a peer's anonymous credential." }, { "name": "setCertifiedSessionKeys", "kind": "function", "signature": "setCertifiedSessionKeys(relay, keyList)", "summary": "Set the full certified session key list (NON-HOST peers). Called when the host broadcasts the shuffled list of all certified keys." }, { "name": "getCertifiedSessionKeys", "kind": "function", "signature": "getCertifiedSessionKeys(relay)", "summary": "Get the list of certified session keys." }, { "name": "buildAnonCredentialOp", "kind": "function", "signature": "buildAnonCredentialOp(relay, credential)", "summary": "Build an __anon_credential__ op for the host. Sent after joining to prove legitimacy and register session key." }, { "name": "buildAnonKeylistOp", "kind": "function", "signature": "buildAnonKeylistOp(relay)", "summary": "Build an __anon_keylist__ op to broadcast the certified session key list. HOST ONLY — sent to all peers after verifying credentials." }, { "name": "buildAnonScoreReportOp", "kind": "function", "signature": "async buildAnonScoreReportOp(relay, targetAnonId, score)", "summary": "Build an anonymous score report op. Uses the session key for signing instead of the persistent ECDSA key." }, { "name": "isAnonCredentialsReady", "kind": "function", "signature": "isAnonCredentialsReady(relay)", "summary": "Check if anonymous credentials are ready for signing/verification." }, { "name": "resetAnonymousRelay", "kind": "function", "signature": "resetAnonymousRelay(relay)", "summary": "" }, { "name": "destroyAnonymousRelay", "kind": "function", "signature": "destroyAnonymousRelay(relay)", "summary": "" }, { "name": "COLLAB_ANON_RELAY_LIMITS", "kind": "constant", "signature": "COLLAB_ANON_RELAY_LIMITS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabCameraInterp", "path": "engine/reference/collab/CollabCameraInterp.md", "source": "engine/collab/CollabCameraInterp.js", "import": "/engine/collab/CollabCameraInterp.js", "sourceHash": "537ff4bfadd967778b7f450f4feedc686dd6f4090447540fb0b298b5398d466e", "summary": "CollabCameraInterp.js Hermite-spline camera interpolation for smooth remote peer camera rendering. Based on Glenn Fiedler's \"Snapshot Interpolation\" (Gaffer on Games, GDC 2015): - Buffer camera snapshots and render slightly behind real-time - Use cubic Hermite splines (position + velocity at each sample) for C1 continuity - Adaptive jitter compensation adjusts the playback delay automatically Hermite basis: H(t) = (2t³ - 3t² + 1)·p0 + (t³ - 2t² + t)·v0·Δt + (-2t³ + 3t²)·p1 + (t³ - t²)·v1·Δt This guarantees the curve passes through p0 and p1 with matching velocities, eliminating the 1st-order discontinuity artifacts that linear interpolation causes.", "exports": [ { "name": "createCameraInterpState", "kind": "function", "signature": "createCameraInterpState()", "summary": "Create the global camera interpolation state. Attach to editor.collab or pass around explicitly." }, { "name": "pushCameraSnapshot", "kind": "function", "signature": "pushCameraSnapshot(state, peerId, pos, target, vel, targetVel, remoteTs)", "summary": "Push a camera_sync snapshot into the interpolation buffer. Call this from the camera_sync op handler instead of snapping peer.camera directly." }, { "name": "getInterpolatedCamera", "kind": "function", "signature": "getInterpolatedCamera(state, peerId)", "summary": "Get the smoothly interpolated camera position for a remote peer. Call this every render frame from CollabOverlayRenderer." }, { "name": "pruneStaleInterpBuffers", "kind": "function", "signature": "pruneStaleInterpBuffers(state)", "summary": "Remove stale peer buffers. Call periodically (~1Hz)." }, { "name": "removePeerInterpBuffer", "kind": "function", "signature": "removePeerInterpBuffer(state, peerId)", "summary": "Remove a specific peer's buffer (on disconnect)." }, { "name": "getInterpStats", "kind": "function", "signature": "getInterpStats(state)", "summary": "Get interpolation stats for UI display." }, { "name": "destroyCameraInterpState", "kind": "function", "signature": "destroyCameraInterpState(state)", "summary": "Destroy all state." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabCodec", "path": "engine/reference/collab/CollabCodec.md", "source": "engine/collab/CollabCodec.js", "import": "/engine/collab/CollabCodec.js", "sourceHash": "0392294f129cd89df5b61802c3909f324eb88d8fd328d2c26a0425a96b5dd45b", "summary": "CollabCodec.js Inline MessagePack encoder/decoder for binary collab messages. Zero dependencies — implements msgpack spec directly. Supports: null, bool, int (safe integer range), float64, string, bin (Uint8Array), array, map (plain objects). Special extension type 0x01: Float32Array with canonical little-endian bytes. Usage: import { encode, decode } from './CollabCodec.js'; const bytes = encode({ ch: 'ops', data: { type: 'transform', pos: new Float32Array([1,2,3]) } }); const obj = decode(bytes);", "exports": [ { "name": "encode", "kind": "function", "signature": "encode(value, options = {})", "summary": "Encode a JS value into a msgpack Uint8Array." }, { "name": "codecEncodeReport", "kind": "function", "signature": "codecEncodeReport(value, options = {})", "summary": "" }, { "name": "decode", "kind": "function", "signature": "decode(data, options = {})", "summary": "Decode a msgpack Uint8Array (or ArrayBuffer) back into a JS value." }, { "name": "codecDecodeReport", "kind": "function", "signature": "codecDecodeReport(data, options = {})", "summary": "" }, { "name": "COLLAB_CODEC_LIMITS", "kind": "constant", "signature": "COLLAB_CODEC_LIMITS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabCore", "path": "engine/reference/collab/CollabCore.md", "source": "engine/collab/CollabCore.js", "import": "/engine/collab/CollabCore.js", "sourceHash": "145b1d28121779715f435b47d8810d202256f23b6a1409e5f7c929daa3390801", "summary": "CollabCore.js WebRTC peer connection management. Manages RTCPeerConnection instances, data channels, and reconnection. Two data channels per peer: 'ops' — reliable, ordered (scene operations) 'presence' — unreliable, unordered (camera/selection at 10Hz)", "exports": [ { "name": "createCollabCore", "kind": "function", "signature": "createCollabCore(config)", "summary": "Create a collab core instance. config: { projectId, selfId, username, onOp, onPresence, onPeerDiscovered, shouldConnectPeer, onPeerJoin, onPeerLeave }" }, { "name": "startCollab", "kind": "function", "signature": "startCollab(core)", "summary": "Start signaling and begin peer discovery." }, { "name": "forceDiscovery", "kind": "function", "signature": "forceDiscovery(core)", "summary": "Force an immediate discovery pass: re-announce on all signaling tiers right now. Lets an app-layer \"Connect now\" find a known contact without waiting for the periodic announce cycle. Does not tear down existing peers." }, { "name": "broadcastOp", "kind": "function", "signature": "broadcastOp(core, op)", "summary": "Broadcast an op to all connected peers. Transport priority: 1. FastChannel (same-origin BroadcastChannel) — <1ms 2. Gossip mesh (partial mesh / supernode mode) — K neighbors, O(log N) delivery 3. Full mesh WebRTC — direct to all (≤6 peers)" }, { "name": "broadcastPresence", "kind": "function", "signature": "broadcastPresence(core, presenceData)", "summary": "Broadcast presence data to all connected peers (unreliable channel). Prefers fast channel for same-origin peers." }, { "name": "collabChunkEnvelopeReport", "kind": "function", "signature": "collabChunkEnvelopeReport(data)", "summary": "" }, { "name": "sendToPeer", "kind": "function", "signature": "sendToPeer(core, peerId, data)", "summary": "Send data to a specific peer only. Prefers fast channel for same-origin peers. Auto-chunks large messages to avoid SCTP size limits." }, { "name": "relayOp", "kind": "function", "signature": "relayOp(core, fromPeerId, op)", "summary": "Relay an op from one peer to all other peers (host-only, relay mode). Optionally filters by spatial interest set." }, { "name": "computeDynamicCapacity", "kind": "function", "signature": "computeDynamicCapacity(core, peerReputation)", "summary": "Compute the dynamic peer capacity based on connection quality. Fast channel peers are free. Trusted peers expand the mesh limit." }, { "name": "collabRelayThresholdReport", "kind": "function", "signature": "collabRelayThresholdReport(value)", "summary": "" }, { "name": "collabPeerScoreReport", "kind": "function", "signature": "collabPeerScoreReport(value)", "summary": "" }, { "name": "checkRelayMode", "kind": "function", "signature": "checkRelayMode(core, peerReputation)", "summary": "Check peer count and toggle relay mode if threshold is crossed. Now uses dynamic capacity — fast peers don't count, trusted peers expand the limit." }, { "name": "setCoreRelayConfig", "kind": "function", "signature": "setCoreRelayConfig(core, opts)", "summary": "Set the spatial authority reference for interest-filtered relay." }, { "name": "setCoreFastChannel", "kind": "function", "signature": "setCoreFastChannel(core, fastChannel)", "summary": "Set the fast channel reference on the core. Called by EditorCollab after creating the fast channel." }, { "name": "setCoreTopology", "kind": "function", "signature": "setCoreTopology(core, topology)", "summary": "Set the mesh topology reference on the core. Called by EditorCollab after creating the topology manager." }, { "name": "isPeerTrusted", "kind": "function", "signature": "isPeerTrusted(core, peerId, peerScore)", "summary": "Check if a peer is trusted (high reputation) and should get a direct connection even in relay mode. Trusted peers bypass the relay host for lower latency." }, { "name": "getPeerConnectionTier", "kind": "function", "signature": "getPeerConnectionTier(core, peerId, peerScore, fastChannel)", "summary": "Get the connection tier label for a peer." }, { "name": "getMaxBufferedAmount", "kind": "function", "signature": "getMaxBufferedAmount(core)", "summary": "Get the maximum bufferedAmount across all peer ops channels. Used by CollabMessageRouter for backpressure detection." }, { "name": "collabBufferedAmountReport", "kind": "function", "signature": "collabBufferedAmountReport(value)", "summary": "" }, { "name": "getSelfId", "kind": "function", "signature": "getSelfId(core)", "summary": "Get the local peer ID." }, { "name": "getPeers", "kind": "function", "signature": "getPeers(core)", "summary": "Get all connected peers." }, { "name": "connectCollabPeer", "kind": "function", "signature": "connectCollabPeer(core, peerId, username = 'Remote')", "summary": "Begin a targeted WebRTC connection to an already-discovered peer." }, { "name": "disconnectCollabPeer", "kind": "function", "signature": "disconnectCollabPeer(core, peerId)", "summary": "Close one direct peer connection without tearing down discovery." }, { "name": "observeCollabPeerMetrics", "kind": "function", "signature": "async observeCollabPeerMetrics(core, peerId)", "summary": "Collect locally observed transport quality. Remote peers cannot supply or inflate these values, which makes them suitable input for topology roles." }, { "name": "destroyCollabCore", "kind": "function", "signature": "destroyCollabCore(core)", "summary": "Destroy all connections and signaling." }, { "name": "deriveCollabChannelId", "kind": "function", "signature": "async deriveCollabChannelId(selfId, peerId)", "summary": "Derive a shared AES-256-GCM key from ECDH key exchange. Called after hello handshake when both peers have ECDH public keys." }, { "name": "collabReconnectPlanReport", "kind": "function", "signature": "collabReconnectPlanReport(attempts)", "summary": "" }, { "name": "collabHeartbeatReport", "kind": "function", "signature": "collabHeartbeatReport(lastPongMs, timestampMs)", "summary": "" }, { "name": "broadcastGoodbye", "kind": "function", "signature": "broadcastGoodbye(core)", "summary": "Broadcast a graceful goodbye to all peers before leaving. This lets other peers immediately remove us instead of waiting for heartbeat timeout or WebRTC state change." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabCrypto", "path": "engine/reference/collab/CollabCrypto.md", "source": "engine/collab/CollabCrypto.js", "import": "/engine/collab/CollabCrypto.js", "sourceHash": "a5e0167ce58d23341f7c29dcd7518fb05ba81604f9d7228dec8059a25444e548", "summary": "CollabCrypto.js ECDH P-256 key exchange + AES-256-GCM encryption for P2P collab channels. Uses the SubtleCrypto API with shared finite-number admission. Flow: 1. Each peer calls generateKeyPair() on connect 2. Peers exchange public keys during hello handshake 3. deriveSharedKey() produces an AES-256-GCM key via ECDH + HKDF 4. All subsequent messages: encrypt() before send, decrypt() on receive 5. HMAC for challenge-response authentication during handshake Nonce scheme: 12 bytes = [8-byte channelId | 4-byte monotonic counter] Counter MUST never repeat for a given key.", "exports": [ { "name": "generateKeyPair", "kind": "function", "signature": "async generateKeyPair()", "summary": "Generate an ECDH P-256 key pair for key exchange." }, { "name": "importPublicKey", "kind": "function", "signature": "async importPublicKey(rawKey)", "summary": "Import a raw public key (65 bytes) received from a remote peer." }, { "name": "deriveSharedKey", "kind": "function", "signature": "async deriveSharedKey(privateKey, remotePublicKey, salt)", "summary": "Derive a shared AES-256-GCM key from our private key + remote public key. Optionally mixes in a room password for authentication." }, { "name": "deriveHmacKey", "kind": "function", "signature": "async deriveHmacKey(privateKey, remotePublicKey, salt)", "summary": "Derive an HMAC-SHA256 key from ECDH shared bits for challenge-response auth." }, { "name": "cryptoNonceReport", "kind": "function", "signature": "cryptoNonceReport(counter, channelId = null)", "summary": "" }, { "name": "encryptedMessageReport", "kind": "function", "signature": "encryptedMessageReport(message, channelId = null)", "summary": "" }, { "name": "nextCryptoSendCounter", "kind": "function", "signature": "nextCryptoSendCounter(state)", "summary": "" }, { "name": "resetCryptoCounters", "kind": "function", "signature": "resetCryptoCounters(state)", "summary": "" }, { "name": "encrypt", "kind": "function", "signature": "async encrypt(key, plaintext, counter, channelId)", "summary": "Encrypt a msgpack payload with AES-256-GCM." }, { "name": "decrypt", "kind": "function", "signature": "async decrypt(key, message, channelId, replayState = null)", "summary": "Decrypt an AES-256-GCM encrypted message." }, { "name": "generateChallenge", "kind": "function", "signature": "generateChallenge()", "summary": "Generate a random 32-byte challenge." }, { "name": "signChallenge", "kind": "function", "signature": "async signChallenge(hmacKey, challenge)", "summary": "Sign a challenge with HMAC-SHA256." }, { "name": "verifyChallenge", "kind": "function", "signature": "async verifyChallenge(hmacKey, challenge, signature)", "summary": "Verify a challenge signature." }, { "name": "createPeerCryptoState", "kind": "function", "signature": "createPeerCryptoState()", "summary": "Create crypto state for a single peer connection." }, { "name": "initPeerCrypto", "kind": "function", "signature": "async initPeerCrypto(state)", "summary": "Initialize crypto state with a fresh key pair." }, { "name": "completePeerCrypto", "kind": "function", "signature": "async completePeerCrypto(state, remotePublicKeyRaw, roomPassword)", "summary": "Complete the handshake: import remote public key, derive shared keys." }, { "name": "isCryptoAvailable", "kind": "function", "signature": "isCryptoAvailable()", "summary": "Check if crypto is available in this environment." }, { "name": "COLLAB_CRYPTO_LIMITS", "kind": "constant", "signature": "COLLAB_CRYPTO_LIMITS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabDivergenceTracker", "path": "engine/reference/collab/CollabDivergenceTracker.md", "source": "engine/collab/CollabDivergenceTracker.js", "import": "/engine/collab/CollabDivergenceTracker.js", "sourceHash": "a7f39090c7d42a1b9f070247e370db0572b74a0a3b16369a29380ed42cb08f2a", "summary": "CollabDivergenceTracker.js Records per-frame position hashes during play mode and compares them across peers to detect simulation divergence. Hash algorithm: FNV-1a 32-bit over quantized entity positions.", "exports": [ { "name": "createDivergenceTracker", "kind": "function", "signature": "createDivergenceTracker()", "summary": "" }, { "name": "divergenceHeartbeatReport", "kind": "function", "signature": "divergenceHeartbeatReport(payload)", "summary": "" }, { "name": "divergenceFrameHashReport", "kind": "function", "signature": "divergenceFrameHashReport(samples)", "summary": "" }, { "name": "recordLocalFrame", "kind": "function", "signature": "recordLocalFrame(tracker, simTime, editor)", "summary": "Record a local frame hash. Call every simHistoryInterval during play." }, { "name": "receiveRemoteHash", "kind": "function", "signature": "receiveRemoteHash(tracker, peerId, simTime, frameHash)", "summary": "Receive a remote heartbeat hash from a peer." }, { "name": "removePeerDivergence", "kind": "function", "signature": "removePeerDivergence(tracker, peerId)", "summary": "Remove a peer's data on disconnect." }, { "name": "getDivergenceLog", "kind": "function", "signature": "getDivergenceLog(tracker)", "summary": "Get all recorded divergence events." }, { "name": "resetDivergenceTracker", "kind": "function", "signature": "resetDivergenceTracker(tracker)", "summary": "Clear all tracking data (call on exitPlayMode)." }, { "name": "exportDivergenceReport", "kind": "function", "signature": "exportDivergenceReport(tracker, localUsername)", "summary": "Export a JSON report of all divergences + local timeline." }, { "name": "computeFrameHash", "kind": "function", "signature": "computeFrameHash(editor)", "summary": "Compute a fast FNV-1a hash of all entity positions in the scene. Quantizes positions to 3 decimal places for float stability." }, { "name": "collabDivergenceFrameHash", "kind": "function", "signature": "collabDivergenceFrameHash(samples)", "summary": "" }, { "name": "injectDivergenceDeps", "kind": "function", "signature": "injectDivergenceDeps(deps)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabEntityAuthority", "path": "engine/reference/collab/CollabEntityAuthority.md", "source": "engine/collab/CollabEntityAuthority.js", "import": "/engine/collab/CollabEntityAuthority.js", "sourceHash": "a728d9b631532d7a040b72fec54f43fb5e33995b924abdae162ca91f337def99", "summary": "CollabEntityAuthority.js Per-entity ownership model for collaborative multiplayer. Every entity has at most one \"owner\" peer. The owner is the sole source of truth for that entity's transform, physics, and interactive state. Ownership transfers via explicit claim/release ops — no server needed. Priority levels (higher number wins): 0 DEFAULT — physics authority (host) owns unclaimed entities 1 PROXIMITY — auto-assigned to nearest peer's camera (future) 2 SELECTED — peer clicked/selected the entity in the inspector 3 GRABBED — peer is actively dragging/manipulating the entity Conflict resolution: - Higher priority always wins (grab beats select beats proximity) - Equal priority: earlier timestamp wins (first-come-first-served) - Owner can always release voluntarily - Stale claims (no refresh for STALE_TIMEOUT_MS) are auto-released Inspired by: Photon Takeover policy, Gaffer on Games authority scheme, Roblox Network Ownership, Source Engine shadow controllers.", "exports": [ { "name": "createEntityAuthority", "kind": "function", "signature": "createEntityAuthority(selfId)", "summary": "Create an entity authority state object." }, { "name": "getEntityOwner", "kind": "function", "signature": "getEntityOwner(auth, entityId)", "summary": "Get the current owner of an entity." }, { "name": "isLocallyOwned", "kind": "function", "signature": "isLocallyOwned(auth, entityId)", "summary": "Check if the local peer owns an entity." }, { "name": "isEntityClaimed", "kind": "function", "signature": "isEntityClaimed(auth, entityId)", "summary": "Check if an entity is owned by anyone (not default authority)." }, { "name": "getEntitiesOwnedBy", "kind": "function", "signature": "getEntitiesOwnedBy(auth, peerId)", "summary": "Get all entities owned by a specific peer." }, { "name": "getLocallyOwnedSet", "kind": "function", "signature": "getLocallyOwnedSet(auth)", "summary": "Get all locally owned entity IDs as a Set (for fast lookup in sync loops)." }, { "name": "shouldBroadcastEntity", "kind": "function", "signature": "shouldBroadcastEntity(auth, entityId, isPlayAuthority)", "summary": "Check if the local peer should broadcast transforms for an entity. Returns true if: (a) we own it, or (b) nobody owns it and we're play authority." }, { "name": "shouldAcceptRemoteTransform", "kind": "function", "signature": "shouldAcceptRemoteTransform(auth, entityId)", "summary": "Check if the local peer should accept remote transforms for an entity. Returns true if we do NOT own it." }, { "name": "claimEntity", "kind": "function", "signature": "claimEntity(auth, entityId, priority)", "summary": "Claim ownership of an entity at a given priority. Returns the op to broadcast, or null if claim was rejected locally." }, { "name": "releaseEntity", "kind": "function", "signature": "releaseEntity(auth, entityId)", "summary": "Release ownership of an entity. Reverts to default authority. Returns the op to broadcast, or null if we didn't own it." }, { "name": "releaseAllLocal", "kind": "function", "signature": "releaseAllLocal(auth)", "summary": "Release ALL claims owned by the local peer (e.g. on disconnect or exit play mode). Returns array of ops to broadcast." }, { "name": "onRemoteAuthorityOp", "kind": "function", "signature": "onRemoteAuthorityOp(auth, op)", "summary": "Handle an incoming entity_authority op from a remote peer. Applies the claim/release to local state after conflict resolution. Returns true if the claim was accepted." }, { "name": "tickAuthority", "kind": "function", "signature": "tickAuthority(auth)", "summary": "Build refresh ops for all local claims (call at ~2Hz from the collab loop). Also prunes stale remote claims." }, { "name": "onPeerDisconnected", "kind": "function", "signature": "onPeerDisconnected(auth, peerId)", "summary": "Handle a peer disconnecting — release all their claims." }, { "name": "getHandoffBlend", "kind": "function", "signature": "getHandoffBlend(auth, entityId)", "summary": "Get handoff blend factor for an entity (0 = fully old owner, 1 = fully new owner). Used by interpolation to smoothly blend during ownership transfer." }, { "name": "onOwnershipChanged", "kind": "function", "signature": "onOwnershipChanged(auth, callback)", "summary": "Set callback for ownership changes." }, { "name": "destroyEntityAuthority", "kind": "function", "signature": "destroyEntityAuthority(auth)", "summary": "Destroy / reset authority state." }, { "name": "AUTHORITY_PRIORITY", "kind": "constant", "signature": "AUTHORITY_PRIORITY", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabFastChannel", "path": "engine/reference/collab/CollabFastChannel.md", "source": "engine/collab/CollabFastChannel.js", "import": "/engine/collab/CollabFastChannel.js", "sourceHash": "5802267e46edb76a3f6ecb697bbb67e7a73c31962ac23953f996775141b91474", "summary": "CollabFastChannel.js Low-overhead data transport for same-origin peers via BroadcastChannel. Problem: WebRTC DataChannels add ~50-100ms RTT even on localhost due to DTLS encryption, SCTP transport, and msgpack encode/decode overhead. Solution: For peers sharing the same browser origin (same-machine testing, same-domain deployment), use the BroadcastChannel API which provides: - Structured clone transfer (no msgpack encode/decode) - No encryption overhead (same-origin security model) - Browser-scheduled local delivery without ICE/STUN/DTLS setup - Zero setup — no ICE/STUN/DTLS negotiation This module creates a dedicated data BroadcastChannel (separate from the signaling channel in CollabSignal.js) that carries ops and presence. CollabCore detects same-origin peers and prefers this transport. For cross-origin / cross-machine peers, WebRTC is still used. Inspired by: Meshtastic's tiered transport (LoRa → BLE → WiFi), choosing the fastest available link per peer.", "exports": [ { "name": "createFastChannel", "kind": "function", "signature": "createFastChannel(projectId, selfId, callbacks = {})", "summary": "Create a fast channel instance." }, { "name": "fastChannelSendOp", "kind": "function", "signature": "fastChannelSendOp(fc, op)", "summary": "Send an op via fast channel to all same-origin peers. Uses structured clone (no msgpack encode/decode)." }, { "name": "fastChannelSendPresence", "kind": "function", "signature": "fastChannelSendPresence(fc, presenceData)", "summary": "Send presence data via fast channel." }, { "name": "fastChannelSendToPeer", "kind": "function", "signature": "fastChannelSendToPeer(fc, peerId, op)", "summary": "Send an op to a specific peer via fast channel." }, { "name": "isFastPeer", "kind": "function", "signature": "isFastPeer(fc, peerId)", "summary": "Check if a specific peer is reachable via fast channel." }, { "name": "getFastPeerIds", "kind": "function", "signature": "getFastPeerIds(fc)", "summary": "Get the set of all fast peer IDs." }, { "name": "getFastChannelStats", "kind": "function", "signature": "getFastChannelStats(fc)", "summary": "Get fast channel stats." }, { "name": "destroyFastChannel", "kind": "function", "signature": "destroyFastChannel(fc)", "summary": "Destroy the fast channel. Sends a bye message to peers first." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabHostMigration", "path": "engine/reference/collab/CollabHostMigration.md", "source": "engine/collab/CollabHostMigration.js", "import": "/engine/collab/CollabHostMigration.js", "sourceHash": "887409c082278d78ec48ed589aa97cde874510da8d93e8b2383332d2281555cf", "summary": "CollabHostMigration.js Automatic host migration for P2P collaboration sessions. Problem: When the host peer drops (closes tab, network outage, crash), relay mode breaks — all non-host peers lose the ability to communicate through the relay hub. The session effectively dies. Solution: Bully-style host election with reputation-weighted scoring. When the host is detected as dead: 1. All peers start a migration election 2. The peer with the highest \"candidacy score\" wins 3. New host assumes relay duties and notifies all peers 4. If the original host returns, it can reclaim the role Election Algorithm (modified Bully): - Each peer computes a candidacy score based on: • Reputation score (40%) — trustworthy peers preferred • Uptime in session (30%) — stable peers preferred • Connection count (20%) — well-connected peers preferred • Deterministic tiebreaker (10%) — lexicographic selfId for consistency - All peers broadcast their candidacy - After a short election timeout, the highest-scoring peer wins - If two peers tie, the one with the lexicographically higher selfId wins Inspired by: - Xbox Live host migration (Halo 2/3) - Photon PUN MasterClient migration - Raft leader election (simplified — no log replication needed) - Bully algorithm (Garcia-Molina, 1982) Current scope: this module elects a relay host and reconfigures routing. Authority-map handoff, replicated-log consensus, election terms/quorums, and signature-gated dispatch are not implemented here and remain audit gaps. Candidate reputation/connection metrics remain locally self-reported, and captured multi-peer host-failure/rejoin traces remain absent.", "exports": [ { "name": "createHostMigration", "kind": "function", "signature": "createHostMigration(selfId, config = {})", "summary": "Create a host migration manager." }, { "name": "startHostMigration", "kind": "function", "signature": "startHostMigration(hm, isHost, hostPeerId)", "summary": "Start host migration monitoring." }, { "name": "migrationSetHost", "kind": "function", "signature": "migrationSetHost(hm, hostPeerId)", "summary": "Set the host peer ID (for joiners who didn't know at startup). Starts the host liveness monitor if not already running." }, { "name": "stopHostMigration", "kind": "function", "signature": "stopHostMigration(hm)", "summary": "Stop host migration monitoring." }, { "name": "hostHeartbeatReceived", "kind": "function", "signature": "hostHeartbeatReceived(hm, fromPeerId)", "summary": "Record that we received a heartbeat (or any message) from the host. Call this from the heartbeat handler." }, { "name": "hostActivityReceived", "kind": "function", "signature": "hostActivityReceived(hm, fromPeerId)", "summary": "Record that we received ANY op from a peer (used for liveness). Even non-heartbeat ops prove the host is alive." }, { "name": "onElectionCandidacy", "kind": "function", "signature": "onElectionCandidacy(hm, peerId, payload)", "summary": "Handle a received election candidacy from another peer." }, { "name": "onElectionResult", "kind": "function", "signature": "onElectionResult(hm, payload)", "summary": "Handle a received election result from another peer." }, { "name": "onHostReclaimRequest", "kind": "function", "signature": "onHostReclaimRequest(hm, originalHostId)", "summary": "Handle the original host returning to the session. The original host broadcasts a reclaim request. The current acting host defers after a grace period, handing duties back." }, { "name": "requestHostReclaim", "kind": "function", "signature": "requestHostReclaim(hm)", "summary": "Called by the original host when it returns to reclaim. Only call if we ARE the original host and someone else took over." }, { "name": "hostMigrationTiebreakerNorm", "kind": "function", "signature": "hostMigrationTiebreakerNorm(selfId)", "summary": "" }, { "name": "hostMigrationCandidacyScoreReport", "kind": "function", "signature": "hostMigrationCandidacyScoreReport(metrics = {}, timestampMs = Date.now()", "summary": "" }, { "name": "migrationAddPeer", "kind": "function", "signature": "migrationAddPeer(hm, peerId)", "summary": "Register a known peer." }, { "name": "migrationRemovePeer", "kind": "function", "signature": "migrationRemovePeer(hm, peerId)", "summary": "Remove a known peer." }, { "name": "migrationUpdateSelfMetrics", "kind": "function", "signature": "migrationUpdateSelfMetrics(hm, score, connectionCount)", "summary": "Update our own metrics (call from collab loop)." }, { "name": "onHostElectionOp", "kind": "function", "signature": "onHostElectionOp(hm, peerId, op)", "summary": "Handle an incoming host_election op. Routes to the appropriate handler based on phase." }, { "name": "buildGoodbyeOp", "kind": "function", "signature": "buildGoodbyeOp(hm)", "summary": "Build a goodbye op to broadcast before leaving. Other peers use this to immediately detect departure instead of waiting for heartbeat timeout." }, { "name": "onPeerGoodbye", "kind": "function", "signature": "onPeerGoodbye(hm, payload, fromPeerId = payload?.peerId)", "summary": "Handle a received goodbye from a departing peer. If the host sent the goodbye, immediately start election (no timeout wait)." }, { "name": "getMigrationState", "kind": "function", "signature": "getMigrationState(hm)", "summary": "" }, { "name": "getMigrationStats", "kind": "function", "signature": "getMigrationStats(hm)", "summary": "" }, { "name": "isCurrentHost", "kind": "function", "signature": "isCurrentHost(hm)", "summary": "" }, { "name": "getCurrentHostId", "kind": "function", "signature": "getCurrentHostId(hm)", "summary": "" }, { "name": "destroyHostMigration", "kind": "function", "signature": "destroyHostMigration(hm)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabIdentity", "path": "engine/reference/collab/CollabIdentity.md", "source": "engine/collab/CollabIdentity.js", "import": "/engine/collab/CollabIdentity.js", "sourceHash": "83acc6170f768b572ac212327918157743880e07ba36326450cd868bc30552e3", "summary": "CollabIdentity.js Cryptographic peer identity using ECDSA P-256 (Web Crypto API). Each peer generates an ECDSA key pair on init. The public key's SHA-256 fingerprint becomes the peer's verified identity — unforgeable without the private key. During the hello handshake, peers exchange public keys and a signed proof (signature of their selfId). The remote side verifies the signature, confirming the peer truly owns the claimed public key. Host verification: the host's fingerprint is embedded in the invite code. Joiners verify the host's fingerprint matches the one in the invite code, preventing host impersonation. Reputation receipts: peers sign their score reports. Others verify the signature before trusting the score, preventing score tampering. Flow: 1. createIdentity() → ECDSA P-256 key pair + fingerprint 2. buildIdentityProof(identity, selfId) → signed selfId (for hello) 3. Remote receives proof → verifyIdentityProof(publicKey, selfId, proof) 4. If host: fingerprint embedded in invite code → joiner checks match 5. signScoreReceipt(identity, scoreData) → signed score for reputation 6. verifyScoreReceipt(publicKey, scoreData, signature) → boolean", "exports": [ { "name": "collabIdentityTimestampReport", "kind": "function", "signature": "collabIdentityTimestampReport(timestamp, nowMs = Date.now()", "summary": "" }, { "name": "collabIdentityPayloadReport", "kind": "function", "signature": "collabIdentityPayloadReport(payload)", "summary": "" }, { "name": "prepareCollabIdentityRecord", "kind": "function", "signature": "prepareCollabIdentityRecord(record)", "summary": "Validate one bounded v1/v2 identity record without guessing future shapes." }, { "name": "collabIdentityCurrentKey", "kind": "function", "signature": "collabIdentityCurrentKey(keyId = COLLAB_IDENTITY_KEY_ID)", "summary": "" }, { "name": "createIdentity", "kind": "function", "signature": "async createIdentity(keyId = COLLAB_IDENTITY_KEY_ID)", "summary": "Generate or load an ECDSA P-256 key pair. Tries IndexedDB first for persistent identity across sessions. If not found, generates a new key pair and stores it. The fingerprint (SHA-256 of public key) stays the same across sessions, enabling long-term reputation tracking." }, { "name": "computeFingerprint", "kind": "function", "signature": "async computeFingerprint(publicKeyRaw)", "summary": "Compute fingerprint from a raw public key (public API for verification)." }, { "name": "buildIdentityProof", "kind": "function", "signature": "async buildIdentityProof(identity, selfId)", "summary": "Build an identity proof: sign our selfId with our private key. The remote peer verifies this signature to confirm we own the public key." }, { "name": "verifyIdentityProof", "kind": "function", "signature": "async verifyIdentityProof(publicKeyRaw, selfId, signature)", "summary": "Verify an identity proof from a remote peer." }, { "name": "collabIdentityScoreReceiptReport", "kind": "function", "signature": "collabIdentityScoreReceiptReport(scoreData, nowMs = Date.now()", "summary": "" }, { "name": "signScoreReceipt", "kind": "function", "signature": "async signScoreReceipt(identity, scoreData)", "summary": "Sign a reputation score receipt. The receipt proves that this peer calculated and reported a specific score for a target peer at a specific time. Other peers verify the signature to prevent score tampering." }, { "name": "verifyScoreReceipt", "kind": "function", "signature": "async verifyScoreReceipt(publicKeyRaw, scoreData, signature, nowMs = Date.now()", "summary": "Verify a reputation score receipt from a remote peer." }, { "name": "signData", "kind": "function", "signature": "async signData(identity, data)", "summary": "Sign arbitrary string data with our identity." }, { "name": "signRawBytes", "kind": "function", "signature": "async signRawBytes(identity, bytes)", "summary": "Sign raw bytes with our identity (no TextEncoder step) — needed when the verifier expects a signature over an exact byte string it issued (e.g. a random challenge), not over the UTF-8 encoding of some stringified form of it. See signData() for the string-based counterpart." }, { "name": "verifyRawBytes", "kind": "function", "signature": "async verifyRawBytes(publicKeyRaw, bytes, signature)", "summary": "Verify a signature on raw bytes. Counterpart to signRawBytes()." }, { "name": "verifyData", "kind": "function", "signature": "async verifyData(publicKeyRaw, data, signature)", "summary": "Verify a signature on arbitrary string data." }, { "name": "createIdentityRegistry", "kind": "function", "signature": "createIdentityRegistry(selfId, identity)", "summary": "Create a registry that tracks verified identities for all connected peers. Each peer's identity is verified once during the hello handshake and then cached. The registry also tracks cross-verified reputation scores." }, { "name": "registerPeerIdentity", "kind": "function", "signature": "async registerPeerIdentity(registry, peerId, publicKeyRaw, identityProof, isHost = false)", "summary": "Register a peer's identity after verifying their proof. Called during the enhanced hello handshake." }, { "name": "removePeerIdentity", "kind": "function", "signature": "removePeerIdentity(registry, peerId)", "summary": "Remove a peer's identity from the registry." }, { "name": "getPeerIdentity", "kind": "function", "signature": "getPeerIdentity(registry, peerId)", "summary": "Get a peer's verified identity info." }, { "name": "setExpectedHostFingerprint", "kind": "function", "signature": "setExpectedHostFingerprint(registry, fingerprint)", "summary": "Set the expected host fingerprint (from the invite code)." }, { "name": "resetIdentityRegistry", "kind": "function", "signature": "resetIdentityRegistry(registry, options = {})", "summary": "" }, { "name": "destroyIdentityRegistry", "kind": "function", "signature": "destroyIdentityRegistry(registry)", "summary": "" }, { "name": "recordScoreReceipt", "kind": "function", "signature": "async recordScoreReceipt(registry, reporterPeerId, targetPeerId, score, timestamp, signature)", "summary": "Record a signed score receipt from a remote peer. Each peer tracks what scores others have reported about them AND about other peers." }, { "name": "getConsensusScore", "kind": "function", "signature": "getConsensusScore(registry, peerId)", "summary": "Get the consensus score for a peer based on all verified receipts. Returns the median of all verified scores reported by different peers. Also detects disputes (significant score disagreements)." }, { "name": "buildScoreReportOp", "kind": "function", "signature": "async buildScoreReportOp(identity, selfId, targetPeerId, score)", "summary": "Build a signed score report op for broadcasting to all peers." }, { "name": "getIdentityStats", "kind": "function", "signature": "getIdentityStats(registry, reputationScores)", "summary": "Get identity system stats for UI display." }, { "name": "isIdentityAvailable", "kind": "function", "signature": "isIdentityAvailable()", "summary": "Check if crypto identity is available." }, { "name": "isCriticalOp", "kind": "function", "signature": "isCriticalOp(opType)", "summary": "Check if an op type requires a signature." }, { "name": "collabIdentityCriticalOpReport", "kind": "function", "signature": "collabIdentityCriticalOpReport(op, senderPeerId, nowMs = Date.now()", "summary": "" }, { "name": "signCriticalOp", "kind": "function", "signature": "async signCriticalOp(identity, op, selfId)", "summary": "Sign a critical op with our ECDSA identity. Appends `_sig` (signature) and `_pub` (public key) fields to the op. The canonical signed data is: `op-sig:type:senderId:timestamp:payloadHash`" }, { "name": "verifyCriticalOp", "kind": "function", "signature": "async verifyCriticalOp(op, senderPeerId, registry)", "summary": "Verify a signed critical op from a remote peer." }, { "name": "collabIdentityPayloadHash", "kind": "function", "signature": "async collabIdentityPayloadHash(str)", "summary": "Helper: SHA-256 hash a string to hex (for canonical op signing)." }, { "name": "computeTrustLevel", "kind": "function", "signature": "computeTrustLevel(registry, peerId, reputationScore)", "summary": "Compute the trust level for a peer." }, { "name": "getTrustColor", "kind": "function", "signature": "getTrustColor(level)", "summary": "Get the display color for a trust level." }, { "name": "getTrustLabel", "kind": "function", "signature": "getTrustLabel(level)", "summary": "Get the display label for a trust level." }, { "name": "COLLAB_IDENTITY_DB_NAME", "kind": "constant", "signature": "COLLAB_IDENTITY_DB_NAME", "summary": "" }, { "name": "COLLAB_IDENTITY_STORE_NAME", "kind": "constant", "signature": "COLLAB_IDENTITY_STORE_NAME", "summary": "" }, { "name": "COLLAB_IDENTITY_KEY_ID", "kind": "constant", "signature": "COLLAB_IDENTITY_KEY_ID", "summary": "" }, { "name": "COLLAB_IDENTITY_RECORD_SCHEMA", "kind": "constant", "signature": "COLLAB_IDENTITY_RECORD_SCHEMA", "summary": "" }, { "name": "COLLAB_IDENTITY_RECORD_VERSION", "kind": "constant", "signature": "COLLAB_IDENTITY_RECORD_VERSION", "summary": "" }, { "name": "COLLAB_IDENTITY_LIMITS", "kind": "constant", "signature": "COLLAB_IDENTITY_LIMITS", "summary": "" }, { "name": "TRUST_LEVEL", "kind": "constant", "signature": "TRUST_LEVEL", "summary": "" }, { "name": "publicKeyRaw", "kind": "constant", "signature": "publicKeyRaw", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabIntegrityVerifier", "path": "engine/reference/collab/CollabIntegrityVerifier.md", "source": "engine/collab/CollabIntegrityVerifier.js", "import": "/engine/collab/CollabIntegrityVerifier.js", "sourceHash": "3bcaed84dcab13fc3b72f0f58c864d77d8d2e1e7a7c7529e199509e67b1c4412", "summary": "CollabIntegrityVerifier.js Integrity validation and anomaly tracking for P2P collab. Inspired by: - Hash-chain receipts: valid ops contribute to a local rolling chain. - Server-side validation rules adapted to pairwise peer validation. - Lockstep P2P: periodic state hashing — all peers hash their zone state and exchange hashes for pairwise divergence detection. - FairPlay: operation whitelist — only registered op types are accepted. Unknown op types are rejected and penalized. Components: 1. Op Receipt Chain — local rolling hash chain per peer 2. Zone State Digest — periodic position hash for pairwise comparison 3. Anomaly Detector — physics/spatial rule violations 4. Operation Whitelist — only valid op types accepted 5. Violation Tracker — accumulates strikes, triggers auto-kick 6. Reputation Integration — violations lower peer score Hashes preserve the existing non-cryptographic legacy FNV-like wire format.", "exports": [ { "name": "collabIntegrityLegacyHash", "kind": "function", "signature": "collabIntegrityLegacyHash(str)", "summary": "Preserve the existing integrity-chain FNV-like string hash. This intentionally keeps the old JavaScript-number multiply path instead of switching to canonical Math.imul FNV-1a, which would change peer digests." }, { "name": "createIntegrityVerifier", "kind": "function", "signature": "createIntegrityVerifier(selfId, config = {})", "summary": "Create an integrity verifier." }, { "name": "validateIncomingOp", "kind": "function", "signature": "validateIncomingOp(verifier, peerId, op)", "summary": "Validate an incoming op from a peer. Checks: 1. Op type is in the whitelist 2. Op has valid structure 3. Entity position changes are within physics limits" }, { "name": "recordOpInChain", "kind": "function", "signature": "recordOpInChain(verifier, peerId, op)", "summary": "Record an op in the peer's hash chain for tamper-evidence. Call after validateIncomingOp succeeds." }, { "name": "getChainHead", "kind": "function", "signature": "getChainHead(verifier, peerId)", "summary": "Get the current chain head hash for a peer (for verification exchange)." }, { "name": "computeZoneDigest", "kind": "function", "signature": "computeZoneDigest(verifier, sceneEntities, ecsWorld, getEntityComponent, authoritySet)", "summary": "Compute a hash digest of all entity positions in the caller's zone. This is exchanged with peers for consensus-based state verification." }, { "name": "buildDigestOp", "kind": "function", "signature": "buildDigestOp(verifier)", "summary": "Build an integrity_digest op to broadcast." }, { "name": "onRemoteDigest", "kind": "function", "signature": "onRemoteDigest(verifier, peerId, digestOp)", "summary": "Handle an incoming integrity_digest from a remote peer. Compares against our own digest — mismatch indicates desync or tampering." }, { "name": "tickIntegrity", "kind": "function", "signature": "tickIntegrity(verifier, peerReputation)", "summary": "Tick the verifier: decay violations, build trust, compute social influence. Call at ~1Hz." }, { "name": "getPeerViolationCount", "kind": "function", "signature": "getPeerViolationCount(verifier, peerId)", "summary": "Get the violation count for a peer." }, { "name": "getPeerViolations", "kind": "function", "signature": "getPeerViolations(verifier, peerId)", "summary": "Get recent violations for a peer." }, { "name": "getAllViolationSummaries", "kind": "function", "signature": "getAllViolationSummaries(verifier)", "summary": "Get all peer violation summaries." }, { "name": "getPeerTier", "kind": "function", "signature": "getPeerTier(verifier, peerId)", "summary": "Get the current tier for a peer." }, { "name": "getPeerTrust", "kind": "function", "signature": "getPeerTrust(verifier, peerId)", "summary": "Get trust level for a peer (0.0-1.0)." }, { "name": "setPlayMode", "kind": "function", "signature": "setPlayMode(verifier, isPlayMode)", "summary": "Set play mode flag — violations during play mode are weighted less." }, { "name": "isPeerThrottled", "kind": "function", "signature": "isPeerThrottled(verifier, peerId)", "summary": "Check if a peer's ops should be throttled (tier >= THROTTLED)." }, { "name": "isPeerMuted", "kind": "function", "signature": "isPeerMuted(verifier, peerId)", "summary": "Check if a peer's scene-edit ops should be blocked (tier >= MUTED)." }, { "name": "getIntegrityStats", "kind": "function", "signature": "getIntegrityStats(verifier)", "summary": "Get verifier stats." }, { "name": "buildCapabilitiesOp", "kind": "function", "signature": "buildCapabilitiesOp(verifier)", "summary": "Build a __capabilities__ op to send to a peer on connect. Contains our supported op types and version string so the remote peer can be lenient about ops we don't recognize (version mismatch, not cheating)." }, { "name": "registerPeerCapabilities", "kind": "function", "signature": "registerPeerCapabilities(verifier, peerId, capabilitiesPayload)", "summary": "Register a remote peer's declared capabilities. Called when we receive a __capabilities__ op from them. Unknown ops from peers with declared capabilities that include the op are treated as version mismatches (INFO), not cheating (HIGH)." }, { "name": "setLocalVersion", "kind": "function", "signature": "setLocalVersion(verifier, version)", "summary": "Set the local version string for capability comparison." }, { "name": "integrityRemovePeer", "kind": "function", "signature": "integrityRemovePeer(verifier, peerId)", "summary": "Remove a peer's tracking state." }, { "name": "destroyIntegrityVerifier", "kind": "function", "signature": "destroyIntegrityVerifier(verifier)", "summary": "Destroy verifier state." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabMeshTopology", "path": "engine/reference/collab/CollabMeshTopology.md", "source": "engine/collab/CollabMeshTopology.js", "import": "/engine/collab/CollabMeshTopology.js", "sourceHash": "c880f9b5916d185ccf0bfd79c84ed9bc0ab66d0f1a657383cb1379f54168724c", "summary": "CollabMeshTopology.js Adaptive mesh topology for scalable P2P collaboration. Problem: Full mesh is O(N²) connections. At 8+ WebRTC peers, browsers struggle with connection management, DTLS overhead, and bandwidth. The old system had a hard limit of 4-8 peers before switching to star relay (single point of failure, bottleneck on host). Solution: Hybrid topology combining proven P2P techniques: 1. PARTIAL MESH — Each peer maintains K direct WebRTC connections to its \"best\" neighbors (lowest latency, highest reputation). K = 3-6 instead of N-1. Scales linearly, not quadratically. 2. GOSSIP PROPAGATION — Ops ripple through the partial mesh. Each peer forwards received ops to its neighbors (minus sender). With K=4, messages reach all 50 peers in ~3 hops (log_K(N)). Deduplication via op fingerprint prevents infinite loops. 3. SUPERNODE ELECTION — High-reputation peers (score ≥ 700) with good uptime and low latency are elected as supernodes. They maintain more connections (up to 2K) and serve as relay hubs between clusters. Inspired by Skype's original P2P architecture. 4. FAST CHANNEL BRIDGING — Same-origin peers use BroadcastChannel (zero cost). They don't count toward K and act as free bridges. Topology modes (auto-selected based on peer count): - FULL_MESH: ≤6 WebRTC peers → everyone connects to everyone - PARTIAL_MESH: 7-50 peers → K-neighbor gossip mesh - SUPERNODE: 20+ peers → supernodes bridge clusters Inspired by: libp2p (IPFS), Kademlia, Bitcoin gossip, Meshtastic, Skype supernode architecture, and epidemic broadcast protocols. Current policy boundaries: topology callbacks recommend connection changes but EditorCollab does not execute them; topology reports are advisory rather than consensus; gossip envelopes are forwarded before application-level integrity validation; and captured large-room WebRTC traces remain absent.", "exports": [ { "name": "createMeshTopology", "kind": "function", "signature": "createMeshTopology(selfId, config = {})", "summary": "Create a topology manager." }, { "name": "resolveTopology", "kind": "function", "signature": "resolveTopology(topo)", "summary": "Resolve the current topology mode based on peer count and quality. Called after peer join/leave and during periodic rebalance." }, { "name": "topologyAddPeer", "kind": "function", "signature": "topologyAddPeer(topo, peerId, info = {})", "summary": "Register a discovered peer (from signaling)." }, { "name": "topologyRemovePeer", "kind": "function", "signature": "topologyRemovePeer(topo, peerId)", "summary": "Remove a peer (disconnected / left)." }, { "name": "topologyPeerConnected", "kind": "function", "signature": "topologyPeerConnected(topo, peerId)", "summary": "Mark a peer as connected (WebRTC DataChannel open)." }, { "name": "topologyPeerDisconnected", "kind": "function", "signature": "topologyPeerDisconnected(topo, peerId)", "summary": "Mark a peer as disconnected." }, { "name": "topologyUpdatePeerMetrics", "kind": "function", "signature": "topologyUpdatePeerMetrics(topo, peerId, metrics)", "summary": "Update a peer's metrics (called from reputation system)." }, { "name": "computeIdealNeighbors", "kind": "function", "signature": "computeIdealNeighbors(topo)", "summary": "Compute the ideal neighbor set based on current metrics. Returns { connect: string[], disconnect: string[] } — peers to add/remove." }, { "name": "evaluateSupernodeStatus", "kind": "function", "signature": "evaluateSupernodeStatus(topo, selfScore, selfLatencyAvg, integrityInfo)", "summary": "Evaluate whether this peer should be a supernode. Criteria: high reputation, low latency, good uptime, clean integrity, trusted. Peers with violations (throttled/muted/kicked) are immediately disqualified. Trust and social standing boost candidacy score." }, { "name": "topologyUpdatePeerIntegrity", "kind": "function", "signature": "topologyUpdatePeerIntegrity(topo, peerId, info)", "summary": "Update a peer's integrity data (called from integrity verifier tick)." }, { "name": "evaluateRemoteSupernodes", "kind": "function", "signature": "evaluateRemoteSupernodes(topo)", "summary": "Evaluate all remote supernodes and demote any that have degraded. Called during rebalance tick. Demoted supernodes are unregistered and a topology change is triggered so the mesh re-routes around them." }, { "name": "topologyRegisterSupernode", "kind": "function", "signature": "topologyRegisterSupernode(topo, peerId, announcement = null)", "summary": "Register a remote peer as a supernode." }, { "name": "topologyUnregisterSupernode", "kind": "function", "signature": "topologyUnregisterSupernode(topo, peerId)", "summary": "Unregister a remote peer as a supernode." }, { "name": "topologyApplyInfo", "kind": "function", "signature": "topologyApplyInfo(topo, fromPeerId, payload)", "summary": "Validate and apply one advisory topology_info payload atomically. The report may expand discovery knowledge but never mutates live routes." }, { "name": "gossipFingerprint", "kind": "function", "signature": "gossipFingerprint(op, originPeerId)", "summary": "Generate a gossip fingerprint for deduplication. Uses a compact hash of the op to avoid forwarding the same op twice." }, { "name": "gossipWrap", "kind": "function", "signature": "gossipWrap(topo, op)", "summary": "Wrap an op for gossip propagation. Adds gossip metadata: origin, TTL, hop count, fingerprint." }, { "name": "gossipReceive", "kind": "function", "signature": "gossipReceive(topo, fromPeerId, op)", "summary": "Process an incoming gossip-wrapped op. Returns { forward: boolean, op: Object, targets: string[] } - forward: true if this op should be forwarded to neighbors - op: the op with decremented TTL - targets: peerIds to forward to (excludes sender and origin)" }, { "name": "startTopology", "kind": "function", "signature": "startTopology(topo)", "summary": "Start the periodic rebalance timer." }, { "name": "stopTopology", "kind": "function", "signature": "stopTopology(topo)", "summary": "Stop the rebalance timer." }, { "name": "getTopologyMode", "kind": "function", "signature": "getTopologyMode(topo)", "summary": "Get current topology mode." }, { "name": "shouldGossip", "kind": "function", "signature": "shouldGossip(topo)", "summary": "Check if we should use gossip forwarding (partial/supernode mode)." }, { "name": "isSupernode", "kind": "function", "signature": "isSupernode(topo)", "summary": "Check if we're a supernode." }, { "name": "getNeighborIds", "kind": "function", "signature": "getNeighborIds(topo)", "summary": "Get the list of our current neighbor peerIds." }, { "name": "getTopologyStats", "kind": "function", "signature": "getTopologyStats(topo)", "summary": "Get topology stats for UI display." }, { "name": "buildSupernodeAnnounce", "kind": "function", "signature": "buildSupernodeAnnounce(topo)", "summary": "Build a supernode announcement op to broadcast. Peers use this to discover supernodes." }, { "name": "buildTopologyInfoOp", "kind": "function", "signature": "buildTopologyInfoOp(topo)", "summary": "Build a topology_info op for neighbor exchange. Peers periodically share their neighbor lists so the mesh can discover better paths (inspired by BGP route sharing)." }, { "name": "destroyMeshTopology", "kind": "function", "signature": "destroyMeshTopology(topo)", "summary": "Destroy the topology manager." }, { "name": "rebalanceTopologyNow", "kind": "function", "signature": "rebalanceTopologyNow(topo)", "summary": "Run one topology rebalance immediately (useful after discovery/metrics changes)." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabMessageRouter", "path": "engine/reference/collab/CollabMessageRouter.md", "source": "engine/collab/CollabMessageRouter.js", "import": "/engine/collab/CollabMessageRouter.js", "sourceHash": "6c1d8906253108481aa844a5495d602c9894dbfd4fb92f05e3252ae5f48a00c4", "summary": "CollabMessageRouter.js Priority-based message orchestration for collab sync. Sits between EditorCollab and CollabCore, providing: - 4 priority lanes (critical → ephemeral) - Bandwidth monitoring via channel.bufferedAmount - Transform coalescing (latest position wins per entity) - Adaptive rate control under backpressure Priority lanes: 0 — Critical: play_sync, __kick__, snapshot → immediate, never throttled 1 — Realtime: play transforms/PBD/grab force → coalesced or rate-budgeted 2 — Scene: create, delete, transform, property… → ordered, rate-budgeted 3 — Ephemeral: sim_heartbeat → latest-only, droppable", "exports": [ { "name": "createMessageRouter", "kind": "function", "signature": "createMessageRouter(sendFn, getBufferedAmount)", "summary": "Create a message router instance." }, { "name": "routerEnqueue", "kind": "function", "signature": "routerEnqueue(router, op)", "summary": "Enqueue an op for prioritized delivery." }, { "name": "messageRouterOpReport", "kind": "function", "signature": "messageRouterOpReport(op)", "summary": "" }, { "name": "messageRouterBufferedAmountReport", "kind": "function", "signature": "messageRouterBufferedAmountReport(value)", "summary": "" }, { "name": "routerFlush", "kind": "function", "signature": "routerFlush(router)", "summary": "Flush all queued ops respecting priority and backpressure. Call once per render frame from the render loop." }, { "name": "routerStart", "kind": "function", "signature": "routerStart(router)", "summary": "Start automatic flush timer (call once on init)." }, { "name": "routerStop", "kind": "function", "signature": "routerStop(router)", "summary": "Stop the automatic flush timer." }, { "name": "getRouterStats", "kind": "function", "signature": "getRouterStats(router)", "summary": "Get router statistics." }, { "name": "resetRouter", "kind": "function", "signature": "resetRouter(router)", "summary": "Reset router state (on disconnect/reconnect)." }, { "name": "destroyRouter", "kind": "function", "signature": "destroyRouter(router)", "summary": "Destroy router." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabOpQueue", "path": "engine/reference/collab/CollabOpQueue.md", "source": "engine/collab/CollabOpQueue.js", "import": "/engine/collab/CollabOpQueue.js", "sourceHash": "464bad375259ccab650a6b5667fa80809efa68fc7f0a1593e412acaf7d353586", "summary": "CollabOpQueue.js Op ordering, deduplication, and per-peer sequence gap handling. Each op: { id, peerId, seq, type, payload, ts } Current scope: bounded local ordering for admitted logical peer IDs. Sequence epochs/wrap, retransmission/NACK, cryptographic sender binding, and captured loss/reordering transport traces remain audit gaps.", "exports": [ { "name": "collabOpAdmissionReport", "kind": "function", "signature": "collabOpAdmissionReport(op)", "summary": "" }, { "name": "createOpQueue", "kind": "function", "signature": "createOpQueue()", "summary": "" }, { "name": "enqueueOp", "kind": "function", "signature": "enqueueOp(queue, op)", "summary": "Enqueue an incoming op. Returns array of ops ready to apply." }, { "name": "flushPeer", "kind": "function", "signature": "flushPeer(queue, peerId)", "summary": "Flush all held ops for a peer (called on timeout or peer leave)." }, { "name": "removePeer", "kind": "function", "signature": "removePeer(queue, peerId)", "summary": "Remove all state for a peer (on disconnect)." }, { "name": "tickOpQueue", "kind": "function", "signature": "tickOpQueue(queue)", "summary": "Tick — flush any peers with stale gaps." }, { "name": "getOpQueueStats", "kind": "function", "signature": "getOpQueueStats(queue)", "summary": "" }, { "name": "clearOpQueue", "kind": "function", "signature": "clearOpQueue(queue)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabPeerReputation", "path": "engine/reference/collab/CollabPeerReputation.md", "source": "engine/collab/CollabPeerReputation.js", "import": "/engine/collab/CollabPeerReputation.js", "sourceHash": "32b6305e19cefa8a0d52b5a95a22678bdc039cb4dc70ff92f6a75ff8b43723d0", "summary": "CollabPeerReputation.js Peer quality scoring system — rates each peer 0-1000 based on real-time connection metrics. Inspired by Meshtastic SNR-based prioritization and multi-layer throttling. Score breakdown (1000 total): 250 — Latency (RTT from heartbeat pings) 200 — Packet delivery (sent vs received ratio) 200 — Connection stability (reconnection count) 150 — Session duration (longer = more trusted) 100 — Jitter (variance in latency — lower = better) 100 — Throughput quality (buffered amount / backpressure) Each sub-score is 0.0–1.0, multiplied by its weight. The total is rounded to an integer 0–1000. Scores update every 2 seconds; observed peer scores are shared through signed reports, while the local self-score rides pongs. Inspired by: Meshtastic SNR-based node prioritization, role-based priority, and automatic traffic scaling for large meshes.", "exports": [ { "name": "createPeerReputation", "kind": "function", "signature": "createPeerReputation(selfId)", "summary": "Create a reputation tracker for all peers." }, { "name": "reputationAddPeer", "kind": "function", "signature": "reputationAddPeer(rep, peerId)", "summary": "Register a new peer." }, { "name": "reputationRemovePeer", "kind": "function", "signature": "reputationRemovePeer(rep, peerId)", "summary": "Remove a peer." }, { "name": "buildPingOps", "kind": "function", "signature": "buildPingOps(rep)", "summary": "Build ping ops to send to all peers. Call at PING_INTERVAL_MS." }, { "name": "buildPongOp", "kind": "function", "signature": "buildPongOp(pingOp, selfScore)", "summary": "Build a pong response to an incoming ping." }, { "name": "onPongReceived", "kind": "function", "signature": "onPongReceived(rep, peerId, pongOp)", "summary": "Handle an incoming pong from a peer. Records RTT and jitter." }, { "name": "recordBufferedAmount", "kind": "function", "signature": "recordBufferedAmount(rep, peerId, bufferedAmount)", "summary": "Record the current bufferedAmount for a peer's data channel. Call this periodically (e.g., every presence tick)." }, { "name": "tickReputation", "kind": "function", "signature": "tickReputation(rep)", "summary": "Recompute scores for all peers. Call at ~0.5Hz." }, { "name": "getPeerScore", "kind": "function", "signature": "getPeerScore(rep, peerId)", "summary": "Get the reputation score for a specific peer (0-1000)." }, { "name": "getPeerMetrics", "kind": "function", "signature": "getPeerMetrics(rep, peerId)", "summary": "Get full metrics for a specific peer (for debug / stats display)." }, { "name": "getSelfScore", "kind": "function", "signature": "getSelfScore(rep)", "summary": "Get the local peer's self-score. This remains the bootstrap score until a self-observation consensus path exists." }, { "name": "getAllPeerScores", "kind": "function", "signature": "getAllPeerScores(rep)", "summary": "Get all peer scores as an array of { peerId, score, subScores, avgRtt, avgJitter }." }, { "name": "getScoreColor", "kind": "function", "signature": "getScoreColor(score)", "summary": "Get the score color for rendering (green → yellow → red gradient)." }, { "name": "getScoreLabel", "kind": "function", "signature": "getScoreLabel(score)", "summary": "Get a human-readable label for a score range." }, { "name": "destroyPeerReputation", "kind": "function", "signature": "destroyPeerReputation(rep)", "summary": "Destroy reputation state." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabPlaySync", "path": "engine/reference/collab/CollabPlaySync.md", "source": "engine/collab/CollabPlaySync.js", "import": "/engine/collab/CollabPlaySync.js", "sourceHash": "6eb749d8695913b4ab10b9ef5f968b4936eccedf3882bee9048918785538ec92", "summary": "CollabPlaySync.js Synchronizes play/pause/stop across all connected peers. Broadcasts a shared determinism seed so all simulations run identically. Sends heartbeat hashes every 1s for divergence detection.", "exports": [ { "name": "createPlaySync", "kind": "function", "signature": "createPlaySync(config = {})", "summary": "" }, { "name": "playSyncCommandReport", "kind": "function", "signature": "playSyncCommandReport(payload)", "summary": "" }, { "name": "playSyncTickReport", "kind": "function", "signature": "playSyncTickReport(simTime)", "summary": "" }, { "name": "playSyncHeartbeatReport", "kind": "function", "signature": "playSyncHeartbeatReport(payload, currentSeed)", "summary": "" }, { "name": "playSyncCorrectionTargetReport", "kind": "function", "signature": "playSyncCorrectionTargetReport(authoritySimTime, localSimTime)", "summary": "" }, { "name": "playSyncAccumulatorCorrectionReport", "kind": "function", "signature": "playSyncAccumulatorCorrectionReport(targetSimTime, localSimTime, correctionRate)", "summary": "" }, { "name": "playSyncTimelineReport", "kind": "function", "signature": "playSyncTimelineReport(editor)", "summary": "" }, { "name": "broadcastPlay", "kind": "function", "signature": "broadcastPlay(playSync, seed)", "summary": "Broadcast a play command to all peers. Called when local user hits Play. seed: optional 32-bit int. Generated here if not provided." }, { "name": "broadcastPause", "kind": "function", "signature": "broadcastPause(playSync)", "summary": "Broadcast a pause command to all peers." }, { "name": "broadcastStop", "kind": "function", "signature": "broadcastStop(playSync)", "summary": "Broadcast a stop command to all peers." }, { "name": "onRemotePlayCommand", "kind": "function", "signature": "onRemotePlayCommand(playSync, op)", "summary": "Handle an incoming play_sync op from a remote peer. Returns the action taken: 'play' | 'pause' | 'stop' | null" }, { "name": "onRemoteHeartbeat", "kind": "function", "signature": "onRemoteHeartbeat(playSync, op)", "summary": "Handle an incoming sim_heartbeat op from a remote peer." }, { "name": "exportTimeline", "kind": "function", "signature": "exportTimeline(editor, filename)", "summary": "Export local simHistory as a downloadable JSON file." }, { "name": "isRemotePlay", "kind": "function", "signature": "isRemotePlay(playSync)", "summary": "Check if the current play command was triggered remotely." }, { "name": "getCurrentSeed", "kind": "function", "signature": "getCurrentSeed(playSync)", "summary": "Get the current determinism seed." }, { "name": "destroyPlaySync", "kind": "function", "signature": "destroyPlaySync(playSync)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabPresence", "path": "engine/reference/collab/CollabPresence.md", "source": "engine/collab/CollabPresence.js", "import": "/engine/collab/CollabPresence.js", "sourceHash": "0d1e5fa0cea40f53608044211caccc806623fdc8eb1bef6060d43111bf8052c2", "summary": "CollabPresence.js Tracks all peers' camera positions, usernames, selections, and colors. Presence packet: { v:1, u:username, c:[x,y,z], t:[tx,ty,tz], s:[entityIds] } Current scope: lossy latest-state presence. Authenticated presence identity, sequence/freshness fields, cross-system stale-peer cleanup, interpolation ownership, and captured churn traces remain audit gaps.", "exports": [ { "name": "presencePacketReport", "kind": "function", "signature": "presencePacketReport(packet)", "summary": "" }, { "name": "createPresenceState", "kind": "function", "signature": "createPresenceState()", "summary": "" }, { "name": "buildLocalPresencePacket", "kind": "function", "signature": "buildLocalPresencePacket(username, cameraPos, cameraTarget, selectionIds, simTime, mode, userColor)", "summary": "Build a presence packet from local state to broadcast." }, { "name": "applyRemotePresence", "kind": "function", "signature": "applyRemotePresence(state, peerId, packet)", "summary": "Apply a remote presence packet for a peer." }, { "name": "addPeer", "kind": "function", "signature": "addPeer(state, peerId, username)", "summary": "Register a peer joining (before first presence packet)." }, { "name": "removePresence", "kind": "function", "signature": "removePresence(state, peerId)", "summary": "Remove a peer (on disconnect)." }, { "name": "getPresenceList", "kind": "function", "signature": "getPresenceList(state)", "summary": "Get list of all known peers with their presence data." }, { "name": "getPeerColor", "kind": "function", "signature": "getPeerColor(state, peerId)", "summary": "Get color for a specific peer." }, { "name": "pruneStalePresence", "kind": "function", "signature": "pruneStalePresence(state)", "summary": "Prune peers not seen for > 30s." }, { "name": "clearPresenceState", "kind": "function", "signature": "clearPresenceState(state)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabSceneSync", "path": "engine/reference/collab/CollabSceneSync.md", "source": "engine/collab/CollabSceneSync.js", "import": "/engine/collab/CollabSceneSync.js", "sourceHash": "dd76eba5a0a28b7e5892801777c540f1461c0c493abf4b9becd1c540ce1b31d9", "summary": "Convert an EditorHistory action into a collab op payload.", "exports": [ { "name": "collabSceneEntityIdReport", "kind": "function", "signature": "collabSceneEntityIdReport(value)", "summary": "" }, { "name": "collabSceneValueReport", "kind": "function", "signature": "collabSceneValueReport(value, options = {})", "summary": "" }, { "name": "actionToOp", "kind": "function", "signature": "actionToOp(action, selfId, seq)", "summary": "Convert an EditorHistory action into a collab op payload." }, { "name": "opToAction", "kind": "function", "signature": "opToAction(op)", "summary": "Convert a collab op back into an EditorHistory-compatible action." }, { "name": "collabSceneOpReport", "kind": "function", "signature": "collabSceneOpReport(op)", "summary": "" }, { "name": "serializeSnapshot", "kind": "function", "signature": "serializeSnapshot(editor)", "summary": "Serialize the full scene state into a compact snapshot for new joiners." }, { "name": "collabSceneSnapshotReport", "kind": "function", "signature": "collabSceneSnapshotReport(snapshot)", "summary": "" }, { "name": "applySnapshot", "kind": "function", "signature": "applySnapshot(editor, snapshot)", "summary": "Apply a full scene snapshot to the editor (for new joiners). Clears existing scene and rebuilds from snapshot." }, { "name": "registerCollabSceneEntity", "kind": "function", "signature": "registerCollabSceneEntity(world, entityId)", "summary": "" }, { "name": "destroyCollabSceneEntity", "kind": "function", "signature": "destroyCollabSceneEntity(world, entityId)", "summary": "" }, { "name": "injectSceneSyncDeps", "kind": "function", "signature": "injectSceneSyncDeps(deps)", "summary": "" }, { "name": "COLLAB_SCENE_LIMITS", "kind": "constant", "signature": "COLLAB_SCENE_LIMITS", "summary": "CollabSceneSync.js Serializes EditorHistory actions <-> collab ops. Handles full scene snapshots for new joiners." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabSignal", "path": "engine/reference/collab/CollabSignal.md", "source": "engine/collab/CollabSignal.js", "import": "/engine/collab/CollabSignal.js", "sourceHash": "90937dd124e88f85d474265f27f31aa077aaf62e9430dc13079e25814d15e381", "summary": "CollabSignal.js 4-tier signaling abstraction for WebRTC peer discovery. Tier 1: BroadcastChannel — same machine, instant, offline Tier 2: SharedWorker — same machine multi-tab relay Tier 4: Particle Masterserver — PRIMARY cross-internet signaling relay. Pinned V2 endpoints use the shared ParticleNetworkDaemon; legacy V1 is accepted only when that endpoint explicitly opts in. Uses the same room/route-scoped HELLO/OFFER/ANSWER/CANDIDATE dispatch as Tiers 1/2 (see _handleSignalMessage) rather than a binary swarm protocol — the Masterserver just fans opaque JSON out to every other session attached to the same locally-derived opaque route. This is server-mediated, so it works across NATs/networks without any third-party dependency. Server-configured via localStorage 'os.network.masterServers' (same list the Particle Network control panel app manages); falls back to the pinned production bootstrap if unset. Tier 3: BitTorrent WSS — EXPLICIT FALLBACK ONLY. It remains off by default and can run only after the user opts in. A V2 integrity failure always fails closed and suppresses legacy/BitTorrent downgrade. Tiers 1/2/4 start immediately; Tier 3 is deferred/conditional (see above). First tier to form a WebRTC connection to a given peer wins — after that, signaling is no longer needed for that peer.", "exports": [ { "name": "createSignalChannel", "kind": "function", "signature": "createSignalChannel(config)", "summary": "Create a signal channel. config: { projectId, selfId, username, onOffer, onAnswer, onCandidate, onPeerJoin, onPeerLeave } Negotiation callbacks receive (peerId, payload, offerId). Generic signaling is deliberately strict: every OFFER/ANSWER/CANDIDATE is addressed to one peer and correlated to one offer generation. The WebTorrent tier retains its independent tracker offer_id lifecycle and does not use these envelopes." }, { "name": "fetchTurnCredentials", "kind": "function", "signature": "async fetchTurnCredentials(channel)", "summary": "Fetch TURN relay credentials from Cloudflare Pages Function. ONLY called as a fallback when STUN-only P2P connection fails. TURN relays ALL traffic through Cloudflare = expensive. Avoid unless necessary." }, { "name": "startSignaling", "kind": "function", "signature": "startSignaling(channel)", "summary": "Start all 3 signaling tiers simultaneously. Uses FREE STUN servers only — no Cloudflare data cost. TURN relay is only fetched on-demand when a direct P2P connection fails." }, { "name": "forceAnnounce", "kind": "function", "signature": "forceAnnounce(channel)", "summary": "Force an immediate discovery re-announce across all active tiers, bypassing the periodic announce timers. Used by app-layer \"Connect now\" so a known contact is found without waiting for the next BC hello / tracker announce cycle." }, { "name": "collabSignalTextReport", "kind": "function", "signature": "collabSignalTextReport(value, maxBytes, options = {})", "summary": "" }, { "name": "collabSignalPayloadReport", "kind": "function", "signature": "collabSignalPayloadReport(payload)", "summary": "" }, { "name": "collabIceServerListReport", "kind": "function", "signature": "collabIceServerListReport(value)", "summary": "" }, { "name": "sendOffer", "kind": "function", "signature": "sendOffer(channel, peerId, sdpOffer, offerId)", "summary": "Send one SDP offer to one discovered peer on the generic signaling tiers." }, { "name": "broadcastOffer", "kind": "function", "signature": "broadcastOffer(channel, peerId, sdpOffer, offerId)", "summary": "Retained as a strict compatibility symbol. Untargeted offers are unsafe in a multi-peer room, so callers must now supply the target and offer generation." }, { "name": "sendAnswer", "kind": "function", "signature": "sendAnswer(channel, peerId, sdpAnswer, offerId)", "summary": "Send an SDP answer to a specific peer." }, { "name": "sendCandidate", "kind": "function", "signature": "sendCandidate(channel, peerId, candidate, offerId)", "summary": "Send an ICE candidate to a specific peer." }, { "name": "destroySignalChannel", "kind": "function", "signature": "destroySignalChannel(channel)", "summary": "Destroy all signaling resources." }, { "name": "collabSignalReconnectPlanReport", "kind": "function", "signature": "collabSignalReconnectPlanReport(attempt)", "summary": "" }, { "name": "collabSignalOfferPlanReport", "kind": "function", "signature": "collabSignalOfferPlanReport(pendingCount, inFlightCount = 0)", "summary": "" }, { "name": "collabSignalPeerCapacityReport", "kind": "function", "signature": "collabSignalPeerCapacityReport(connectionCount)", "summary": "" }, { "name": "collabSignalTrackerIdHex", "kind": "function", "signature": "collabSignalTrackerIdHex(value)", "summary": "" }, { "name": "collabSignalTrackerBinaryReport", "kind": "function", "signature": "collabSignalTrackerBinaryReport(value)", "summary": "" }, { "name": "collabSignalHelloReport", "kind": "function", "signature": "collabSignalHelloReport(message, selfId = '')", "summary": "" }, { "name": "collabSignalPeerHelloReport", "kind": "function", "signature": "collabSignalPeerHelloReport(message, selfId = '')", "summary": "" }, { "name": "isBitTorrentFallbackEnabled", "kind": "function", "signature": "isBitTorrentFallbackEnabled()", "summary": "" }, { "name": "setBitTorrentFallbackEnabled", "kind": "function", "signature": "setBitTorrentFallbackEnabled(enabled)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabSpatialAuthority", "path": "engine/reference/collab/CollabSpatialAuthority.md", "source": "engine/collab/CollabSpatialAuthority.js", "import": "/engine/collab/CollabSpatialAuthority.js", "sourceHash": "860fb2f6d3390806d1c5869b77a2acdff2047fdab9a3ca1e94dc56067456a023", "summary": "CollabSpatialAuthority.js Distributed spatial authority for collaborative multiplayer. Each peer owns a circular \"zone\" centered on their camera position. Entities within a peer's zone are simulated locally by that peer. Entities outside all zones are dormant (no physics, no sync). Authority resolution (Roblox + Gaffer hybrid): - Nearest peer within zone radius wins (automatic proximity) - 20% hysteresis prevents ping-pong at boundaries - Higher-priority claims (SELECTED, GRABBED) override proximity - Sequence numbers resolve conflicts (Gaffer-style) Interest management (Photon-style): - Interest area = zoneRadius × interestMultiplier (default 1.3×) - Only send state for entities you're authoritative over - Only receive state for entities in your interest area Inspired by: Star Citizen dynamic server meshing, Roblox Network Ownership, Photon Fusion Shared Authority + AoI grid, Gaffer on Games authority scheme.", "exports": [ { "name": "createSpatialAuthority", "kind": "function", "signature": "createSpatialAuthority(selfId, config)", "summary": "Create a spatial authority state." }, { "name": "computeZoneRadius", "kind": "function", "signature": "computeZoneRadius(sceneBounds)", "summary": "Auto-compute zone radius from scene bounds." }, { "name": "setZoneRadius", "kind": "function", "signature": "setZoneRadius(auth, radius)", "summary": "Update the zone radius (e.g., after scene bounds change or manual override). Rebuilds the spatial grid with the new cell size." }, { "name": "updatePeerPosition", "kind": "function", "signature": "updatePeerPosition(auth, peerId, position)", "summary": "Update a peer's camera position (called from presence packets)." }, { "name": "removePeer", "kind": "function", "signature": "removePeer(auth, peerId)", "summary": "Remove a peer (on disconnect)." }, { "name": "updateEntityPosition", "kind": "function", "signature": "updateEntityPosition(auth, entityId, x, z)", "summary": "Update an entity's position in the spatial grid. Call this when entity transforms change (from physics step or remote sync)." }, { "name": "removeEntity", "kind": "function", "signature": "removeEntity(auth, entityId)", "summary": "Remove an entity from the spatial grid (on entity delete)." }, { "name": "resolveAuthority", "kind": "function", "signature": "resolveAuthority(auth, entityId, x, z)", "summary": "Resolve authority for a single entity based on proximity. Applies hysteresis: current owner keeps it unless new peer is 20% closer." }, { "name": "getMyAuthoritySet", "kind": "function", "signature": "getMyAuthoritySet(auth)", "summary": "Get all entity IDs that the local peer is authoritative over. Uses the auto-authority map (resolved at RESOLVE_INTERVAL_MS)." }, { "name": "getMyInterestSet", "kind": "function", "signature": "getMyInterestSet(auth)", "summary": "Get all entity IDs within the local peer's interest area (zone × interestMultiplier)." }, { "name": "getPeerInterestSet", "kind": "function", "signature": "getPeerInterestSet(auth, peerId)", "summary": "Get the interest set for a specific peer (used by relay host for filtering)." }, { "name": "isInMyZone", "kind": "function", "signature": "isInMyZone(auth, x, z)", "summary": "Check if an entity position is within the local peer's authority zone." }, { "name": "isInBufferZone", "kind": "function", "signature": "isInBufferZone(auth, x, z)", "summary": "Check if an entity position is within the buffer zone (boundary ring)." }, { "name": "isDormant", "kind": "function", "signature": "isDormant(auth, entityId)", "summary": "Check if an entity is dormant (outside all peer zones)." }, { "name": "tickSpatialAuthority", "kind": "function", "signature": "tickSpatialAuthority(auth)", "summary": "Periodic tick: re-resolve auto-authority for all tracked entities. Call this at ~2Hz from the collab loop (or faster if needed)." }, { "name": "destroySpatialAuthority", "kind": "function", "signature": "destroySpatialAuthority(auth)", "summary": "Clear all state (on leave room / exit play mode)." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabTransformSync", "path": "engine/reference/collab/CollabTransformSync.md", "source": "engine/collab/CollabTransformSync.js", "import": "/engine/collab/CollabTransformSync.js", "sourceHash": "216ba966056a93e4b512526e3d187a0124073efbc78bbfb3370d9a9db66bfb55", "summary": "CollabTransformSync.js Broadcasts entity transform updates during play mode so grabbed/moved objects are visible on all peer screens in real time. Authority model: - The peer who presses Play becomes the physics authority. - Authority broadcasts ALL entity transforms at ~10Hz. - Non-authority peers receive and apply transforms, skipping local physics. - Grabbed entity transforms are always sent at ~15Hz by anyone.", "exports": [ { "name": "createTransformSync", "kind": "function", "signature": "createTransformSync()", "summary": "Create a transform sync state object." }, { "name": "trackLocalGrab", "kind": "function", "signature": "trackLocalGrab(syncState, entityId)", "summary": "Mark an entity as being actively grabbed/dragged by the local user." }, { "name": "untrackLocalGrab", "kind": "function", "signature": "untrackLocalGrab(syncState, entityId)", "summary": "Unmark an entity when released." }, { "name": "buildPlayTransformOp", "kind": "function", "signature": "buildPlayTransformOp(syncState, ecsWorld, getEntityComponent)", "summary": "Build a play_transforms op for grabbed entities only. Returns null if nothing to broadcast or if throttled." }, { "name": "buildFullPlayTransformOp", "kind": "function", "signature": "buildFullPlayTransformOp(syncState, ecsWorld, getEntityComponent, sceneEntities, entityAuthority, spatialAuthoritySet)", "summary": "Build a play_transforms op for ALL scene entities. Only called by the physics authority at ~10Hz." }, { "name": "buildPbdStateOp", "kind": "function", "signature": "buildPbdStateOp(syncState, physicsSimulations, spatialAuthoritySet)", "summary": "Build a play_pbd_state op that snapshots PBD particle positions. Any peer running physics simulations broadcasts at ~30Hz for real-time rope sync. Only includes sims with >0 particles. Full float precision for smooth visual sync." }, { "name": "applyRemotePbdState", "kind": "function", "signature": "applyRemotePbdState(op, physicsSimulations)", "summary": "Apply incoming PBD particle state from the authority (host). Non-authority clients do NOT run their own PBD solver for these sims — they just apply the received positions directly. Tags each sim with `_remoteAuthority = true` so stepPhysicsSimulations skips the local solver for it (prevents local physics from fighting the authoritative positions)." }, { "name": "applyRemotePlayTransforms", "kind": "function", "signature": "applyRemotePlayTransforms(op, peerId, ecsWorld, getEntityComponent, setEntityComponent, syncState)", "summary": "Apply incoming play_transforms from a remote peer. Pushes transforms into the interpolation buffer, measures jitter for adaptive delay, and detects \"nuke\" events (massive state changes) for instant snap." }, { "name": "interpolateRemoteEntities", "kind": "function", "signature": "interpolateRemoteEntities(syncState, ecsWorld, getEntityComponent, localDragEntityId, entityAuthority)", "summary": "Interpolate buffered remote transforms and write to ECS + physics. Called every render frame by non-authority peers. Uses adaptive render delay that auto-adjusts based on measured packet jitter. On LAN/good connections: as low as ~20ms. On jittery links: up to 150ms. Slowly tightens delay when stable; instantly widens on late arrivals." }, { "name": "getInterpDelay", "kind": "function", "signature": "getInterpDelay(syncState)", "summary": "Get the current adaptive interpolation delay (ms) for diagnostics." }, { "name": "getRemoteGrabGlows", "kind": "function", "signature": "getRemoteGrabGlows(syncState, presenceState)", "summary": "Get set of entity IDs currently being grabbed by remote peers. Returns Map for glow rendering." }, { "name": "destroyTransformSync", "kind": "function", "signature": "destroyTransformSync(syncState)", "summary": "Destroy / reset transform sync state." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/CollabZoneHandoff", "path": "engine/reference/collab/CollabZoneHandoff.md", "source": "engine/collab/CollabZoneHandoff.js", "import": "/engine/collab/CollabZoneHandoff.js", "sourceHash": "caac89e016c76f2c87a451b784dd443a9e63790cbca94496b87c57362ea04d6f", "summary": "CollabZoneHandoff.js Smooth authority transfer protocol when entities cross spatial zone boundaries. Buffer zone (15% of zone radius): - Entity enters buffer → both peers simulate, current owner broadcasts state - Entity crosses buffer center → handoff op with full state snapshot - 500ms hysteresis prevents rapid back-and-forth Handoff op: { type: 'zone_handoff', payload: { entityId, fromPeer, toPeer, seq, state } } - state: { pos, rot, vel, angVel, pbdParticles? } - seq: authority sequence number (higher always wins, Gaffer-style) Assembly awareness: if entity A is constrained to entity B, both get handed off together to the same peer. Fallback: if fromPeer disconnects mid-handoff, nearest remaining peer takes ownership immediately. Inspired by: Roblox \"buffer zone\" (red outline), Star Citizen entity graph authority transfers, Gaffer on Games ownership sequence numbers.", "exports": [ { "name": "createZoneHandoff", "kind": "function", "signature": "createZoneHandoff()", "summary": "Create a zone handoff manager." }, { "name": "initiateHandoff", "kind": "function", "signature": "initiateHandoff(handoff, entityId, fromPeer, toPeer)", "summary": "Start a pending handoff for an entity (called when spatial authority detects a zone change). Does NOT commit yet — waits for hysteresis period." }, { "name": "cancelHandoff", "kind": "function", "signature": "cancelHandoff(handoff, entityId)", "summary": "Cancel a pending handoff (entity moved back to original zone)." }, { "name": "buildHandoffOp", "kind": "function", "signature": "buildHandoffOp(entityId, fromPeer, toPeer, seq, entityState)", "summary": "Build a zone_handoff op with full entity state for network transmission. Called by the outgoing peer when handoff commits." }, { "name": "captureEntityState", "kind": "function", "signature": "captureEntityState(ecsWorld, getEntityComponent, entityId, physicsSimulations)", "summary": "Capture entity state for the handoff snapshot." }, { "name": "onRemoteHandoffOp", "kind": "function", "signature": "onRemoteHandoffOp(handoff, op, selfId, ecsWorld, setEntityComponent, getEntityComponent, physicsSimulations)", "summary": "Handle an incoming zone_handoff op from a remote peer. Applies the state snapshot if the sequence number is higher than our last." }, { "name": "tickZoneHandoff", "kind": "function", "signature": "tickZoneHandoff(handoff, selfId)", "summary": "Tick pending handoffs. Commits any that have passed the hysteresis period. Prunes stale pending handoffs." }, { "name": "onHandoffPeerDisconnect", "kind": "function", "signature": "onHandoffPeerDisconnect(handoff, peerId)", "summary": "Handle peer disconnect: cancel pending handoffs involving this peer and reassign any entities that were mid-handoff." }, { "name": "onHandoffComplete", "kind": "function", "signature": "onHandoffComplete(handoff, callback)", "summary": "Set callback for handoff completion." }, { "name": "destroyZoneHandoff", "kind": "function", "signature": "destroyZoneHandoff(handoff)", "summary": "Destroy handoff state." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/PhysicsGrab", "path": "engine/reference/collab/PhysicsGrab.md", "source": "engine/collab/PhysicsGrab.js", "import": "/engine/collab/PhysicsGrab.js", "sourceHash": "d25759edb1b6bb5b572e474544a3e82c3cceb9cec69b37c60e058374a3f72c2c", "summary": "PhysicsGrab.js Mass-proportional spring-damper (PD controller) physics grab system. How other games do it: - Garry's Mod Physgun: pure spring-damper, body stays dynamic - Half-Life 2 gravity gun: spring + angular correction torque - Boneworks/BONELAB VR: PD controller with grip strength cap - UE4 Physics Handle: D6 joint linear drive to target pos This implementation uses a **frequency / damping-ratio** parameterization (ref: Orange Duck \"Spring-It-On\", Gaffer on Games \"Spring Physics\"): omega = 2π × frequency (natural frequency, rad/s) kp = omega² × mass (spring stiffness, N/m) ← mass-proportional kd = 2 × ζ × omega × mass (damping, N·s/m) ← mass-proportional With ζ = 1.0 (critical damping), the object reaches the target as fast as possible with zero overshoot regardless of mass. A 0.5 kg ball and a 200 kg crate both converge at the same rate. Multiple players grabbing the same object creates competing spring forces that resolve naturally through physics — tug-of-war emerges with no special-case code needed. Fatigue model (Boneworks-inspired): - Holding heavy objects drains fatigue over time - Effective strength = baseStrength * (0.2 + 0.8 * fatigue) - Minimum 20% strength even when exhausted - Fatigue recovers quickly when not holding Grip break: - Progressive grip weakening beyond GRIP_WEAKEN_DIST - Full slip at GRIP_BREAK_DIST Scope: point-target PD forces for dynamic rigid bodies. Constraint/joint drives, rotational grabs, continuous collision detection, solver substep tuning, and captured multi-peer PhysX traces remain outside this module.", "exports": [ { "name": "physicsGrabPeerIdReport", "kind": "function", "signature": "physicsGrabPeerIdReport(peerId)", "summary": "" }, { "name": "physicsGrabVectorReport", "kind": "function", "signature": "physicsGrabVectorReport(value, kind = 'position')", "summary": "" }, { "name": "physicsGrabForceReport", "kind": "function", "signature": "physicsGrabForceReport(objPos, objVel, targetPos, strength, mass)", "summary": "" }, { "name": "grabForceOperationReport", "kind": "function", "signature": "grabForceOperationReport(op, transportPeerId = null)", "summary": "" }, { "name": "admitRemoteGrabForce", "kind": "function", "signature": "admitRemoteGrabForce(remoteGrabs, op, transportPeerId, receivedAtMs = Date.now()", "summary": "" }, { "name": "pruneRemoteGrabForces", "kind": "function", "signature": "pruneRemoteGrabForces(remoteGrabs, nowMs = Date.now()", "summary": "" }, { "name": "removeRemoteGrabPeer", "kind": "function", "signature": "removeRemoteGrabPeer(remoteGrabs, peerId)", "summary": "" }, { "name": "computeGrabForce", "kind": "function", "signature": "computeGrabForce(objPos, objVel, targetPos, strength, mass)", "summary": "Compute mass-proportional spring-damper grab force. Uses frequency/damping-ratio parameterization so the convergence rate is identical regardless of object mass. Critical damping (ζ=1) means the object reaches the cursor as fast as possible with zero overshoot." }, { "name": "tickFatigue", "kind": "function", "signature": "tickFatigue(fatigue, loadRatio, dt)", "summary": "Update fatigue based on load this frame." }, { "name": "effectiveStrength", "kind": "function", "signature": "effectiveStrength(baseStrength, fatigue)", "summary": "Effective strength considering fatigue. Even fully exhausted players retain 20% strength (adrenaline)." }, { "name": "canGrab", "kind": "function", "signature": "canGrab(mass, strength)", "summary": "Check if an object is too heavy to pick up at all. Returns false if mass > 4x strength (can't apply meaningful force)." }, { "name": "createLocalGrab", "kind": "function", "signature": "createLocalGrab(entityId, targetPos, baseStrength)", "summary": "Create a local grab state for the player's own grab." }, { "name": "buildGrabForceOp", "kind": "function", "signature": "buildGrabForceOp(peerId, entityId, targetPos, strength, fatigue)", "summary": "Build a play_grab_force op to broadcast our cursor target to peers. Other peers apply the same spring force, creating tug-of-war physics." }, { "name": "applyGrabForcesToActor", "kind": "function", "signature": "applyGrabForcesToActor(actor, PhysX, objPos, objVel, grabs, mass)", "summary": "Apply all active grab forces to a PhysX actor. Call this BEFORE stepPhysicsWorld each frame." }, { "name": "GRAB_FREQUENCY", "kind": "constant", "signature": "GRAB_FREQUENCY", "summary": "" }, { "name": "GRAB_DAMPING_RATIO", "kind": "constant", "signature": "GRAB_DAMPING_RATIO", "summary": "" }, { "name": "GRAB_MASS_DEFAULT", "kind": "constant", "signature": "GRAB_MASS_DEFAULT", "summary": "" }, { "name": "PLAYER_STRENGTH", "kind": "constant", "signature": "PLAYER_STRENGTH", "summary": "" }, { "name": "GRIP_WEAKEN_DIST", "kind": "constant", "signature": "GRIP_WEAKEN_DIST", "summary": "" }, { "name": "GRIP_BREAK_DIST", "kind": "constant", "signature": "GRIP_BREAK_DIST", "summary": "" }, { "name": "FATIGUE_RATE", "kind": "constant", "signature": "FATIGUE_RATE", "summary": "" }, { "name": "FATIGUE_RECOVERY", "kind": "constant", "signature": "FATIGUE_RECOVERY", "summary": "" }, { "name": "STALE_GRAB_MS", "kind": "constant", "signature": "STALE_GRAB_MS", "summary": "" }, { "name": "PHYSICS_GRAB_LIMITS", "kind": "constant", "signature": "PHYSICS_GRAB_LIMITS", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/SpatialHashGrid", "path": "engine/reference/collab/SpatialHashGrid.md", "source": "engine/collab/SpatialHashGrid.js", "import": "/engine/collab/SpatialHashGrid.js", "sourceHash": "48103be11b8c0976da457398bb8b69ad0b35ac67a91ce8bd159474f6312ed1ad", "summary": "SpatialHashGrid.js O(1) spatial lookup grid for interest management and zone queries. Uses a 2D grid (XZ plane) where each cell stores a Set of entity IDs. Supports radius and AABB queries without iterating all entities. Inspired by: Photon Fusion AoI grid, SpatialOS worker partitioning.", "exports": [ { "name": "spatialHashGridIdReport", "kind": "function", "signature": "spatialHashGridIdReport(id)", "summary": "" }, { "name": "spatialHashGridPointReport", "kind": "function", "signature": "spatialHashGridPointReport(grid, x, z)", "summary": "" }, { "name": "createSpatialHashGrid", "kind": "function", "signature": "createSpatialHashGrid(cellSize, options = {})", "summary": "Create a spatial hash grid." }, { "name": "gridInsert", "kind": "function", "signature": "gridInsert(grid, id, x, z)", "summary": "Insert an entity into the grid." }, { "name": "gridRemove", "kind": "function", "signature": "gridRemove(grid, id)", "summary": "Remove an entity from the grid." }, { "name": "gridClear", "kind": "function", "signature": "gridClear(grid)", "summary": "Clear all entities from the grid." }, { "name": "gridQueryRadius", "kind": "function", "signature": "gridQueryRadius(grid, x, z, radius)", "summary": "Query all entity IDs within a radius of a point (XZ plane). Returns entities whose grid position is within the radius." }, { "name": "gridQueryRect", "kind": "function", "signature": "gridQueryRect(grid, minX, minZ, maxX, maxZ)", "summary": "Query all entity IDs within an axis-aligned bounding box (XZ plane)." }, { "name": "gridGetPosition", "kind": "function", "signature": "gridGetPosition(grid, id)", "summary": "Get the stored position for an entity." }, { "name": "gridSize", "kind": "function", "signature": "gridSize(grid)", "summary": "Get the total number of entities in the grid." }, { "name": "gridGetStats", "kind": "function", "signature": "gridGetStats(grid)", "summary": "" }, { "name": "destroySpatialHashGrid", "kind": "function", "signature": "destroySpatialHashGrid(grid)", "summary": "" }, { "name": "SPATIAL_HASH_GRID_LIMITS", "kind": "constant", "signature": "SPATIAL_HASH_GRID_LIMITS", "summary": "" }, { "name": "gridUpdate", "kind": "constant", "signature": "gridUpdate", "summary": "Update an entity's position. Alias for insert (handles cell migration)." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "collab/index", "path": "engine/reference/collab/index.md", "source": "engine/collab/index.js", "import": "/engine/collab/index.js", "sourceHash": "8356c3e7e65211508b9b2cd943001692fdb5438f1743fd1b89962bf096fb44d6", "summary": "engine/collab/index.js Barrel export for all collab modules.", "exports": [], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/bootloader", "path": "engine/reference/compat/bootloader.md", "source": "engine/compat/bootloader.js", "import": "/engine/compat/bootloader.js", "sourceHash": "e460c4298b2126ff9b7159ba3430559e202519909287cbfeb24349105f69a647", "summary": "bootloader.js — the Engine Compatibility Bootloader entry point. Boot flow (Phases 1-2 implemented here; 3-7 plug in via ctx hooks): 1. load source (source-loader) 2. parse HTML (html-ingestor) 3. static probe → profile (probe-scanner + profile-builder) 4. merge with cached profile(profile-cache) 5. [validate] (ctx.validate — schema-registry, Phase 3) 6. [heal] (ctx.heal — healing-pipeline, Phase 4) 7. build scoped realm + heal DOM + scope CSS (runtime-realm) 8. [interpose] (ctx.interpose — interposers, Phase 5) 9. execute guest scripts 10. cache profile, install error recovery, return an app handle The bootloader is engine-agnostic: pass a `ctx` with optional { storage, profileCache, gpu, scheduler, validate, heal, interpose, onError }.", "exports": [ { "name": "CompatBootloader", "kind": "class", "signature": "class CompatBootloader", "summary": "" }, { "name": "CompatApp", "kind": "class", "signature": "class CompatApp", "summary": "A booted guest app handle." }, { "name": "bootExternalApp", "kind": "function", "signature": "async bootExternalApp(options, ctx = {})", "summary": "Convenience one-shot boot without holding a CompatBootloader instance." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/css-healer", "path": "engine/reference/compat/css-healer.md", "source": "engine/compat/css-healer.js", "import": "/engine/compat/css-healer.js", "sourceHash": "01b6bd528da890518e15151d8978952b531d5f50ab7933d881fa52195271804c", "summary": "css-healer.js — scope a guest app's CSS so it cannot style the OS shell. External WebGPU apps routinely style `html, body, canvas, *, :root` globally. `scopeCss(css, scope)` rewrites every style rule so it only applies inside the guest's realm container (e.g. `[data-engine-app=\"tempolux\"]`): html, body → [data-engine-app=\"id\"] canvas → [data-engine-app=\"id\"] canvas * → [data-engine-app=\"id\"] * .hud .row → [data-engine-app=\"id\"] .hud .row At-rules are handled correctly: @media/@supports/@container/@layer/@scope have their inner rules scoped; @keyframes/@font-face/@page/@property/@import are left intact (their \"selectors\" are not element selectors).", "exports": [ { "name": "scopeCss", "kind": "function", "signature": "scopeCss(css, scope)", "summary": "Scope a full stylesheet string to `scope` (a selector like `[data-engine-app=\"id\"]`)." }, { "name": "scopeSelectorFor", "kind": "function", "signature": "scopeSelectorFor(appId)", "summary": "Convenience: the canonical realm scope selector for an app id." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/dom-healer", "path": "engine/reference/compat/dom-healer.md", "source": "engine/compat/dom-healer.js", "import": "/engine/compat/dom-healer.js", "sourceHash": "dcfe566bd11c2d23bfc4ec9d6856d25440183733d39c2c7844e58516d651a170", "summary": "dom-healer.js — create DOM elements a guest app requires but that are missing. Many single-file WebGPU apps assume ``, an overlay `#ov`, a HUD `#hud`, etc. already exist. The compatibility profile lists those in `profile.dom.requiredElements`; this healer ensures each exists inside the guest's realm container BEFORE the guest's scripts run, so `getElementById` and friends resolve instead of throwing.", "exports": [ { "name": "healDom", "kind": "function", "signature": "healDom(rootEl, profile)", "summary": "Ensure every `profile.dom.requiredElements` entry exists under `rootEl`." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/error-recovery", "path": "engine/reference/compat/error-recovery.md", "source": "engine/compat/error-recovery.js", "import": "/engine/compat/error-recovery.js", "sourceHash": "70f015036138359a5c47082e4a88948d483d652173a949302d0703fa84123578", "summary": "error-recovery.js — keep a crashing guest from taking down the OS. Installs scoped error capture and drives a recovery ladder when a guest throws repeatedly within a short window: 1. tolerate isolated errors (already recorded), 2. reboot the realm (fresh parse + heal + run), 3. reboot in SAFE MODE (network off, shader-heal off, GPU limits clamped), 4. render an in-realm error panel with a manual Restart — OS stays alive. Errors counted toward escalation: runtime-error, promise-error, script, gpu-device-lost. Benign infos (warnings, clamps, recovery notices) are ignored.", "exports": [ { "name": "installErrorRecovery", "kind": "function", "signature": "installErrorRecovery(app, { win = (typeof window !== 'undefined' ? window : null)", "summary": "" }, { "name": "makeSafeProfile", "kind": "function", "signature": "makeSafeProfile(profile)", "summary": "A safer variant of a profile used for safe-mode reboots." }, { "name": "renderErrorPanel", "kind": "function", "signature": "renderErrorPanel(app, info)", "summary": "Render a friendly, non-fatal error panel inside the guest's realm container." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/healers/asset-healer", "path": "engine/reference/compat/healers/asset-healer.md", "source": "engine/compat/healers/asset-healer.js", "import": "/engine/compat/healers/asset-healer.js", "sourceHash": "9f8e5ca3da39a6ab8597cc30cf94afc8fcd010522272d586c384d57481859aac", "summary": "healers/asset-healer.js — resolve bundled relative asset references. A multi-file guest references ``, ``, etc. Those relative URLs won't resolve inside the realm, so this pass rewrites any reference present in the package `files` map to a blob URL. The created URLs are recorded on `model._assetBlobs` so the realm revokes them on destroy.", "exports": [ { "name": "healAssets", "kind": "function", "signature": "healAssets({ model, files }, report)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/healers/error-healer", "path": "engine/reference/compat/healers/error-healer.md", "source": "engine/compat/healers/error-healer.js", "import": "/engine/compat/healers/error-healer.js", "sourceHash": "0ce5fe8f4b04a57f8f11d501775dac536ae779f264b8d02f3eb8a74c4ca27814", "summary": "healers/error-healer.js — enable scoped error capture for the guest. Marks the profile so the bootloader installs error/unhandledrejection capture (Phase 7's recovery layer reads `healing.captureErrors`). Kept as its own pass so the recovery policy can grow independently.", "exports": [ { "name": "healErrorPolicy", "kind": "function", "signature": "healErrorPolicy({ profile }, report)", "summary": "healers/error-healer.js — enable scoped error capture for the guest. Marks the profile so the bootloader installs error/unhandledrejection capture (Phase 7's recovery layer reads `healing.captureErrors`). Kept as its own pass so the recovery policy can grow independently." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/healers/gpu-healer", "path": "engine/reference/compat/healers/gpu-healer.md", "source": "engine/compat/healers/gpu-healer.js", "import": "/engine/compat/healers/gpu-healer.js", "sourceHash": "1545fccc75ed5bdb85c0cc17879bc6a0164cf24cd639d9541aa55b0819d13b1b", "summary": "healers/gpu-healer.js — normalise GPU-related profile fields before boot. Sets a sensible `gpu.presentation` and ensures the runtime healing flags the interposer relies on (`clampGpuLimits`, `wrapQueueSubmit`) are populated. The actual limit-clamping happens at runtime in `interposers/gpu.js`.", "exports": [ { "name": "healGpu", "kind": "function", "signature": "healGpu({ profile }, report)", "summary": "healers/gpu-healer.js — normalise GPU-related profile fields before boot. Sets a sensible `gpu.presentation` and ensures the runtime healing flags the interposer relies on (`clampGpuLimits`, `wrapQueueSubmit`) are populated. The actual limit-clamping happens at runtime in `interposers/gpu.js`." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/healers/lifecycle-healer", "path": "engine/reference/compat/healers/lifecycle-healer.md", "source": "engine/compat/healers/lifecycle-healer.js", "import": "/engine/compat/healers/lifecycle-healer.js", "sourceHash": "bfa3c1da7ec852c0aeaadcaf0218bc3619cc5a43be07f47a97727c9d3c7c0e81", "summary": "healers/lifecycle-healer.js — ensure lifecycle healing flags are populated. These flags drive the interposers and the recovery layer (Phase 7): whether to recover on GPU context loss, namespace storage, and route downloads safely.", "exports": [ { "name": "healLifecycle", "kind": "function", "signature": "healLifecycle({ profile }, report)", "summary": "healers/lifecycle-healer.js — ensure lifecycle healing flags are populated. These flags drive the interposers and the recovery layer (Phase 7): whether to recover on GPU context loss, namespace storage, and route downloads safely." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/healers/shader-healer", "path": "engine/reference/compat/healers/shader-healer.md", "source": "engine/compat/healers/shader-healer.js", "import": "/engine/compat/healers/shader-healer.js", "sourceHash": "4856cc4ceda0f129133a2a511d0ddd1a6c0c6fca6e26d2ac98834c1f355fdc26", "summary": "healers/shader-healer.js — migrate deprecated WGSL attribute syntax. Older WGSL used `[[stage(...)]]` / `[[group(x), binding(y)]]` / `[[location(n)]]` / `[[builtin(...)]]`, which modern WebGPU rejects. This pass rewrites those tokens to the current `@stage` / `@group @binding` / `@location` / `@builtin` forms inside inline guest scripts. The patterns are WGSL-specific and do not occur in normal JS, so the rewrite is safe. Gated by `profile.healing.healShaders`.", "exports": [ { "name": "healShaders", "kind": "function", "signature": "healShaders({ model, profile }, report)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/healing-pipeline", "path": "engine/reference/compat/healing-pipeline.md", "source": "engine/compat/healing-pipeline.js", "import": "/engine/compat/healing-pipeline.js", "sourceHash": "0ae6ff990638f031e7dc45c5372d59be67e3073a70e6449747e389ddf6ff5fae", "summary": "healing-pipeline.js — ordered pre-boot healing passes over a guest. Runs after probing and before the realm is built, mutating the parsed model and the profile in place. Ordered per the compat spec: DOM/CSS scoping happen in the realm itself; here we do the model/profile-level passes: GPU flags → lifecycle flags → error policy → asset URL rewrite → WGSL repair. Each pass is isolated (a throwing healer never aborts the others) and appends to a human-readable report returned to the caller.", "exports": [ { "name": "runHealingPipeline", "kind": "function", "signature": "runHealingPipeline(ctxObj)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/html-ingestor", "path": "engine/reference/compat/html-ingestor.md", "source": "engine/compat/html-ingestor.js", "import": "/engine/compat/html-ingestor.js", "sourceHash": "f46ae40ea0c0f80615b2d9083b13fb4f1ac04de9babed7d02f4181ff7c4c15fa", "summary": "html-ingestor.js — parse a guest HTML document into a structured model. Uses DOMParser (scripts parsed this way are INERT — they will not execute on insertion), so we can safely inspect and relocate the DOM, then hand the extracted scripts to the runtime realm to execute in controlled order. The returned model: { doc, // the parsed Document (inert) title, scripts: [{ module, src, code, async, defer }], // document order styles: [{ inline, href, code }], // document order links: [{ rel, href }], canvases:[{ id, width, height }], assets: string[], // referenced asset URLs (img/src, etc.) }", "exports": [ { "name": "parseHTML", "kind": "function", "signature": "parseHTML(html, baseUrl = null)", "summary": "html-ingestor.js — parse a guest HTML document into a structured model. Uses DOMParser (scripts parsed this way are INERT — they will not execute on insertion), so we can safely inspect and relocate the DOM, then hand the extracted scripts to the runtime realm to execute in controlled order. The returned model: { doc, // the parsed Document (inert) title, scripts: [{ module, src, code, async, defer }], // document order styles: [{ inline, href, code }], // document order links: [{ rel, href }], canvases:[{ id, width, height }], assets: string[], // referenced asset URLs (img/src, etc.) }" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/iframe-realm", "path": "engine/reference/compat/iframe-realm.md", "source": "engine/compat/iframe-realm.js", "import": "/engine/compat/iframe-realm.js", "sourceHash": "4624e30e3c859591e7425baa3bc98a3f7ffc07425a8541dae8030721f4721304", "summary": "iframe-realm.js — a hard-isolation execution root for UNTRUSTED guest apps. Unlike RuntimeRealm (light-DOM, shared OS origin — best-effort isolation), this runs the guest inside a `sandbox=\"allow-scripts\"` iframe WITHOUT `allow-same-origin`, so it gets a unique opaque origin and cannot touch the OS document, cookies, localStorage/IndexedDB, or kernel globals. It is a real security boundary suitable for community/unverified packages and live remote sites. The guest document is assembled self-contained (bundled JS → `data:` modules with imports rewritten; bundled CSS/assets → inline/`data:` URLs) because parent-origin blob URLs are unreachable from the opaque-origin iframe. A tiny injected bridge routes window.open()/anchor navigations up to the host via postMessage (the host opens them in the OS Browser). Trade-offs vs RuntimeRealm: no shared WebGPU device (the iframe requests its own), and no direct syscall access (a postMessage RPC would be needed). Used only when isolation is requested.", "exports": [ { "name": "IframeRealm", "kind": "class", "signature": "class IframeRealm", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/index", "path": "engine/reference/compat/index.md", "source": "engine/compat/index.js", "import": "/engine/compat/index.js", "sourceHash": "c8382c030e2e0e979d5f3713c020d8c08bd9b56eebb0a62e1d5b463c6745546b", "summary": "engine/compat/index.js — the Engine Compatibility namespace. `createCompat(ctx)` returns the `engine.compat` API used across the OS: await engine.compat.boot({ id, source, mount, mode, permissions }); `ctx` wires the compat layer to the host engine/kernel (all optional): storage — kernel.storageManager (profile/snapshot persistence) gpu — { getOrCreateSharedDevice(adapter, desc), format, healDeviceDescriptor } scheduler — engine frame scheduler (RAF interposition, Phase 5/6) validate — async (profile) => { valid, errors } (Phase 3) heal — async ({ model, profile, files, appId }) (Phase 4) interpose — async ({ realm, profile, app, ctx }) (Phase 5) onError — (info) => void Phases 3-7 register their hooks onto the same ctx, so this factory stays the single, stable entry point as the pipeline grows.", "exports": [ { "name": "createCompat", "kind": "function", "signature": "createCompat(ctx = {})", "summary": "" }, { "name": "COMPAT_VERSION", "kind": "constant", "signature": "COMPAT_VERSION", "summary": "" }, { "name": "CompatBootloader", "kind": "re-export", "signature": "CompatBootloader", "summary": "" }, { "name": "ProfileCache", "kind": "re-export", "signature": "ProfileCache", "summary": "" }, { "name": "bootExternalApp", "kind": "re-export", "signature": "bootExternalApp", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/interposers/fetch", "path": "engine/reference/compat/interposers/fetch.md", "source": "engine/compat/interposers/fetch.js", "import": "/engine/compat/interposers/fetch.js", "sourceHash": "ea590fee8f7eaff993be16af3cdf72c0711099d8f5ee9308060a52b4577cb098", "summary": "interposers/fetch.js — default-deny network egress for guest apps + serving bundled package files. Resolution order: 1. If the ref resolves to a bundled package file (e.g. `fetch('data.json')` or a `.wasm`), serve it directly from the file map — relative paths in a blob-loaded module would otherwise 404 against the OS origin. 2. Same-origin, relative, `blob:` and `data:` requests pass through. 3. Cross-origin requests are blocked unless the profile granted `network.fetch` — preventing a wrapped third-party app from phoning home.", "exports": [ { "name": "makeFetchShim", "kind": "function", "signature": "makeFetchShim({ profile, onError, realm = null } = {})", "summary": "interposers/fetch.js — default-deny network egress for guest apps + serving bundled package files. Resolution order: 1. If the ref resolves to a bundled package file (e.g. `fetch('data.json')` or a `.wasm`), serve it directly from the file map — relative paths in a blob-loaded module would otherwise 404 against the OS origin. 2. Same-origin, relative, `blob:` and `data:` requests pass through. 3. Cross-origin requests are blocked unless the profile granted `network.fetch` — preventing a wrapped third-party app from phoning home." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/interposers/file-export", "path": "engine/reference/compat/interposers/file-export.md", "source": "engine/compat/interposers/file-export.js", "import": "/engine/compat/interposers/file-export.js", "sourceHash": "2ea761a2705a5efb2fac2a10376b35a37b48edf150097f270799a2b46ae4102b", "summary": "interposers/file-export.js — safe blob/download handling for a guest realm. Guests export files via `URL.createObjectURL(blob)` + an `` click (or `showSaveFilePicker`). Two problems: created object URLs leak if never revoked, and downloads are invisible to the OS. This shim wraps `URL` so every `createObjectURL` is tracked (and revoked on realm destroy) and each export is counted into the app's metrics — without blocking the legitimate download.", "exports": [ { "name": "makeUrlShim", "kind": "function", "signature": "makeUrlShim(realm, { metrics, onExport } = {})", "summary": "interposers/file-export.js — safe blob/download handling for a guest realm. Guests export files via `URL.createObjectURL(blob)` + an `` click (or `showSaveFilePicker`). Two problems: created object URLs leak if never revoked, and downloads are invisible to the OS. This shim wraps `URL` so every `createObjectURL` is tracked (and revoked on realm destroy) and each export is counted into the app's metrics — without blocking the legitimate download." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/interposers/gpu", "path": "engine/reference/compat/interposers/gpu.md", "source": "engine/compat/interposers/gpu.js", "import": "/engine/compat/interposers/gpu.js", "sourceHash": "5b254642ab7e1f06c6cfac748ece27c5ebbcb0e886ebf1f7551e2612d79dcb63", "summary": "interposers/gpu.js — wrap `navigator.gpu` for a guest realm. The guest keeps using the real WebGPU implementation, but through a shim that: • clamps `requiredLimits` to what the adapter actually supports (a very common crash cause when an app hard-codes limits from a beefier GPU), • drops unsupported `requiredFeatures` instead of throwing, • counts `queue.submit` calls into the app's metrics, • reports device-loss (so the recovery layer can react) without spamming on intentional `destroy()`. It deliberately does NOT share the kernel's device — each guest gets its own device so it cannot corrupt OS GPU state. Sharing/surface hand-off is Phase 6.", "exports": [ { "name": "makeGpuShim", "kind": "function", "signature": "makeGpuShim({ metrics, onError } = {})", "summary": "interposers/gpu.js — wrap `navigator.gpu` for a guest realm. The guest keeps using the real WebGPU implementation, but through a shim that: • clamps `requiredLimits` to what the adapter actually supports (a very common crash cause when an app hard-codes limits from a beefier GPU), • drops unsupported `requiredFeatures` instead of throwing, • counts `queue.submit` calls into the app's metrics, • reports device-loss (so the recovery layer can react) without spamming on intentional `destroy()`. It deliberately does NOT share the kernel's device — each guest gets its own device so it cannot corrupt OS GPU state. Sharing/surface hand-off is Phase 6." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/interposers/index", "path": "engine/reference/compat/interposers/index.md", "source": "engine/compat/interposers/index.js", "import": "/engine/compat/interposers/index.js", "sourceHash": "faf80bed633d2ed7b8ecf644a18f35522720c039adfd9414f3291602b887ca82", "summary": "interposers/index.js — install per-realm API shims for a guest app. Guests run in the shared window, so we cannot replace globals process-wide without breaking the OS. Instead we: 1. build a per-realm `context` of shims (gpu/raf/storage/fetch), 2. register it at `globalThis.__engineRealms.get(appId)`, 3. return a code `transform` that prepends a tiny prelude to each guest script which LEXICALLY SHADOWS the relevant globals with the shims. Module scripts: the prelude's top-level `const`s shadow the globals within the module's own scope. Classic scripts: wrapped in an IIFE (only when there's a single classic script, to avoid breaking cross-script global sharing). Which globals are shadowed is driven by `profile.uses`, minimising both collision risk and overhead.", "exports": [ { "name": "installInterposers", "kind": "function", "signature": "installInterposers({ realm, profile, ctx, app } = {})", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/interposers/navigation", "path": "engine/reference/compat/interposers/navigation.md", "source": "engine/compat/interposers/navigation.js", "import": "/engine/compat/interposers/navigation.js", "sourceHash": "bf074fc0524d3cebcd874c6fb17dc033eb33be4fd1b999d83eb605f21628b430", "summary": "navigation.js — keep a guest's \"open a new window\" / external navigation INSIDE the OS instead of spawning a real browser popup or navigating the whole OS page away. Guests run in the shared OS document (light DOM, not an iframe), so an unhandled `` click or `window.open()` would either pop a real browser window or unload the entire OS. We intercept both and hand the URL to the host via `onOpenWindow(url, info)` — the host decides where it goes (default: the in-OS Browser app). Two mechanisms: 1. DOM click-capture on the realm container — anchors that open a new window (target=_blank/_new) or point off-origin are cancelled and routed. Always installed (cheap, prevents the OS-unload footgun). 2. Lexically-shadowed `window.open` / `open()` / `location` — routes JS-driven popups and redirects. Only bound when the probe detected such usage (`profile.uses.windowOpen`), to minimise shadowing blast radius.", "exports": [ { "name": "makeOpenShim", "kind": "function", "signature": "makeOpenShim({ onOpenWindow, onError } = {})", "summary": "Replacement for window.open / open(): route the URL, return a harmless stub." }, { "name": "makeWindowProxy", "kind": "function", "signature": "makeWindowProxy(openShim, { onOpenWindow, onError } = {})", "summary": "Proxy over the real window that only overrides `open` and `location` writes." }, { "name": "makeLocationProxy", "kind": "function", "signature": "makeLocationProxy({ onOpenWindow, onError } = {})", "summary": "Proxy over location: reads pass through; href=/assign/replace are routed." }, { "name": "installNavCapture", "kind": "function", "signature": "installNavCapture(realm, { onOpenWindow, onError } = {})", "summary": "Capture-phase click handler on the realm container. Cancels + routes anchor navigations that would open a new window or leave the OS origin. Returns a cleanup function (also registered on the realm)." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/interposers/raf", "path": "engine/reference/compat/interposers/raf.md", "source": "engine/compat/interposers/raf.js", "import": "/engine/compat/interposers/raf.js", "sourceHash": "da4600bd5f756bafbdf8dfa83f9c09d876e31e315dce785d12d1c4b2d3cd7056", "summary": "interposers/raf.js — managed requestAnimationFrame for a guest realm. Guest render loops are the #1 resource leak when an app's window closes: the raw `requestAnimationFrame` loop keeps running forever. This shim tracks every pending frame and cancels them all on `realm.destroy()`, so closing a guest window actually stops its GPU work. Errors thrown inside a frame callback are reported instead of silently killing the loop's owner.", "exports": [ { "name": "makeRafShim", "kind": "function", "signature": "makeRafShim(realm)", "summary": "interposers/raf.js — managed requestAnimationFrame for a guest realm. Guest render loops are the #1 resource leak when an app's window closes: the raw `requestAnimationFrame` loop keeps running forever. This shim tracks every pending frame and cancels them all on `realm.destroy()`, so closing a guest window actually stops its GPU work. Errors thrown inside a frame callback are reported instead of silently killing the loop's owner." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/interposers/storage", "path": "engine/reference/compat/interposers/storage.md", "source": "engine/compat/interposers/storage.js", "import": "/engine/compat/interposers/storage.js", "sourceHash": "9c9ea4a132b652585799460a4b72d7fec8b650f3eca3dadf2394ff229ff1f6f7", "summary": "interposers/storage.js — per-app namespaced localStorage / sessionStorage. Guests freely use `localStorage.foo = x` and `localStorage.getItem(...)`. Left unscoped they would collide with each other and with the OS. This shim transparently prefixes every key with `compat::` and supports both the Storage method API and direct property access (via a Proxy). Falls back to an in-memory store when Web Storage is unavailable.", "exports": [ { "name": "makeStorageShim", "kind": "function", "signature": "makeStorageShim(appId, backing)", "summary": "interposers/storage.js — per-app namespaced localStorage / sessionStorage. Guests freely use `localStorage.foo = x` and `localStorage.getItem(...)`. Left unscoped they would collide with each other and with the OS. This shim transparently prefixes every key with `compat::` and supports both the Storage method API and direct property access (via a Proxy). Falls back to an in-memory store when Web Storage is unavailable." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/interposers/worker", "path": "engine/reference/compat/interposers/worker.md", "source": "engine/compat/interposers/worker.js", "import": "/engine/compat/interposers/worker.js", "sourceHash": "3f1f3ef4f83374f126b7356605a6ca16047d5e0d376f04bc756137dcd363d7f4", "summary": "interposers/worker.js — resolve guest Worker(url) references to bundled blobs. A guest's `new Worker('worker.js')` references a path relative to its original document, which won't resolve once the guest runs from blob URLs in the OS realm. This shim rewrites a relative/bundled worker URL to its pre-linked module blob (imports already rewritten + shims applied), or a blob of the bundled file. Remote/absolute URLs pass through unchanged. Returns a Worker subclass, or null if Worker is unavailable.", "exports": [ { "name": "makeWorkerShim", "kind": "function", "signature": "makeWorkerShim(realm, RealWorker = (typeof Worker !== 'undefined' ? Worker : null)", "summary": "interposers/worker.js — resolve guest Worker(url) references to bundled blobs. A guest's `new Worker('worker.js')` references a path relative to its original document, which won't resolve once the guest runs from blob URLs in the OS realm. This shim rewrites a relative/bundled worker URL to its pre-linked module blob (imports already rewritten + shims applied), or a blob of the bundled file. Remote/absolute URLs pass through unchanged. Returns a Worker subclass, or null if Worker is unavailable." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/module-linker", "path": "engine/reference/compat/module-linker.md", "source": "engine/compat/module-linker.js", "import": "/engine/compat/module-linker.js", "sourceHash": "2f754c26d47d2b3487d332881a529533aaa54cba76c84d74f501b472f19d7ce9", "summary": "module-linker.js — turn an in-memory file map into runnable blob-URL modules. Loading an ES module from a `blob:` URL loses its path context, so relative imports (`import './a.js'`) and `import.meta.url`-relative resolution break (the blob has no directory). Following the es-module-shims technique, we rewrite every relative / bundled import specifier in each JS module to the `blob:` URL of its resolved target (created in dependency order), optionally apply a code transform (the interposer prelude / shader healing), and return a `path → blobURL` map plus a resolver for inline-module imports. Bare specifiers (`import 'three'`) may be resolved by the caller-provided import resolver (import map / CDN fallback). Absolute/remote URLs are left untouched.", "exports": [ { "name": "buildModuleBlobs", "kind": "function", "signature": "buildModuleBlobs({ files, transform = null, onWarn = null, resolveBare = null, resolveExternal = null, urlKind = 'blob' } = {})", "summary": "Build blob-URL modules for every bundled JS file, with relative imports rewritten to reference each other's blob URLs." }, { "name": "buildImportResolver", "kind": "function", "signature": "buildImportResolver(profile)", "summary": "Build a resolver for BARE import specifiers (`three`, `@scope/pkg`, subpaths) from a compat profile. Resolution order: 1. exact match in `profile.imports.map` 2. longest trailing-slash prefix match (`three/` → base) in the map 3. CDN fallback `` when `profile.healing.cdnImports !== false` (default CDN https://esm.sh/, overridable via `profile.imports.cdn`) Returns null when nothing matches (the import is left unresolved)." }, { "name": "isBareSpecifier", "kind": "function", "signature": "isBareSpecifier(spec)", "summary": "A bare specifier: not relative (./ ../ /), not an absolute/remote URL." }, { "name": "isRelativeSpecifier", "kind": "function", "signature": "isRelativeSpecifier(spec)", "summary": "" }, { "name": "isPackageSpecifier", "kind": "function", "signature": "isPackageSpecifier(spec)", "summary": "" }, { "name": "discoverSpecs", "kind": "function", "signature": "discoverSpecs(code)", "summary": "Collect every (string-literal) import specifier from module code." }, { "name": "rewriteSpecs", "kind": "function", "signature": "rewriteSpecs(code, urlFor)", "summary": "Replace import specifiers using `urlFor(spec)`. When it returns a falsy value the original specifier is kept (bare/remote/cyclic)." }, { "name": "resolveSpec", "kind": "function", "signature": "resolveSpec(spec, importerRel, files)", "summary": "Resolve an import specifier to a bundled file path, or null when it is bare (no leading ./ ../ or /) or absolute/remote. Tries the literal path, then `.js`/`.mjs`, then `/index.js`." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/probe-scanner", "path": "engine/reference/compat/probe-scanner.md", "source": "engine/compat/probe-scanner.js", "import": "/engine/compat/probe-scanner.js", "sourceHash": "df6195017e8b826e0b546145ded842d28b11007a7625f33f82530dc577e943d7", "summary": "probe-scanner.js — statically detect what a guest app uses. Combines the parsed DOM model with a regex scan of all script source to infer the `uses`, `dom`, and `gpu` sections of a compatibility profile. This is a heuristic pass (static, no execution) — the healing + interposition layers refine it at runtime and the profile cache promotes it once it boots.", "exports": [ { "name": "scanSource", "kind": "function", "signature": "scanSource(model, files = null)", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/profile-builder", "path": "engine/reference/compat/profile-builder.md", "source": "engine/compat/profile-builder.js", "import": "/engine/compat/profile-builder.js", "sourceHash": "949a73707c4b3c1503a3e4d070431f69b10a23fd52da48d8fa6c8f309a69ed45", "summary": "Build a full profile from a static scan result.", "exports": [ { "name": "buildProfile", "kind": "function", "signature": "buildProfile(id, scan, opts = {})", "summary": "Build a full profile from a static scan result." }, { "name": "mergeProfiles", "kind": "function", "signature": "mergeProfiles(saved, fresh)", "summary": "Merge a saved profile with a freshly scanned one. Saved healing/permissions decisions win (they were promoted as working); newly detected requirements and `uses`/`gpu` flags are unioned in." }, { "name": "profilePermissionList", "kind": "function", "signature": "profilePermissionList(profile)", "summary": "Map a profile to a kernel/AppRegistry permission list (best-effort)." }, { "name": "sha256Hex", "kind": "function", "signature": "async sha256Hex(str)", "summary": "SHA-256 hex of a string (used for source/version hashing)." }, { "name": "PROFILE_FORMAT", "kind": "constant", "signature": "PROFILE_FORMAT", "summary": "profile-builder.js — assemble & merge compatibility profiles. A profile is the durable description of what a guest app needs and how to heal it. The static scanner produces a fresh profile; the cache may hold a saved one from a previous version. `mergeProfiles` reuses known-good healing decisions and layers in newly detected requirements." } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/profile-cache", "path": "engine/reference/compat/profile-cache.md", "source": "engine/compat/profile-cache.js", "import": "/engine/compat/profile-cache.js", "sourceHash": "5eff703e5cac636ee24742b0e8f076dc3ba81e51900585c1c3426308a45d9ba5", "summary": "profile-cache.js — persist & version compatibility profiles. Storage layout (via the kernel StorageManager facade): /os/compat/profiles/{id}.json ← active (stable or testing) profile /os/compat/index.json ← { [id]: { knownVersions: [...] } } /os/compat/snapshots/{id}/{ts}.json ← runtime snapshots (Phase 7) If no storage facade is provided (or a write fails), it degrades to an in-memory cache so the bootloader still works in a bare harness/test.", "exports": [ { "name": "ProfileCache", "kind": "class", "signature": "class ProfileCache", "summary": "" } ], "subsystem": "engine" }, { "schemaVersion": 1, "title": "compat/runtime-realm", "path": "engine/reference/compat/runtime-realm.md", "source": "engine/compat/runtime-realm.js", "import": "/engine/compat/runtime-realm.js", "sourceHash": "a763db46bdc35d97cd2eb4a2979e39953da34326bbbda03cbb13d1f43398fb6d", "summary": "runtime-realm.js — a controlled, scoped execution root for a guest app. Trusted same-origin guests (Mode A/B) reference elements via `document.*`, so the realm is a SCOPED LIGHT-DOM container (`
`) rather than a shadow root — `getElementById('c')` must still resolve. Isolation comes from: • CSS scoping (css-healer) so guest styles can't touch the OS shell, • API interposition (Phase 5) so guest browser calls route through the engine, • DOM healing so required elements exist before scripts run. Scripts parsed by DOMParser are inert; the realm re-executes them in document order: classic inline → fresh ", "exports": [], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "motion/PageTransition", "path": "plauna/reference/motion/PageTransition.md", "source": "plauna/motion/PageTransition.js", "import": "/plauna/motion/PageTransition.js", "sourceHash": "248eb96f969e8b54ed308b05830aca51ec3059ad2f7186dec698f084f8b2c871", "summary": "PageTransition - Modern page/view blending for Plauna. Wraps the native View Transitions API (Level 1/2) where available and falls back to CSS class/transition-based cross-fades for older browsers. Designed for SPA \"page\" swaps, tab changes, and content fades inside a Plauna app. Usage: const pt = new PageTransition({ type: 'slide-left', duration: 350 }); await pt.start(() => { // update the DOM here });", "exports": [ { "name": "PageTransition", "kind": "class", "signature": "class PageTransition", "summary": "" }, { "name": "startPageTransition", "kind": "function", "signature": "startPageTransition(update, options = {})", "summary": "Convenience function for one-off transitions." } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "motion/PageTransitionContracts", "path": "plauna/reference/motion/PageTransitionContracts.md", "source": "plauna/motion/PageTransitionContracts.js", "import": "/plauna/motion/PageTransitionContracts.js", "sourceHash": "324d899287c5421192e917aa514d5d42501ba440bd4b2effc720ab9781072d1e", "summary": "", "exports": [ { "name": "UnsupportedPageTransitionVersionError", "kind": "class", "signature": "class UnsupportedPageTransitionVersionError extends Error", "summary": "" }, { "name": "preparePageTransitionIntent", "kind": "function", "signature": "preparePageTransitionIntent(input)", "summary": "" }, { "name": "preparePageTransitionResolved", "kind": "function", "signature": "preparePageTransitionResolved(input)", "summary": "" }, { "name": "PAGE_TRANSITION_SCHEMA_VERSION", "kind": "constant", "signature": "PAGE_TRANSITION_SCHEMA_VERSION", "summary": "" }, { "name": "PAGE_TRANSITION_INTENT_SCHEMA", "kind": "constant", "signature": "PAGE_TRANSITION_INTENT_SCHEMA", "summary": "" }, { "name": "PAGE_TRANSITION_RESOLVED_SCHEMA", "kind": "constant", "signature": "PAGE_TRANSITION_RESOLVED_SCHEMA", "summary": "" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "motion/PageTransitionManager", "path": "plauna/reference/motion/PageTransitionManager.md", "source": "plauna/motion/PageTransitionManager.js", "import": "/plauna/motion/PageTransitionManager.js", "sourceHash": "dc658349f46e63e25b352f76401bda2471c823403445b02d485a1b3ec9033050", "summary": "PageTransitionManager - Cross-document (MPA) view transition orchestration. This module runs on every page that opts in. It injects a shared stylesheet containing the PageTransition presets and, on supported browsers, sets the active view transition type for cross-document navigations via the pageswap and pagereveal events. Pages can control their transition with a data attribute on the element: The default is the project's default preset (etch). If the attribute is absent or the value is unknown, the default is used.", "exports": [], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "motion/PageTransitionPresets", "path": "plauna/reference/motion/PageTransitionPresets.md", "source": "plauna/motion/PageTransitionPresets.js", "import": "/plauna/motion/PageTransitionPresets.js", "sourceHash": "5cb1546706b6d1e675de5151d34201b40cde06b8c28103be82c303179b285b0e", "summary": "PageTransitionPresets - Shared transition presets and stylesheet generation. This module is the single source of truth for the keyframes and CSS used by both the same-document PageTransition engine and the cross-document PageTransitionManager. Keeping the presets in one place means SPA demos and MPA page navigation can share the same effects and the same default.", "exports": [ { "name": "directionToPreset", "kind": "function", "signature": "directionToPreset(direction)", "summary": "" }, { "name": "resolvePreset", "kind": "function", "signature": "resolvePreset(name, state = { index: 0 })", "summary": "" }, { "name": "keyframesForPreset", "kind": "function", "signature": "keyframesForPreset(name)", "summary": "" }, { "name": "presetStyleSheet", "kind": "function", "signature": "presetStyleSheet(namespace)", "summary": "" }, { "name": "ensureStyleSheet", "kind": "function", "signature": "ensureStyleSheet(namespace)", "summary": "" }, { "name": "DEFAULT_PRESET", "kind": "constant", "signature": "DEFAULT_PRESET", "summary": "" }, { "name": "DEFAULT_DURATION", "kind": "constant", "signature": "DEFAULT_DURATION", "summary": "" }, { "name": "DEFAULT_EASING", "kind": "constant", "signature": "DEFAULT_EASING", "summary": "" }, { "name": "DIRECTION_PRESETS", "kind": "constant", "signature": "DIRECTION_PRESETS", "summary": "" }, { "name": "TYPES", "kind": "constant", "signature": "TYPES", "summary": "" }, { "name": "SPECIAL_TYPES", "kind": "constant", "signature": "SPECIAL_TYPES", "summary": "" }, { "name": "ALL_TYPES", "kind": "constant", "signature": "ALL_TYPES", "summary": "" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "motion/TransitionEngine", "path": "plauna/reference/motion/TransitionEngine.md", "source": "plauna/motion/TransitionEngine.js", "import": "/plauna/motion/TransitionEngine.js", "sourceHash": "33ca27d906e31a81b9701f5d3dcc232470cdc274738ea9bd264910b5d37b6542", "summary": "TransitionEngine - Property animation system for Plauna Provides smooth transitions and animations for UI properties", "exports": [ { "name": "TransitionEngine", "kind": "class", "signature": "class TransitionEngine", "summary": "" }, { "name": "TransitionUtils", "kind": "constant", "signature": "TransitionUtils", "summary": "" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "notifications/NotificationSystem", "path": "plauna/reference/notifications/NotificationSystem.md", "source": "plauna/notifications/NotificationSystem.js", "import": "/plauna/notifications/NotificationSystem.js", "sourceHash": "9748d96249cf48cd191fc19f6b6923451af31d0c727edd6d04cb0abb9de375c3", "summary": "============================================================================ NotificationSystem - Centralized Notification Management ============================================================================ NotificationSystem provides a unified API for user notifications, separating them from debug logging and integrating with ToastManager for UI feedback. NOTIFICATION CHANNELS: 1. Toasts: UI notifications via ToastManager (top-right corner) 2. Console: Browser console.log/error/warn for debugging 3. Sounds: Optional audio feedback using Web Audio API NOTIFICATION LEVELS (priority order): - debug (0): Development debugging information - info (1): General informational messages - success (2): Success confirmations - warning (3): Warning messages - error (4): Error messages - critical (5): Critical errors requiring immediate attention NOTIFICATION TYPES: - system: System-level notifications (startup, shutdown, etc.) - action: User action feedback (clicks, submissions, etc.) - validation: Form validation errors - performance: Performance metrics and warnings - security: Security-related alerts - network: Network request status GROUPING: - createGroup(name, options): Create a notification group - Groups collect related notifications and report summary - Useful for batch operations or multi-step processes CONVENIENCE METHODS: - debug(message, type, data): Debug-level notification - info(message, type, data): Info-level notification - success(message, type, data): Success-level notification - warning(message, type, data): Warning-level notification - error(message, type, data): Error-level notification - critical(message, type, data): Critical-level notification SOUND EFFECTS: - Uses Web Audio API to generate simple beep sounds - Different frequencies for different levels - Can be disabled via enableSounds option MIN LEVEL FILTERING: - minLevel option filters notifications below specified level - Useful for suppressing debug messages in production INTEGRATION: - Uses global Toast from ToastManager for UI toasts - Toast position defaults to top-right - Console output includes prefix (default: '[Plauna]') USAGE: const notify = new NotificationSystem({ minLevel: 'info' }); notify.success('File saved successfully', 'action'); notify.error('Failed to load data', 'network', { url: '/api/data' });", "exports": [ { "name": "NotificationSystem", "kind": "class", "signature": "class NotificationSystem", "summary": "" }, { "name": "Notify", "kind": "constant", "signature": "Notify", "summary": "" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "particle/ParticleController", "path": "plauna/reference/particle/ParticleController.md", "source": "plauna/particle/ParticleController.js", "import": "/plauna/particle/ParticleController.js", "sourceHash": "a3659aca55e1918c43a4c088234b744502d943c5feec307f308199d578fa8a78", "summary": "ParticleController - Manages particle effects and animations Handles particle system initialization and control for showcase", "exports": [ { "name": "ParticleController", "kind": "class", "signature": "class ParticleController", "summary": "ParticleController - Manages particle effects and animations Handles particle system initialization and control for showcase" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "particle/bridge", "path": "plauna/reference/particle/bridge.md", "source": "plauna/particle/bridge.js", "import": "/plauna/particle/bridge.js", "sourceHash": "add11bd6169ac88b1bea8382cf8476905a40398090fd1e7f1f57f29db220740a", "summary": "PlaunaParticleBridge - Connects Plauna to Particle Engine's VGPU Follows existing VGPU patterns from ViewportPanel", "exports": [ { "name": "PlaunaGPUBridge", "kind": "class", "signature": "class PlaunaGPUBridge", "summary": "PlaunaParticleBridge - Connects Plauna to Particle Engine's VGPU Follows existing VGPU patterns from ViewportPanel" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "style/AdaptiveThemeFactory", "path": "plauna/reference/style/AdaptiveThemeFactory.md", "source": "plauna/style/AdaptiveThemeFactory.js", "import": "/plauna/style/AdaptiveThemeFactory.js", "sourceHash": "1a563e32bd26835aa2d3c2ea732b1f57fcc7d3e962b3a287247865fb4debc37a", "summary": "", "exports": [ { "name": "AdaptiveThemeFactory", "kind": "class", "signature": "class AdaptiveThemeFactory", "summary": "" }, { "name": "adaptiveThemeFactory", "kind": "constant", "signature": "adaptiveThemeFactory", "summary": "" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "style/CSSGenerator", "path": "plauna/reference/style/CSSGenerator.md", "source": "plauna/style/CSSGenerator.js", "import": "/plauna/style/CSSGenerator.js", "sourceHash": "cf79013ff717a9e420f50c167d50838df282f1bae39bbb7519e186a5c10583b2", "summary": "CSSGenerator - Runtime CSS generation from DesignTokens and LayerManager. CSS generation pattern: - Generates CSS custom properties from design tokens - Supports theme-based variable sets (bright/night) - Caches generated CSS for performance - Injects CSS into document via style tags - Supports z-index layer variables Architecture: - tokens: DesignTokens instance for token resolution - layerValues: LayerManager z-index values - generatedCSS: Map of cached CSS strings - styleElement: DOM style element for CSS injection - themes: Pre-defined theme variable sets", "exports": [ { "name": "CSSGenerator", "kind": "class", "signature": "class CSSGenerator", "summary": "" }, { "name": "cssGenerator", "kind": "constant", "signature": "cssGenerator", "summary": "" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "style/ComputedStyle", "path": "plauna/reference/style/ComputedStyle.md", "source": "plauna/style/ComputedStyle.js", "import": "/plauna/style/ComputedStyle.js", "sourceHash": "5a93e204225ee79f36475509594685463211d0a7ac68a452d1406dc44609990f", "summary": "ComputedStyle - Style resolution and caching system for Plauna. Style resolution pattern: - Handles style inheritance from parent nodes - Resolves design token references - Computes final style values for rendering - Caches computed styles for performance - Tracks performance statistics Architecture: - cache: Map of computed style results - tokenCache: Map of resolved token values - styleCache: Map of style property resolutions - performanceStats: Metrics for cache hits/misses and timing Style categories: - Position and layout: position, display, flex properties - Sizing: width, height, min/max dimensions, flex basis/grow/shrink - Spacing: margin, padding - Visual: colors, borders, shadows, opacity - Typography: font family, size, weight, line height, alignment - Interaction: pointer events, cursor - Accessibility: visibility, z-index - Transform and animation", "exports": [ { "name": "ComputedStyle", "kind": "class", "signature": "class ComputedStyle", "summary": "" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "style/DesignTokenContracts", "path": "plauna/reference/style/DesignTokenContracts.md", "source": "plauna/style/DesignTokenContracts.js", "import": "/plauna/style/DesignTokenContracts.js", "sourceHash": "c7a5cf3ed072856205d9ca341fddc0c7996b3914c6971aa183aca7ee53e978a2", "summary": "Accept legacy raw token maps and return a canonical, safely cloned v1 envelope.", "exports": [ { "name": "UnsupportedDesignTokenVersionError", "kind": "class", "signature": "class UnsupportedDesignTokenVersionError extends Error", "summary": "" }, { "name": "prepareDesignTokenDocument", "kind": "function", "signature": "prepareDesignTokenDocument(input)", "summary": "Accept legacy raw token maps and return a canonical, safely cloned v1 envelope." }, { "name": "createDesignTokenExport", "kind": "function", "signature": "createDesignTokenExport(input)", "summary": "Emit metadata additively so legacy readers still see token categories at the root." }, { "name": "DESIGN_TOKEN_SCHEMA", "kind": "constant", "signature": "DESIGN_TOKEN_SCHEMA", "summary": "" }, { "name": "DESIGN_TOKEN_SCHEMA_VERSION", "kind": "constant", "signature": "DESIGN_TOKEN_SCHEMA_VERSION", "summary": "" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "style/DesignTokens", "path": "plauna/reference/style/DesignTokens.md", "source": "plauna/style/DesignTokens.js", "import": "/plauna/style/DesignTokens.js", "sourceHash": "da420ccc14e4020f3462b8a6d92a5d10ae49b85d2c80af5016de49a65cb90cd1", "summary": "DesignTokens - Design system token management. Token management pattern: - Centralized token system for Plauna styling - Manages spacing, typography, color, motion, borderRadius, shadows, zIndex - Observer pattern for token change notifications - Caching for performance optimization - Deep merge strategy for token inheritance Architecture: - tokens: Merged token object (defaults + custom) - observers: Set of callback functions - cache: Map of cached token lookups", "exports": [ { "name": "DesignTokens", "kind": "class", "signature": "class DesignTokens", "summary": "DesignTokens - Design system token management. Token management pattern: - Centralized token system for Plauna styling - Manages spacing, typography, color, motion, borderRadius, shadows, zIndex - Observer pattern for token change notifications - Caching for performance optimization - Deep merge strategy for token inheritance Architecture: - tokens: Merged token object (defaults + custom) - observers: Set of callback functions - cache: Map of cached token lookups" }, { "name": "tokens", "kind": "constant", "signature": "tokens", "summary": "" }, { "name": "TokenUtils", "kind": "constant", "signature": "TokenUtils", "summary": "" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "style/LayerManager", "path": "plauna/reference/style/LayerManager.md", "source": "plauna/style/LayerManager.js", "import": "/plauna/style/LayerManager.js", "sourceHash": "f2469425f3962220de13ef0f37b3bcfe6e8cd38c56448e0fb93f8f46c851b3ef", "summary": "LayerManager - Semantic z-index management system. Z-index management pattern: - Centralized z-index constants organized by stacking context - Arithmetic relationships for self-documenting code - Prevents z-index wars by providing semantic layer names - Uses isolation: isolate for stacking context isolation Stacking contexts (lowest to highest): - Layout: backdrop, surface, widget gallery - Modal: backdrop, panel - Dropdown: backdrop, dropdown - Tooltip - Notification: toast, alert Arithmetic pattern: - base = 0 - above = 1 - below = -1 - Each layer is defined relative to the previous layer", "exports": [ { "name": "getStackingContextCSS", "kind": "function", "signature": "getStackingContextCSS(layerName)", "summary": "Create CSS for stacking context isolation. Stacking context pattern: - Uses isolation: isolate to create new stacking context - Prevents side effects from parent stacking contexts - Returns CSS object with isolation and z-index" }, { "name": "getLayerZIndex", "kind": "function", "signature": "getLayerZIndex(layerName)", "summary": "Get z-index value for a layer" }, { "name": "getLayerCSSVariables", "kind": "function", "signature": "getLayerCSSVariables()", "summary": "Get all layer values as CSS custom properties" }, { "name": "zLayoutBackdrop", "kind": "constant", "signature": "zLayoutBackdrop", "summary": "" }, { "name": "zLayoutSurface", "kind": "constant", "signature": "zLayoutSurface", "summary": "" }, { "name": "zLayoutWidgetGallery", "kind": "constant", "signature": "zLayoutWidgetGallery", "summary": "" }, { "name": "zModalBackdrop", "kind": "constant", "signature": "zModalBackdrop", "summary": "" }, { "name": "zModalPanel", "kind": "constant", "signature": "zModalPanel", "summary": "" }, { "name": "zDropdownBackdrop", "kind": "constant", "signature": "zDropdownBackdrop", "summary": "" }, { "name": "zDropdown", "kind": "constant", "signature": "zDropdown", "summary": "" }, { "name": "zTooltip", "kind": "constant", "signature": "zTooltip", "summary": "" }, { "name": "zNotificationToast", "kind": "constant", "signature": "zNotificationToast", "summary": "" }, { "name": "zNotificationAlert", "kind": "constant", "signature": "zNotificationAlert", "summary": "" }, { "name": "layerValues", "kind": "constant", "signature": "layerValues", "summary": "" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "style/StyleSizing", "path": "plauna/reference/style/StyleSizing.md", "source": "plauna/style/StyleSizing.js", "import": "/plauna/style/StyleSizing.js", "sourceHash": "fc53654bce81be48fd296856034daa4dac86370600c341b920f3347115f242e6", "summary": "", "exports": [ { "name": "resolvePlaunaStyleSize", "kind": "function", "signature": "resolvePlaunaStyleSize(value, options = {})", "summary": "" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "style/ThemeController", "path": "plauna/reference/style/ThemeController.md", "source": "plauna/style/ThemeController.js", "import": "/plauna/style/ThemeController.js", "sourceHash": "d2ad330c69dbed0f6e85d6482149cabac38894e22f56d7e432e6c51286ba5a6f", "summary": "ThemeController - Runtime theme management and switching. Theme switching pattern: - Manages bright/night theme switching with live CSS updates - Persists theme preference to localStorage - Listens to system theme preference (prefers-color-scheme) - Observer pattern for theme change notifications - Applies theme via data-theme attribute and CSS variables Features: - Auto-switch based on system preference - Manual theme switching with setTheme() - Theme persistence across sessions - Observer notifications for reactive updates", "exports": [ { "name": "ThemeController", "kind": "class", "signature": "class ThemeController", "summary": "" }, { "name": "themeController", "kind": "constant", "signature": "themeController", "summary": "" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "style/ThemeManager", "path": "plauna/reference/style/ThemeManager.md", "source": "plauna/style/ThemeManager.js", "import": "/plauna/style/ThemeManager.js", "sourceHash": "fdf9101d7853ef469a07369c2952cefe0d8651f3d633952f80a5b2cbe1772d03", "summary": "ThemeManager - Theme management system for Plauna. Theme management pattern: - Provides theme registration and switching - Supports custom token overrides - Observer pattern for theme change notifications - Deep merge strategy for token inheritance - Pre-registered themes (light, dark) Architecture: - themes: Map of registered theme definitions - observers: Set of callback functions for change notifications - customTokens: Map of custom token overrides - currentTheme: Currently active theme ID", "exports": [ { "name": "ThemeManager", "kind": "class", "signature": "class ThemeManager", "summary": "" }, { "name": "ThemeUtils", "kind": "constant", "signature": "ThemeUtils", "summary": "" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "style/index", "path": "plauna/reference/style/index.md", "source": "plauna/style/index.js", "import": "/plauna/style/index.js", "sourceHash": "8769ccaf5807e2dbc9f2c0aa71360b8f37fff546fec5a8e02edf5ed35498a23f", "summary": "Style Module Exports Central export point for all Plauna styling utilities and managers. Exported modules: - LayerManager: Semantic z-index management system - ThemeManager: Theme registration and management - DesignTokens: Design system token management - WidgetStyleManager: Theme-aware widget styling - CSSGenerator: Runtime CSS generation - ThemeController: Runtime theme switching Usage: import { tokens, ThemeManager, layerValues } from './style/index.js';", "exports": [], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "surface/surface-manager", "path": "plauna/reference/surface/surface-manager.md", "source": "plauna/surface/surface-manager.js", "import": "/plauna/surface/surface-manager.js", "sourceHash": "fe179792c3c283b3098014a32b4cba09edb988a2d54d6322b96903283f36cdcf", "summary": "PlaunaSurfaceManager - Manages GPU surfaces and rendering Integrates with existing VGPU patterns", "exports": [ { "name": "PlaunaSurfaceManager", "kind": "class", "signature": "class PlaunaSurfaceManager", "summary": "" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "text/pretext-service", "path": "plauna/reference/text/pretext-service.md", "source": "plauna/text/pretext-service.js", "import": "/plauna/text/pretext-service.js", "sourceHash": "23ebfd88f83466a0b2ed50b29f0422e5f613f01b4661c00b5d7e5b5490efe0e8", "summary": "PlaunaTextService - DOM-free text measurement and layout Implements Pretext-style text measurement for Plauna", "exports": [ { "name": "PlaunaTextService", "kind": "class", "signature": "class PlaunaTextService", "summary": "PlaunaTextService - DOM-free text measurement and layout Implements Pretext-style text measurement for Plauna" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "themes/ThemeContracts", "path": "plauna/reference/themes/ThemeContracts.md", "source": "plauna/themes/ThemeContracts.js", "import": "/plauna/themes/ThemeContracts.js", "sourceHash": "b2f168771b7085d0cb3432a526d7f7fec5a1305c16e2621069f832a0b53dce93", "summary": "", "exports": [ { "name": "validateThemeId", "kind": "function", "signature": "validateThemeId(value, label = 'Theme id')", "summary": "" }, { "name": "prepareThemeVariables", "kind": "function", "signature": "prepareThemeVariables(input, { allowNull = true } = {})", "summary": "" }, { "name": "prepareThemeRegistry", "kind": "function", "signature": "prepareThemeRegistry(input)", "summary": "" }, { "name": "prepareThemeManifest", "kind": "function", "signature": "prepareThemeManifest(input, requestedId)", "summary": "" }, { "name": "THEME_SCHEMA_VERSION", "kind": "constant", "signature": "THEME_SCHEMA_VERSION", "summary": "" } ], "subsystem": "plauna" }, { "schemaVersion": 1, "title": "themes/ThemeLoader", "path": "plauna/reference/themes/ThemeLoader.md", "source": "plauna/themes/ThemeLoader.js", "import": "/plauna/themes/ThemeLoader.js", "sourceHash": "14d9ab06a572b4b9c05d54fdc1a65d5542a8bc465ba0b07bfcfe8fc3214b8417", "summary": "============================================================================ ThemeLoader - File-Based Theme Discovery and Loading ============================================================================ ThemeLoader is a file-based theme system inspired by WordPress but modernized. It loads themes from plauna/themes/{id}/theme.json and applies CSS variables. THEME STRUCTURE: plauna/themes/ ├── _base/ # Base theme with all token defaults (required) │ └── theme.json # Defines every possible CSS variable ├── dark/ # Dark theme (extends _base) │ └── theme.json # Only overrides what's different from _base ├── light/ # Light theme (extends _base) │ └── theme.json ├── high-contrast/ # High contrast theme (extends dark) │ └── theme.json ├── custom/ # User starter template (extends dark) │ └── theme.json └── index.json # Registry of discoverable themes THEME MANIFEST (theme.json): { \"name\": \"Theme Name\", \"description\": \"Theme description\", \"extends\": \"parent-theme-id\", // Optional: parent theme to inherit from \"variables\": { \"color-primary\": \"#3b82f6\", // CSS variable name → value \"spacing-md\": \"16px\", // null or omitted values inherit from parent } } THEME RESOLUTION CASCADE (highest priority wins): 1. _base theme defaults (all variables defined) 2. Parent theme variables (if extends is set) 3. Current theme variables (overrides parent) 4. Runtime overrides (applyOverrides() - per-session changes) CSS VARIABLE APPLICATION: - Variables are written to