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

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

.. _sphx_glr__gallery_validation_validate_text_direction.py:


Text direction
==============

Pygfx text supports multiple text directions. Latin scripts (like English)
are left-to-right. A right-to-left direction is used for e.g. Arabic,
and top-to-bottom sometimes for Asian languages.

By default pygfx auto-selects a direction based on the script, choosing
either between ltr or rtl (Asian languages go ltr).

In this example the same piece of (English) text is shown with
different directions, and the bounding box for each text is also
shown. A correct bounding box is a pretty good indicator that
all anchor variants work (testing all anchors for all directions
would be a lot).

.. GENERATED FROM PYTHON SOURCE LINES 19-96



.. image-sg:: /_gallery/validation/images/sphx_glr_validate_text_direction_001.webp
   :alt: validate text direction
   :srcset: /_gallery/validation/images/sphx_glr_validate_text_direction_001.webp
   :class: sphx-glr-single-img





.. code-block:: Python



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

    scene = gfx.Scene()


    scene.add(gfx.Background.from_color("#fff"))
    text = """
    some text on a line
    other text on another line
    """.strip()


    material = gfx.TextMaterial(color="#000", aa=True)


    text1 = gfx.Text(
        text=text,
        direction="ltr",
        font_size=1,
        max_width=10,
        text_align="right",
        anchor="bottom-right",
        anchor_offset=0.5,
        material=material,
    )

    text2 = gfx.Text(
        text=text,
        direction="rtl",
        font_size=1,
        max_width=10,
        text_align="right",
        anchor="top-right",
        anchor_offset=0.5,
        material=material,
    )

    text3 = gfx.Text(
        text=text,
        direction="btt",
        font_size=0.6,
        max_width=8,
        anchor="bottom-left",
        anchor_offset=0.5,
        material=material,
    )

    text4 = gfx.Text(
        text=text,
        direction="ttb",
        font_size=0.6,
        max_width=8,
        anchor="top-left",
        anchor_offset=0.5,
        material=material,
    )


    scene.add(text1, text2, text3, text4)


    for text in (text1, text2, text3, text4):
        bh = gfx.BoxHelper(color="green")
        bh.set_transform_by_object(text)
        text.add(bh)

    camera = gfx.OrthographicCamera(24, 18)

    renderer = gfx.renderers.WgpuRenderer(RenderCanvas(size=(800, 600)))

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

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


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

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


.. _sphx_glr_download__gallery_validation_validate_text_direction.py:

.. only:: html

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

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

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

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

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

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

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