.. role:: ts-api-decorator

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

.. js:module:: Bcf
   :noindex:

.. container:: ts-api-section

   .. js:class:: BCFSnapshot



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~Bcf.BCFSnapshot.constructor`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~Bcf.BCFSnapshot.getData`
   * :js:meth:`~Bcf.BCFSnapshot.getFilename`
   * :js:meth:`~Bcf.BCFSnapshot.getUrl`
   * :js:meth:`~Bcf.BCFSnapshot.createFromImage`
   * :js:meth:`~Bcf.BCFSnapshot.snapshotDataFromImage`





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

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

.. container:: ts-api-section

   .. js:function:: BCFSnapshot.constructor( filename, data)

      :param filename: None
      :type filename: string
      :param data: None
      :type data: Uint8Array


      :rtype: BCFSnapshot



Methods
=======

.. rst-class:: ts-api-section

getData
-------

.. js:method:: BCFSnapshot.getData()



   Gets png data.


   :rtype: Uint8Array

.. rst-class:: ts-api-section

getFilename
-----------

.. js:method:: BCFSnapshot.getFilename()



   Gets the filename.


   :rtype: string

.. rst-class:: ts-api-section

getUrl
------

.. js:method:: BCFSnapshot.getUrl()



   Gets a url for images corresponding to viewpoints.


   :rtype: string

.. rst-class:: ts-api-section

:ts-api-decorator:`static` createFromImage
------------------------------------------

.. js:method:: BCFSnapshot.createFromImage( filename, image)

   :param filename: None
   :type filename: string
   :param image: None
   :type image: HTMLImageElement


   Creates a BCF Snapshot from an HTMLImageElement.


   :rtype: BCFSnapshot

.. rst-class:: ts-api-section

:ts-api-decorator:`static` snapshotDataFromImage
------------------------------------------------

.. js:method:: BCFSnapshot.snapshotDataFromImage( img)

   :param img: None
   :type img: HTMLImageElement


   Gets image data as a Uint8Array from an HTMLImageElement.


   :rtype: Uint8Array

