Crate ocl [−] [src]
| GitHub
Rust implementation of OpenCL™.
This documentation is sometimes built from the dev branch and may occasionally differ slightly from what is on crates.io and the master branch.
Documentation is very much a work in progress, as is the library itself. Please help by filing an issue about unclear and/or incomplete documentation and it will be addressed.
An explanation of how dimensions and sizes of buffers and work queues are intended to be used will be coming as soon as a few more things are ironed out. Until then please see the examples.
Low Level Interfaces
For lower level interfaces and to use OpenCL features that have not yet been implemented on the top-level interface types, see the core and cl_h modules.
Help Wanted
Please help complete any functionality you may need by filing an issue or creating a pull request.
“OpenCL and the OpenCL logo are trademarks of Apple Inc. used by permission by Khronos.”
Modules
| builders |
Builders and associated settings-related types. |
| cl_h |
Rust bindings for the OpenCL ABI. |
| core |
Thin wrappers for the OpenCL FFI functions and types. |
| enums |
Enumerators for settings and information requests. |
| flags |
Bitflags for various parameter types. |
| traits |
Commonly used traits. |
| util |
Utility and debugging functions. |
Structs
| Buffer |
A chunk of memory physically located on a device, such as a GPU. |
| Context |
A context for a particular platform and set of device types. |
| Device |
A device identifier. |
| Event |
An event representing a command or user created event. |
| EventList |
A list of events for coordinating enqueued commands. |
| Image |
A section of device memory which represents one or many images. |
| Kernel |
A kernel which represents a 'procedure'. |
| Platform |
A platform identifier. |
| ProQue |
An all-in-one chimera of the |
| Program |
A program from which kernels can be created from. |
| Queue |
A command queue which manages all actions taken on kernels, buffers, and images. |
| Sampler |
An image sampler used to process images. |
Enums
| Error |
An enum containing either a |
| SpatialDims |
Specifies a size or offset in up to three dimensions. |
Type Definitions
| Result |
|