goldy 0.1.0

Goldy - Modern Graphics Library
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

# Goldy: Modern GPU Library

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

A modern Rust GPU library that deliberately sheds legacy baggage. Goldy targets only modern GPU APIs (Vulkan 1.3+, DX12, Metal) and can therefore be significantly simpler than libraries that must maintain backward compatibility.

## Quick Example

```rust
use goldy::{Instance, DeviceType, Buffer, BufferUsage, Color, CommandEncoder, FrameOutput, TextureFormat};

fn main() -> anyhow::Result<()> {
    let instance = Instance::new()?;
    let device = instance.create_device(DeviceType::DiscreteGpu)?;
    
    let frame = FrameOutput::new(&device, 800, 600, TextureFormat::Rgba8Unorm);
    let mut encoder = CommandEncoder::new();
    {
        let mut pass = encoder.begin_render_pass();
        pass.clear(Color::CORNFLOWER_BLUE);
    }
    
    let pixels = frame.render(encoder)?;
    Ok(())
}
```

## Features

| Attribute | Description |
|-----------|-------------|
| **Rust-native** | Idiomatic Rust API, not a wrapper around C |
| **Modern-only** | Vulkan 1.3+, DX12, Metal baseline |
| **Slang shaders** | Single shader language for all backends |
| **Legacy-free** | No OpenGL, no Vulkan <1.3, no OpenCL |
| **Unified** | Graphics and compute in one API |
| **Fast-moving** | Not a standard—can iterate quickly |
| **WASI-ready** | Designed for sandboxed GPU access |

## Installation

```toml
[dependencies]
goldy = "0.1"
```

## Documentation

đŸ“– **[Full Documentation](https://koubaa.github.io/goldy/)**

- [Getting Started](https://koubaa.github.io/goldy/getting-started/installation.html)
- [Examples](https://koubaa.github.io/goldy/examples/overview.html)
- [API Reference](https://koubaa.github.io/goldy/reference/api.html)
- [Design Philosophy](https://koubaa.github.io/goldy/design/motivation.html)

## Examples

Run the interactive examples:

```bash
cargo run --example triangle --release      # Basic triangle
cargo run --example digital_clock --release # 7-segment clock
cargo run --example plasma --release        # Demoscene plasma
cargo run --example mandelbrot --release    # Fractal explorer
cargo run --example starfield --release     # 3D starfield
cargo run --example particles --release     # Rain/snow
```

See [all examples](https://koubaa.github.io/goldy/examples/overview.html).

## Motivation

Goldy is inspired by Sebastian Aaltonen's ["No Graphics API"](https://www.sebastianaaltonen.com/blog/no-graphics-api) vision of what's possible with modern GPU hardware. By targeting only modern GPUs (2018+), Goldy can:

- Use dynamic rendering (no render pass objects)
- Use bindless descriptors (no descriptor sets)
- Assume coherent caches (simpler synchronization)
- Provide a dramatically simpler API

Goldy is also inspired by:
- Wayland's compositor architecture
- Ralph Levien's ["Requiem for piet-gpu-hal"](https://raphlinus.github.io/rust/gpu/2023/01/07/requiem-piet-gpu-hal.html)
- Slang's vision for unified shader language
- [WGPU](https://gfx-rs.github.io/2019/03/06/wgpu.html)
- This paper on GPU abstractions: https://www.kom.tu-darmstadt.de/papers/KCGS17.pdf

Read more in [Design Philosophy](https://koubaa.github.io/goldy/design/motivation.html).

## Target Hardware

| Platform | Minimum |
|----------|---------|
| NVIDIA | RTX 2000 / GTX 1600 (2018+) |
| AMD | RDNA 1 / RX 5000 (2019+) |
| Intel | Xe / Alchemist (2022+) |
| Apple | M1 / A14 (2020+) |

## License

MIT License - see [LICENSE](LICENSE) for details.

## Author

Mohamed Koubaa

## Contributing

Contributions welcome! See [CONTRIBUTING](https://koubaa.github.io/goldy/contributing.html).