Files

T

Martin Pool b9cf5886e4 Run doctests in CI and fix up existing doctests (#37851 )

Follows on from
https://github.com/zed-industries/zed/pull/37716#pullrequestreview-3195695110
by @SomeoneToIgnore

After this the doctests will be run in CI to check that the examples are
still accurate.

Note that doctests aren't run by Nextest: you can run them locally with
`cargo test --doc`.

Summary:
* Run tests from CI
* Loosen an exact float comparison to match approximately (otherwise it
fails)
* Fixed one actual bug in the tests for `dilate` where the test code
assumed that `dilate` mutates `self` rather than returning a new object
* Add some `must_use` on some functions that seemed at risk of similar
bugs, following the Rust stdlib style to add it where ignoring the
result is almost certainly a bug.
* Fix some cases where the doc examples seem to have gone out of date
with the code
* Add imports to doctests that need them
* Add some dev-dependencies to make the tests build
* Fix the `key_dispatch` module docstring, which was accidentally
attached to objects within that module
* Skip some doctest examples that seem like they need an async
environment or that just looked hard to get running

AI usage: I asked Claude to do some of the repetitive tests. I checked
the output and fixed up some things that seemed to not be in the right
spirit of the test, or too longwinded.

I think we could reasonably run the tests on only Linux to save CI
CPU-seconds and latency, but I haven't done that yet, partly because of
how it's implemented in the action.

Release Notes:

- N/A

2025-09-12 23:24:04 +03:00

docs

docs: Change render function's return type (#27229 )

2025-03-20 22:48:22 -06:00

examples

Extract a scheduler crate from GPUI to enable unified integration testing of client and server code (#37326 )

2025-09-04 17:14:53 +02:00

resources/windows

windows: Move manifest file to gpui (#11036 )

2024-04-26 13:56:48 -07:00

src

Run doctests in CI and fix up existing doctests (#37851 )

2025-09-12 23:24:04 +03:00

tests

Add #[serde(deny_unknown_fields)] to action structs that didn't have it (#33679 )

2025-07-01 00:20:02 +00:00

build.rs

Auto-fix clippy::collapsible_if violations (#36428 )

2025-08-19 13:27:24 +00:00

Cargo.toml

Update oo7 to 0.5.0 (#38043 )

2025-09-12 10:18:44 -06:00

LICENSE-APACHE

chore: Add crate licenses. (#4158 )

2024-01-23 16:56:22 +01:00

README.md

docs: Note edge case for macOS 26 (#37392 )

2025-09-02 19:40:07 -04:00

README.md

Welcome to GPUI!

GPUI is a hybrid immediate and retained mode, GPU accelerated, UI framework for Rust, designed to support a wide variety of applications.

Getting Started

GPUI is still in active development as we work on the Zed code editor and isn't yet on crates.io. You'll also need to use the latest version of stable Rust and be on macOS or Linux. Add the following to your Cargo.toml:

gpui = { git = "https://github.com/zed-industries/zed" }

Everything in GPUI starts with an Application. You can create one with Application::new(), and kick off your application by passing a callback to Application::run(). Inside this callback, you can create a new window with App::open_window(), and register your first root view. See gpui.rs for a complete example.

Dependencies

GPUI has various system dependencies that it needs in order to work.

macOS

On macOS, GPUI uses Metal for rendering. In order to use Metal, you need to do the following:

Install Xcode from the macOS App Store, or from the Apple Developer website. Note this requires a developer account.

Ensure you launch Xcode after installing, and install the macOS components, which is the default option. If you are on macOS 26 (Tahoe) you will need to use --features gpui/runtime_shaders or add the feature in the root Cargo.toml

Install Xcode command line tools
```
xcode-select --install
```
Ensure that the Xcode command line tools are using your newly installed copy of Xcode:
```
sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer
```

The Big Picture

GPUI offers three different registers depending on your needs:

State management and communication with Entity's. Whenever you need to store application state that communicates between different parts of your application, you'll want to use GPUI's entities. Entities are owned by GPUI and are only accessible through an owned smart pointer similar to an Rc. See the app::context module for more information.
High level, declarative UI with views. All UI in GPUI starts with a view. A view is simply an Entity that can be rendered, by implementing the Render trait. At the start of each frame, GPUI will call this render method on the root view of a given window. Views build a tree of elements, lay them out and style them with a tailwind-style API, and then give them to GPUI to turn into pixels. See the div element for an all purpose swiss-army knife of rendering.
Low level, imperative UI with Elements. Elements are the building blocks of UI in GPUI, and they provide a nice wrapper around an imperative API that provides as much flexibility and control as you need. Elements have total control over how they and their child elements are rendered and can be used for making efficient views into large lists, implement custom layouting for a code editor, and anything else you can think of. See the element module for more information.

Each of these registers has one or more corresponding contexts that can be accessed from all GPUI services. This context is your main interface to GPUI, and is used extensively throughout the framework.

Other Resources

In addition to the systems above, GPUI provides a range of smaller services that are useful for building complex applications:

Actions are user-defined structs that are used for converting keystrokes into logical operations in your UI. Use this for implementing keyboard shortcuts, such as cmd-q. See the action module for more information.
Platform services, such as quit the app or open a URL are available as methods on the app::App.
An async executor that is integrated with the platform's event loop. See the executor module for more information.,
The [gpui::test] macro provides a convenient way to write tests for your GPUI applications. Tests also have their own kind of context, a TestAppContext which provides ways of simulating common platform input. See app::test_context and test modules for more details.

Currently, the best way to learn about these APIs is to read the Zed source code, ask us about it at a fireside hack, or drop a question in the Zed Discord. We're working on improving the documentation, creating more examples, and will be publishing more guides to GPUI on our blog.