REFERENCE / GODOT GDEXTENSION
Plugin API
Find properties, methods and signals for page lifecycle, object bindings and rendering.
Reference content comes from the plugin’s Godot class documentation.
UltralightAPI →
Persistent application API registry with a caller-selected JavaScript namespace.
CLASS / RefCountedUltralightBinding →
Revocable export owned by one document.
CLASS / RefCountedUltralightBindingOptions →
Member visibility and conversion options for an export.
CLASS / RefCountedUltralightError →
Structured script, conversion, loading or lifecycle error.
CLASS / RefCountedUltralightFrameEvent →
Read-only document and frame identity for lifecycle signals.
CLASS / UltralightViewUltralightInspector →
Embedded developer tools for an UltralightView.
CLASS / UltralightJSValueUltralightJSArray →
Retained live JavaScript Array handle.
CLASS / UltralightJSValueUltralightJSObject →
Retained live JavaScript object handle.
CLASS / RefCountedUltralightJSValue →
Document-scoped handle for checked JavaScript access.
CLASS / RefCountedUltralightResult →
Explicit success value or structured failure.
CLASS / ObjectUltralightSingleton →
Control the shared Ultralight renderer and remote inspector.
CLASS / RefCountedUltralightTask →
Single-completion asynchronous operation with a retained result.
CLASS / RefCountedUltralightUndefined →
Distinct representation of JavaScript undefined.
CLASS / TextureRectUltralightView →
Render HTML, CSS and JavaScript in a Godot TextureRect.
Document lifecycle
Load explicitly with load_url/load_html and wait for main-document dom_ready. frame_dom_ready also reports child frames. Registries install before window_ready and page scripts. Navigation, reload and rebuild invalidate old handles and unfinished tasks.
Data and objects
Containers are shared in both directions and nested values are wrapped lazily. Use evaluate_copy or snapshot for independent copies. C# helpers support public members, Task/ValueTask and collection adapters without [Export]. read_only restricts writes; members selects root members.
Rendering configuration
accelerated requests RenderingDevice; is_accelerated() reports the actual backend. Compatibility and headless fall back to CPU. Apply accelerated or transparent changes with rebuild(), which replaces the document.
Ultralight Free caps View animations and repaints at 60 FPS. max_render_fps = 0 removes only the per-view limit, not the SDK edition ceiling.