Label3D

Inherits: GeometryInstance < VisualInstance < CullInstance < Spatial < Node < Object Displays plain text in a 3D world.

Description

Label3D displays plain text in a 3D world. It gives you control over the horizontal and vertical alignment.

Properties

Methods

Enumerations

DrawFlags:

  • FLAG_SHADED = 0 —- If set, lights in the environment affect the label.
  • FLAG_DOUBLE_SIDED = 1 —- If set, text can be seen from the back as well. If not, the text is invisible when looking at it from behind.
  • FLAG_DISABLE_DEPTH_TEST = 2 —- Disables the depth test, so this object is drawn on top of all others. However, objects drawn after it in the draw order may cover it.
  • FLAG_FIXED_SIZE = 3 —- Label is scaled by depth so that it always appears the same size on screen.
  • FLAG_MAX = 4 —- Represents the size of the DrawFlags enum.

AlphaCutMode:

  • ALPHA_CUT_DISABLED = 0 —- This mode performs standard alpha blending. It can display translucent areas, but transparency sorting issues may be visible when multiple transparent materials are overlapping.
  • ALPHA_CUT_DISCARD = 1 —- This mode only allows fully transparent or fully opaque pixels. This mode is also known as alpha testing or 1-bit transparency. Note: This mode might have issues with anti-aliased fonts and outlines, try adjusting alpha_scissor_threshold or using SDF font. Note: When using text with overlapping glyphs (e.g., cursive scripts), this mode might have transparency sorting issues between the main text and the outline.
  • ALPHA_CUT_OPAQUE_PREPASS = 2 —- This mode draws fully opaque pixels in the depth prepass. This is slower than ALPHA_CUT_DISABLED or ALPHA_CUT_DISCARD, but it allows displaying translucent areas and smooth edges while using proper sorting. Note: When using text with overlapping glyphs (e.g., cursive scripts), this mode might have transparency sorting issues between the main text and the outline.

Align:

  • ALIGN_LEFT = 0 —- Align rows to the left (default).
  • ALIGN_CENTER = 1 —- Align rows centered.
  • ALIGN_RIGHT = 2 —- Align rows to the right.
  • ALIGN_FILL = 3 —- Expand row whitespaces to fit the width.

VAlign:

  • VALIGN_TOP = 0 —- Align the whole text to the top.
  • VALIGN_CENTER = 1 —- Align the whole text to the center.
  • VALIGN_BOTTOM = 2 —- Align the whole text to the bottom.
  • VALIGN_FILL = 3 —- Align the whole text by spreading the rows.

    Property Descriptions

  • AlphaCutMode alpha_cut AlphaCutMode for possible values.
  • float alpha_scissor_threshold Threshold at which the alpha scissor will discard values.
  • bool autowrap true, wraps the text to the width.
  • BillboardMode billboard BillboardMode for possible values.
  • bool double_sided true, text can be seen from the back as well, if false, it is invisible when looking at it from behind.
  • bool fixed_size true, the label is rendered at the same size regardless of distance.
  • Font font Font used for the Label3D‘s text.
  • Align horizontal_alignment Align constants.
  • float line_spacing Label3D.
  • Color modulate Color of the Label3D.
  • bool no_depth_test true, depth testing is disabled and the object will be drawn in render order.
  • Vector2 offset The text drawing offset (in pixels).
  • Color outline_modulate Font‘s outline.
  • int outline_render_priority Sets the render priority for the text outline. Higher priority objects will be sorted in front of lower priority objects. Note: This only applies if alpha_cut is set to ALPHA_CUT_DISABLED (default value). Note: This only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority).
  • float pixel_size The size of one pixel’s width on the label to scale it in 3D.
  • int render_priority Sets the render priority for the text. Higher priority objects will be sorted in front of lower priority objects. Note: This only applies if alpha_cut is set to ALPHA_CUT_DISABLED (default value). Note: This only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority).
  • bool shaded true, the Light in the Environment has effects on the label.
  • String text The text to display on screen.
  • bool uppercase true, all the text displays as UPPERCASE.
  • VAlign vertical_alignment VAlign constants.
  • float width Text width (in pixels), used for autowrap and fill alignment.

    Method Descriptions

  • TriangleMesh generate_triangle_mesh ( ) const TriangleMesh with the label’s vertices following its current configuration (such as its pixel_size).
  • bool get_draw_flag ( DrawFlags flag ) const Returns the value of the specified flag.
  • set_draw_flag ( DrawFlags flag, bool enabled ) true, the specified flag will be enabled. See DrawFlags for a list of flags.