API Reference¶

Purpose¶

Use this folder for Gaussian Splatting API references and regeneration scripts.

Usage¶

Task	Document	Source
Read public script API extracted from `.gd` files (test, internal tooling, and benchmark harness scripts excluded by default).	`gdscript_reference.md`	`scripts/extract_gdscript_docs.py`
Read shader functions and uniform blocks extracted from GLSL files (undocumented entries omitted by default).	`shader_reference.md`	`scripts/generate_shader_docs.py`
Read the maintained node-level API guide.	`gaussian_splat_node3d.md`	`modules/gaussian_splatting/nodes/gaussian_splat_node_3d.cpp:84`
Read the GaussianData API reference.	`gaussian_data.md`	`modules/gaussian_splatting/core/gaussian_data.cpp`
Read the GaussianSplatAsset API reference.	`gaussian_splat_asset.md`	`modules/gaussian_splatting/core/gaussian_splat_asset.cpp`
Read the GaussianSplatWorld3D API reference.	`gaussian_splat_world3d.md`	`modules/gaussian_splatting/nodes/gaussian_splat_world3d.cpp`
Read the GaussianSplatContainer API reference.	`gaussian_splat_container.md`	`modules/gaussian_splatting/nodes/gaussian_splat_container.cpp`
Read the GaussianSplatDynamicInstance3D API reference.	`gaussian_splat_dynamic_instance3d.md`	`modules/gaussian_splatting/nodes/gaussian_splat_dynamic_instance3d.cpp`
Read the GaussianSplatManager API reference.	`gaussian_splat_manager.md`	`modules/gaussian_splatting/core/gaussian_splat_manager.cpp`
Read the GaussianSplatRenderer API reference.	`gaussian_splat_renderer.md`	`modules/gaussian_splatting/renderer/gaussian_splat_renderer.cpp`
Read project setting controls used by the module.	`../reference/project-settings.md`	`docs/reference/project-settings.md`
Browse internal infrastructure classes that have no dedicated API pages.	`internal-classes.md`	`modules/gaussian_splatting/register_types.cpp`

API¶

Artifact	Type	Regeneration entrypoint
`gdscript_reference.md`	Generated	`scripts/extract_gdscript_docs.py`
`shader_reference.md`	Generated	`scripts/generate_shader_docs.py`
`gaussian_splat_node3d.md`	Maintained	`modules/gaussian_splatting/nodes/gaussian_splat_node_3d.h:341`

Examples¶

python3 scripts/extract_gdscript_docs.py
python3 scripts/extract_gdscript_docs.py --scope all
python3 scripts/generate_shader_docs.py
python3 scripts/generate_shader_docs.py --include-undocumented
python3 scripts/docs/check_links.py docs/api

Strict mode¶

Use --strict to fail the script when undocumented entries exceed a threshold. Because many shaders are not yet fully commented, bare --strict (which defaults to zero allowed undocumented entries) will exit non-zero. Pass explicit thresholds to use it as a CI gate while documentation is still being expanded:

# Allow current baseline coverage and tighten thresholds as comments improve.
python3 scripts/generate_shader_docs.py --strict \
    --max-undocumented-functions 150 \
    --max-undocumented-fields 130

Troubleshooting¶

Problem	Action	Source
Internal links fail in this folder.	Run `python3 scripts/docs/check_links.py docs/api` and fix reported links.	`scripts/docs/check_links.py`
Node API docs drift from code.	Reconcile methods, properties, and signals against `_bind_methods()`.	`modules/gaussian_splatting/nodes/gaussian_splat_node_3d.cpp:84`
Generated GDScript reference includes internal/test/tooling scripts.	Regenerate with default `--scope public` (or use explicit `--scope all` only for internal audits).	`scripts/extract_gdscript_docs.py`
Shader docs generation fails in strict mode.	Add missing shader comments in GLSL sources, or temporarily adjust strict thresholds for audit-only runs.	`scripts/generate_shader_docs.py --strict`