OpenCL^TM SDK (in development)

This is the Khronos OpenCL SDK. It brings together all the components needed to develop OpenCL applications:

• OpenCL Headers (external/OpenCL-Headers/)
• OpenCL C++ bindings (external/OpenCL-CLHPP/include)
• OpenCL Loader (external/OpenCL-ICD-Loader)
• OpenCL utility library (lib/include)

It also contains resources useful to OpenCL developers:

• Code samples (samples/)
• Documentation (docs/)

Build Instructions

Dependencies

• This repository uses sub-modules for the OpenCL Headers, OpenCL C++ bindings, and OpenCL ICD Loader and some of their transitive dependencies.

• To clone a new repository with all sub-modules included, use the --recursive option. Note that this option clones all sub-modules and their dependencies, which are not strictly required for the OpenCL SDK:

  git clone --recursive https://github.com/KhronosGroup/OpenCL-SDK.git
  

• Alternatively, to clone only the sub-modules for the OpenCL SDK, first clone this repository without sub-modules included then setup submodules non-recursively:

  git clone https://github.com/KhronosGroup/OpenCL-SDK.git
  git submodule init
  git submodule update
  

• The SDK uses CMake for its build system. If CMake is not provided by your build system or OS package manager, please consult the CMake website.

• The SDK samples depend on

• Templatized C++ Command Line Parser Library (aka. TCLAP)

• Simple and Fast Multimedia Library (aka. SFML)
• OpenGL Mathematics (aka. GLM)

Example Build

In most cases, the following steps may be used to build the OpenCL SDK.

1. Clone this repo and update submodules:

   git clone https://github.com/KhronosGroup/OpenCL-SDK.git
   git submodule init
   git submodule update
   

2. Create a "build" directory:

   mkdir build
   cd build
   

3. Generate build files inside of the "build" directory:

   cmake .. -DCMAKE_BUILD_TYPE=Release
   

4. Build the OpenCL SDK and copy files to an "install" directory:

   cmake --build . --target install --config Release
   

Or, build the OpenCL SDK using the generated build files directly.

To customize a build, the following CMake variables are supported. To specify one of these variables via the command line generator, use the CMake syntax -D<variable>=<value>. See your CMake documentation for more details.