commit | 524f5ca96c3b9775f9d1debbdbcc2666bcce5c07 | [log] [tgz] |
---|---|---|
author | Kévin Petit <[email protected]> | Wed Jun 10 20:02:48 2020 +0100 |
committer | GitHub <[email protected]> | Wed Jun 10 12:02:48 2020 -0700 |
tree | 0b24107b5cc098c61ae2ce558db76f9dfaa03016 | |
parent | 432b551429b362a877ed9b647b7114022b332be0 [diff] |
Merge all unit tests into a single source file (#103) No changes to the moved code (that's why I wanted to do this as a separate PR). Contributes to #25 Signed-off-by: Kévin Petit <[email protected]>
Doxgen documentation for the cl2.hpp header is available here:
http://khronosgroup.github.io/OpenCL-CLHPP/
Components:
include/CL/cl2.hpp
: The latest, maintained, version of the C++ bindings. It should work with all versions of OpenCL (including 1.x). This is what most users will want.
docs
: Doxygen file used to generate HTML documentation for cl2.hpp
.
examples
: A simple example application using the very basic features of the bindings.
tests
: A (very small, incomplete) set of regression tests. Building the tests requires Python, Ruby, Unity and CMock. For the last two we use Unity 2.1.0 and CMock top-of-tree from Github (the version 2.0.204 on Sourceforge does not work).
CMakeLists.txt
: Build system for the examples and tests and logic for the bindings installation.
To get external dependencies needed for testing, use --recursive
when cloning the repository, or run git submodule update --init
.
You may need to tell CMake where to find the OpenCL headers and libraries, using the variables OPENCL_INCLUDE_DIR
and OPENCL_LIB_DIR
.
These can be set either as environment variables, or on the cmake command line using the syntax -D<VAR>=<VALUE>
.
The following is an example set of commands to checkout and build the C++ bindings (adapt paths as required):
git clone --recursive https://github.com/KhronosGroup/OpenCL-CLHPP cd OpenCL-CLHPP mkdir build cd build cmake .. -DOPENCL_INCLUDE_DIR=/path/to/OpenCL/headers -DOPENCL_LIB_DIR=/path/to/OpenCL/library make make test
After building, the headers appear in build/include/CL/
.
If Doxygen is available, you can generate HTML documentation by typing make docs
.