FrameRateMonitor

new Cesium.FrameRateMonitor(options)

监测 Scene 中的帧率(每秒帧数),如果帧率低于阈值则引发事件。稍后,如果帧率恢复到所需水平,将会引发一个单独的事件。 为了避免为单个 Scene 创建多个 FrameRateMonitors,请使用 FrameRateMonitor.fromScene 而不是显式构造实例。
Name Type Description
options object optional 具有以下属性的对象:
Name Type Default Description
scene Scene 要监控性能的 Scene 实例。
samplingWindow number 5.0 optional 用于计算平均帧率的滑动窗口长度(以秒为单位)。
quietPeriod number 2.0 optional 启动时和每次页面变为可见时(即用户切换回标签时)待机的时间长度(以秒为单位),然后开始测量性能。
warmupPeriod number 5.0 optional 预热期的长度(以秒为单位)。在预热期间,需要一个单独的(通常更低的)帧率。
minimumFrameRateDuringWarmup number 4 optional 预热期间可接受性能所需的最低每秒帧数。如果在预热期间的任何 samplingWindow 中,帧率平均低于此值,则将引发 lowFrameRate 事件, 并且如果有的话,页面将重定向到 redirectOnLowFrameRateUrl。
minimumFrameRateAfterWarmup number 8 optional 预热期结束后,可接受性能所需的最低每秒帧数。如果在预热期后在任何 samplingWindow 中,帧率平均低于此值,则将引发 lowFrameRate 事件 并且如果有的话,页面将重定向到 redirectOnLowFrameRateUrl。

Members

static Cesium.FrameRateMonitor.defaultSettings : object

默认的帧率监控设置。这些设置在 FrameRateMonitor.fromScene 需要创建一个新的帧率监控时使用,对于任何未传递给 FrameRateMonitor 构造函数的设置。

lastFramesPerSecond : number

获取在最后一个 samplingWindow 中最近计算出的平均每秒帧数。 如果尚未计算帧率,则此属性可能为 undefined。
获取检测到低帧率时引发的事件。函数将传递给 Scene 实例作为第一个参数,以及在采样窗口内的平均每秒帧数 作为第二个参数。

minimumFrameRateAfterWarmup : number

获取或设置在预热期结束后可接受性能所需的最低每秒帧数。如果在预热期后在任何 samplingWindow 中,帧率平均低于此值, 则将触发 lowFrameRate 事件,并且如果有的话,页面将重定向到 redirectOnLowFrameRateUrl

minimumFrameRateDuringWarmup : number

获取或设置在预热期间可接受性能所需的最低每秒帧数。如果在预热期间的任何 samplingWindow 中,帧率平均低于此值, 则将引发 lowFrameRate 事件,并且如果有的话,页面将重定向到 redirectOnLowFrameRateUrl
获取帧率恢复到正常水平时引发的事件,之前帧率曾低。 函数将传递给 Scene 实例作为第一个参数,以及平均 每秒帧数在采样窗口内作为第二个参数。
获取或设置在启动时以及每次页面变为可见时(即用户切换回标签时)等待的时间长度(以秒为单位), 然后开始测量性能。
获取或设置用于计算平均帧率的滑动窗口长度,单位为秒。
获取要监控性能的 Scene 实例。
获取或设置预热期的长度(以秒为单位)。在预热期间,需要一个单独的(通常较低的)帧率。

Methods

static Cesium.FrameRateMonitor.fromScene(scene)FrameRateMonitor

获取给定场景的 FrameRateMonitor。如果场景尚未具有 FrameRateMonitor,则会使用 FrameRateMonitor.defaultSettings 创建一个。
Name Type Description
scene Scene 要获取 FrameRateMonitor 的场景。
Returns:
场景的 FrameRateMonitor
从所有正在监听的事件中取消订阅此实例。 一旦对象被销毁,则不应使用;调用除 isDestroyed 以外的任何函数将导致 DeveloperError 异常。因此, 将返回值(undefined)分配给对象,如示例中所示。
Throws:
See:
如果该对象已被销毁则返回 true;否则返回 false。

如果此对象已被销毁,则不应使用;调用除 isDestroyed 以外的任何函数将导致 DeveloperError 异常。
Returns:
如果该对象已被销毁则返回 true;否则返回 false。
See:
暂停帧率监控。要恢复监控,必须为每次调用此函数调用一次 FrameRateMonitor#unpause
恢复帧率监控。如果 FrameRateMonitor#pause 被调用多次, 则必须调用此函数相同次数才能真正恢复监控。
需要帮助?获得答案的最快方法是来自社区和团队 Cesium Forum.