Skip to content

Commit ecff444

Browse files
committed
Sync README, sort changelog
- fix Embree version check for HASHes in suyperbuild - fix "scheduled" CI workflow
1 parent 282d907 commit ecff444

File tree

5 files changed

+27
-36
lines changed

5 files changed

+27
-36
lines changed

.github/workflows/scheduled.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ jobs:
2323
secrets: inherit
2424
with:
2525
image: ospray/docker-images:arch
26-
level-zero-version: public/1.15.1 # for ispcrt
2726
cmd: |
2827
export CC=clang
2928
export CXX=clang++
@@ -34,7 +33,6 @@ jobs:
3433
secrets: inherit
3534
with:
3635
image: ospray/docker-images:arch
37-
level-zero-version: public/1.15.1 # for ispcrt
3836
cmd: |
3937
export CC=clang
4038
export CXX=clang++
@@ -57,7 +55,6 @@ jobs:
5755
secrets: inherit
5856
with:
5957
runs-on: '["build", "NAS", "mpi"]'
60-
level-zero-version: public/1.15.1 # for ispcrt
6158
cmd: |
6259
scripts\build\win.ps1 -G "Visual Studio 17 2022" -buildType Debug -DBUILD_OSPRAY_CI_EXTRAS=ON -DBUILD_ISPCRT_FROM_SOURCE=ON -DBUILD_EMBREE_FROM_SOURCE=ON -DBUILD_ISA_AVX512=OFF -DBUILD_OIDN=OFF -DBUILD_OSPRAY_MODULE_MPI=ON -DBUILD_OSPRAY_MODULE_MULTIDEVICE=ON
6360
artifact-out: build-windows-debug-all

CHANGELOG.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@ Version History
33

44
### Changes in v3.1.0:
55

6-
- Improve noise in reflections of ThisGlass
76
- Principled and Luminous materials support emissive textures
7+
- Add native support for disc and oriented disc geometry
8+
- Add support for mirror repeat and clamp to edge texture wrap modes
9+
- GPU device now also supports motion blur
10+
- Improve noise in reflections of ThinGlass
811
- Improve adaptive accumulation: working with GPU, fix correlations
912
- Fix indirectly seen albedo and normal buffer
10-
- Fix empty image on Windows when focusDistance=0
11-
- Fix missing SDK headers for `ISPCDevice*`
1213
- Fix artifacts when using specular texture for Principled
13-
- Add native support for disc and oriented disc geometry
1414
- Fixes for PixelFilter
1515
- Parameter was ignored (always using the default Gaussian)
1616
- Avoid a shift/misalignment within the pixel for first sample
17-
- GPU device now also supports motion blur
18-
- Add support for mirror repeat and clamp to edge texture wrap modes
17+
- Fix empty image on Windows when `focusDistance=0`
18+
- Fix missing SDK headers for `ISPCDevice*`
1919
- The new minimum versions of dependencies:
2020
- Embree v4.3.1
2121
- Open VKL v2.0.1
@@ -286,7 +286,7 @@ Version History
286286
Toolkit
287287
- OSPRay now requires minimum Open VKL v0.13.0 to bring the following
288288
improvements:
289-
- Support half precision float (fp16) voxel data in strutured
289+
- Support half precision float (fp16) voxel data in structured
290290
volumes (regular and spherical) and VDB volume
291291
- Supporting tricubic filtering via `VKL_FILTER_TRICUBIC` filter
292292
for VDB volume

README.md

Lines changed: 18 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
OSPRay
22
======
33

4-
This is release v3.1.0 (devel) of Intel® OSPRay. For changes and new
5-
features see the [changelog](CHANGELOG.md). Visit http://www.ospray.org
6-
for more information.
4+
This is release v3.1.0 of Intel® OSPRay. For changes and new features
5+
see the [changelog](CHANGELOG.md). Visit http://www.ospray.org for more
6+
information.
77

88
OSPRay Overview
99
===============
@@ -81,7 +81,7 @@ before you can build OSPRay you need the following prerequisites:
8181
Linux development tools.
8282

8383
- Additionally you require a copy of the [Intel® Implicit SPMD Program
84-
Compiler (ISPC)](http://ispc.github.io), version 1.21.1 or later.
84+
Compiler (ISPC)](http://ispc.github.io), version 1.23.0 or later.
8585
Please obtain a release of ISPC from the [ISPC downloads
8686
page](https://ispc.github.io/downloads.html). If ISPC is not found by
8787
CMake its location can be hinted with the variable `ispcrt_DIR`.
@@ -98,19 +98,19 @@ before you can build OSPRay you need the following prerequisites:
9898
variable `RKCOMMON_TASKING_SYSTEM` to `OpenMP` or `Internal`.
9999

100100
- OSPRay also heavily uses Intel [Embree](https://www.embree.org/),
101-
installing version 4.3.0 or newer is required. If Embree is not found
101+
installing version 4.3.1 or newer is required. If Embree is not found
102102
by CMake its location can be hinted with the variable `embree_DIR`.
103103

104104
- OSPRay supports volume rendering (enabled by default via
105105
`OSPRAY_ENABLE_VOLUMES`), which heavily uses Intel [Open
106-
VKL](https://www.openvkl.org/), version 2.0.0 or newer is required. If
106+
VKL](https://www.openvkl.org/), version 2.0.1 or newer is required. If
107107
Open VKL is not found by CMake its location can be hinted with the
108108
variable `openvkl_DIR`, or disable `OSPRAY_ENABLE_VOLUMES`.
109109

110110
- OSPRay also provides an optional module implementing the `denoiser`
111111
image operation, which is enabled by `OSPRAY_MODULE_DENOISER`. This
112112
module requires Intel [Open Image
113-
Denoise](https://openimagedenoise.github.io/) in version 2.1.0 or
113+
Denoise](https://openimagedenoise.github.io/) in version 2.2.0 or
114114
newer. You may need to hint the location of the library with the CMake
115115
variable `OpenImageDenoise_DIR`.
116116

@@ -159,7 +159,7 @@ version) and [Embree](https://github.com/embree/embree/releases/).
159159
To build OSPRay’s GPU module you need
160160

161161
- a SYCL compiler, either the open source [oneAPI DPC++ Compiler
162-
2023-09-22](https://github.com/intel/llvm/releases/tag/nightly-2023-09-22)
162+
2023-10-26](https://github.com/intel/llvm/releases/tag/nightly-2023-10-26)
163163
or the latest [Intel oneAPI DPC++/C++
164164
Compiler](https://www.intel.com/content/www/us/en/developer/articles/tool/oneapi-standalone-components.html#dpcpp-cpp)
165165
- a recent [CMake](http://www.cmake.org), version 3.25.3 or higher
@@ -340,18 +340,6 @@ CMake is easy:
340340
- You should now have `libospray.[so,dylib]` as well as a set of
341341
[example applications](#tutorials).
342342

343-
### Entitlements on Mac OS X
344-
345-
Mac OS X requires notarization of applications as a security mechanism,
346-
and [entitlements must be
347-
declared](https://developer.apple.com/documentation/bundleresources/entitlements)
348-
during the notarization process. OSPRay’s `denoiser` uses OIDN, which
349-
uses just-in-time compilation through
350-
[oneDNN](https://github.com/oneapi-src/oneDNN) and thus requires the
351-
following entitlement:
352-
353-
- [`com.apple.security.cs.allow-jit`](https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_security_cs_allow-jit)
354-
355343
### Compiling OSPRay on Windows
356344

357345
On Windows using the CMake GUI (`cmake-gui.exe`) is the most convenient
@@ -433,9 +421,9 @@ Documentation
433421
=============
434422

435423
The following [API
436-
documentation](https://www.ospray.org/OSPRay_readme_devel.pdf "OSPRay Documentation")
424+
documentation](https://www.ospray.org/OSPRay_readme.pdf "OSPRay Documentation")
437425
of OSPRay can also be found as a [pdf
438-
document](https://www.ospray.org/OSPRay_readme_devel.pdf "OSPRay Documentation").
426+
document](https://www.ospray.org/OSPRay_readme.pdf "OSPRay Documentation").
439427

440428
For a deeper explanation of the concepts, design, features and
441429
performance of OSPRay also have a look at the IEEE Vis 2016 paper
@@ -1941,7 +1929,8 @@ like an environment map).
19411929

19421930
The [path tracer](#path-tracer) will consider illumination by
19431931
[geometries](#geometries) which have a light emitting material assigned
1944-
(for example the [Luminous](#luminous) material).
1932+
(for example the [Luminous](#luminous) or [Principled](#principled)
1933+
material).
19451934

19461935
Materials
19471936
---------
@@ -2101,6 +2090,7 @@ table below.
21012090
| float | sheenTint | 0 | how much sheen is tinted from sheenColor toward baseColor |
21022091
| float | sheenRoughness | 0.2 | sheen roughness in \[0–1\], 0 is perfectly smooth |
21032092
| float | opacity | 1 | cut-out opacity/transparency, 1 is fully opaque |
2093+
| vec3f | emissiveColor | black | color (and intensity) of the emitted light |
21042094

21052095
Parameters of the Principled material.
21062096

@@ -2390,6 +2380,10 @@ because it is always `OSP_INTENSITY_QUANTITY_RADIANCE`).
23902380

23912381
Parameters accepted by the Luminous material.
23922382

2383+
The emission can be textured by passing a `map_color`
2384+
[texture](#texture) handle, [texture
2385+
transformations](#texture-transformations) are supported as well.
2386+
23932387
<figure>
23942388
<img src="https://ospray.github.io/images/material_Luminous.jpg"
23952389
style="width:60.0%" alt="Rendering of a yellow Luminous material." />
@@ -3135,7 +3129,7 @@ additional project dependency at compile time. The module implements a
31353129
“`denoiser`” frame operation, which denoises the entire frame before the
31363130
frame is completed. OIDN will automatically select the fastest device,
31373131
using a GPU when available. The device selection be overridden by the
3138-
environment valiable `OIDN_DEFAULT_DEVICE`, possible values are `cpu`,
3132+
environment variable `OIDN_DEFAULT_DEVICE`, possible values are `cpu`,
31393133
`sycl`, `cuda`, `hip`, or a physical device ID
31403134
31413135
Rendering

doc/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3076,7 +3076,7 @@ additional project dependency at compile time. The module implements a
30763076
"`denoiser`" frame operation, which denoises the entire frame before the
30773077
frame is completed. OIDN will automatically select the fastest device,
30783078
using a GPU when available. The device selection be overridden by the
3079-
environment valiable `OIDN_DEFAULT_DEVICE`, possible values are `cpu`,
3079+
environment variable `OIDN_DEFAULT_DEVICE`, possible values are `cpu`,
30803080
`sycl`, `cuda`, `hip`, or a physical device ID
30813081

30823082

scripts/superbuild/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ endif()
130130

131131
option(BUILD_EMBREE_FROM_SOURCE "Build Embree or use pre-built version?" OFF)
132132
set(EMBREE_VERSION "4.3.1" CACHE STRING "Which version of Embree to build?")
133-
if (EMBREE_VERSION STREQUAL "4.3.0")
133+
if (EMBREE_VERSION STREQUAL "4.3.1")
134134
if (BUILD_EMBREE_FROM_SOURCE)
135135
set(EMBREE_HASH "bdab87b285efa1a9f1f57fe74b2743c659c487fee7e32221db43a6b8f5e36e5f")
136136
else()

0 commit comments

Comments
 (0)