1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
//! # Platforms
//!
//! Freya supports multiple desktop platforms plus experimental Android and Web support, each with a
//! specific graphics backend configuration. The rendering is powered by [Skia](https://skia.org/) through the
//! `skia-safe` bindings.
//!
//! ## Supported Platforms
//!
//! | Platform | Graphics Backend |
//! |----------|-----------------|
//! | Linux | Vulkan (preferred), OpenGL (fallback), Software (fallback) |
//! | Windows | Vulkan (preferred), OpenGL (fallback), Software (fallback) |
//! | macOS | Metal, Software (fallback) |
//! | Android (experimental) | OpenGL, Software (fallback) |
//! | Web (experimental) | WebGL |
//!
//! ## Rendering Backends
//!
//! ### Vulkan (Linux, Windows)
//!
//! The default and preferred rendering backend on Linux and Windows. Vulkan provides modern, high-performance
//! GPU-accelerated rendering. Freya will use Vulkan when available.
//!
//! ### OpenGL (Linux, Windows)
//!
//! Used as a fallback on Linux and Windows when Vulkan is not available or not supported by the hardware.
//! For debugging purposes, you can force OpenGL by setting the `FREYA_RENDERER` environment variable:
//!
//! ```sh
//! FREYA_RENDERER=opengl cargo run
//! ```
//!
//! ### Metal (macOS)
//!
//! The best graphics backend for macOS.
//!
//! ### OpenGL (Android)
//!
//! Used to render on Android, where Freya draws through Skia's OpenGL backend.
//!
//! ### WebGL (Web)
//!
//! Used to render in the browser, where Freya draws into a `canvas` element through Skia's OpenGL
//! backend on top of WebGL 2.
//!
//! ### Software (all platforms)
//!
//! CPU-based rendering used as a last-resort fallback when no GPU backend could be initialized.
//! You can also force it at runtime:
//!
//! ```sh
//! FREYA_RENDERER=software cargo run
//! ```
//!
//! To build a software-only app without any of the GPU backends and their dependencies,
//! disable the default `gpu` feature:
//!
//! ```toml
//! freya = { version = "...", default-features = false, features = ["winit"] }
//! ```
//!
//! ## Android
//!
//! Android support is highly experimental.
//!
//! Building for Android requires the Android SDK, the NDK and `cargo-ndk`. See the
//! [`android`](https://github.com/marc2332/freya/tree/main/examples/android) example for a complete
//! project setup and step-by-step build instructions.
//!
//! ## Web
//!
//! Web support is experimental. Apps are compiled to WebAssembly with Emscripten and run in a
//! `canvas` element. See the [`web`](https://github.com/marc2332/freya/tree/main/examples/web)
//! example for the project setup and build instructions, it is what runs at
//! [freyaui.dev/demo](https://freyaui.dev/demo).