From 927c66102f0c4feafdfc38472ef4e1b575dd6afb Mon Sep 17 00:00:00 2001 From: Sebastian Herholz Date: Thu, 24 Mar 2022 08:46:09 +0100 Subject: [PATCH] [doc] Added disclaimer to the doc --- README.md | 6 ++++++ doc/Makefile | 2 +- doc/disclaimer.md | 4 ++++ openpgl/field/Field.h | 4 ++++ 4 files changed, 15 insertions(+), 1 deletion(-) create mode 100644 doc/disclaimer.md diff --git a/README.md b/README.md index 02ed96d..60a62a9 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,12 @@ license](http://www.apache.org/licenses/LICENSE-2.0). | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | Path traced image of a variation of the Nishita Sky Demo scene from Blender Studio (CC0) without and with using Open PGL to guide directional samples (i.e., on surfaces and inside the water volume). | +# Disclaimer + +The current version of Open PGL is still in a beta stage and should be +used with caution in any production related environment. The API +specification is still in flux and might change with upcoming releases. + # Version History ## Open PGL 0.3.0 diff --git a/doc/Makefile b/doc/Makefile index 3da769b..feb48a9 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -43,7 +43,7 @@ tmpdir: ## Markdown ## ---------------------------------------------------------------------------- -../README.md: tmp/readme_head.md overview.md examples.md changelog.md support.md compilation.md tmp/including.md api.md related_projects.md +../README.md: tmp/readme_head.md overview.md examples.md disclaimer.md changelog.md support.md compilation.md tmp/including.md api.md related_projects.md $(PANDOC) $+ -t gfm > $@ ## ---------------------------------------------------------------------------- diff --git a/doc/disclaimer.md b/doc/disclaimer.md new file mode 100644 index 0000000..49cb2fb --- /dev/null +++ b/doc/disclaimer.md @@ -0,0 +1,4 @@ +Disclaimer +=============== + +The current version of Open PGL is still in a beta stage and should be used with caution in any production related environment. The API specification is still in flux and might change with upcoming releases. diff --git a/openpgl/field/Field.h b/openpgl/field/Field.h index 962a369..da39cd5 100644 --- a/openpgl/field/Field.h +++ b/openpgl/field/Field.h @@ -305,7 +305,9 @@ struct Field inline void fitRegions(SampleContainer& samples) { size_t nGuidingRegions = m_regionStorageContainer.size(); +#if defined( OPENPGL_SHOW_PRINT_OUTS) std::cout << "fitRegion: "<< (m_isSurface? "surface":"volume") << "\tnGuidingRegions = " << nGuidingRegions << std::endl; +#endif #if defined(OPENPGL_USE_OMP_THREADING) #pragma omp parallel for num_threads(this->m_nCores) schedule(dynamic) for (size_t n=0; n < nGuidingRegions; n++) @@ -353,7 +355,9 @@ struct Field void updateRegions(SampleContainer& samples) { size_t nGuidingRegions = m_regionStorageContainer.size(); +#if defined( OPENPGL_SHOW_PRINT_OUTS) std::cout << "updateRegion: " << (m_isSurface? "surface":"volume") << "\tnGuidingRegions = " << nGuidingRegions << std::endl; +#endif #if defined(OPENPGL_USE_OMP_THREADING) #pragma omp parallel for num_threads(this->m_nCores) schedule(dynamic) for (size_t n=0; n < nGuidingRegions; n++)