IncularAPI Reference
API overview
Facade modules, features, and preludes — where every class lives.
Everything application-facing is reachable through the incular facade. Depend
on leaf crates only to bypass it.
For generated Rust signatures and item-level documentation, use
docs.rs/incular after publication, or run
cargo doc --workspace --all-features --no-deps --open from a checkout.
Features
| Feature | Purpose | Default |
|---|---|---|
desktop | Native runner + every WGPU backend | Yes |
desktop-host | Native runner; pair with at least one backend below | Via desktop |
dx12, metal, vulkan, gl | WGPU backends; each enables desktop-host, ignored where unavailable | Via desktop |
controls | Incular controls and visual slots | Yes |
material | Material presentation; enables controls | Yes |
devtools | Diagnostics transport + instrumentation | No |
hot-reload | Live code patching in debug builds under dx serve --hot-patch | No |
Preludes
| Import | Contents |
|---|---|
incular::prelude | Neutral types: widgets, layout, text, runtime, animation, navigation, rendering (+ platform services with desktop) |
incular::controls_prelude | Button, Checkbox, Switch, Input, Card, ControlTheme, … |
incular::material_prelude | MaterialApp, Scaffold, buttons, dialogs, ThemeData, … |
Namespaces
incular::scroll—ScrollController,ScrollPhysics,ScrollMetrics, and notificationsincular::reactive—Action,Effect, andMemo, kept distinct from widget namesincular::testing—Simulation,Screenshot- Top-level mirrors:
animation,config,core,gestures,image,layout,navigation,rendering(aliaspainting),runtime,semantics,text,widgets;controls/materialandplatform/wgpu/OS runners are feature-gated.
Class index
- Application:
Application,WindowHandle,Restoration - State:
Signal,Memo,Effect,Action,Tasks,UndoHistory - Layout widgets:
Container,Row,Column,Flex,Expanded,Flexible,Spacer,Stack,Positioned,Wrap,Table,Sizing - Values:
EdgeInsets,Alignment,Constraints,Axis,MainAxisAlignment,Color,Transform - Content:
Text,RichText,TextStyle,Fonts,EditableText,TextEditingController,Image,Icon - Painting:
Canvas,Paint,Path,Brush,BlendMode,AnimationController,Curves,Tweens,Physics - Input:
GestureDetector,Focus,Keyboard,Form - Navigation:
Navigator,Overlay,ListView,SliverList - Design:
Button,MaterialApp,Theme - Platform:
Desktop,Semantics,Testing,DevTools,Hot reload - Environment:
MediaQuery,LayoutBuilder,Localization,WidgetsApp,Router,View - Transitions:
SizeTransition,PositionedTransition,AlignTransition - Gallery:
all 42 examples