Download Samples using the Code Sample Browser for Intel® oneAPI Toolkits

Use the Code Sample Browser for Intel oneAPI Toolkits to browse the collection of online Intel® oneAPI samples. You can copy the samples to your local disk as buildable sample projects. Most Intel oneAPI sample projects are built using Make* or CMake, so the build instructions are included as part of the sample in a README file. Code Sample Browser for Intel oneAPI Toolkits is a stand-alone single-file executable that has no dependencies on dynamic runtime libraries.

For a list of components that support CMake, see Use CMake with oneAPI Applications.

To download the Intel® Rendering Toolkit (Render Kit) samples:

1. Open a new terminal.
2. Some OSPRay programs may require the OpenMP* runtime library. Append the path the to runtime, libomp.so, to the dynamic load search path. Workaround format:

   export /path/to/library:${LD_LIBRARY_PATH}

   Ubuntu* 22.04 workaround example:

   export /usr/lib/llvm-14/lib:${LD_LIBRARY_PATH}

   See the forum for more detail on the workaround.
3. If you did not set up Intel oneAPI Toolkit environment permanently: Set up environment variables:

   Component Directory Layout

   For system wide installations:

   . /opt/intel/oneapi/setvars.sh

   For private installations:

   . ~/intel/oneapi/setvars.sh

   Unified Directory Layout

   For system wide installations:

   . /opt/intel/oneapi/<toolkit-version>/oneapi-vars.sh

   For private installations:

   . ~/intel/oneapi/<toolkit-version>/oneapi-vars.sh

   See Set up Environment Variables for other options.

   NOTE:

   If you installed the Render Kit to a custom location, make sure to replace /opt/intel/oneapi/ (for root or sudo users) or ~/intel/oneapi/ (for non-root users) with the custom installation path before running the command.
4. From the terminal, run the Code Sample Browser for Intel oneAPI Toolkits with C++ and C samples.

   oneapi-cli -l cpp,c

   The oneAPI CLI menu appears:

   

5. Select Create a project using arrow keys, then press Enter.

   The language selection will appear.

   

6. Select the language for your sample. For your first project, select cpp, then press Enter.

   The toolkit samples list appears. Render Kit samples are located underneath the oneAPI Libraries subtree.

   

7. Navigate to oneAPI Libraries > OSPRay > Intel OSPRay Getting Started, then press Enter.
8. Specify a location to download the project to. By default, it is the path from where you ran the Code Sample Browser for Intel oneAPI Toolkits and project name. Intel OSPRay Getting Started by default extracts to a folder name of 01_ospray_gsg

   

9. Press Tab to select Create, then press Enter.
10. Repeat the steps to download samples for other components: oneAPI Libraries > Embree > Intel Embree Getting Started (02_embree_gsg) for Intel® Embree, oneAPI Libraries > Open Image Denoise > Intel Open Image Denoise Getting Started (04_oidn_gsg) for Intel® Open Image Denoise, and oneAPI Libraries > ISPC > Intel Implicit SPMD Program Compiler Getting Started (05_ispc_gsg) for Intel® Implicit SPMD Program Compiler (Intel® ISPC). The samples are numbered and staged to be tried in order.

    Intel Open Volume Kernel Library 03_openvkl_gsg sample is available in the C language menu option of the Code Sample Browser for Intel oneAPI Toolkits:

    1. Select c language:

       

    2. Select the Intel Open VKL sample oneAPI Libraries > Open VKL > Intel Open VKL Getting Started:

       

See Exploring Intel oneAPI Samples from the Command Line for a video tutorial on creating a project with the command line.

Build and Run an Intel® OSPRay Sample using CMake*

1. Navigate to the folder where you downloaded the 01_ospray_gsg sample.
2. Run the following commands to build the sample:

   mkdir build

   cd build

   cmake ..

   cmake --build .

3. Run the application.

   ./ospTutorialCpp

   If you experience any runtime errors see the troubleshoot forum post.
4. Review the output images with an image viewer application for PPM file type. For example, with ImageMagick*:

   <path-to-ImageMagick>/display-im6 firstFrameCpp.ppm

   <path-to-ImageMagick>/display-im6 accumulatedFrameCpp.ppm

   You should see the output images:

   • Single-accumulation render firstFrameCpp:

     

   • Ten-accumulation render accumulatedFrameCpp:

     

GPU Users: Run Intel OSPRay on GPU

1. Delete the CPU output images:

   rm *.ppm

2. On Intel® Data Center MAX Series GPU, set topology runtime control for running Intel OSPRay and Intel Embree programs:

   export ZE_FLAT_DEVICE_HIERARCHY=COMPOSITE

3. Run the application and specify GPU as a device target:

   ./ospTutorialCpp.exe --osp:load-modules=gpu --osp:device=gpu

4. Review firstFrameCpp.ppm and accumulatedFrameCpp.ppm output images.

Build and Run an Intel® Embree Sample using CMake*

1. Navigate to the folder where you downloaded the 02_embree_gsg sample.
2. Run the following commands to build the sample:

   cd cpu

   mkdir build

   cd build

   cmake ..

   cmake --build .

3. Run the application.

   ./minimal

   The sample application performs two ray-to-triangle intersect tests with the Intel Embree API. One test is successful, while the other test is a miss. Output is written to the terminal:

   0.000000, 0.000000, -1.000000: Found intersection on geometry 0, primitive 0 at tfar=1.000000
   1.000000, 1.000000, -1.000000: Did not find any intersection.

GPU Users: Build and Run an Intel® Embree Sample for GPU using CMake*

1. On Intel® Data Center MAX Series GPU, set topology runtime control for running Intel OSPRay and Intel Embree programs:

   export ZE_FLAT_DEVICE_HIERARCHY=COMPOSITE

2. Navigate to the folder where you downloaded the 02_embree_gsg sample.
3. Run the following commands to build the sample:

   cd gpu

   mkdir build

   cd build

   cmake ..

   cmake --build .

4. Run the application.

   ./minimal_sycl

   The sample application performs two ray-to-triangle intersect tests with the Intel Embree API. One test is successful, while the other test is a miss. Output is written to the terminal:

   0.330000, 0.330000, -1.000000: Found intersection on geometry 0, primitive 0 at tfar=1.000000
   1.000000, 1.000000, -1.000000: Did not find any intersection.

Build and Run an Intel® Open Volume Kernel Library Sample using CMake*

1. Navigate to the folder where you downloaded the 03_openvkl_gsg sample.
2. Run the following commands to build the sample:

   mkdir build

   cd build

   cmake ..

   cmake --build .

3. Run the application.

   ./vklTutorial

   The sample application shows sampling within a procedurally generated volume and outputs. Sampling, gradient computation, and multi-attribute sampling. Output is written to the terminal.

GPU Users: Build and Run Intel Open VKL on GPU

1. Navigate to the folder where you downloaded the 03_openvkl_gsg sample.
2. Run the following commands to build the sample:

   cd gpu

   mkdir build

   cd build

   cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER=icpx ..

   cmake --build .

3. Run the application.

   ./vklTutorialGPU.exe

   The sample application shows sampling within a procedurally generated volume and outputs. Sampling, gradient computation, and multi-attribute sampling. Output is written to the terminal.

Build and Run an Intel® Open Image Denoise Sample using CMake*

1. Navigate to the folder where you downloaded the 04_oidn_gsg sample.
2. Run the following commands to build the sample:

   mkdir build

   cd build

   cmake ..

   cmake --build .

3. Convert the accumulatedFrameCpp.ppm image to PFM format with LSB data ordering. For example, with the ImageMagick* convert tool:

   <path-to-ImageMagick>/convert-im6 <path-to-sample>/01_ospray_gsg/build/accumulatedFrameCpp.ppm -endian LSB PFM:accumulatedFrameCpp.pfm

   NOTE:

   ‘accumulatedFrameCpp.pfm’ is also already converted and available in the 04_oidn_gsg directory if you wish to skip this conversion.
4. Run the application to denoise the image.

   ./oidnDenoise -d cpu -hdr accumulatedFrameCpp.pfm -o denoised.pfm

5. Review the output image with an image viewer application for PPM file type. For example, with ImageMagick*:

   <path-to-ImageMagick>/display-im6 denoised.pfm

   • Original ten-accumulation render accumulatedFrameCpp:

     

   • Denoised result denoised.pfm:

     

6. GPU Users: Run the application to denoise the image using Intel GPU:

   ./oidnDenoise -d sycl -hdr accumulatedFrameCpp.pfm -o denoised.pfm

7. Review the output image with a PFM capable image viewer application. For example, with ImageMagick*:

   <path-to-ImageMagick>/display-im6 denoised.pfm

Build and Run an Intel® Implicit SPMD Program Compiler Sample using CMake*

1. Navigate to the folder where you downloaded the 05_ispc_gsg sample.
2. Run the following commands to build the sample:

   mkdir build

   cd build

   cmake ..

   cmake --build .

3. Run a single-target sample application:

   ./simple

4. Run a multi-target sample application:

   ./simple_multi

Build and Run an Intel® Open PGL Sample using CMake*

1. Navigate to any new writable and empty folder:

   cd /home/${USER}

   mkdir pgl_gsg

   cd pgl_gsg

2. Create a new file, openpgl_check.cpp, using a raw text editor (notepad, etc.). Save the below contents into the file:

   #include <iostream>
   
   #include <openpgl/cpp/OpenPGL.h>
   
   int main(int argc, char *argv[]) {
   
   openpgl::cpp::Device device(PGL_DEVICE_TYPE_CPU_4);
   
   PGLFieldArguments fieldArgs;
   
   pglFieldArgumentsSetDefaults(fieldArgs, PGL_SPATIAL_STRUCTURE_KDTREE,
   
   PGL_DIRECTIONAL_DISTRIBUTION_PARALLAX_AWARE_VMM);
   
   openpgl::cpp::Field field(&device, fieldArgs);
   
   std::cout << "Field created successfully... exiting\n";
   
   return 0;
   
   }

3. Create a new file, CMakeLists.txt, using a raw text editor (notepad, etc.). Save the below contents into the file:

   cmake_minimum_required(VERSION 3.1)
   
   project(openpgl_check LANGUAGES CXX)
   
   include_directories("$ENV{ONEAPI_ROOT}/openpgl/latest/include")
   
   link_directories("$ENV{ONEAPI_ROOT}/openpgl/latest/lib")
   
   add_executable(openpgl_check openpgl_check.cpp)
   
   target_link_libraries(openpgl_check PRIVATE openpgl)
   
   set_property(TARGET openpgl_check PROPERTY CXX_STANDARD 11)

4. Run the following commands to build the sample:

   mkdir build

   cd build

   cmake ..

   cmake --build . 

5. Run the check application:

   ./openpgl_check

6. If you see the below output without error, you have successfully built and runtime linked to the Intel® Open PGL library:

   Field created successfully... exiting

Next Steps

All samples have detailed README.md instructions for further review. Next, try running pre-compiled sample applications included with the toolkit OR explore additional resources in Next Steps.