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

.. only:: html

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

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

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

.. _sphx_glr__gallery_feature_demo_pbr.py:


PBR Rendering 1
===============


This example shows a complete PBR rendering effect.
The cubemap of skybox is also the environment cubemap of the helmet.

.. GENERATED FROM PYTHON SOURCE LINES 11-18

.. warning::
    An external model is needed to run this example.

To run this example, you need a model from the source repo's example
folder. If you are running this example from a local copy of the code (dev
install) no further actions are needed. Otherwise, you may have to replace
the path below to point to the location of the model.

.. GENERATED FROM PYTHON SOURCE LINES 18-30

.. code-block:: default


    import os
    from pathlib import Path

    try:
        # modify this line if your model is located elsewhere
        model_dir = Path(__file__).parents[1] / "data"
    except NameError:
        # compatibility with sphinx-gallery
        model_dir = Path(os.getcwd()).parent / "data"









.. GENERATED FROM PYTHON SOURCE LINES 31-32

Once the path is set correctly, you can use the model as follows:

.. GENERATED FROM PYTHON SOURCE LINES 32-81

.. code-block:: default



    import imageio.v3 as iio
    from wgpu.gui.auto import WgpuCanvas, run
    import pygfx as gfx


    # Init
    canvas = WgpuCanvas(size=(640, 480), title="gfx_pbr")
    renderer = gfx.renderers.WgpuRenderer(canvas)
    scene = gfx.Scene()

    # Read cube image and turn it into a 3D image (a 4d array)
    env_img = iio.imread("imageio:meadow_cube.jpg")
    cube_size = env_img.shape[1]
    env_img.shape = 6, cube_size, cube_size, env_img.shape[-1]

    # Create environment map
    env_tex = gfx.Texture(
        env_img, dim=2, size=(cube_size, cube_size, 6), generate_mipmaps=True
    )

    # Apply env map to skybox
    background = gfx.Background(None, gfx.BackgroundSkyboxMaterial(map=env_tex))
    scene.add(background)

    # Load meshes, and apply env map
    # Note that this lits the helmet already
    gltf_path = model_dir / "DamagedHelmet" / "glTF" / "DamagedHelmet.gltf"
    meshes = gfx.load_meshes(gltf_path)
    scene.add(*meshes)
    m = meshes[0]  # this example has just one mesh
    m.geometry.texcoords1 = m.geometry.texcoords  # use second set of texcoords for ao map
    m.material.env_map = env_tex

    # Add extra light more or less where the sun seems to be in the skybox
    light = gfx.SpotLight(color="#444")
    light.local.position = (-500, 1000, -1000)
    scene.add(light)

    # Create camera and controller
    camera = gfx.PerspectiveCamera(45, 640 / 480)
    camera.show_object(m, view_dir=(1.8, -0.6, -2.7))
    controller = gfx.OrbitController(camera, register_events=renderer)


    if __name__ == "__main__":
        renderer.request_draw(lambda: renderer.render(scene, camera))
        run()



.. image-sg:: /_gallery/feature_demo/images/sphx_glr_pbr_001.png
   :alt: pbr
   :srcset: /_gallery/feature_demo/images/sphx_glr_pbr_001.png
   :class: sphx-glr-single-img






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

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


.. _sphx_glr_download__gallery_feature_demo_pbr.py:

.. only:: html

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




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

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

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

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


.. only:: html

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

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