.. role:: clio-static
   :class: clio-flag clio-flag-static


###########
BCFSnapshot
###########

.. js:class:: wv.Bcf.BCFSnapshot

   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wv.Bcf.BCFSnapshot.constructor`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~static wv.Bcf.BCFSnapshot.createFromImage`
   * :js:meth:`~static wv.Bcf.BCFSnapshot.snapshotDataFromImage`
   * :js:meth:`~wv.Bcf.BCFSnapshot.getData`
   * :js:meth:`~wv.Bcf.BCFSnapshot.getFilename`
   * :js:meth:`~wv.Bcf.BCFSnapshot.getUrl`
   
   



.. rst-class:: kind-group kind-constructors

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


.. js:method:: wv.Bcf.BCFSnapshot.constructor

      .. rst-class:: sig-pretty-signature
      
         | BCFSnapshot(**filename**\ : *string*\ , **data**\ : *Uint8Array*\ ): :js:class:`BCFSnapshot <wv.Bcf.BCFSnapshot>`
      
      **Parameters**
      
      
         **filename**\ : *string*
      
         **data**\ : *Uint8Array*
      
      
      **Returns**\ : :js:class:`BCFSnapshot <wv.Bcf.BCFSnapshot>`
      



.. rst-class:: kind-group kind-methods

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


.. js:method:: static wv.Bcf.BCFSnapshot.createFromImage

      .. rst-class:: clio-flags
      
         :clio-static:`static`
      
      .. rst-class:: sig-pretty-signature
      
         | createFromImage(**filename**\ : *string*\ , **image**\ : *HTMLImageElement*\ ): :js:class:`BCFSnapshot <wv.Bcf.BCFSnapshot>`
      
      Creates a BCF Snapshot from an HTMLImageElement.
      
      **Parameters**
      
      
         **filename**\ : *string*
      
         **image**\ : *HTMLImageElement*
      
      
      **Returns**\ : :js:class:`BCFSnapshot <wv.Bcf.BCFSnapshot>`
      



.. js:method:: static wv.Bcf.BCFSnapshot.snapshotDataFromImage

      .. rst-class:: clio-flags
      
         :clio-static:`static`
      
      .. rst-class:: sig-pretty-signature
      
         | snapshotDataFromImage(**img**\ : *HTMLImageElement*\ ): *Uint8Array*
      
      Gets image data as a Uint8Array from an HTMLImageElement.
      
      **Parameters**
      
      
         **img**\ : *HTMLImageElement*
      
      
      **Returns**\ : *Uint8Array*
      



.. js:method:: wv.Bcf.BCFSnapshot.getData

      .. rst-class:: sig-pretty-signature
      
         | getData(): *Uint8Array*
      
      Gets png data.
      
      **Returns**\ : *Uint8Array*
      



.. js:method:: wv.Bcf.BCFSnapshot.getFilename

      .. rst-class:: sig-pretty-signature
      
         | getFilename(): *string*
      
      Gets the filename.
      
      **Returns**\ : *string*
      



.. js:method:: wv.Bcf.BCFSnapshot.getUrl

      .. rst-class:: sig-pretty-signature
      
         | getUrl(): *string*
      
      Gets a url for images corresponding to viewpoints.
      
      **Returns**\ : *string*
      




