Crate opencl_sys
source · [−]Expand description
OpenCL C FFI bindings for the Rust programming language.
Description
Rust FFI Bindings to the Khronos OpenCL C language headers, see the OpenCL Resource Guide.
The API for OpenCL versions and extensions are controlled by Rust features such as “CL_VERSION_2_0” and “cl_khr_gl_sharing”. To enable an OpenCL version, the feature for that version and all previous OpenCL versions must be enabled, e.g. for “CL_VERSION_2_0”; “CL_VERSION_1_1” and “CL_VERSION_1_2” must also be enabled.
The default features are “CL_VERSION_1_1” and “CL_VERSION_1_2”.
Rust deprecation warnings are given for OpenCL API functions that are
deprecated by an enabled OpenCL version e.g., clCreateCommandQueue is
deprecated whenever “CL_VERSION_2_0” is enabled.
The Rust FFI files attempt to match the format and layout of the original C source files instead of bindgen output files to ease maintenance.
Contribution
If you want to contribute through code or documentation, the Contributing
guide is the best place to start.
If you have any questions, please feel free to ask.
Just please abide by our Code of Conduct.
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
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.
OpenCL and the OpenCL logo are trademarks of Apple Inc. used under license by Khronos.
Modules
FFI bindings for cl_d3d10.h
cl_d3d10.h contains OpenCL extensions that provide interoperability with Direct3D 10.
OpenCL extensions are documented in the OpenCL-Registry
FFI bindings for cl_d3d11.h
cl_d3d11.h contains OpenCL extensions that provide interoperability with Direct3D 11.
OpenCL extensions are documented in the OpenCL-Registry
FFI bindings for cl_dx9_media_sharing.h
cl_dx9_media_sharing.h contains OpenCL extensions that provide interoperability with Direct3D 9.
OpenCL extensions are documented in the OpenCL-Registry
FFI bindings for cl_egl.h
OpenCL extensions are documented in the OpenCL-Registry
Structs
Constants
New property to clGetDeviceInfo for retrieving supported intermediate languages.
Index of layer in a multilayer hardware buffer
Index of plane in a multiplanar hardware buffer
Data consistency with host property
Import memory size value to indicate a size for the whole buffer.
Android hardware buffer type value for CL_IMPORT_TYPE_ARM property
Default and valid properties name for cl_arm_import_memory
DMA BUF memory type value for CL_IMPORT_TYPE_ARM property
Host process memory type default value for CL_IMPORT_TYPE_ARM property
Protected memory property
New property to clGetProgramInfo for retrieving for retrieving the IL of a program.