Skip to content

Public API reference

Include <huxerui/huxerui.h> for the complete cross-platform API. Link HuxerUI::huxerui for the shared library or HuxerUI::huxerui_static for static linkage. Platform-specific integration headers and <huxerui/testing/ui_test.h> remain explicit includes; tests link the separate HuxerUI::testing target.

The Application audience is ordinary cross-platform UI code. Extension means custom layout, retained behavior, painting, or root-service work. Platform integration connects native objects or producers. Adapter is reserved for a platform shell implementation and should not appear in ordinary application code.

Header Audience Reference
huxerui.h Application umbrella This index
app.h Application; adapter boundary is isolated on the reference page Application and root services
root.h Extension Application and root services
view.h Application and extension View and components
state.h Application State and environment
environment.h Application and extension State and environment
event.h Application and extension Events
lifecycle.h Application Lifecycle
task.h Application Tasks
modifier.h, indication.h Application and extension Modifiers and indication
layout.h, virtual_layout.h Extension Layout, scrolling, and virtualization
scroll.h Application and extension Layout, scrolling, and virtualization
navigation.h Application Navigation
presentation.h Application Presentation and layers
layer.h Extension Presentation and layers
theme.h Application and extension Theme
animation.h Application Animation
window.h Application; adapter boundary is isolated on the reference page Window
Header Audience Reference
text.h, text_input.h, clipboard.h Application and adapter Text and input
validation.h Application Text and input
resource.h Application and adapter Resources
file.h, file_drop.h Application Files
http.h Application HTTP
stream.h Application Streams
system.h Application and platform integration System capabilities
testing/ui_test.h Application testing UI testing
semantics.h Application and extension Semantics
Header Audience Reference
color.h Application Color and geometry
geometry.h Application and extension Color and geometry
vector.h Application and extension Path and vector
paint.h Extension and adapter Paint and render scene
render_scene.h Adapter Paint and render scene
platform_registry.h Application and platform integration PlatformModule
external_texture.h Application consumer ExternalTexture
android/*, ios/*, macos/*, windows/*, linux/*, web/* Platform integration Platform-specific API
Header Audience Reference
data.h Application Bytes and Uri
gesture.h Application and extension Gestures
platform_adapter.h Adapter Platform boundary

Names in huxerui::detail, Runtime collaboration types not documented on these pages, and repository platform-backend classes are not application or extension API. Public adapter contracts such as PlatformAdapter, RenderScene, and text-service interfaces are documented only on their owning boundary pages rather than mixed into component guidance.