From 07f94d68b51a4ca1b6ccad1f216a372b6460035d Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Mon, 27 May 2024 13:47:57 +0200 Subject: Update outdated `README`s of subcrates --- core/README.md | 12 ------------ wgpu/README.md | 35 +---------------------------------- winit/README.md | 12 ------------ 3 files changed, 1 insertion(+), 58 deletions(-) diff --git a/core/README.md b/core/README.md index 519e0608..de11acad 100644 --- a/core/README.md +++ b/core/README.md @@ -13,15 +13,3 @@ This crate is meant to be a starting point for an Iced runtime.

[documentation]: https://docs.rs/iced_core - -## Installation -Add `iced_core` as a dependency in your `Cargo.toml`: - -```toml -iced_core = "0.9" -``` - -__Iced moves fast and the `master` branch can contain breaking changes!__ If -you want to learn about a specific release, check out [the release list]. - -[the release list]: https://github.com/iced-rs/iced/releases diff --git a/wgpu/README.md b/wgpu/README.md index 95d7028a..8e9602ea 100644 --- a/wgpu/README.md +++ b/wgpu/README.md @@ -6,14 +6,7 @@ `iced_wgpu` is a [`wgpu`] renderer for [`iced_runtime`]. For now, it is the default renderer of Iced on [native platforms]. -[`wgpu`] supports most modern graphics backends: Vulkan, Metal, 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. -- Clip areas, useful to implement scrollables or hide overflowing content. -- Images and SVG, loaded from memory or the file system. -- Meshes of triangles, useful to draw geometry freely. +[`wgpu`] supports most modern graphics backends: Vulkan, Metal, DX12, OpenGL, and WebGPU.

The native target @@ -25,29 +18,3 @@ Currently, `iced_wgpu` supports the following primitives: [native platforms]: https://github.com/gfx-rs/wgpu#supported-platforms [WebGPU API]: https://gpuweb.github.io/gpuweb/ [`wgpu_glyph`]: https://github.com/hecrj/wgpu_glyph - -## Installation -Add `iced_wgpu` as a dependency in your `Cargo.toml`: - -```toml -iced_wgpu = "0.10" -``` - -__Iced moves fast and the `master` branch can contain breaking changes!__ If -you want to learn about a specific release, check out [the release list]. - -[the release list]: https://github.com/iced-rs/iced/releases - -## Current limitations - -The current implementation is quite naive; it uses: - -- A different pipeline/shader for each primitive -- A very simplistic layer model: every `Clip` primitive will generate new layers -- _Many_ render passes instead of preparing everything upfront -- A glyph cache that is trimmed incorrectly when there are multiple layers (a [`glyph_brush`] limitation) - -Some of these issues are already being worked on! If you want to help, [get in touch!] - -[get in touch!]: ../CONTRIBUTING.md -[`glyph_brush`]: https://github.com/alexheretic/glyph-brush diff --git a/winit/README.md b/winit/README.md index 91307970..c60e81f9 100644 --- a/winit/README.md +++ b/winit/README.md @@ -15,15 +15,3 @@ It exposes a renderer-agnostic `Application` trait that can be implemented and t [documentation]: https://docs.rs/iced_winit [`iced_native`]: ../native [`winit`]: https://github.com/rust-windowing/winit - -## Installation -Add `iced_winit` as a dependency in your `Cargo.toml`: - -```toml -iced_winit = "0.9" -``` - -__Iced moves fast and the `master` branch can contain breaking changes!__ If -you want to learn about a specific release, check out [the release list]. - -[the release list]: https://github.com/iced-rs/iced/releases -- cgit