xgpui-platform 3.0.0

Native and browser platform selection for xgpui
Documentation 
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

# xgpui-platform

Platform selection and application construction for **xgpui**. This facade
chooses the native backend for macOS, Windows, Linux or FreeBSD, and the browser
backend for WebAssembly.

## Application setup

```toml
[dependencies]
gpui = { package = "xgpui", version = "4.0.0" }
gpui_platform = { package = "xgpui-platform", version = "3.0.0" }
```

The registry package is `xgpui-platform`; Rust code imports `gpui_platform`.
Start an ordinary application with `gpui_platform::application()`. Use
`gpui_platform::headless()` for a headless application, or `current_platform`
when supplying your own application construction.

For a complete window and render example, see
[hello_world.rs](https://github.com/gpui-luma-dev/xgpui/blob/main/gpui/crates/gpui/examples/hello_world.rs).

## Browser applications

Call `web_init()` from the WASM entry point. `application_with_web_backend()`
selects a browser renderer, while `single_threaded_web()` constructs an
application without the multithreaded entry point. Browser applications need
WASM packaging and a compatible server configuration; see the local-development
guide rather than treating a native executable as a browser build.

## Features

| Feature | Purpose |
| --- | --- |
| `wayland`, `x11` | Forward Linux window-system support. |
| `font-kit` | Forward macOS font discovery. |
| `runtime_shaders` | Forward runtime Metal shader compilation. |
| `screen-capture` | Forward supported native screen capture integration. |
| `test-support`, `bench-support` | Test and benchmark helpers. |

Platform behavior and native prerequisites remain backend-specific.

## Documentation

- [Local development and platform prerequisites](https://xgpui.dev/local-development.html)
- [xgpui API additions and compatibility](https://xgpui.dev/gpui-public-api.html)
- [Release preparation](https://xgpui.dev/releasing.html)
- [Repository](https://github.com/gpui-luma-dev/xgpui) ยท [Website](https://xgpui.dev/)

## Versioning and provenance

xgpui framework packages use `1.0.0`; this is independent of the upstream
`release/1.25.3` baseline. Derived from Zed's `gpui_platform` through
[gpui-unofficial](https://github.com/gpui-archipelago/gpui-unofficial), captured at
`39d276b1500d503ec6d37efcaaa0dc0c00730576` from Zed `v1.25.3`
(`8dd255c3eafb5231056fe4e6f601cedd011f1c93`).

Licensed under Apache-2.0. xgpui is independent of Zed Industries.