https://github.com/khronosgroup/opencl-sdk
OpenCL SDK
https://github.com/khronosgroup/opencl-sdk
Last synced: about 1 year ago
JSON representation
OpenCL SDK
- Host: GitHub
- URL: https://github.com/khronosgroup/opencl-sdk
- Owner: KhronosGroup
- License: apache-2.0
- Created: 2020-02-10T17:18:01.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-05-06T16:56:03.000Z (about 1 year ago)
- Last Synced: 2025-05-07T10:17:34.156Z (about 1 year ago)
- Language: C++
- Homepage:
- Size: 669 KB
- Stars: 651
- Watchers: 39
- Forks: 136
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# OpenCLTM 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](https://cmake.org).
- The SDK samples depend on
- [Templatized C++ Command Line Parser Library](http://tclap.sourceforge.net/) (aka. TCLAP)
- [Simple and Fast Multimedia Library](https://www.sfml-dev.org/) (aka. SFML)
- [OpenGL Mathematics](https://glm.g-truc.net/0.9.9/index.html) (aka. GLM)
### Example Build
> The example build guide uses [Vcpkg](https://vcpkg.io/en/index.html) to fetch all dependencies. Note that Vcpkg is _not_ a requirement and is only used for convenience. One may provide dependencies through any other CMake mechanism. For details on how to install Vcpkg, refer to its [Getting Started Guide](https://vcpkg.io/en/getting-started.html). The example build assumes targeting 64-bit Windows.
1. Clone this repo with the rest of the OpenCL SDK components:
git clone https://github.com/KhronosGroup/OpenCL-SDK.git
git submodule init
git submodule update
1. Build and install SDK with samples and no downstream unit tests:
cmake -D BUILD_TESTING=OFF \
-D BUILD_DOCS=OFF \
-D BUILD_EXAMPLES=OFF \
-D BUILD_TESTS=OFF \
-D OPENCL_SDK_BUILD_SAMPLES=ON \
-D OPENCL_SDK_TEST_SAMPLES=OFF \
-D CMAKE_TOOLCHAIN_FILE=/vcpkg/install/root/scripts/buildsystems/vcpkg.cmake \
-D CMAKE_BUILD_TYPE=Release \
-B ./OpenCL-SDK/build -S ./OpenCL-SDK
cmake --build ./OpenCL-SDK/build --target install
Samples that make use of OpenGL interop are disabled by default to reduce
the number of dependencies for most users. They can be enabled using the
`OPENCL_SDK_BUILD_OPENGL_SAMPLES` CMake option.
_(Note: on Linux, paths to dependent libraries are automatically handled by RPATH in both the build and install tree. On Windows, all DLLs have to be on the `PATH`. Vcpkg copies dependent DLLs to the build tree, but in order to do the same in the install tree, a sufficiently new CMake version is required. CMake 3.21 introduces `install(IMPORTED_RUNTIME_ARTIFACTS)`.)_