UltralightView

acceleratedbool

Request GPU rendering through Godot RenderingDevice. Configure before initialization. Compatibility, headless and unavailable devices use CPU Surface rendering. Use is_accelerated to check the actual backend. Reinitialization reloads the page.

Default: — · Accessors: set_accelerated() / get_accelerated()

max_render_fpsint

Limit this view's animation and repaint rate. Changes apply immediately and survive init_view. Zero removes the per-view limit; the SDK edition ceiling still applies (60 FPS for the public Free edition). Godot frame limits and VSync are independent.

Default: — · Accessors: set_max_render_fps() / get_max_render_fps()

source_typeint

Initial page source: 0 selects URL, 1 selects inline HTML.

Default: — · Accessors: set_source_type() / get_source_type()

initial_urlString

URL loaded during initial automatic initialization when source_type is 0.

Default: — · Accessors: set_initial_url() / get_initial_url()

initial_htmlString

HTML loaded during initial automatic initialization when source_type is 1.

Default: — · Accessors: set_initial_html() / get_initial_html()

initial_base_urlString

Base URL for relative resources in initial inline HTML.

Default: — · Accessors: set_initial_base_url() / get_initial_base_url()

document_readybool

Whether the current main document has reached DOM readiness. Read-only.

Default: — · Accessors: is_document_ready() · Read-only

navigation_idint

Main-document generation identifier. Read-only.

Default: — · Accessors: get_navigation_id() · Read-only

current_urlString

Current main-document URL, separate from initial source configuration. Read-only.

Default: — · Accessors: get_current_url() · Read-only

htmlString

Legacy inline source setter. Prefer initial_html and source_type or runtime load_html.

Default: — · Accessors: set_html_content() / get_html_content()

htmlUrlString

Legacy URL source setter. Prefer initial_url or runtime load_url.

Default: — · Accessors: set_html_url() / get_html_url()

transparentbool

Enable a transparent page background. Configure before initialization. Changing it on an existing view requires reinitialization.

Default: — · Accessors: set_transparent() / get_transparent()

lazybool

Defer automatic initialization. Explicit load requests initialize after layout even when lazy is enabled.

Default: — · Accessors: set_lazy() / get_lazy()

set_accelerated

Set accelerated.

get_accelerated

Return accelerated.

is_accelerated

Return whether this view actually uses GPU RenderingDevice. A request through accelerated can fall back to CPU if the device is unavailable or initialization fails.

get_render_statistics

Return rendering statistics. These fields are always present:

• accelerated: actual rendering backend.
• sdk_edition, sdk_max_fps: SDK edition and its frame-rate ceiling; zero means no edition ceiling.
• max_render_fps: requested per-view frame-rate limit.
• ultralight_render_us: Ultralight rendering time in microseconds, shared across all views.
• cpu_page_upload_bytes, cpu_mipmap_count, cpu_upload_us: CPU Surface upload counters for this view. These survive reinitialization.

Only an active accelerated view adds GPU fields: gpu_available, bitmap_upload_bytes, geometry_upload_bytes, state_upload_bytes, draws, batches, feedback_copies, render_passes, rd_record_us, gpu_us and gpu_draws_by_shader. GPU counters cover all views. Zero GPU timing can mean timestamps are unavailable. GPU mode can still upload SDK resource bitmaps, including Canvas content.

CPU, uninitialized and fallback views omit GPU fields. Rendering preparation timings exclude JavaScript execution outside the render call and do not represent total application frame time.

set_max_render_fps

Set max_render_fps.

get_max_render_fps

Return max_render_fps.

get_bridge_statistics

Return counts of active bindings, host container proxies, host object proxies and retained JavaScript handles for diagnostics.

unbind

Revoke the current temporary export with this name, including nested proxies.

load_url

Navigate to url and return a task that completes at main-document DOM readiness. timeout is in seconds, finite and greater than zero. Before layout, the request waits for a usable size.

load_html

Load inline HTML with base_url for relative resources. Return a task for main-document DOM readiness; timeout is in seconds.

reload

Reload the current page and return its DOM readiness task. An inline page retains its HTML and base URL.

wait_ready

Observe the current main document. May complete immediately when already ready. Navigation invalidates an unfinished wait.

wait_for_selector

Wait until a CSS selector matches an element in the current main document. Invalid selectors fail. This checks existence, not visibility.

evaluate

Evaluate source and return an explicit result. Arrays and objects are live shared handles; null is Nil and undefined is UltralightUndefined.

evaluate_copy

Evaluate source and recursively copy own enumerable data into independent Godot containers. Cycles, unsupported values and depth over 64 fail.

evaluate_handle

Evaluate source and retain its raw JavaScript value, including primitives, in an UltralightJSValue handle.

evaluate_async

Evaluate source and observe a returned Promise, or complete with an ordinary value. Timeout is in seconds. Navigation cancels delivery to the old document.

is_closed

Return whether close has permanently disabled this View.

close

Permanently close this View, detach API registries, invalidate document handles and finish pending tasks.

is_initialized

Return whether the native SDK View exists.

is_loading

Return whether the main document is loading.

is_document_ready

Return document_ready.

get_navigation_id

Return navigation_id.

get_current_url

Return current_url.

get_last_load_error

Return the latest structured main-document load error, or null when no error is recorded.

input_text

Send committed text to the focused page. This does not provide IME preedit or candidate-window positioning.

scroll_pixels

Send a pixel scroll delta to the page.

set_source_type

Set source_type.

get_source_type

Return source_type.

set_initial_url

Set initial_url.

get_initial_url

Return initial_url.

set_initial_html

Set initial_html.

get_initial_html

Return initial_html.

set_initial_base_url

Set initial_base_url.

get_initial_base_url

Return initial_base_url.

set_html_content

Set html.

get_html_content

Return html.

set_html_url

Set htmlUrl.

get_html_url

Return htmlUrl.

set_transparent

Set transparent.

get_transparent

Return transparent.

set_lazy

Set lazy.

get_lazy

Return lazy.

rebuild

Recreate the native View to apply backend configuration. Invalidates old document state and tasks; attached API registries are restored for the new document.

init_view

Compatibility alias for rebuilding. Automatic initialization and explicit load methods handle ordinary layout and loading.

bind_func

Compatibility function export. New code should use bind_function or UltralightAPI.register_function.

bind_object

Export a temporary Godot Object with optional UltralightBindingOptions. Return its revocable binding. Use UltralightAPI.register_object for persistent exports or root Array and Dictionary containers.

bind_function

Export a temporary global function and return its revocable UltralightBinding. For navigation persistence use UltralightAPI.

bind_object_legacy

Compatibility entry for the old query_members boolean. New code should use UltralightAPI and UltralightBindingOptions.

execute_script

Compatibility evaluation using copied values and Nil/logged errors. Prefer evaluate for explicit errors and shared values.

fire_key_event

Forward a keyboard event to an initialized page. Normal Control input forwards key events while the web view has focus.

fire_mouse_event

Forward a mouse event to an initialized page. position uses coordinates local to the web view, in pixels. Pass MOUSE_BUTTON_NONE for motion, a mouse button with is_pressed for press/release, or a wheel button for scrolling. The Control normally forwards its own GUI input automatically.