Skip to content
This repository was archived by the owner on Jan 28, 2024. It is now read-only.

Commit 1a1700c

Browse files
committed
Add starter documentation with further references
1 parent 944cdee commit 1a1700c

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
11
# Go wrapper library for OpenCL 2.2
22

3+
This library provides a complete wrapper for the OpenCL 2.2 API.
4+
If you require a different API level, refer to [the opencl-go project][opencl-go] to see which versions are available.
5+
36
**This is work-in-progress. The wrapper is not yet in a state to provide useful functionality**
47

8+
## Usage
9+
10+
To build and work with this library, you need an OpenCL SDK installed on your system.
11+
Refer to [the documentation on opencl-go][opencl-go] on how to do this.
12+
13+
The API requires knowledge of the [OpenCL API][opencl-api]. While the wrapper hides some low-level C-API details,
14+
there is still heavy use of `unsafe.Pointer` and the potential for memory access-violations if used wrong.
15+
16+
[opencl-api]:[https://registry.khronos.org/OpenCL/sdk/2.2/docs/man/html/]
17+
[opencl-go]:[https://opencl-go.github.com]
18+
519
## License
620

721
This project is based on the MIT License. See `LICENSE` file.

doc.go

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
// Package cl22 provides a wrapper API to OpenCL 2.2.
22
//
3+
// If you require a different API level, refer to the opencl-go project (https://opencl-go.github.com) to see which
4+
// versions are available.
5+
//
6+
// To build and work with this library, you need an OpenCL SDK installed on your system.
7+
// Refer to the documentation on opencl-go (https://opencl-go.github.com) on how to do this.
8+
//
9+
// The API requires knowledge of the OpenCL API. While the wrapper hides some low-level C-API details,
10+
// there is still heavy use of `unsafe.Pointer` and the potential for memory access-violations if used wrong.
11+
//
312
// This library wraps/represents constants, types, and functions as closely to the original API as possible -
413
// while applying Go idioms.
514
// It also provides convenience functions where practical. For example: PlatformInfoString().

0 commit comments

Comments
 (0)