.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "_gallery/feature_demo/image_overlay.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_image_overlay.py>`
        to download the full example code.

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

.. _sphx_glr__gallery_feature_demo_image_overlay.py:


Image with another image overlaid
=================================

Show an image with another image overlaid with alpha blending.

.. GENERATED FROM PYTHON SOURCE LINES 7-65



.. image-sg:: /_gallery/feature_demo/images/sphx_glr_image_overlay_001.webp
   :alt: image overlay
   :srcset: /_gallery/feature_demo/images/sphx_glr_image_overlay_001.webp
   :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    Imageio: 'coffee.png' was not found on your computer; downloading it now.
    Try 1. Download from https://github.com/imageio/imageio-binaries/raw/master/images/coffee.png (441 kB)
    Downloading: 8192/451102 bytes (1.8%)451102/451102 bytes (100.0%)
      Done
    File saved as /home/docs/.imageio/images/coffee.png.






|

.. code-block:: Python



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

    canvas = RenderCanvas()
    renderer = gfx.renderers.WgpuRenderer(canvas)
    scene = gfx.Scene()

    # add image

    im = iio.imread("imageio:coffee.png")

    image = gfx.Image(
        gfx.Geometry(grid=gfx.Texture(im, dim=2)),
        gfx.ImageBasicMaterial(clim=(0, 255)),
    )
    scene.add(image)

    # make overlay using red values

    # empty array for overlay, shape is [nrows, ncols, RGBA]
    overlay = np.zeros(shape=(*im.shape[:2], 4), dtype=np.float32)

    # set the blue values of some pixels with an alpha > 1
    overlay[im[:, :, -1] > 200] = np.array([0.0, 0.0, 1.0, 0.6]).astype(np.float32)

    overlay_image = gfx.Image(
        gfx.Geometry(grid=gfx.Texture(overlay, dim=2)), gfx.ImageBasicMaterial(clim=(0, 1))
    )

    # place on top of image
    overlay_image.world.z = 1

    scene.add(overlay_image)

    # put the original image below
    image_original = gfx.Image(
        gfx.Geometry(grid=gfx.Texture(im, dim=2)),
        gfx.ImageBasicMaterial(clim=(0, 255)),
    )

    image_original.world.y = im.shape[0] + 10

    scene.add(image_original)

    camera = gfx.PerspectiveCamera(0)
    camera.show_object(scene)
    camera.local.scale_y = -1
    camera.zoom = 1.2

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

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


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

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


.. _sphx_glr_download__gallery_feature_demo_image_overlay.py:

.. only:: html

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

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

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

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

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

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

      :download:`Download zipped: image_overlay.zip <image_overlay.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#image_overlay.py"></iframe>