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

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

.. _sphx_glr__gallery_feature_demo_transparency1.py:


Transparency 1
==============

Example showing transparency using three overlapping planes.
The normal blending can produce correct results by sorting
the objects in z.

Press space to toggle the order of the planes.
Press 1-7 to select the blending mode.

.. GENERATED FROM PYTHON SOURCE LINES 12-100



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





.. code-block:: Python



    from rendercanvas.auto import RenderCanvas, loop
    import pygfx as gfx


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

    background = gfx.Background.from_color("#000")

    geometry = gfx.plane_geometry(50, 50)

    # Note: marking the material as transparent, so the renderer sorts the objects
    # by depth in the correct way. It also implicitly sets depth_write to False.
    plane1 = gfx.Mesh(
        geometry,
        gfx.MeshBasicMaterial(color=(1, 0, 0, 0.7)),
    )
    plane2 = gfx.Mesh(
        geometry,
        gfx.MeshBasicMaterial(color=(0, 1, 0, 0.7)),
    )
    plane3 = gfx.Mesh(
        geometry,
        gfx.MeshBasicMaterial(color=(0, 0, 1, 0.7)),
    )

    plane1.local.position = (-10, -10, 1)
    plane2.local.position = (0, 0, 2)
    plane3.local.position = (10, 10, 3)

    scene.add(background, plane1, plane2, plane3)

    camera = gfx.OrthographicCamera(100, 100)

    scene_overlay = gfx.Scene()

    blend_text = gfx.Text(
        text=f"alpha_mode: {plane1.material.alpha_mode}",
        anchor="bottom-left",
        material=gfx.TextMaterial(outline_thickness=0.3, aa=True),
    )
    scene_overlay.add(blend_text)

    screen_camera = gfx.ScreenCoordsCamera()

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


    @renderer.add_event_handler("key_down")
    def handle_event(event):
        canvas.request_draw()
        if event.key == " ":
            print("Rotating scene element order")
            scene.add(scene.children[1])  # skip bg
        elif event.key == ".":
            clr = "#fff" if background.material.color_bottom_left == "#000" else "#000"
            print(f"Changing background color to {clr}")
            background.material.set_colors(clr)
        elif event.key in "1234567":
            m = [
                None,
                "auto",  # 1
                "solid",  # 2
                "blend",  # 3
                "add",  # 4
                "dither",  # 5
                "bayer",  # 6
                "weighted_blend",  # 7
            ]
            alpha_mode = m[int(event.key)]
            for plane in plane1, plane2, plane3:
                plane.material.alpha_mode = alpha_mode
            print("Selecting blending", alpha_mode)
            blend_text.set_text(f"alpha_mode: {alpha_mode}")


    def animate():
        renderer.render(scene, camera, flush=False)
        renderer.render(scene_overlay, screen_camera, flush=True)


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


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

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


.. _sphx_glr_download__gallery_feature_demo_transparency1.py:

.. only:: html

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

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

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

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

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

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

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