Skip to content

Commit

Permalink
documentation wording clarification
Browse files Browse the repository at this point in the history
  • Loading branch information
lukemckinstry committed Sep 26, 2024
1 parent 54ab092 commit 797ebb2
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions packages/engine/Source/Scene/FrameRateMonitor.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ function FrameRateMonitor(options) {
this._scene = options.scene;

/**
* Gets or sets the length of the sliding window over which to compute the average frame rate, in seconds.
* Gets or sets the length of the sliding window over which to compute the average frame rate, in seconds, for the
* purpose of calculating if the frame rate is lower or higher than the minimum frame rate threshold.
* @type {number}
*/
this.samplingWindow = defaultValue(
Expand All @@ -51,7 +52,8 @@ function FrameRateMonitor(options) {
);

/**
* Gets or sets the length of the sliding window over which to compute the average frame rate, in seconds.
* Gets or sets the length of the sliding window over which to compute the average frame rate, in number of frame,
* for the purpose of calculating and displaying <code>averageFramesPerSecond</code>.
* @type {number}
*/
this.averageFrameRateWindow = defaultValue(
Expand Down

0 comments on commit 797ebb2

Please sign in to comment.