https://github.com/chances/bismuth
A generic, bring your own framework/engine graphics library for games and visualizations
https://github.com/chances/bismuth
3d-graphics crystal graphics graphics-library windowing
Last synced: 8 days ago
JSON representation
A generic, bring your own framework/engine graphics library for games and visualizations
- Host: GitHub
- URL: https://github.com/chances/bismuth
- Owner: chances
- Created: 2021-08-17T05:55:49.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-11T21:43:21.000Z (about 2 years ago)
- Last Synced: 2025-04-05T09:24:50.650Z (about 1 month ago)
- Topics: 3d-graphics, crystal, graphics, graphics-library, windowing
- Language: Crystal
- Homepage: https://chances.github.io/bismuth
- Size: 81.1 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Bismuth
A generic, bring your own framework/engine graphics library for games and visualizations.
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
bismuth:
github: chances/bismuth
```
2. Run `shards install`
## Usage
```crystal
require "bismuth"
# TODO: Write usage instructions here
```
See the [API documentation](https://chances.github.io/bismuth).
### Debian Linux
Required libraries:
- [`libvulkan-dev`](https://github.com/KhronosGroup/Vulkan-Loader)
- `mesa-vulkan-drivers`
#### For NVidia GPUs
- `nvidia-driver-470`
### Running Examples
#### Triangle
##### macOS
```shell
make bin/triangle.app
open bin/triangle.app
```
##### Linux
```shell
make bin/triangle
./bin/triangle
```
## Behind the Name
Bismuth germanium oxide is one of [many other piezoelectric materials](https://en.wikipedia.org/wiki/Crystal_oscillator#Other_materials) used as crystal oscillators.
> A crystal oscillator is an electronic oscillator circuit that uses the mechanical resonance of a vibrating crystal of piezoelectric material to create an electrical signal with a constant frequency.
[Crystal oscillator](https://en.wikipedia.org/wiki/Crystal_oscillator), Wikipedia, 2021.