Expand description
§Incular
Build native desktop apps in Rust with a declarative, retained UI framework.
Incular combines composable widgets, reactive state, and a retained rendering pipeline. Describe your interface in Rust, connect it to application state, and let Incular update and render the parts that change. Its shared Winit desktop host and WGPU renderer run on Windows, Linux, and macOS.
§Architecture and support
| Contract | Status |
|---|---|
| Ownership | Feature-controlled public facade and application preludes. |
| API class | application; re-exports retain the defining API class under the architecture contract. |
| Support | Re-exports inherit original API classes; platform features are target-specific. |
§What you can build
- Reactive interfaces:
Signal,Memo,Effect, andActionfor state, derived values, side effects, and asynchronous operations. - Rich desktop UI: flexible layout, text and text editing, images, scrolling lists, forms, and custom canvas painting.
- Interactive experiences: pointer gestures, keyboard input, focus management, transitions, and animation.
- Accessible applications: platform-neutral semantics projected into native accessibility systems.
- Layered design systems: neutral widgets with optional themed Controls and Material components.
- Full application flows: routing, overlays, restoration, windows, and native desktop services.
- Runtime diagnostics: opt-in instrumentation and a standalone DevTools application.
§A first window
use incular::prelude::*;
fn main() -> Result<(), Box<dyn std::error::Error>> {
let app = Application::new(|_cx| {
Container::builder()
.padding(EdgeInsets::all(24.0))
.alignment(Alignment::CENTER)
.child(Text::new("Hello, Incular!"))
.build()
.into()
})?;
incular::run(app)?;
Ok(())
}§Try Incular
You’ll need Rust 1.89 or newer, a desktop environment, and a compatible GPU driver. Platform-specific setup is covered in the installation guide.
git clone https://github.com/FabortLabs/incular.git
cd incular
cargo run -p incular --example helloThe checkout includes a gallery of examples, from controls and animation to navigation and custom rendering.
§Documentation
- What is Incular? — the framework’s mental model
- Quick start — build an app and add reactive state
- API overview — modules, preludes, and feature flags
- Example gallery
- Architecture — crate responsibilities and design boundaries
§Feature flags
| Feature | Purpose | Default |
|---|---|---|
desktop | Native desktop runner with every WGPU backend | Yes |
desktop-host | Native desktop runner; pair it with at least one backend below | Via desktop |
dx12, metal, vulkan, gl | WGPU backends; each enables desktop-host and is ignored where unavailable | Via desktop |
controls | Themed Incular controls | Yes |
material | Material presentation; enables controls | Yes |
devtools | Diagnostics transport and runtime instrumentation | No |
hot-reload | Live code patching in debug builds under dx serve --hot-patch | No |
The main incular::prelude contains the neutral framework API. Import themed controls from incular::controls_prelude and Material components from incular::material_prelude.
§Contributing
Incular is actively developed and pre-1.0. Contributions and feedback are welcome; see the contribution guide, code of conduct, and security policy.
Licensed under Apache-2.0.
Re-exports§
pub use incular_accessibility as accessibility;pub use incular_animation as animation;pub use incular_assets as assets;pub use incular_config as config;pub use incular_controls as controls;pub use incular_core as core;pub use incular_gestures as gestures;pub use incular_image as image;pub use incular_layout as layout;pub use incular_material as material;pub use incular_rendering as painting;pub use incular_rendering as rendering;pub use incular_runtime as runtime;pub use incular_semantics as semantics;pub use incular_text as text;pub use incular_widgets as widgets;pub use incular_platform as platform;pub use incular_wgpu as wgpu;pub use incular_linux as linux;
Modules§
- controls_
prelude - Opt-in Controls convenience imports. Controls stay separate from the base
prelude so applications without the optional
controlsfeature keep the renderer-neutral API surface. - material_
prelude - Opt-in Material convenience imports. Material is intentionally not part of
preludeso a base Widgets application cannot accidentally depend on a design system. Enable thematerialfeature and import this module when using Material components. - prelude
- Common application-facing types for the initial native UI slice.
- reactive
- Reactive values and owner-mounted asynchronous primitives. This namespace
keeps
reactive::Effectandreactive::Actiondistinct from Incular’s rendering and widget types with the same conventional names. - scroll
- Public scrolling policies and notifications.
- testing
- High-level application testing tools. These drive Incular’s normalized input/event path in-process and capture rendered application frames without injecting OS input or capturing the desktop.
Constants§
- PERFORMANCE_
OVERLAY_ KEY - Widget key that marks the performance-overlay mount point.
Functions§
- install_
performance_ overlay - Installs the repaint-contained debug performance overlay into
window. The tree must contain a placeholder keyed withPERFORMANCE_OVERLAY_KEY; publishing rebuilds only that element. - overlay_
lines - Formats a snapshot into standard overlay lines (thin wrapper over
incular_runtime::PerformanceSnapshot::overlay_lines). - run
- Runs an application on the native backend selected by the compilation target.