API reference

kui_c.h · C API · 3/3

Browse entries grouped by interface file. Expand an entry for declarations, usage and version boundaries.

Read the related guide →

Entries retain declarations and sources. Runtime verification is recorded per entry; internal source candidates are not a promise of SDK delivery.

sdk/c/include/kui_c.h
kui_status_message
Declared3.61.7C / Go / Rust

Get a static description of a status code; the result is never NULL, allocates nothing and needs no release. Input strings use UTF-8 and explicit byte lengths; length 0 means strlen. Required names, selectors, paths and source text must not be NULL.

kui_c.h
KUI_C_API const char* kui_status_message(KuiStatus s);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:124

Report an issue with this entry →
kui_window_add_event_listener
Declared3.61.7C / Go / Rust

Register a named window event listener and optionally receive its ID. A nonzero once flag makes it run once. The callback event is borrowed, valid only during that callback, and must not be released or saved for later.

kui_c.h
KUI_C_API KuiStatus kui_window_add_event_listener(KuiWindow* window, const char* event_name, size_t len, KuiWindowEventFn fn, void* user_data, int once, KuiListenerId* out_id);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:738

Report an issue with this entry →
kui_window_clear_frame_radius
Declared3.61.7C / Go / Rust

Clear the explicit window frame radius setting. Requires a valid window handle.

kui_c.h
KUI_C_API KuiStatus kui_window_clear_frame_radius(KuiWindow* window);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:734

Report an issue with this entry →
kui_window_close
Declared3.61.7C / Go / Rust

Invoke the window close operation; the uniquely owned handle still needs release according to its lifecycle.

kui_c.h
KUI_C_API KuiStatus kui_window_close(KuiWindow* w);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:266

Report an issue with this entry →
kui_window_create
Declared3.61.7C / Go / Rust

Create a uniquely owned window from KuiWindowProps. It is already visible on return. Zero-initialize properties for defaults; opacity=0 means 1.0. Hide immediately to configure off-screen. Release the handle exactly once.

kui_c.h
KUI_C_API KuiStatus kui_window_create (const KuiWindowProps* props, KuiWindow** out);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:240

Report an issue with this entry →
kui_window_get_device_pixel_ratio
Declared3.61.7C / Go / Rust

Read the window device pixel ratio.

kui_c.h
KUI_C_API KuiStatus kui_window_get_device_pixel_ratio(KuiWindow* w, float* out_ratio);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:263

Report an issue with this entry →
kui_window_get_devtools_port
Declared3.61.7C / Go / Rust

Read the listening port of the window DevTools server. Returns NOT_FOUND when that window has no DevTools server.

kui_c.h
KUI_C_API KuiStatus kui_window_get_devtools_port(KuiWindow* window, uint16_t* out_port);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:735

Report an issue with this entry →
kui_window_get_devtools_url
Declared3.61.7C / Go / Rust

Read the window DevTools connection URL. UTF-8 output uses the caller buffer: query with NULL/0, then allocate out_len+1; the length excludes NUL. Insufficient capacity returns BUFFER_TOO_SMALL and the required length; positive capacity still receives a truncated NUL-terminated result.

kui_c.h
KUI_C_API KuiStatus kui_window_get_devtools_url(KuiWindow* w, char* buf, size_t buf_capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:275

Report an issue with this entry →
kui_window_get_document
Declared3.61.7C / Go / Rust

Get a counted reference to the window-owned document and release it when done. This reference can keep the document alive after window release. A window cannot attach an external document.

kui_c.h
KUI_C_API KuiStatus kui_window_get_document(KuiWindow* w, KuiDocument** out);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:248

Report an issue with this entry →
kui_window_get_native_handle
Declared3.61.7C / Go / Rust

Get the borrowed operating-system window identifier: HWND on Windows, NSWindow* on macOS or X11 Window on Linux. This adds no ownership beyond the uniquely owned window.

kui_c.h
KUI_C_API KuiStatus kui_window_get_native_handle(KuiWindow* w, void** out_handle);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:278

Report an issue with this entry →
kui_window_get_position
Declared3.61.7C / Go / Rust

Read the window position coordinates.

kui_c.h
KUI_C_API KuiStatus kui_window_get_position(KuiWindow* w, int* out_x, int* out_y);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:256

Report an issue with this entry →
kui_window_get_size
Declared3.61.7C / Go / Rust

Read the window width and height.

kui_c.h
KUI_C_API KuiStatus kui_window_get_size(KuiWindow* w, int* out_width, int* out_height);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:253

Report an issue with this entry →
kui_window_get_title
Declared3.61.7C / Go / Rust

Read the window title. UTF-8 output uses the caller buffer: query with NULL/0, then allocate out_len+1; the length excludes NUL. Insufficient capacity returns BUFFER_TOO_SMALL and the required length; positive capacity still receives a truncated NUL-terminated result.

kui_c.h
KUI_C_API KuiStatus kui_window_get_title(KuiWindow* w, char* buf, size_t buf_capacity, size_t* out_len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:250

Report an issue with this entry →
kui_window_hide
Declared3.61.7C / Go / Rust

Hide the specified window.

kui_c.h
KUI_C_API KuiStatus kui_window_hide (KuiWindow* w);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:244

Report an issue with this entry →
kui_window_is_maximized
Declared3.61.7C / Go / Rust

Read whether the window is maximized.

kui_c.h
KUI_C_API KuiStatus kui_window_is_maximized(KuiWindow* w, int* out_maximized);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:265

Report an issue with this entry →
kui_window_is_minimized
Declared3.61.7C / Go / Rust

Read whether the window is minimized.

kui_c.h
KUI_C_API KuiStatus kui_window_is_minimized(KuiWindow* w, int* out_minimized);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:264

Report an issue with this entry →
kui_window_is_visible
Declared3.61.7C / Go / Rust

Read whether the window is currently visible.

kui_c.h
KUI_C_API KuiStatus kui_window_is_visible(KuiWindow* w, int* out_visible);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:245

Report an issue with this entry →
kui_window_maximize
Declared3.61.7C / Go / Rust

Maximize the window.

kui_c.h
KUI_C_API KuiStatus kui_window_maximize (KuiWindow* w);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:259

Report an issue with this entry →
kui_window_minimize
Declared3.61.7C / Go / Rust

Minimize the window.

kui_c.h
KUI_C_API KuiStatus kui_window_minimize (KuiWindow* w);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:258

Report an issue with this entry →
kui_window_on_resize
Declared3.61.7C / Go / Rust

Replace the window resize callback; pass NULL to clear it. The callback receives width, height and user_data.

kui_c.h
KUI_C_API KuiStatus kui_window_on_resize(KuiWindow* w, KuiWindowResizeFn fn, void* user_data);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:271

Report an issue with this entry →
kui_window_release
Declared3.61.7C / Go / Rust

Destroy the uniquely owned window; this is not a reference-count decrement. Call exactly once per window handle. Previously obtained counted document references can keep the document alive.

kui_c.h
KUI_C_API KuiStatus kui_window_release(KuiWindow* w);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:242

Report an issue with this entry →
kui_window_remove_event_listener
Declared3.61.7C / Go / Rust

Remove a window listener using its event name and listener ID. The ID must be paired with its event type.

kui_c.h
KUI_C_API KuiStatus kui_window_remove_event_listener(KuiWindow* window, const char* event_name, size_t len, KuiListenerId id);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:742

Report an issue with this entry →
kui_window_remove_event_listeners
Declared3.61.7C / Go / Rust

Remove every listener registered under one window event name.

kui_c.h
KUI_C_API KuiStatus kui_window_remove_event_listeners(KuiWindow* window, const char* event_name, size_t len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:745

Report an issue with this entry →
kui_window_resize
Declared3.61.7C / Go / Rust

Resize the actual operating-system window width and height.

kui_c.h
KUI_C_API KuiStatus kui_window_resize (KuiWindow* w, int width, int height);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:255

Report an issue with this entry →
kui_window_restore
Declared3.61.7C / Go / Rust

Restore the window to its normal state.

kui_c.h
KUI_C_API KuiStatus kui_window_restore (KuiWindow* w);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:260

Report an issue with this entry →
kui_window_set_always_on_top
Declared3.61.7C / Go / Rust

Enable or disable always-on-top behavior for the window.

kui_c.h
KUI_C_API KuiStatus kui_window_set_always_on_top(KuiWindow* w, int on_top);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:261

Report an issue with this entry →
kui_window_set_frame_radius
Declared3.61.7C / Go / Rust

Set the window frame corner radius. The radius must be nonnegative, and window must be a valid uniquely owned window handle.

kui_c.h
KUI_C_API KuiStatus kui_window_set_frame_radius(KuiWindow* window, float radius);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:733

Report an issue with this entry →
kui_window_set_frameless_sizeable
Declared3.61.7C / Go / Rust

Set whether a frameless window can be resized. window is uniquely owned and must remain valid; it is not a reference-counted object that can be copied and released repeatedly.

kui_c.h
KUI_C_API KuiStatus kui_window_set_frameless_sizeable(KuiWindow* window, int enabled);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:732

Report an issue with this entry →
kui_window_set_opacity
Declared3.61.7C / Go / Rust

Set the window opacity.

kui_c.h
KUI_C_API KuiStatus kui_window_set_opacity(KuiWindow* w, float opacity);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:262

Report an issue with this entry →
kui_window_set_position
Declared3.61.7C / Go / Rust

Set the window position coordinates.

kui_c.h
KUI_C_API KuiStatus kui_window_set_position(KuiWindow* w, int x, int y);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:257

Report an issue with this entry →
kui_window_set_script_engine
Declared3.61.7C / Go / Rust

Associate a borrowed script engine with a window on the main thread. NULL detaches it. The window does not take ownership of the handle; keep the engine valid while the window uses it. Returns NOT_SUPPORTED when scripting is disabled.

kui_c.h
KUI_C_API KuiStatus kui_window_set_script_engine(KuiWindow* window, KuiScriptEngine* engine);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:819

Report an issue with this entry →
kui_window_set_title
Declared3.61.7C / Go / Rust

Set the window title. Input strings use UTF-8 and explicit byte lengths; length 0 means strlen. Required names, selectors, paths and source text must not be NULL.

kui_c.h
KUI_C_API KuiStatus kui_window_set_title(KuiWindow* w, const char* title, size_t len);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:252

Report an issue with this entry →
kui_window_should_close
Declared3.61.7C / Go / Rust

Read the flag indicating whether the window should close.

kui_c.h
KUI_C_API KuiStatus kui_window_should_close(KuiWindow* w, int* out_should_close);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:267

Report an issue with this entry →
kui_window_show
Declared3.61.7C / Go / Rust

Show the specified window.

kui_c.h
KUI_C_API KuiStatus kui_window_show (KuiWindow* w);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:243

Report an issue with this entry →
kui_window_start_devtools
Declared3.61.7C / Go / Rust

Start window DevTools on the supplied port and report whether it started through out_started.

kui_c.h
KUI_C_API KuiStatus kui_window_start_devtools(KuiWindow* w, uint16_t port, int* out_started);

Verification scope

Indexed from current sources. Runtime, combination and platform checks have not been completed for every entry.

sdk/c/include/kui_c.h:273

Report an issue with this entry →
Browse this reference type →