Update incorrect documentation (#3608)

This commit is contained in:
Romain Guy
2021-03-03 14:42:47 -08:00
committed by GitHub
parent 30b0f39a36
commit 627186abc8
4 changed files with 10 additions and 10 deletions

View File

@@ -288,7 +288,7 @@ public class IndirectLight {
* range can be adjusted with this method.</p>
*
* @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 <i>lux</i>, or <i>lumen/m^2</i> (default = 30000)
*
* @return This Builder, for chaining calls.
*/
@@ -354,14 +354,14 @@ public class IndirectLight {
* range can be adjusted with this method.</p>
*
* @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 <i>lux</i>, or <i>lumen/m^2</i> (default = 30000)
*/
public void setIntensity(float intensity) {
nSetIntensity(getNativeObject(), intensity);
}
/**
* Returns the environment's intensity in cd/m<sup>2</sup>.
* Returns the environment's intensity in <i>lux</i>, or <i>lumen/m^2</i>.
*/
public float getIntensity() {
return nGetIntensity(getNativeObject());

View File

@@ -121,7 +121,7 @@ public class Skybox {
* its place.</p>
*
* @param envIntensity Scale factor applied to the skybox texel values such that
* the result is in cd/m<sup>2</sup> (lux) units (default = 30000)
* the result is in <i>lux</i>, or <i>lumen/m^2</i> (default = 30000)
*
* @return This Builder, for chaining calls.
*
@@ -237,7 +237,7 @@ public class Skybox {
}
/**
* Returns the <code>Skybox</code>'s intensity in cd/m<sup>2</sup>.
* Returns the <code>Skybox</code>'s intensity in <i>lux</i>, or <i>lumen/m^2</i>.
*/
public float getIntensity() { return nGetIntensity(getNativeObject()); }

View File

@@ -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 <i>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 <i>lux</i>, or <i>lumen/m^2</i>.
*/
float getIntensity() const noexcept;

View File

@@ -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;