Google Git
Sign in
android / platform / external / OpenCL-CLHPP / 3b03738fef487378b188d21cc5f2bae276aa8721
commit3b03738fef487378b188d21cc5f2bae276aa8721[log] [tgz]
authorKévin Petit <[email protected]>Wed Sep 02 08:57:26 2020 +0100
committerGitHub <[email protected]>Wed Sep 02 08:57:26 2020 +0100
treed05d38b238244e11c6f6bcd09b9d3992a665da36
parentfee9d2d17a293b6357220c47e2b6dcff2b7d93ce [diff]
Rename cl2.hpp to opencl.hpp (#104)

- Keep a cl2.hpp symlink for now for backwards compability
- Remove "CL2" from the name of examples
- Use opencl.hpp directly in tests and examples
- Remove a couple of unused variables in the trivial example

Fixes #25

Signed-off-by: Kévin Petit <[email protected]>

# Conflicts:
#	include/CL/cl2.hpp
10 files changed
tree: d05d38b238244e11c6f6bcd09b9d3992a665da36
  1. docs/
  2. examples/
  3. external/
  4. include/
  5. tests/
  6. .gitmodules
  7. .travis.yml
  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.