GDScript API Reference¶

Last generated: 2026-04-05

Scope: public

Scripts scanned: 5

Undocumented members are omitted by default. Use --include-undocumented to include them.

Script¶

scripts/core/gaussian_splatting_manager.gd

gaussian_splatting_manager

Member	Description
`_deferred_gpu_init()`	Allocates a local RenderingDevice and prints adapter information.
`_initialize_gpu_resources()`	Schedules GPU initialization after the rendering server is ready.
`_process(_delta: float)`	Updates frame counters and emits periodic FPS metrics. @param _delta: Frame delta in seconds.
`_ready()`	Initializes GPU resources for the Gaussian Splatting manager.
`get_performance_stats()`	Returns performance metrics including sort/render times and GPU memory usage.
`load_compute_shaders()`	Validates availability of embedded radix-sort compute kernels.
`sort_keys_gpu(keys: PackedInt32Array, values: PackedInt32Array = PackedInt32Array())`	Sorts key/value pairs using the GPU radix sort pipeline (CPU fallback for now). @param keys: Keys to sort. @param values: Optional values to keep in sync with keys. @return Sorted keys array.

templates/gaussian_splat_template/autoload/gaussian_bootstrap.gd

gaussian_bootstrap

Member	Description
`_log_runtime_configuration()`	Prints adapter and sorting configuration information for diagnostics.
`_ready()`	Resolves the GaussianSplatManager singleton and logs runtime configuration.
`ensure_submission_lock()`	Acquires a submission lock from the manager when supported. @return Lock object or null if unavailable.
`get_global_stats()`	Returns global renderer statistics when available.

templates/gaussian_splat_template/scripts/camera/orbit_camera_rig.gd

OrbitCameraRig

Member	Description
`_handle_mouse_button(event: InputEventMouseButton)`	Updates orbit/pan state and applies zoom on wheel input. @param event: Mouse button event.
`_handle_mouse_motion(event: InputEventMouseMotion)`	Applies orbit rotation or panning based on the current input state. @param event: Mouse motion event.
`_physics_process(delta: float)`	Handles keyboard-driven translation for the orbit rig. @param delta: Frame delta in seconds.
`_ready()`	Initializes the camera reference and cached orbit angles.
`_unhandled_input(event: InputEvent)`	Dispatches mouse events to orbit or pan handlers. @param event: Input event from the scene tree.
`_zoom(amount: float)`	Moves the camera along its local forward axis. @param amount: Positive or negative zoom distance.
`focus(bounds: AABB)`	Repositions the rig to frame the provided bounds. @param bounds: Axis-aligned bounds to focus on.

templates/gaussian_splat_template/scripts/main_scene.gd

GaussianTemplateRoot

Member	Description
`_configure_gaussian_node()`	Applies template defaults to the GaussianSplatNode3D instance.
`_focus_camera()`	Centers the orbit camera on the current Gaussian bounds.
`_ready()`	Configures the template scene by wiring the node, overlay, and camera focus.
`_wire_overlay()`	Binds the overlay to the gaussian node and camera rig.

templates/gaussian_splat_template/scripts/ui/performance_overlay.gd

GaussianPerformanceOverlay

Member	Description
`_colorize_buffer_percent(percent: float, value_str: String)`	Returns color-coded string for buffer usage percentage
`_colorize_gpu_time(time_ms: float, value_str: String)`	Returns color-coded string for GPU timing (ms)
`_colorize_lod_reduction(percent: float, value_str: String)`	Returns color-coded string for LOD reduction percentage (higher = more aggressive = red)
`_colorize_vram_percent(percent: float, value_str: String)`	Returns color-coded string for VRAM usage percentage
`_format_number(value: int)`	Formats large numbers with K/M suffixes for readability
`_process(delta: float)`	Tracks frame timing and refreshes the overlay at the configured interval. @param delta: Frame delta in seconds.
`_ready()`	Enables processing so the overlay refreshes at runtime.
`_refresh_overlay()`	Rebuilds the overlay text with the latest renderer statistics using Custom Performance Monitors.
`_try_resolve_camera()`	Resolves the camera from the configured NodePath when missing.
`set_camera_node(node: Node3D)`	Assigns the camera rig node used for pose reporting. @param node: Camera rig node.
`set_gaussian_node(node: GaussianSplatNode3D)`	Assigns the Gaussian node used for statistics queries. @param node: GaussianSplatNode3D to monitor.

Generated by:

scripts/extract_gdscript_docs.py