geovista.pantry.textures
========================

.. py:module:: geovista.pantry.textures

.. autoapi-nested-parse::

   Download, cache and load image textures.

   Notes
   -----
   .. versionadded:: 0.5.0

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   geovista.pantry.textures.black_marble
   geovista.pantry.textures.blue_marble
   geovista.pantry.textures.checkerboard
   geovista.pantry.textures.natural_earth_1
   geovista.pantry.textures.natural_earth_hypsometric


Module Contents
---------------

.. py:function:: black_marble(*, location = False)

   
   Get the NASA Black Marble 'night lights' texture.

   If the resource is not already available in the geovista
   :data:`geovista.cache.CACHE`, then it will be downloaded from the
   :data:`geovista.cache.BASE_URL`.

   :Parameters:

       **location** : :class:`python:bool`, default=False
           Determine whether the absolute path filename to the texture resource
           location within the cache is returned, or the actual texture.



   :Returns:

       :class:`python:str` or :obj:`Texture <pyvista.Texture>`
           The PyVista texture filename or the texture.








   .. rubric:: Notes

   .. versionadded:: 0.6.0



   ..
       !! processed by numpydoc !!

.. py:function:: blue_marble(*, location = False)

   
   Get the NASA Blue Marble Next Generation with topography and bathymetry texture.

   If the resource is not already available in the geovista
   :data:`geovista.cache.CACHE`, then it will be downloaded from the
   :data:`geovista.cache.BASE_URL`.

   :Parameters:

       **location** : :class:`python:bool`, default=False
           Determine whether the absolute path filename to the texture resource
           location within the cache is returned, or the actual texture.



   :Returns:

       :class:`python:str` or :obj:`Texture <pyvista.Texture>`
           The PyVista texture filename or the texture.








   .. rubric:: Notes

   .. versionadded:: 0.1.0



   ..
       !! processed by numpydoc !!

.. py:function:: checkerboard(*, location = False)

   
   Get the UV checker map 4K texture.

   If the resource is not already available in the geovista
   :data:`geovista.cache.CACHE`, then it will be downloaded from the
   :data:`geovista.cache.BASE_URL`.

   :Parameters:

       **location** : :class:`python:bool`, default=False
           Determine whether the absolute path filename to the texture resource
           location within the cache is returned, or the actual texture.



   :Returns:

       :class:`python:str` or :obj:`Texture <pyvista.Texture>`
           The PyVista texture filename or the texture.








   .. rubric:: Notes

   .. versionadded:: 0.1.0



   ..
       !! processed by numpydoc !!

.. py:function:: natural_earth_1(*, location = False)

   
   Get the 1:50m Natural Earth texture.

   This is the Natural Earth 1 with shaded relief and water texture.

   This resource has been down-sampled to 65% of its original resolution.

   If the resource is not already available in the geovista
   :data:`geovista.cache.CACHE`, then it will be downloaded from the
   :data:`geovista.cache.BASE_URL`.

   :Parameters:

       **location** : :class:`python:bool`, default=False
           Determine whether the absolute path filename to the texture resource
           location within the cache is returned, or the actual texture.



   :Returns:

       :class:`python:str` or :obj:`Texture <pyvista.Texture>`
           The PyVista texture filename or the texture.








   .. rubric:: Notes

   .. versionadded:: 0.1.0



   ..
       !! processed by numpydoc !!

.. py:function:: natural_earth_hypsometric(*, location = False)

   
   Get the 1:50m Natural Earth texture.

   This is the Natural Earth cross-blended hypsometric tints with shaded relief and
   water texture.

   This resource has been down-sampled to 65% of its original resolution.

   If the resource is not already available in the geovista
   :data:`geovista.cache.CACHE`, then it will be downloaded from the
   :data:`geovista.cache.BASE_URL`.

   :Parameters:

       **location** : :class:`python:bool`, default=False
           Determine whether the absolute path filename to the texture resource
           location within the cache is returned, or the actual texture.



   :Returns:

       :class:`python:str` or :obj:`Texture <pyvista.Texture>`
           The PyVista texture filename or the texture.








   .. rubric:: Notes

   .. versionadded:: 0.1.0



   ..
       !! processed by numpydoc !!