From 627186abc8cec01cf7099706d023d079e168fd4e Mon Sep 17 00:00:00 2001 From: Romain Guy Date: Wed, 3 Mar 2021 14:42:47 -0800 Subject: [PATCH] Update incorrect documentation (#3608) --- .../java/com/google/android/filament/IndirectLight.java | 6 +++--- .../src/main/java/com/google/android/filament/Skybox.java | 4 ++-- filament/include/filament/IndirectLight.h | 6 +++--- filament/include/filament/Skybox.h | 4 ++-- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/android/filament-android/src/main/java/com/google/android/filament/IndirectLight.java b/android/filament-android/src/main/java/com/google/android/filament/IndirectLight.java index 2fbfe49cce..1bfed49a51 100644 --- a/android/filament-android/src/main/java/com/google/android/filament/IndirectLight.java +++ b/android/filament-android/src/main/java/com/google/android/filament/IndirectLight.java @@ -288,7 +288,7 @@ public class IndirectLight { * range can be adjusted with this method.

* * @param envIntensity Scale factor applied to the environment and irradiance such that - * the result is in cd/m^2 (lux) units (default = 30000) + * the result is in lux, or lumen/m^2 (default = 30000) * * @return This Builder, for chaining calls. */ @@ -354,14 +354,14 @@ public class IndirectLight { * range can be adjusted with this method.

* * @param intensity Scale factor applied to the environment and irradiance such that - * the result is in cd/m^2 units (default = 30000) + * the result is in lux, or lumen/m^2 (default = 30000) */ public void setIntensity(float intensity) { nSetIntensity(getNativeObject(), intensity); } /** - * Returns the environment's intensity in cd/m2. + * Returns the environment's intensity in lux, or lumen/m^2. */ public float getIntensity() { return nGetIntensity(getNativeObject()); diff --git a/android/filament-android/src/main/java/com/google/android/filament/Skybox.java b/android/filament-android/src/main/java/com/google/android/filament/Skybox.java index 2fd1d0f7f5..d418234420 100644 --- a/android/filament-android/src/main/java/com/google/android/filament/Skybox.java +++ b/android/filament-android/src/main/java/com/google/android/filament/Skybox.java @@ -121,7 +121,7 @@ public class Skybox { * its place.

* * @param envIntensity Scale factor applied to the skybox texel values such that - * the result is in cd/m2 (lux) units (default = 30000) + * the result is in lux, or lumen/m^2 (default = 30000) * * @return This Builder, for chaining calls. * @@ -237,7 +237,7 @@ public class Skybox { } /** - * Returns the Skybox's intensity in cd/m2. + * Returns the Skybox's intensity in lux, or lumen/m^2. */ public float getIntensity() { return nGetIntensity(getNativeObject()); } diff --git a/filament/include/filament/IndirectLight.h b/filament/include/filament/IndirectLight.h index 8c9ab31d3e..166dcc2bb6 100644 --- a/filament/include/filament/IndirectLight.h +++ b/filament/include/filament/IndirectLight.h @@ -220,7 +220,7 @@ public: * range can be adjusted with this method. * * @param envIntensity Scale factor applied to the environment and irradiance such that - * the result is in cd/m^2 (lux) units (default = 30000) + * the result is in lux, or lumen/m^2 (default = 30000) * * @return This Builder, for chaining calls. */ @@ -260,12 +260,12 @@ public: * range can be adjusted with this method. * * @param intensity Scale factor applied to the environment and irradiance such that - * the result is in cd/m^2 units (default = 30000) + * the result is in lux, or lumen/m^2(default = 30000) */ void setIntensity(float intensity) noexcept; /** - * Returns the environment's intensity in cd/m^2. + * Returns the environment's intensity in lux, or lumen/m^2. */ float getIntensity() const noexcept; diff --git a/filament/include/filament/Skybox.h b/filament/include/filament/Skybox.h index 4a0b919379..6279e493de 100644 --- a/filament/include/filament/Skybox.h +++ b/filament/include/filament/Skybox.h @@ -112,7 +112,7 @@ public: * * * @param envIntensity Scale factor applied to the skybox texel values such that - * the result is in cd/m^2 (lux) units (default = 30000) + * the result is in lux, or lumen/m^2 (default = 30000) * * @return This Builder, for chaining calls. * @@ -167,7 +167,7 @@ public: uint8_t getLayerMask() const noexcept; /** - * Returns the skybox's intensity in cd/m^2. + * Returns the skybox's intensity in lux, or lumen/m^2. */ float getIntensity() const noexcept;