freya/_docs/platforms.rs
1//! # Platforms
2//!
3//! Freya supports multiple desktop platforms, each with a specific graphics backend configuration.
4//! The rendering is powered by [Skia](https://skia.org/) through the `skia-safe` bindings.
5//!
6//! ## Supported Platforms
7//!
8//! | Platform | Graphics Backend |
9//! |----------|-----------------|
10//! | Linux | Vulkan (preferred), OpenGL (fallback) |
11//! | Windows | Vulkan (preferred), OpenGL (fallback) |
12//! | macOS | Metal |
13//!
14//! ## Rendering Backends
15//!
16//! ### Vulkan (Linux, Windows)
17//!
18//! The default and preferred rendering backend on Linux and Windows. Vulkan provides modern, high-performance
19//! GPU-accelerated rendering. Freya will use Vulkan when available.
20//!
21//! ### OpenGL (Linux, Windows)
22//!
23//! Used as a fallback on Linux and Windows when Vulkan is not available or not supported by the hardware.
24//! For debugging purposes, you can force OpenGL by setting the `FREYA_RENDERER` environment variable:
25//!
26//! ```sh
27//! FREYA_RENDERER=opengl cargo run
28//! ```
29//!
30//! ### Metal (macOS)
31//!
32//! The best graphics backend for macOS.