.. role:: clio-optional
   :class: clio-flag clio-flag-optional


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

.. js:class:: cee.pt.FrameMetrics

   Performance metrics for a single frame load.
   
   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.pt.FrameMetrics.applyMs`
   * :js:data:`~cee.pt.FrameMetrics.bytes`
   * :js:data:`~cee.pt.FrameMetrics.cacheHit`
   * :js:data:`~cee.pt.FrameMetrics.decodeMs`
   * :js:data:`~cee.pt.FrameMetrics.downloadMs`
   * :js:data:`~cee.pt.FrameMetrics.frameIndex`
   * :js:data:`~cee.pt.FrameMetrics.particleCount`
   * :js:data:`~cee.pt.FrameMetrics.timestamp`
   * :js:data:`~cee.pt.FrameMetrics.totalMs`
   * :js:data:`~cee.pt.FrameMetrics.transferBytes`
   
   



.. rst-class:: kind-group kind-properties

.. rubric:: Properties
   :class: kind-group-title


.. js:data:: cee.pt.FrameMetrics.applyMs

      .. rst-class:: sig-pretty-signature
      
         | applyMs: *number*
      



.. js:data:: cee.pt.FrameMetrics.bytes

      .. rst-class:: sig-pretty-signature
      
         | bytes: *number*
      



.. js:data:: cee.pt.FrameMetrics.cacheHit

      .. rst-class:: sig-pretty-signature
      
         | cacheHit: *boolean*
      



.. js:data:: cee.pt.FrameMetrics.decodeMs

      .. rst-class:: sig-pretty-signature
      
         | decodeMs: *number*
      



.. js:data:: cee.pt.FrameMetrics.downloadMs

      .. rst-class:: sig-pretty-signature
      
         | downloadMs: *number*
      



.. js:data:: cee.pt.FrameMetrics.frameIndex

      .. rst-class:: sig-pretty-signature
      
         | frameIndex: *number*
      



.. js:data:: cee.pt.FrameMetrics.particleCount

      .. rst-class:: sig-pretty-signature
      
         | particleCount: *number*
      



.. js:data:: cee.pt.FrameMetrics.timestamp

      .. rst-class:: sig-pretty-signature
      
         | timestamp: *number*
      



.. js:data:: cee.pt.FrameMetrics.totalMs

      .. rst-class:: sig-pretty-signature
      
         | totalMs: *number*
      



.. js:data:: cee.pt.FrameMetrics.transferBytes

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | transferBytes: *number*
      
      Compressed on-the-wire size. Undefined on cache hit or when unavailable.
      




