.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "_gallery/validation/validate_skybox.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download__gallery_validation_validate_skybox.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr__gallery_validation_validate_skybox.py:


Validate Skybox
===============

This validates that the skybox background is rendered correctly,
as well as that the environment-map matches that background. Therefore
it also covers the internal cube-camera-renderer.

Note that the blue -Z side is marked "back", but since camera's look down the
-Z direction, it'd be what the camera would see if it was not rotated.

.. GENERATED FROM PYTHON SOURCE LINES 12-79



.. image-sg:: /_gallery/validation/images/sphx_glr_validate_skybox_001.webp
   :alt: validate skybox
   :srcset: /_gallery/validation/images/sphx_glr_validate_skybox_001.webp
   :class: sphx-glr-single-img





.. code-block:: Python



    import os

    import numpy as np
    import imageio.v3 as iio
    import pygfx as gfx
    from pathlib import Path
    from rendercanvas.auto import RenderCanvas, loop

    try:
        data_dir = Path(__file__).parents[1] / "data"
    except NameError:
        data_dir = Path(os.getcwd()).parent / "data"  # compat with sphinx-gallery

    data = iio.imread(data_dir / "cubemap.jpg")

    h = data.shape[0] // 3
    w = data.shape[1] // 4

    """
    The layout of the example cubemap looks like this:
     ┌────┬────┬────┬────┐
     │    │ +Y │    │    │
     ├────┼────┼────┼────┤
     │ -X │ +Z │ +X │ -Z │
     ├────┼────┼────┼────┤
     │    │ -Y │    │    │
     └────┴────┴────┴────┘
     """
    posx = np.ascontiguousarray(data[1 * h : 2 * h, 2 * w : 3 * w])
    negx = np.ascontiguousarray(data[1 * h : 2 * h, 0 * w : 1 * w])
    posy = np.ascontiguousarray(data[0 * h : 1 * h, 1 * w : 2 * w])
    negy = np.ascontiguousarray(data[2 * h : 3 * h, 1 * w : 2 * w])
    posz = np.ascontiguousarray(data[1 * h : 2 * h, 1 * w : 2 * w])
    negz = np.ascontiguousarray(data[1 * h : 2 * h, 3 * w : 4 * w])

    datas = [posx, negx, posy, negy, posz, negz]

    tex = gfx.Texture(np.stack(datas, axis=0), dim=2, size=(w, h, 6), generate_mipmaps=True)

    canvas = RenderCanvas(size=(640, 640))
    renderer = gfx.renderers.WgpuRenderer(canvas)

    scene = gfx.Scene()

    background = gfx.Background(None, gfx.BackgroundSkyboxMaterial(map=tex))
    scene.add(background)

    mesh = gfx.Mesh(
        gfx.sphere_geometry(2, 64, 64),
        gfx.MeshStandardMaterial(roughness=0.01, metalness=1, side="Front"),
    )
    mesh.material.env_map = tex
    scene.add(mesh)

    camera = gfx.PerspectiveCamera(90)
    camera.local.position = (2, 3, 4)
    camera.show_pos(mesh)

    controller = gfx.OrbitController(camera, register_events=renderer)

    renderer.request_draw(lambda: renderer.render(scene, camera))

    if __name__ == "__main__":
        print(__doc__)
        loop.run()


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.390 seconds)


.. _sphx_glr_download__gallery_validation_validate_skybox.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: validate_skybox.ipynb <validate_skybox.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: validate_skybox.py <validate_skybox.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: validate_skybox.zip <validate_skybox.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_

.. only:: html

    Interactive example
    -------------------

    Try this example in your browser using Pyodide. Might not work with all examples and all devices. Check the output and your browser's console for details.

    .. raw:: html

        <iframe src="./../pyodide.html#validate_skybox.py"></iframe>