Google Git
Sign in
android / platform / external / OpenCL-CLHPP / 8df6c8f457f4eb3914338f189f01dcb193664f61
commit8df6c8f457f4eb3914338f189f01dcb193664f61[log] [tgz]
authorKévin Petit <[email protected]>Tue Aug 24 21:47:35 2021 +0100
committerGitHub <[email protected]>Tue Aug 24 16:47:35 2021 -0400
tree5185afb22a0fa116e1b428281dca90b6d9cc890c
parentf7237f3799009d856935e1eecfd7c9301fe522b4 [diff]
Transition CI to Github Actions (#142)

Signed-off-by: Kevin Petit <[email protected]>
2 files changed
tree: 5185afb22a0fa116e1b428281dca90b6d9cc890c
  1. .github/
  2. docs/
  3. examples/
  4. external/
  5. include/
  6. tests/
  7. .gitmodules
  8. CMakeLists.txt
  9. CODE_OF_CONDUCT.md
  10. LICENSE.txt
  11. README.md
README.md

OpenCLTM API C++ bindings

Doxgen documentation for the bindings is available here:

http://khronosgroup.github.io/OpenCL-CLHPP/

Components:

  • include/CL/opencl.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.

  • include/CL/cl2.hpp: Includes opencl.hpp and emits a warning, for backwards compability.

  • docs: Doxygen file used to generate HTML documentation for opencl.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.