75 lines
2.5 KiB
Rust
75 lines
2.5 KiB
Rust
//! A renderer-agnostic native GUI runtime.
|
|
//!
|
|
//! 
|
|
//!
|
|
//! `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 [`window::Backend`] 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.
|
|
//!
|
|
//! # 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/hecrj/iced/tree/master/core
|
|
//! [`iced_winit`]: https://github.com/hecrj/iced/tree/master/winit
|
|
//! [`druid`]: https://github.com/xi-editor/druid
|
|
//! [`raw-window-handle`]: https://github.com/rust-windowing/raw-window-handle
|
|
//! [`Widget`]: widget/trait.Widget.html
|
|
//! [`window::Backend`]: window/trait.Backend.html
|
|
//! [`UserInterface`]: struct.UserInterface.html
|
|
//! [renderer]: renderer/index.html
|
|
#![deny(missing_docs)]
|
|
#![deny(missing_debug_implementations)]
|
|
#![deny(unused_results)]
|
|
#![forbid(unsafe_code)]
|
|
#![forbid(rust_2018_idioms)]
|
|
pub mod keyboard;
|
|
pub mod layout;
|
|
pub mod mouse;
|
|
pub mod renderer;
|
|
pub mod subscription;
|
|
pub mod widget;
|
|
pub mod window;
|
|
|
|
mod clipboard;
|
|
mod element;
|
|
mod event;
|
|
mod hasher;
|
|
mod runtime;
|
|
mod user_interface;
|
|
|
|
pub use iced_core::{
|
|
Align, Background, Color, Font, HorizontalAlignment, Length, Point,
|
|
Rectangle, Size, Vector, VerticalAlignment,
|
|
};
|
|
pub use iced_futures::{executor, futures, Command};
|
|
|
|
#[doc(no_inline)]
|
|
pub use executor::Executor;
|
|
|
|
pub use clipboard::Clipboard;
|
|
pub use element::Element;
|
|
pub use event::Event;
|
|
pub use hasher::Hasher;
|
|
pub use layout::Layout;
|
|
pub use renderer::Renderer;
|
|
pub use runtime::Runtime;
|
|
pub use subscription::Subscription;
|
|
pub use user_interface::{Cache, UserInterface};
|
|
pub use widget::*;
|