From 25f8a23ef93f07fca33b4298ed81132369bc78b1 Mon Sep 17 00:00:00 2001
From: Lukas Werner <lks.werner@fau.de>
Date: Thu, 22 Mar 2018 16:34:28 +0100
Subject: [PATCH] Documentation for ShadingParameters functions
---
src/pe/raytracing/ShadingParameters.h | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/src/pe/raytracing/ShadingParameters.h b/src/pe/raytracing/ShadingParameters.h
index c833f5f92..7d0930379 100644
--- a/src/pe/raytracing/ShadingParameters.h
+++ b/src/pe/raytracing/ShadingParameters.h
@@ -63,12 +63,17 @@ struct ShadingParameters {
shininess = config.getParameter<real_t>("shininess");
}
+ /*!\brief Makes a rendered object shiny by setting the shininess and adjusting the specularColor.
+ * \param _shininess Shininess
+ */
ShadingParameters& makeGlossy(real_t _shininess = 30) {
shininess = _shininess;
specularColor.set(real_t(1), real_t(1), real_t(1));
return *this;
}
+ /*!\brief Makes the rendered object matte by setting the shininess attribute to zero and adjusting the specularColor.
+ */
ShadingParameters& makeMatte() {
shininess = 0;
specularColor.set(real_t(0.1), real_t(0.1), real_t(0.1));
--
GitLab