obwio 0.1.0

OpenCL bindings and runtime utilities for Rust
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

# OBWIO


OBWIO is a Rust crate that provides low-level bindings to the OpenCL API, enabling direct access to GPU compute functionality across platforms. It is designed for developers who want full control over OpenCL without relying on high-level abstractions or wrappers.

## Overview


OBWIO exposes the raw OpenCL interface through auto-generated Rust bindings. These bindings allow you to interact with OpenCL devices, contexts, buffers, and kernels directly, making it suitable for performance-critical applications such as graphics engines, machine learning frameworks, and custom GPU runtimes.

## Features


- Auto-generated bindings using `bindgen`
- Supports OpenCL 1.x and 2.x
- Cross-platform compatibility (Windows, Linux, macOS)
- Minimal overhead and full control over OpenCL calls
- Ideal for advanced users building low-level GPU systems

## Installation


Add OBWIO to your `Cargo.toml`:

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

## Example


```rust
use obwio::clGetPlatformIDs;

fn main() {
    unsafe {
        let mut num_platforms = 0;
        let err = clGetPlatformIDs(0, std::ptr::null_mut(), &mut num_platforms);
        println!("Found {} OpenCL platforms (err code: {})", num_platforms, err);
    }
}
```

## Requirements


- Rust 1.70 or later
- OpenCL SDK installed on your system
- Compatible OpenCL runtime and drivers

## License


Licensed under:
- Apache License, Version 2.0

## Contributing


Contributions are welcome. If you're building a wrapper or using OBWIO in a larger project, feel free to open issues or submit pull requests.

## Acknowledgments


OBWIO uses `bindgen` to generate FFI bindings and depends on the Khronos OpenCL headers. Thanks to the Rust and OpenCL communities for their documentation and tooling support.