:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TextMesh.xml. .. _class_TextMesh: TextMesh ======== **Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Generate an :ref:`PrimitiveMesh` from the text. .. rst-class:: classref-introduction-group Description ----------- Generate an :ref:`PrimitiveMesh` from the text. TextMesh can be generated only when using dynamic fonts with vector glyph contours. Bitmap fonts (including bitmap data in the TrueType/OpenType containers, like color emoji fonts) are not supported. The UV layout is arranged in 4 horizontal strips, top to bottom: 40% of the height for the front face, 40% for the back face, 10% for the outer edges and 10% for the inner edges. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------+---------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`curve_step` | ``0.5`` | +-----------------------------------+---------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`depth` | ``0.05`` | +-----------------------------------+---------------------------------------------------------------------------+-----------+ | :ref:`Font` | :ref:`font` | | +-----------------------------------+---------------------------------------------------------------------------+-----------+ | :ref:`Align` | :ref:`horizontal_alignment` | ``1`` | +-----------------------------------+---------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`pixel_size` | ``0.01`` | +-----------------------------------+---------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`text` | ``""`` | +-----------------------------------+---------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`uppercase` | ``false`` | +-----------------------------------+---------------------------------------------------------------------------+-----------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_TextMesh_Align: .. rst-class:: classref-enumeration enum **Align**: .. _class_TextMesh_constant_ALIGN_LEFT: .. rst-class:: classref-enumeration-constant :ref:`Align` **ALIGN_LEFT** = ``0`` Align rows to the left (default). .. _class_TextMesh_constant_ALIGN_CENTER: .. rst-class:: classref-enumeration-constant :ref:`Align` **ALIGN_CENTER** = ``1`` Align rows centered. .. _class_TextMesh_constant_ALIGN_RIGHT: .. rst-class:: classref-enumeration-constant :ref:`Align` **ALIGN_RIGHT** = ``2`` Align rows to the right. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_TextMesh_property_curve_step: .. rst-class:: classref-property :ref:`float` **curve_step** = ``0.5`` .. rst-class:: classref-property-setget - void **set_curve_step** **(** :ref:`float` value **)** - :ref:`float` **get_curve_step** **(** **)** Step (in pixels) used to approximate Bézier curves. .. rst-class:: classref-item-separator ---- .. _class_TextMesh_property_depth: .. rst-class:: classref-property :ref:`float` **depth** = ``0.05`` .. rst-class:: classref-property-setget - void **set_depth** **(** :ref:`float` value **)** - :ref:`float` **get_depth** **(** **)** Depths of the mesh, if set to ``0.0`` only front surface, is generated, and UV layout is changed to use full texture for the front face only. .. rst-class:: classref-item-separator ---- .. _class_TextMesh_property_font: .. rst-class:: classref-property :ref:`Font` **font** .. rst-class:: classref-property-setget - void **set_font** **(** :ref:`Font` value **)** - :ref:`Font` **get_font** **(** **)** :ref:`Font` used for the **TextMesh**'s text. .. rst-class:: classref-item-separator ---- .. _class_TextMesh_property_horizontal_alignment: .. rst-class:: classref-property :ref:`Align` **horizontal_alignment** = ``1`` .. rst-class:: classref-property-setget - void **set_horizontal_alignment** **(** :ref:`Align` value **)** - :ref:`Align` **get_horizontal_alignment** **(** **)** Controls the text's horizontal alignment. Supports left, center and right. Set it to one of the :ref:`Align` constants. .. rst-class:: classref-item-separator ---- .. _class_TextMesh_property_pixel_size: .. rst-class:: classref-property :ref:`float` **pixel_size** = ``0.01`` .. rst-class:: classref-property-setget - void **set_pixel_size** **(** :ref:`float` value **)** - :ref:`float` **get_pixel_size** **(** **)** The size of one pixel's width on the text to scale it in 3D. .. rst-class:: classref-item-separator ---- .. _class_TextMesh_property_text: .. rst-class:: classref-property :ref:`String` **text** = ``""`` .. rst-class:: classref-property-setget - void **set_text** **(** :ref:`String` value **)** - :ref:`String` **get_text** **(** **)** The text to generate mesh from. .. rst-class:: classref-item-separator ---- .. _class_TextMesh_property_uppercase: .. rst-class:: classref-property :ref:`bool` **uppercase** = ``false`` .. rst-class:: classref-property-setget - void **set_uppercase** **(** :ref:`bool` value **)** - :ref:`bool` **is_uppercase** **(** **)** If ``true``, all the text displays as UPPERCASE. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`