Merge pull request #1748 from iced-rs/feature/software-renderer

Software renderer, runtime renderer fallback, and core consolidation

1 files changed, 71 insertions, 0 deletions

diff --git a/runtime/src/lib.rs b/runtime/src/lib.rs
new file mode 100644
index 00000000..aa45e57a
--- /dev/null
+++ b/runtime/src/lib.rs
@@ -0,0 +1,71 @@
+//! A renderer-agnostic native GUI runtime.
+//!
+//! ![The native path of the Iced ecosystem](https://github.com/iced-rs/iced/raw/improvement/update-ecosystem-and-roadmap/docs/graphs/native.png)
+//!
+//! `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 couple 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.
+//!
+//! # Usage
+//! The strategy to use this crate depends on your particular use case. If you
+//! want to:
+//! - Implement a custom shell or integrate it in your own system, check out the
+//! [`UserInterface`] type.
+//! - Build a new renderer, see the [renderer] module.
+//! - Build a custom widget, start at the [`Widget`] trait.
+//!
+//! [`iced_core`]: https://github.com/iced-rs/iced/tree/0.8/core
+//! [`iced_winit`]: https://github.com/iced-rs/iced/tree/0.8/winit
+//! [`druid`]: https://github.com/xi-editor/druid
+//! [`raw-window-handle`]: https://github.com/rust-windowing/raw-window-handle
+//! [renderer]: crate::renderer
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
+)]
+#![deny(
+    missing_debug_implementations,
+    //missing_docs,
+    unused_results,
+    clippy::extra_unused_lifetimes,
+    clippy::from_over_into,
+    clippy::needless_borrow,
+    clippy::new_without_default,
+    clippy::useless_conversion
+)]
+#![forbid(unsafe_code, rust_2018_idioms)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+pub mod clipboard;
+pub mod command;
+pub mod font;
+pub mod keyboard;
+pub mod program;
+pub mod system;
+pub mod user_interface;
+pub mod window;
+
+// We disable debug capabilities on release builds unless the `debug` feature
+// is explicitly enabled.
+#[cfg(feature = "debug")]
+#[path = "debug/basic.rs"]
+mod debug;
+#[cfg(not(feature = "debug"))]
+#[path = "debug/null.rs"]
+mod debug;
+
+pub use iced_core as core;
+pub use iced_futures as futures;
+
+pub use command::Command;
+pub use debug::Debug;
+pub use font::Font;
+pub use program::Program;
+pub use user_interface::UserInterface;