embree/tutorials/README.md.in at ac7b5e401d8d345a99abe09b7b3f18dba57907d7 · RenderKit/embree · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
## Copyright 2009-2021 Intel Corporation
## SPDX-License-Identifier: Apache-2.0

This folder contains sources of the Embree tutorials for illustration
purposes of the API. Follow the next sections to compile the
tutorials.

Compilation under Windows using SYCL
-------------------------------------

Install one of the SYCL compilers supported by Embree, see section
[Compiling Embree / Windows SYCL Compilation] of the Embree
documentation.

Then open some "x64 Native Tools Command Prompt" of Visual Studio and
execute the following line which properly configures the environment to
use the DPC++ compiler:

    set "DPCPP_DIR=path_to_dpcpp_compiler"
    set "PATH=%DPCPP_DIR%\bin;%PATH%"
    set "PATH=%DPCPP_DIR%\lib;%PATH%"
    set "CPATH=%DPCPP_DIR%\include;%CPATH%"
    set "INCLUDE=%DPCPP_DIR%\include;%INCLUDE%"
    set "LIB=%DPCPP_DIR%\lib;%LIB%"

Now download and unpack some recent TBB version for Windows, e.g. oneTBB 2022.3.0:

  https://github.com/oneapi-src/oneTBB/releases/download/v2022.3.0/oneapi-tbb-2022.3.0-win.zip

To compile tutorials contained in this folder first create and enter a
build folder inside the tutorial you want to compile. E.g. for the
minimal tutorial execute:

    cd minimal
    mkdir build
    cd build

Then configure the tutorial you would like to compile by pointing to
the Embree and TBB installation on your system.

    cmake -G Ninja
          -D CMAKE_CXX_COMPILER=clang++
          -D CMAKE_C_COMPILER=clang
          -D CMAKE_BUILD_TYPE=Release
          -D embree_DIR=%cd%\..\..\..\lib\cmake\embree-@EMBREE_VERSION@\
          -D TBB_DIR=path_to_tbb\oneapi-tbb-2021.2.0\lib\cmake\tbb ..

Now you can build the tutorial:

    cmake --build .

In order to run the tutorial you have to set the PATH to the bin
folder in order to find the Embree DLL:

  set PATH=%cd%\..\..\..\bin;%PATH%

Now you can run the tutorial:

    .\minimal.exe
    .\minimal_sycl.exe


Compilation under Linux using SYCL
-----------------------------------

Install one of the SYCL compilers supported by Embree, see section
[Compiling Embree / Linux SYCL Compilation] of the Embree
documentation.

To properly configure your environment, you have to source the
`startup.sh` of the unpacked DPC++ compiler:

    source dpcpp_compiler/startup.sh

Now download and unpack some recent TBB version for Linux, e.g. oneTBB 2022.3.0:

  wget https://github.com/oneapi-src/oneTBB/releases/download/v2022.3.0/oneapi-tbb-2022.3.0-lin.tgz
  tar xzf oneapi-tbb-2022.3.0-lin.tgz

To compile tutorials contained in this folder first create and enter a
build folder inside the tutorial you want to compile. E.g. for the
minimal tutorial execute:

    cd minimal
    mkdir build
    cd build

Then configure the tutorial you would like to compile by pointing to
the Embree and TBB installation on your system.

    cmake -D CMAKE_BUILD_TYPE=Release \
          -D CMAKE_CXX_COMPILER=clang++ \
          -D CMAKE_C_COMPILER=clang \
          -D embree_DIR=`pwd`/../../../lib/cmake/embree-@EMBREE_VERSION@/ \
          -D TBB_DIR=path_to_tbb/oneapi-tbb-2021.2.0/lib/cmake/tbb/ ..

Now you can build the tutorial:

    cmake --build .

Now you can run the tutorial:

    ./minimal
    ./minimal_sycl