Improved docs for the physical camera properties (#7680)

mvaligursky · Martin Valigursky · web-flow · commit fe79efe38e49 · 2025-05-19T15:10:46.000+01:00
Co-authored-by: Martin Valigursky &lt;mvaligursky@snapchat.com&gt;
diff --git a/src/framework/components/camera/component.js b/src/framework/components/camera/component.js
@@ -301,7 +301,8 @@ class CameraComponent extends Component {
     }
 
     /**
-     * Sets the camera aperture in f-stops. Default is 16. Higher value means less exposure.
+     * Sets the camera aperture in f-stops. Default is 16. Higher value means less exposure. Used
+     * if {@link Scene#physicalUnits} is true.
      *
      * @type {number}
      */
@@ -910,7 +911,8 @@ class CameraComponent extends Component {
     }
 
     /**
-     * Sets the camera sensitivity in ISO. Defaults to 1000. Higher value means more exposure.
+     * Sets the camera sensitivity in ISO. Defaults to 1000. Higher value means more exposure. Used
+     * if {@link Scene#physicalUnits} is true.
      *
      * @type {number}
      */
@@ -928,7 +930,8 @@ class CameraComponent extends Component {
     }
 
     /**
-     * Sets the camera shutter speed in seconds. Defaults to 1/1000s. Longer shutter means more exposure.
+     * Sets the camera shutter speed in seconds. Defaults to 1/1000s. Longer shutter means more
+     * exposure. Used if {@link Scene#physicalUnits} is true.
      *
      * @type {number}
      */

Original file line number	Diff line number	Diff line change
`@@ -301,7 +301,8 @@ class CameraComponent extends Component {`
`301`	`301`	`}`
`302`	`302`
`303`	`303`	`/**`
`304`		`- * Sets the camera aperture in f-stops. Default is 16. Higher value means less exposure.`
	`304`	`+ * Sets the camera aperture in f-stops. Default is 16. Higher value means less exposure. Used`
	`305`	`+ * if {@link Scene#physicalUnits} is true.`
`305`	`306`	`*`
`306`	`307`	`* @type {number}`
`307`	`308`	`*/`
`@@ -910,7 +911,8 @@ class CameraComponent extends Component {`
`910`	`911`	`}`
`911`	`912`
`912`	`913`	`/**`
`913`		`- * Sets the camera sensitivity in ISO. Defaults to 1000. Higher value means more exposure.`
	`914`	`+ * Sets the camera sensitivity in ISO. Defaults to 1000. Higher value means more exposure. Used`
	`915`	`+ * if {@link Scene#physicalUnits} is true.`
`914`	`916`	`*`
`915`	`917`	`* @type {number}`
`916`	`918`	`*/`
`@@ -928,7 +930,8 @@ class CameraComponent extends Component {`
`928`	`930`	`}`
`929`	`931`
`930`	`932`	`/**`
`931`		`- * Sets the camera shutter speed in seconds. Defaults to 1/1000s. Longer shutter means more exposure.`
	`933`	`+ * Sets the camera shutter speed in seconds. Defaults to 1/1000s. Longer shutter means more`
	`934`	`+ * exposure. Used if {@link Scene#physicalUnits} is true.`
`932`	`935`	`*`
`933`	`936`	`* @type {number}`
`934`	`937`	`*/`