Do not build CL/GL samples by default (#131)

These require many dependencies and it seems fetching the dependencies
of SFML is currently broken. Better to disable them by default so first
time users do not need to resolve complex dependency issues to get going.

Signed-off-by: Kevin Petit <kevin.petit@arm.com>

Author: kpet

.github/workflows/presubmit.yml

@@ -274,6 +274,7 @@ jobs:
         -D BUILD_TESTING=ON
         -D BUILD_EXAMPLES=ON
         -D OPENCL_SDK_BUILD_SAMPLES=ON
+        -D OPENCL_SDK_BUILD_OPENGL_SAMPLES=ON
         `if [[ "${{matrix.BIN}}" == "32" ]]; then echo "-D OPENCL_SDK_BUILD_OPENGL_SAMPLES=OFF"; fi;`
         -D OPENCL_ICD_LOADER_BUILD_TESTING=ON
         -D CMAKE_C_STANDARD=${{matrix.STD.C}}
@@ -499,6 +500,7 @@ jobs:
           -D BUILD_DOCS=ON `
           -D BUILD_TESTING=ON `
           -D OPENCL_SDK_BUILD_SAMPLES=ON `
+          -D OPENCL_SDK_BUILD_OPENGL_SAMPLES=ON `
           -D CMAKE_C_STANDARD=${{matrix.STD.C}} `
           -D CMAKE_CXX_STANDARD=${{matrix.STD.CXX}} `
           -D CMAKE_C_FLAGS="${env:CMAKE_CFLAGS}" `
@@ -530,6 +532,7 @@ jobs:
           -D BUILD_DOCS=ON `
           -D BUILD_TESTING=ON `
           -D OPENCL_SDK_BUILD_SAMPLES=ON `
+          -D OPENCL_SDK_BUILD_OPENGL_SAMPLES=ON `
           -D CMAKE_C_STANDARD=${{matrix.STD.C}} `
           -D CMAKE_CXX_STANDARD=${{matrix.STD.CXX}} `
           -D CMAKE_C_FLAGS="${env:CMAKE_CFLAGS}" `
@@ -736,6 +739,7 @@ jobs:
         -D BUILD_TESTING=ON
         -D BUILD_EXAMPLES=ON
         -D OPENCL_SDK_BUILD_SAMPLES=ON
+        -D OPENCL_SDK_BUILD_OPENGL_SAMPLES=ON
         -D CMAKE_C_STANDARD=${{matrix.STD.C}}
         -D CMAKE_CXX_STANDARD=${{matrix.STD.CXX}}
         -D CMAKE_C_FLAGS="${CMAKE_CFLAGS}"
@@ -878,7 +882,6 @@ jobs:
         -D CMAKE_TOOLCHAIN_FILE=$ANDROID_NDK/build/cmake/android.toolchain.cmake
         -D ANDROID_ABI=${{matrix.ABI}}
         -D ANDROID_PLATFORM=${{matrix.API_LEVEL}}
-        -D OPENCL_SDK_BUILD_OPENGL_SAMPLES=OFF
         -S $GITHUB_WORKSPACE
         -B $GITHUB_WORKSPACE/build
 

CMakeLists.txt

@@ -25,7 +25,7 @@ project(OpenCL-SDK
 include(CMakeDependentOption)
 option(OPENCL_SDK_BUILD_UTILITY_LIBRARIES "Build utility libraries" ON)
 cmake_dependent_option(OPENCL_SDK_BUILD_SAMPLES "Build sample code" ON OPENCL_SDK_BUILD_UTILITY_LIBRARIES OFF)
-cmake_dependent_option(OPENCL_SDK_BUILD_OPENGL_SAMPLES "Build OpenCL-OpenGL interop sample code" ON OPENCL_SDK_BUILD_SAMPLES OFF)
+cmake_dependent_option(OPENCL_SDK_BUILD_OPENGL_SAMPLES "Build OpenCL-OpenGL interop sample code" OFF OPENCL_SDK_BUILD_SAMPLES OFF)
 cmake_dependent_option(OPENCL_SDK_BUILD_VULKAN_SAMPLES "Build OpenCL-Vulkan interop sample code" ON OPENCL_SDK_BUILD_SAMPLES OFF)
 cmake_dependent_option(OPENCL_SDK_TEST_SAMPLES "Add CTest to samples (where applicable)" ON OPENCL_SDK_BUILD_SAMPLES OFF)
 

README.md

@@ -61,4 +61,8 @@ If CMake is not provided by your build system or OS package manager, please cons
              -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)`.)_