b3-core 0.2.0

A cross-platform framework that provides access and management of the main elements of a graphical application.
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

# B3. Core

![Crates.io Version](https://img.shields.io/crates/v/b3-core?cacheSeconds=60&link=https%3A%2F%2Fcrates.io%2Fcrates%2Fb3-core)
![docs.rs](https://img.shields.io/docsrs/b3-core?cacheSeconds=60&link=https%3A%2F%2Fdocs.rs%2Fcrate%2Fb3-core%2Flatest)
![GitHub License](https://img.shields.io/github/license/Klein-Stein/b3-core?cacheSeconds=60&link=https%3A%2F%2Fgithub.com%2FKlein-Stein%2Fb3-core%2Fblob%2Fmaster%2FLICENSE)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Klein-Stein/b3-core/rust.yml?cacheSeconds=60)

**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.

<p align="center">
  <img src="images/preview.png" alt="Preview"/>
</p>

**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][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][github], and not project's mirrors.

**Main:**

- **GitHub**: <https://github.com/Klein-Stein/b3-core>

**Mirror:**

- **GitFlic**: <https://gitflic.ru/project/klein-stein/b3-core>

## Roadmap

- [x] **macOS:** Application menu support
- [x] **macOS:** Support of system events
- [x] **macOS:** Support of windows
- [x] **macOS:** Support of modal windows
- [x] **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](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:

```sh
# 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][license].

[winit]:
https://github.com/rust-windowing/winit
[github]:
https://github.com
[license]:
LICENSE