Docs: Improve light pages. (#491)

three-types · Jun 30, 2023 · 071b6ac · 071b6ac
1 parent de3164c
commit 071b6ac
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 11 deletions.
diff --git a/types/three/src/lights/Light.d.ts b/types/three/src/lights/Light.d.ts
@@ -38,7 +38,7 @@ export abstract class Light<TShadowSupport extends LightShadow | undefined = Lig
 
     /**
      * The light's intensity, or strength.
-     * In {@link THREE.WebGLRenderer.physicallyCorrectLights | physically correct} mode, the units of intensity depend on the type of light.
+     * When {@link THREE.WebGLRenderer.useLegacyLights | legacy lighting mode} is disabled, the units of intensity depend on the type of light.
      * @remarks Expects a `Float`
      * @defaultValue `1`
      */

diff --git a/types/three/src/lights/PointLight.d.ts b/types/three/src/lights/PointLight.d.ts
@@ -37,7 +37,7 @@ export class PointLight extends Light<PointLightShadow> {
     /**
      * The light's intensity.
      *
-     * When **{@link WebGLRenderer.physicallyCorrectLights | physically correct} mode** — intensity is the luminous intensity of the light measured in candela (cd).
+     * When **{@link WebGLRenderer.useLegacyLights | legacy lighting mode} is disabled** — intensity is the luminous intensity of the light measured in candela (cd).
      * @remarks Changing the intensity will also change the light's power.
      * @remarks Expects a `Float`
      * @defaultValue `1`
@@ -48,7 +48,7 @@ export class PointLight extends Light<PointLightShadow> {
      * When **Default mode** — When distance is zero, light does not attenuate. When distance is non-zero,
      * light will attenuate linearly from maximum intensity at the light's position down to zero at this distance from the light.
      *
-     * When **{@link WebGLRenderer.physicallyCorrectLights | Physically correct} rendering mode** — When distance is zero,
+     * When **{@link WebGLRenderer.useLegacyLights | legacy lighting mode} is disabled** — When distance is zero,
      * light will attenuate according to inverse-square law to infinite distance.
      * When distance is non-zero, light will attenuate according to inverse-square law until near the distance cutoff,
      * where it will then attenuate quickly and smoothly to 0. Inherently, cutoffs are not physically correct.
@@ -68,7 +68,7 @@ export class PointLight extends Light<PointLightShadow> {
 
     /**
      * The amount the light dims along the distance of the light.
-     * In **{@link WebGLRenderer.physicallyCorrectLights | physically correct} rendering mode** — the default value **should not** be changed.
+     * In context of physically-correct rendering the default value should not be changed.
      * @remarks Expects a `Float`
      * @defaultValue `2`
      */
@@ -87,7 +87,7 @@ export class PointLight extends Light<PointLightShadow> {
 
     /**
      * The light's power.
-     * When **{@link WebGLRenderer.physicallyCorrectLights | physically correct} rendering mode** — power is the luminous power of the light measured in lumens (lm).
+     * When **{@link WebGLRenderer.useLegacyLights | legacy lighting mode} is disabled** — power is the luminous power of the light measured in lumens (lm).
      * @remarks Changing the power will also change the light's intensity.
      * @remarks Expects a `Float`
      */

diff --git a/types/three/src/lights/RectAreaLight.d.ts b/types/three/src/lights/RectAreaLight.d.ts
@@ -66,7 +66,7 @@ export class RectAreaLight extends Light<undefined> {
     /**
      * The light's intensity.
      * @remarks Changing the intensity will also change the light's power.
-     * In **{@link WebGLRenderer.physicallyCorrectLights | physically correct} rendering mode** — intensity is the luminance (brightness) of the light measured in nits (cd/m^2).
+     * When **{@link WebGLRenderer.useLegacyLights | legacy lighting mode} is disabled** — intensity is the luminance (brightness) of the light measured in nits (cd/m^2).
      * @remarks Expects a `Float`
      * @defaultValue `1`
      */
@@ -75,7 +75,7 @@ export class RectAreaLight extends Light<undefined> {
     /**
      * The light's power.
      * @remarks Changing the power will also change the light's intensity.
-     * In **{@link WebGLRenderer.physicallyCorrectLights | physically correct} rendering mode** — power is the luminous power of the light measured in lumens (lm).
+     * When **{@link WebGLRenderer.useLegacyLights | legacy lighting mode} is disabled** — power is the luminous power of the light measured in lumens (lm).
      * @remarks Expects a `Float`
      */
     power: number;

diff --git a/types/three/src/lights/SpotLight.d.ts b/types/three/src/lights/SpotLight.d.ts
@@ -97,7 +97,7 @@ export class SpotLight extends Light<SpotLightShadow> {
     /**
      * The light's intensity.
      * @remarks Changing the intensity will also change the light's power.
-     * When **{@link WebGLRenderer.physicallyCorrectLights | Physically correct} rendering mode** — intensity is the luminous intensity of the light measured in candela (cd).
+     * When **{@link WebGLRenderer.useLegacyLights | legacy lighting mode} is disabled** — intensity is the luminous intensity of the light measured in candela (cd).
      * @remarks Expects a `Float`
      * @defaultValue `1`
      */
@@ -107,7 +107,7 @@ export class SpotLight extends Light<SpotLightShadow> {
      * When **Default mode** — When distance is zero, light does not attenuate. When distance is non-zero,
      * light will attenuate linearly from maximum intensity at the light's position down to zero at this distance from the light.
      *
-     * When **{@link WebGLRenderer.physicallyCorrectLights | Physically correct} rendering mode** — When distance is zero,
+     * When **{@link WebGLRenderer.useLegacyLights | legacy lighting mode} is disabled** — When distance is zero,
      * light will attenuate according to inverse-square law to infinite distance.
      * When distance is non-zero, light will attenuate according to inverse-square law until near the distance cutoff,
      * where it will then attenuate quickly and smoothly to `0`. Inherently, cutoffs are not physically correct.
@@ -126,7 +126,7 @@ export class SpotLight extends Light<SpotLightShadow> {
 
     /**
      * The amount the light dims along the distance of the light.
-     * In **{@link WebGLRenderer.physicallyCorrectLights | physically correct} rendering mode** — the default value should not be changed.
+     * In context of physically-correct rendering the default value should not be changed.
      * @remarks Expects a `Float`
      * @defaultValue `2`
      */
@@ -141,7 +141,7 @@ export class SpotLight extends Light<SpotLightShadow> {
     /**
      * The light's power.
      * @remarks Changing the power will also change the light's intensity.
-     * In **{@link WebGLRenderer.physicallyCorrectLights | physically correct} rendering mode** —  power is the luminous power of the light measured in lumens (lm).
+     * When **{@link WebGLRenderer.useLegacyLights | legacy lighting mode} is disabled** —  power is the luminous power of the light measured in lumens (lm).
      * @remarks Expects a `Float`
      */
     power: number;