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


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

.. js:class:: Bcf.BCFSnapshot

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




Constructors
============

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

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





Methods
=======

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

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



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

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



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

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



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

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



.. js:method:: static 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*
   





