13 unstable releases (4 breaking)

0.8.2 Apr 26, 2024
0.8.1 Mar 7, 2024
0.8.0 Feb 4, 2024
0.7.2 Aug 12, 2023
0.5.2 Nov 17, 2022

#1233 in GUI

Download history 136/week @ 2024-02-11 297/week @ 2024-02-18 177/week @ 2024-02-25 350/week @ 2024-03-03 160/week @ 2024-03-10 210/week @ 2024-03-17 85/week @ 2024-03-24 184/week @ 2024-03-31 208/week @ 2024-04-07 108/week @ 2024-04-14 279/week @ 2024-04-21 196/week @ 2024-04-28 183/week @ 2024-05-05 99/week @ 2024-05-12 114/week @ 2024-05-19 97/week @ 2024-05-26

514 downloads per month
Used in 7 crates (via gdk4-win32)

MIT license

260KB
5.5K SLoC

gtk4-rs CI

A group of crates that aims to provide complete GTK 4 bindings. This repository contains all the "core" crates of GTK 4.

  • GTK
  • GDK: An intermediate layer which isolates GTK from the details of the windowing system.
    • GDK Wayland: Wayland backend specific functions.
    • GDK Win32: Windows backend specific functions.
    • GDK X11: X backend specific functions.
  • GSK: An intermediate layer which isolates GTK from the details of the OpenGL or Vulkan implementation.

The GTK 4 crates also depends on other libraries part of the platform like:

Those are common with the GTK 3 and GStreamer bindings and are part of the gtk-rs-core repository.

For more information about each crate, please refer to their README.md file in their directory.

Minimum supported Rust version

Currently, the minimum supported Rust version is 1.70.

Documentation

Ecosystem

The gtk4-rs repository contains Rust crates for GTK 4. However there is a large ecosystem of GObject libraries and many of these libraries have Rust bindings based on the tooling included in gtk-rs. Of particular note:

  • gtk-rs-core - bindings for some of the core libraries such as glib, gio, pango, graphene
  • gstreamer-rs - bindings for the GStreamer media framework

Additionally, Rust bindings for various libraries are hosted on GNOME's GitLab instance and can be found at https://gitlab.gnome.org/World/Rust.

When using crates that are not part of the gtk4-rs repository, you will need to be careful and ensure that they do not pull in incompatible versions of core crates like glib-rs.

Built with GTK4 Rust bindings

A small list of applications built with gtk4-rs:

Libraries built with gtk4-rs:

  • Relm4: An idiomatic GUI library inspired by Elm

Contributing

The bindings are composed of two parts:

  • Automatically generated ones using gir
  • Manual parts

The automatic ones can be generated using the generator.py script

python3 ./generator.py

If you didn't do so yet, please check out all the submodules before via

$ git submodule update --checkout

All the crates except gtk4-macros follow this structure

   ./crate 
   ├── Gir.toml
   ├── README.md
   ├── src
   │   ╰── auto
   ├── sys
   ╰── tests
  • README.md: Explanations about the crate itself and eventually some details.
  • Gir.toml: Used by gir to generate most of the code.
  • src: Contains the source code of the crate.
  • src/auto: Contains the automatically generated part of the source code.
  • sys: Contains the 1:1 bindings of the C API.

Dependencies

~1.3–9MB
~78K SLoC