diff options
author | 2019-11-20 09:41:04 +0100 | |
---|---|---|
committer | 2019-11-20 09:41:04 +0100 | |
commit | cb4827059fdb34fa9b0cea714fb81b28741a08e7 (patch) | |
tree | 4980866f610c0c6a27aa99638c43f7eeee170d46 /native/README.md | |
parent | c47f5095c85d5b259b298dd2446929dc9cbf1753 (diff) | |
download | iced-cb4827059fdb34fa9b0cea714fb81b28741a08e7.tar.gz iced-cb4827059fdb34fa9b0cea714fb81b28741a08e7.tar.bz2 iced-cb4827059fdb34fa9b0cea714fb81b28741a08e7.zip |
Add `README` for each subcrate
Diffstat (limited to 'native/README.md')
-rw-r--r-- | native/README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/native/README.md b/native/README.md new file mode 100644 index 00000000..60f350b8 --- /dev/null +++ b/native/README.md @@ -0,0 +1,23 @@ +# `iced_native` +[][documentation] +[](https://crates.io/crates/iced_native) +[](https://github.com/hecrj/iced/blob/master/LICENSE) +[](https://iced.zulipchat.com) + +`iced_native` takes [`iced_core`] and builds a native runtime on top of it, featuring: +- A custom layout engine, greatly inspired by [`druid`] +- Event handling for all the built-in widgets +- A renderer-agnostic API + +To achieve this, it introduces a bunch of reusable interfaces: +- A `Widget` trait, which is used to implement new widgets: from layout requirements to event and drawing logic. +- A bunch of `Renderer` traits, meant to keep the crate renderer-agnostic. +- A `Windowed` trait, leveraging [`raw-window-handle`], which can be implemented by graphical renderers that target _windows_. Window-based shells (like [`iced_winit`]) can use this trait to stay renderer-agnostic. + + + +[documentation]: https://docs.rs/iced_native +[`iced_core`]: ../core +[`iced_winit`]: ../winit +[`druid`]: https://github.com/xi-editor/druid +[`raw-window-handle`]: https://github.com/rust-windowing/raw-window-handle |