Skip to content

Commit eb52d7e

Browse files
MichaelRoyceCarrollJoeOsterericlars
authored
Rendering toolkit embree code sample PR (#710)
* ONSAM-1414 Broken Link in Headers (#685) * Update Makefile * Update Makefile * Update Makefile * Update DCT.hpp * Update intrin_ftz_sample.cpp * Update merge_sort.cpp * Update intrin_double_sample.cpp * Update intrin_dot_sample.cpp * Update DCT.cpp * fix deprecation notice (#682) * initial commit for RenderingToolkit GSG sample proposal * signed inital commit for RenderingToolkit GSG intro samples Signed-off-by: Michael R Carroll <[email protected]> * Added generated GUIDS to .repo-tools/Docs_Automation/guids.json (signed commit) Signed-off-by: Michael R Carroll <[email protected]> * Update README.md Moving README.md content to individual folders * Order samples folders Signed-off-by: Michael R Carroll <[email protected]> * Update README.md * Adding per sample component README.md files Signed-off-by: Michael R Carroll <[email protected]> * Update README.md * Adding percomponent LICENSE placeholder files (to be reviewed) Signed-off-by: Michael R Carroll <[email protected]> * Adding converted .pfm input file. This file could help users if they get stuck. It is not too big. Signed-off-by: Michael R Carroll <[email protected]> * Updating sample.json files per Joseph Oster guidance Signed-off-by: Michael R Carroll <[email protected]> * Updates to oidn README.md for linux and macos Signed-off-by: Michael R Carroll <[email protected]> * Update README for library requirements Signed-off-by: Michael R Carroll <[email protected]> * New branch for just embree sample Signed-off-by: Michael R Carroll <[email protected]> * Add description to base README.md Signed-off-by: Michael R Carroll <[email protected]> * removing overlapping content. overlap to RenderingToolkit-ospray branch Signed-off-by: Michael R Carroll <[email protected]> * Updates for embree README.md Signed-off-by: Michael R Carroll <[email protected]> * Updates for the embree README.md (editorial) Signed-off-by: Michael R Carroll <[email protected]> * clang-format for source Signed-off-by: Michael R Carroll <[email protected]> * Escape extra quotes for CI and get the correct minimal.exe in sample.json Signed-off-by: Michael R Carroll <[email protected]> * Should be no Release folder for sample.json on macos or lin. It has been removed Signed-off-by: Michael R Carroll <[email protected]> * Escape for accurate exe invoke Signed-off-by: Michael R Carroll <[email protected]> * Updates for CMakeLists.txt and sample.json to be more adaptable for CI and public build Signed-off-by: Michael R Carroll <[email protected]> * Update some errors in embree README.md Signed-off-by: Michael R Carroll <[email protected]> * Moving file heirarchy to RenderingToolkit/GettingStarted Signed-off-by: Michael R Carroll <[email protected]> * CMakeLists change for variable consistency Signed-off-by: Michael R Carroll <[email protected]> * Update sample.json * Update sample.json for DYLD_LIBRARY_PATH CI workaround * CMakeLists health updates Signed-off-by: Michael R Carroll <[email protected]> Co-authored-by: JoeOster <[email protected]> Co-authored-by: ericlars <[email protected]>
1 parent c11a355 commit eb52d7e

File tree

5 files changed

+619
-0
lines changed

5 files changed

+619
-0
lines changed

‎RenderingToolkit/GettingStarted/02_embree_gsg/CMakeLists.txt

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
cmake_minimum_required(VERSION 3.16)
2+
project(EMBREE_GSG LANGUAGES CXX)
3+
4+
set(ONEAPI_ROOT "")
5+
if(DEFINED ENV{ONEAPI_ROOT})
6+
set(ONEAPI_ROOT "$ENV{ONEAPI_ROOT}")
7+
message(STATUS "ONEAPI_ROOT FROM ENVIRONMENT: ${ONEAPI_ROOT}")
8+
else()
9+
if(WIN32)
10+
set(ONEAPI_ROOT "C:/Program Files (x86)/Intel/oneAPI")
11+
else()
12+
set(ONEAPI_ROOT /opt/intel/oneapi)
13+
endif()
14+
message(STATUS "ONEAPI_ROOT DEFAULT: ${ONEAPI_ROOT}")
15+
endif(DEFINED ENV{ONEAPI_ROOT})
16+
17+
find_package(embree 3.0 REQUIRED PATHS ${ONEAPI_ROOT})
18+
19+
if(MSVC)
20+
set(CMAKE_CXX_STANDARD 11)
21+
set(CMAKE_CXX_STANDARD_REQUIRED ON)
22+
set(CMAKE_CXX_EXTENSIONS OFF)
23+
else()
24+
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
25+
endif(MSVC)
26+
27+
include_directories(${EMBREE_INCLUDE_DIR} ${RKCOMMON_INCLUDE_DIRS})
28+
link_directories(${EMBREE_ROOT}/lib ${ONEAPI_ROOT}/rkcommon/latest/lib)
29+
30+
add_executable(minimal src/minimal.cpp)
31+
target_link_libraries(minimal PRIVATE embree rkcommon)
32+
33+
install(TARGETS minimal
34+
DESTINATION ${CMAKE_INSTALL_BINDIR}
35+
)

‎RenderingToolkit/GettingStarted/02_embree_gsg/LICENSE.txt

Lines changed: 202 additions & 0 deletions
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.

‎RenderingToolkit/GettingStarted/02_embree_gsg/README.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Getting Started Sample for Intel oneAPI Rendering Toolkit: Intel Embree
2+
3+
Embree is a collection of high-performance ray tracing kernels. Improve performance of photo-realistic rendering applications by using performance optimized ray-tracing kernels.
4+
5+
| Minimum Requirements | Description
6+
|:--- |:---
7+
| OS | Linux* Ubuntu* 18.04, CentOS 8 (or compatible); Windows 10; MacOS 10.15+
8+
| Hardware | Intel 64 Penryn or newer with SSE4.1 extensions; ARM64 with NEON extensions
9+
| Compiler Toolchain | Windows* OS: MSVS 2019 with Windows* SDK and CMake*; Other platforms: C++11 compiler, a C99 compiler (ex: gcc/c++/clang), and CMake*
10+
| Libraries | Install Intel oneAPI Rendering Toolkit including Embree
11+
12+
| Optimized Requirements | Description
13+
| :--- | :---
14+
| Hardware | Intel 64 Skylake or newer with AVX512 extentions, ARM64 with NEON extensions
15+
16+
| Objective | Description
17+
|:--- |:---
18+
| What you will learn | How to build and run a basic sample program using the Embree API from the Render Kit.
19+
| Time to complete | 5 minutes
20+
21+
## Purpose
22+
23+
This sample program, `minimal`, performs two ray to triangle intersect tests with the Embree API. One test is successful, while the other test is 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+
## License
30+
31+
This code sample is licensed under the Apache 2.0 license. See
32+
[LICENSE.txt](LICENSE.txt) for details.
33+
34+
Third party program Licenses can be found here: [third-party-programs.txt](https://github.com/oneapi-src/oneAPI-samples/blob/master/third-party-programs.txt)
35+
36+
## Build and Run
37+
38+
### Windows OS:
39+
40+
Run a new **x64 Native Tools Command Prompt for MSVS 2019**
41+
42+
```
43+
call <path-to-oneapi-folder>\setvars.bat
44+
cd <path-to-oneAPI-samples>\RenderingToolkit\02_embree_gsg
45+
mkdir build
46+
cd build
47+
cmake ..
48+
cmake --build . --config Release
49+
cd Release
50+
minimal.exe
51+
```
52+
53+
Review the terminal output (stdout)
54+
55+
56+
### Linux OS:
57+
58+
Start a new Terminal session
59+
```
60+
source <path-to-oneapi-folder>/setvars.sh
61+
cd <path-to-oneAPI-samples>/RenderingToolkit/02_embree_gsg
62+
mkdir build
63+
cd build
64+
cmake ..
65+
cmake --build .
66+
./minimal
67+
```
68+
69+
Review the terminal output (stdout)
70+
71+
72+
### MacOS:
73+
74+
Start a new Terminal session
75+
76+
```
77+
source <path-to-oneapi-folder>/setvars.sh
78+
cd <path-to-oneAPI-samples>/RenderingToolkit/02_embree_gsg
79+
mkdir build
80+
cd build
81+
cmake ..
82+
cmake --build .
83+
./minimal
84+
```
85+
86+
Review the terminal output (stdout)

‎RenderingToolkit/GettingStarted/02_embree_gsg/sample.json

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
{
2+
"guid": "87FA013D-0B19-45AE-BCD5-43412BE0A99F",
3+
"name": "Intel Embree Getting Started",
4+
"categories": ["Toolkit/oneAPI Libraries/Embree"],
5+
"description": "This introductory hello rendering toolkit sample illustrates how to cast a ray into a scene with Intel Embree",
6+
"builder": ["cli"],
7+
"languages": [{"cpp":{}}],
8+
"dependencies": ["tbb","rkcommon"],
9+
"os":["linux", "windows", "darwin"],
10+
"targetDevice": ["CPU"],
11+
"ciTests": {
12+
"linux": [
13+
{
14+
"id": "Intel_Embree_minimal_lin",
15+
"steps": [
16+
"mkdir build",
17+
"cd build",
18+
"cmake ..",
19+
"cmake --build . ",
20+
"./minimal"
21+
]
22+
}
23+
],
24+
"windows":[
25+
{
26+
"env": ["call \"C:\\Program Files (x86)\\Intel\\oneAPI\\setvars.bat\""],
27+
"id": "Intel_Embree_minimal_win",
28+
"steps":[
29+
"mkdir build",
30+
"cd build",
31+
"cmake -G\"Visual Studio 16 2019\" -A x64 -DCMAKE_PREFIX_PATH=\"C:/Program Files (x86)/Intel/oneAPI\" ..",
32+
"cmake --build . --config Release",
33+
"cd Release",
34+
".\\minimal.exe"
35+
]
36+
37+
}
38+
],
39+
"darwin": [
40+
{
41+
"id": "Intel_Embree_minimal_mac",
42+
"steps": [
43+
"mkdir build",
44+
"cd build",
45+
"cmake ..",
46+
"cmake --build . ",
47+
"export DYLD_LIBRARY_PATH=${LIBRARY_PATH} && ./minimal"
48+
]
49+
}
50+
]
51+
52+
53+
}
54+
}

0 commit comments

Comments
 (0)