Lib.rs

› GUI
#applications #framework #cross-platform #window #windowing #events #notifications

b3-core

A cross-platform framework that provides access and management of the main elements of a graphical application

by ghostman2013

6 releases (3 breaking)

0.4.0 Jun 6, 2024
0.3.1 Jun 5, 2024
0.2.0 Jun 4, 2024
0.1.1 Jun 4, 2024
0.1.0 May 31, 2024

#910 in GUI

Custom license

100KB
2.5K SLoC

B3. Core

Crates.io Version docs.rs GitHub License GitHub Actions Workflow Status

⚠️WARNING The project is under active development. The current codebase may be unstable and incomplete, and the API may be significantly changed in future versions. At this stage, it is highly discouraged to use this crate in the release build.

Preview

B3. Core is a cross-platform framework that provides access and management of the main elements of a graphical application:

  • events including mouse, keyboard and touchpad events,
  • menus: application, context and etc.,
  • windows,
  • notifications,
  • tray.

The framework was heavily inspired by winit crate.

Repository

If you want to make a Pull Request or open a new Issue, please, make sure that you are on GitHub.com, and not project's mirrors.

Main:

Mirror:

Roadmap

  • macOS: Application menu support
  • macOS: Support of system events
  • macOS: Support of windows
  • macOS: Support of modal windows
  • macOS: Support of notifications

Features

Feature Description
dh Provide raw display and window pointers
notifications Enable a support of user notifications

Examples

The project contains few examples in the examples folder.

Example Description
hello-app Minimally viable application with a trivial application menu. This example will only be visible on OS that supports the main application menu.
hello-window Example of application with multiple windows, notifications and the main application menu.
hello-vulkan Example of Vulkan initialization. It requires an additional configuration (see below).

To launch the hello-vulkan example it's required to specify environment variables that point to installed Vulkan libraries. To do this, create .env file in project's root directory:

# Replace <...> by actual paths
cat <<EOT >> .env
VULKAN_SDK=<VULKAN_SDK_DIR>/<TARGET_PLATFORM_DIR>
PATH=<VULKAN_SDK_DIR>/<TARGET_PLATFORM_DIR>/bin:$PATH
DYLD_LIBRARY_PATH=<VULKAN_SDK_DIR>/<TARGET_PLATFORM_DIR>/lib:$DYLD_LIBRARY_PATH
VK_ICD_FILENAMES=<VULKAN_SDK_DIR>/<TARGET_PLATFORM_DIR>/share/vulkan/icd.d/MoltenVK_icd.json
VK_LAYER_PATH=<VULKAN_SDK_DIR>/<TARGET_PLATFORM_DIR>/share/vulkan/explicit_layer.d
EOT

License

This project is distributed under the MIT license.

Dependencies

~0.7–3MB
~66K SLoC