FrameRateMonitor
Monitors the frame rate (frames per second) in a Scene and raises an event if the frame rate is lower than a threshold. Later, if the frame rate returns to the required level, a separate event is raised. To avoid creating multiple FrameRateMonitors for a single Scene, use FrameRateMonitor.fromScene instead of constructing an instance explicitly.
See also
Properties
Gets the most recently computed average frames-per-second over the last samplingWindow. This property may be undefined if the frame rate has not been computed.
Gets the event that is raised when a low frame rate is detected. The function will be passed the Scene instance as its first parameter and the average number of frames per second over the sampling window as its second parameter.
Gets or sets the minimum frames-per-second that are required for acceptable performance after the end of the warmup period. If the frame rate averages less than this during any samplingWindow after the warmupPeriod, the lowFrameRate event will be raised and the page will redirect to the redirectOnLowFrameRateUrl, if any.
Gets or sets the minimum frames-per-second that are required for acceptable performance during the warmup period. If the frame rate averages less than this during any samplingWindow during the warmupPeriod, the lowFrameRate event will be raised and the page will redirect to the redirectOnLowFrameRateUrl, if any.
Gets the event that is raised when the frame rate returns to a normal level after having been low. The function will be passed the Scene instance as its first parameter and the average number of frames per second over the sampling window as its second parameter.
Gets or sets the length of time to wait at startup and each time the page becomes visible (i.e. when the user switches back to the tab) before starting to measure performance, in seconds.
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 warmup period, in seconds. During the warmup period, a separate (usually lower) frame rate is required.
Functions
Unsubscribes this instance from all events it is listening to. Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.
Returns true if this object was destroyed; otherwise, false.
Pauses monitoring of the frame rate. To resume monitoring, FrameRateMonitor.unpause must be called once for each time this function is called.
Resumes monitoring of the frame rate. If FrameRateMonitor.pause was called multiple times, this function must be called the same number of times in order to actually resume monitoring.