.. role:: ts-api-decorator

############
FrameMetrics
############

.. js:module:: cee.pt
   :noindex:

.. container:: ts-api-section

   .. js:class:: FrameMetrics

      Performance metrics for a single frame load.



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-interface

   * :js:attr:`~cee.pt.FrameMetrics.applyMs`
   * :js:attr:`~cee.pt.FrameMetrics.bytes`
   * :js:attr:`~cee.pt.FrameMetrics.cacheHit`
   * :js:attr:`~cee.pt.FrameMetrics.decodeMs`
   * :js:attr:`~cee.pt.FrameMetrics.downloadMs`
   * :js:attr:`~cee.pt.FrameMetrics.frameIndex`
   * :js:attr:`~cee.pt.FrameMetrics.particleCount`
   * :js:attr:`~cee.pt.FrameMetrics.timestamp`
   * :js:attr:`~cee.pt.FrameMetrics.totalMs`
   * :js:attr:`~cee.pt.FrameMetrics.transferBytes`





------------

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: FrameMetrics.applyMs

      :type: number





.. container:: ts-api-section

   .. js:attribute:: FrameMetrics.bytes

      :type: number





.. container:: ts-api-section

   .. js:attribute:: FrameMetrics.cacheHit

      :type: boolean





.. container:: ts-api-section

   .. js:attribute:: FrameMetrics.decodeMs

      :type: number





.. container:: ts-api-section

   .. js:attribute:: FrameMetrics.downloadMs

      :type: number





.. container:: ts-api-section

   .. js:attribute:: FrameMetrics.frameIndex

      :type: number





.. container:: ts-api-section

   .. js:attribute:: FrameMetrics.particleCount

      :type: number





.. container:: ts-api-section

   .. js:attribute:: FrameMetrics.timestamp

      :type: number





.. container:: ts-api-section

   .. js:attribute:: FrameMetrics.totalMs

      :type: number





.. container:: ts-api-section

   .. js:attribute:: FrameMetrics.transferBytes

      :type: number :ts-api-decorator:`optional`

      Compressed on-the-wire size. Undefined on cache hit or when unavailable.



