Skip to content

Commit 11d8285

Browse files
Rendering Embree4 GSG Updates (#1353)
* stage embree gsg for cpu Signed-off-by: MichaelRoyceCarroll <[email protected]> * Add gpu to Rendering 02_embree... TODO: test/json val/readme Signed-off-by: Carroll, Michael R <[email protected]> * Adding license file in all folders for 02_embree Signed-off-by: Carroll, Michael R <[email protected]> * Update Embree gsg README.md * Update embree4 readme.md * embree minimal samples updated for embree 4... prewindows testing Signed-off-by: Carroll, Michael R <[email protected]> * Checked on Windows, fixed readme... ready for PR review Signed-off-by: MichaelRoyceCarroll <[email protected]> * Embree4 gsg JSON automation updates Signed-off-by: Carroll, Michael R <[email protected]> * README updates... thx to @jkinsky feedback Signed-off-by: Carroll, Michael R <[email protected]> --------- Signed-off-by: MichaelRoyceCarroll <[email protected]> Signed-off-by: Carroll, Michael R <[email protected]> Co-authored-by: MichaelRoyceCarroll <[email protected]>
1 parent f6a74dd commit 11d8285

13 files changed

+1092
-87
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,19 @@
11
# Getting Started Sample for Intel&reg; oneAPI Rendering Toolkit (Render Kit): Intel&reg; Embree
22

3-
Intel&reg; Embree is a collection of high-performance ray tracing kernels.
4-
Improve performance of photo-realistic rendering applications by using
5-
performance optimized ray-tracing kernels.
3+
Intel Embree is a library of high-performance ray tracing kernels. Improve performance of photo-realistic rendering applications with Intel Embree.
64

7-
| Minimum Requirements | Description
8-
|:--- |:---
9-
| OS | Linux* Ubuntu* 18.04 <br>CentOS 8 (or compatible) <br>Windows* 10 <br>macOS 10.15+
10-
| Hardware | Intel 64 Penryn or newer with SSE4.1 extensions; ARM64 with NEON extensions <br>(Optimized requirements: Intel 64 Skylake or newer with AVX512 extentions, ARM64 with NEON extensions)
11-
| Compiler Toolchain | Windows: MSVS 2019 with Windows SDK and CMake*; Other platforms: C++11 compiler, a C99 compiler (for example gcc/c++/clang), and CMake*
12-
| Libraries | Install Intel&reg; oneAPI Rendering Toolkit (Render Kit), including Embree
5+
## Versions
136

14-
| Objective | Description
15-
|:--- |:---
16-
| What you will learn | How to build and run a basic sample program using the Embree API from the Render Kit.
17-
| Time to complete | 5 minutes
7+
1. [CPU](./cpu/) - for Intel64 (x86-64) Host)
8+
- This version of the `minimal` program uses a C++11 (or C99) compiler to target the host processor.
9+
2. [GPU](./gpu/) - for Intel&reg; Arc&trade; hardware (Xe-HPG))
10+
- This `minimal_sycl` program uses Intel&reg; oneAPI DPC/C++ Compiler and SYCL* Runtimes to target the GPU.
1811

19-
## Purpose
20-
21-
This sample program, `minimal`, performs two ray to triangle intersect tests
22-
with the Intel&reg; Embree API. One test is successful, while the other test is
23-
a miss. Output is written to the console (stdout).
24-
25-
## Key Implementation Details
26-
27-
This source code is constructed to build with a C++ or a C compiler.
28-
29-
## Build and Run
30-
31-
### Windows
32-
33-
1. Run a new **x64 Native Tools Command Prompt for MSVS 2019**.
34-
35-
```
36-
call <path-to-oneapi-folder>\setvars.bat
37-
cd <path-to-oneAPI-samples>\RenderingToolkit\02_embree_gsg
38-
mkdir build
39-
cd build
40-
cmake ..
41-
cmake --build . --config Release
42-
cd Release
43-
minimal.exe
44-
```
45-
46-
2. Review the terminal output (stdout).
47-
48-
49-
### Linux and macOS
50-
51-
1. Start a new Terminal session.
52-
```
53-
source <path-to-oneapi-folder>/setvars.sh
54-
cd <path-to-oneAPI-samples>/RenderingToolkit/02_embree_gsg
55-
mkdir build
56-
cd build
57-
cmake ..
58-
cmake --build .
59-
./minimal
60-
```
61-
2. Review the terminal output (stdout).
6212

6313
## License
6414

6515
This code sample is licensed under the Apache 2.0 license. See
6616
[LICENSE.txt](LICENSE.txt) for details.
6717

6818
Third party program Licenses can be found here:
69-
[third-party-programs.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/third-party-programs.txt).
19+
[third-party-programs.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/third-party-programs.txt).

RenderingToolkit/GettingStarted/02_embree_gsg/CMakeLists.txt renamed to RenderingToolkit/GettingStarted/02_embree_gsg/cpu/CMakeLists.txt

+11-11
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,34 @@ cmake_minimum_required(VERSION 3.16)
22
project(EMBREE_GSG LANGUAGES CXX)
33

44
set(ONEAPI_ROOT "")
5-
if(DEFINED ENV{ONEAPI_ROOT})
5+
if (DEFINED ENV{ONEAPI_ROOT})
66
set(ONEAPI_ROOT "$ENV{ONEAPI_ROOT}")
77
message(STATUS "ONEAPI_ROOT FROM ENVIRONMENT: ${ONEAPI_ROOT}")
88
else()
9-
if(WIN32)
9+
if (WIN32)
1010
set(ONEAPI_ROOT "C:/Program Files (x86)/Intel/oneAPI")
1111
else()
1212
set(ONEAPI_ROOT /opt/intel/oneapi)
1313
endif()
1414
message(STATUS "ONEAPI_ROOT DEFAULT: ${ONEAPI_ROOT}")
1515
endif(DEFINED ENV{ONEAPI_ROOT})
1616

17-
find_package(embree 3.0 REQUIRED PATHS ${ONEAPI_ROOT})
17+
find_package(embree 4.0 REQUIRED PATHS ${ONEAPI_ROOT})
1818

19-
if(MSVC)
19+
if (MSVC)
2020
set(CMAKE_CXX_STANDARD 11)
2121
set(CMAKE_CXX_STANDARD_REQUIRED ON)
2222
set(CMAKE_CXX_EXTENSIONS OFF)
2323
else()
2424
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
2525
endif(MSVC)
2626

27-
include_directories(${EMBREE_INCLUDE_DIR} ${RKCOMMON_INCLUDE_DIRS})
28-
link_directories(${EMBREE_ROOT}/lib ${ONEAPI_ROOT}/rkcommon/latest/lib)
29-
27+
include_directories(${EMBREE_INCLUDE_DIR})
28+
link_directories(${EMBREE_ROOT}/lib)
3029
add_executable(minimal src/minimal.cpp)
31-
target_link_libraries(minimal PRIVATE embree rkcommon)
30+
target_link_libraries(minimal PRIVATE embree)
31+
if (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
32+
set(CMAKE_INSTALL_PREFIX "${PROJECT_SOURCE_DIR}" CACHE PATH "" FORCE)
33+
endif()
3234

33-
install(TARGETS minimal
34-
DESTINATION ${CMAKE_INSTALL_BINDIR}
35-
)
35+
install(TARGETS minimal RUNTIME DESTINATION bin/)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

0 commit comments

Comments
 (0)