FrameRateMonitor

new Cesium.FrameRateMonitor(options)

监视Scene中的帧速率(每秒帧数),如果帧速率低于阈值,则引发事件。 稍后,如果帧速率返回到所需的级别,则会引发单独的事件。 为了避免为单个Scene创建多个frameratemonitor,可以使用FrameRateMonitor.fromScene而不是显式地构造一个实例。
Name Type Description
options Object optional 具有下列属性的对象:
Name Type Default Description
scene Scene 用于监视性能的场景实例。
samplingWindow Number 5.0 optional 用来计算平均帧速率的滑动窗口的长度,以秒为单位。
quietPeriod Number 2.0 optional 在开始测量性能之前,在启动时等待的时间以及每次页面变得可见(例如,当用户切换回选项卡时)的时间(以秒为单位)。
warmupPeriod Number 5.0 optional 预热时间的长度,以秒为单位。在预热期间,需要一个通常较低的帧速率。
minimumFrameRateDuringWarmup Number 4 optional 在预热期间,可接受的性能所需的每秒最少帧数。如果在预热期间的任何采样窗口中帧速率的平均值低于此值,则会引发lowFrameRate事件,并且页面将重定向到redirectOnLowFrameRateUrl(如果有的话)。
minimumFrameRateAfterWarmup Number 8 optional 在预热阶段结束后,可接受的性能所要求的每秒最少帧数。如果在预热期之后的任何采样窗口中帧速率的平均值低于此值,则会引发lowFrameRate事件,并且页面将重定向到redirectOnLowFrameRateUrl(如果有的话)。

Members

staticCesium.FrameRateMonitor.defaultSettings : Object

默认的帧速率监控设置,当FrameRateMonitor.fromscene需要创建一个新的帧速率监控器时,以及对于没有传递给FrameRateMonitor构造函数的任何设置,将使用这些设置。

lastFramesPerSecond : Number

获取最后一个samplingWindow >上最近计算的平均每秒帧数。如果未计算帧速率,则此属性可能未定义。
获取检测到低帧速率时引发的事件。函数的第一个参数是Scene实例,第二个参数是采样窗口每秒的平均帧数。

minimumFrameRateAfterWarmup : Number

获取或设置预热期间过后可接受性能所需的每秒最低帧数。

minimumFrameRateDuringWarmup : Number

获取或设置预热期间可接受性能所需的每秒最低帧数。
获取在帧速率较低后返回到正常水平时引发的事件。函数的第一个参数是Scene实例,第二个参数是采样窗口每秒的平均帧数。

quietPeriod : Number

获取或者设置在开始测量性能之前,在启动时等待的时间以及每次页面变得可见(例如,当用户切换回选项卡时)的时间(以秒为单位)。

samplingWindow : Number

获取或设置要在其上计算平均帧速率的滑动窗口的长度(以秒为单位)。
获取用于监视性能的Scene实例。

warmupPeriod : Number

获取或设置预热周期的长度,以秒为单位。

Methods

staticCesium.FrameRateMonitor.fromScene(scene)FrameRateMonitor

获取给定场景的FrameRateMonitor。如果场景还没有FrameRateMonitor,则使用FrameRateMonitor.defaultsettings创建一个。
Name Type Description
scene Scene 获取FrameRateMonitor的场景。
Returns:
场景的FrameRateMonitor.
销毁此对象持有的WebGL资源。

一旦对象被销毁,它将不能在使用; 调用除isDestroyed之外的任何函数都会导致DeveloperError异常。 因此,将返回值(undefined)赋给对象,如示例所示。
Throws:
See:

isDestroyed()Boolean

如果该对象没被销毁,返回false。

如果该对象已经被销毁, 使用isDestroyed 会触发 DeveloperError 异常.
Returns:
false
See:
暂停对帧速率的监视。要恢复监视,每次调用此函数时必须调用FrameRateMonitor#unpause一次。
继续监控帧速率。如果多次调用FrameRateMonitor#pause,则必须调用相同次数的此函数才能实际恢复监视。