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
// Copyright (c) 2020-2021 Via Technology Ltd. All Rights Reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //! [![crates.io](https://img.shields.io/crates/v/cl3.svg)](https://crates.io/crates/cl3) //! [![docs.io](https://docs.rs/cl3/badge.svg)](https://docs.rs/cl3/) //! [![OpenCL 3.0](https://img.shields.io/badge/OpenCL-3.0-blue.svg)](https://www.khronos.org/registry/OpenCL/) //! [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) //! ![Rust](https://github.com/kenba/cl3/workflows/Rust/badge.svg) //! //! A Rust adapter for the Khronos [OpenCL](https://www.khronos.org/registry/OpenCL/) API. //! //! # Description //! //! A functional, safe Rust interface to the Khronos OpenCL 3.0 //! [C API](https://github.com/KhronosGroup/OpenCL-Headers/blob/master/CL/cl.h) //! based upon the [cl-sys](https://crates.io/crates/cl-sys) OpenCL FFI bindings. //! //! [OpenCL 3.0](https://www.khronos.org/registry/OpenCL/specs/3.0-unified/html/OpenCL_API.html) //! is a unified specification that adds little new functionality to previous OpenCL versions. //! It specifies that all **OpenCL 1.2** features are **mandatory**, while all //! OpenCL 2.x and 3.0 features are now optional. //! //! ## Design //! //! This crate applies the [adapter pattern](https://en.wikipedia.org/wiki/Adapter_pattern) //! to convert OpenCL C API functions into Rust functions that return a //! [Result](https://doc.rust-lang.org/std/result/) containing the desired result of //! the C function or the OpenCL error code. //! The exception is `svm_free`, which just provides a safe wrapper for the //! `clSVMFree` C API function. //! //! Most of the modules are named after their equivalent OpenCL "API" sections in //! [cl.h](https://github.com/KhronosGroup/OpenCL-Headers/blob/master/CL/cl.h). //! They contain Rust adapter functions for the OpenCL API C functions defined //! in those sections with their associated types and constants. The exceptions are: //! //! * [error_codes] - contains the OpenCL API error codes from cl.h and a function //! (`error_text`) to convert an error code to it's enum name from cl.h. //! * [info_type] - contains a Rust enum (`InfoType`) to hold the OpenCL types //! that can be returned from OpenCL "Info" functions, e.g. clGetPlatformInfo, //! clGetDeviceInfo, clGetProgramInfo, etc. //! * [macros] - contains Rust macros to call the OpenCL "Info" functions and //! return the appropriate `InfoType` in a Rust Result. //! //! It is vital to call the correct `InfoType` method type when decoding the //! result of "Info" functions, since the methods will panic if called with the //! wrong type, see [info_type]. //! //! # Use //! //! See [cl3](https://crates.io/crates/cl3). //! //! ## License //! //! Licensed under the Apache License, Version 2.0, as per Khronos Group OpenCL. //! You may obtain a copy of the License at: <http://www.apache.org/licenses/LICENSE-2.0> //! //! OpenCL and the OpenCL logo are trademarks of Apple Inc. used under license by Khronos. extern crate cl_sys; pub mod command_queue; pub mod context; pub mod device; pub mod error_codes; pub mod event; pub mod info_type; pub mod kernel; pub mod macros; pub mod memory; pub mod platform; pub mod program; pub mod sampler; pub mod types;