From 6a0e442ad68c2b104b7e91ef80798610a79aca6b Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Fri, 22 Nov 2019 22:14:24 +0100 Subject: Write docs for `iced_wgpu` --- wgpu/src/lib.rs | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) (limited to 'wgpu/src/lib.rs') diff --git a/wgpu/src/lib.rs b/wgpu/src/lib.rs index d770f872..9f9ed8db 100644 --- a/wgpu/src/lib.rs +++ b/wgpu/src/lib.rs @@ -1,3 +1,29 @@ +//! A [`wgpu`] renderer for [`iced_native`]. +//! +//! ![`iced_wgpu` crate graph](https://github.com/hecrj/iced/blob/cae26cb7bc627f4a5b3bcf1cd023a0c552e8c65e/docs/graphs/wgpu.png?raw=true) +//! +//! For now, it is the default renderer of [Iced] in native platforms. +//! +//! [`wgpu`] supports most modern graphics backends: Vulkan, Metal, DX11, and +//! DX12 (OpenGL and WebGL are still WIP). Additionally, it will support the +//! incoming [WebGPU API]. +//! +//! Currently, `iced_wgpu` supports the following primitives: +//! - Text, which is rendered using [`wgpu_glyph`]. No shaping at all. +//! - Quads or rectangles, with rounded borders and a solid background color. +//! - Images, lazily loaded from the filesystem. +//! - Clip areas, useful to implement scrollables or hide overflowing content. +//! +//! [Iced]: https://github.com/hecrj/iced +//! [`iced_native`]: https://github.com/hecrj/iced/tree/master/native +//! [`wgpu`]: https://github.com/gfx-rs/wgpu-rs +//! [WebGPU API]: https://gpuweb.github.io/gpuweb/ +//! [`wgpu_glyph`]: https://github.com/hecrj/wgpu_glyph +#![deny(missing_docs)] +#![deny(missing_debug_implementations)] +#![deny(unused_results)] +#![deny(unsafe_code)] +#![deny(rust_2018_idioms)] mod image; mod primitive; mod quad; -- cgit