TextMesh Pro

https://docs.unity3d.com/Packages/com.unity.textmeshpro@4.0/manual/
Admin
TextMesh Pro is a Unity package that provides advanced 2D and 3D text rendering with features like...
Tokens:43,660
Snippets:253
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Font and material tag example

Source: https://docs.unity3d.com/Packages/com.unity.textmeshpro@4.0/manual/RichTextFont.html

Example showing how to switch fonts and materials using the <font> tag with the 'material' attribute.

```markup
Would you like <font="Impact SDF">a different font?</font> or just <font="NotoSans" material="NotoSans Outline">a different material?
```

--------------------------------

### Strikethrough and Underline Example

Source: https://docs.unity3d.com/Packages/com.unity.textmeshpro@4.0/manual/RichTextStrikethroughUnderline.html

Example of using the <s> (strikethrough) and <u> (underline) tags in a TextMeshPro text string.

```plaintext
The <s>quick brown</s> fox jumps over <u>the lazy dog</u>.
```

--------------------------------

### Successive color tags example

Source: https://docs.unity3d.com/Packages/com.unity.textmeshpro@4.0/manual/RichTextColor.html

Shows how successive <color> tags override each other, with the last tag taking precedence until a closing tag or another color tag is used.

```markup
<color="red">Red <color=#005500>Dark Green <#0000FF>Blue <color=#FF000088>Semitransparent Red
```

--------------------------------

### Setting caret positions with <pos> tag

Source: https://docs.unity3d.com/Packages/com.unity.textmeshpro@4.0/manual/RichTextPos.html

Example showing how to use the <pos> tag to set horizontal caret positions at 75%, 25%, 50%, and 0%.

```text
at <pos=75%>75%
at <pos=25%>25%
at <pos=50%>50%
at 0%
```

--------------------------------

### Using <line-indent> to indent every new line

Source: https://docs.unity3d.com/Packages/com.unity.textmeshpro@4.0/manual/RichTextLineIndentation.html

This example shows how to indent every new line with a single <line-indent> tag. The indentation is set to 15% and affects only manual line breaks, not word-wrapped lines.

```text
<line-indent=15%>This is the first line of this text example.
This is the second line of the same text.
```

--------------------------------

### Example of capitalization tags

Source: https://docs.unity3d.com/Packages/com.unity.textmeshpro@4.0/manual/RichTextLetterCase.html

Shows the four capitalization tags applied to the same text. The <allcaps> tag is functionally identical to <uppercase>, and <smallcaps> also reduces the size of characters entered in lowercase.

```markup
<lowercase>Alice and Bob watched TV.</lowercase>
<uppercase>Alice and Bob watched TV.</uppercase>
<allcaps>Alice and Bob watched TV.</allcaps>
<smallcaps>Alice and Bob watched TV.</smallcaps>
```

--------------------------------

### Example of <align> tags for text alignment

Source: https://docs.unity3d.com/Packages/com.unity.textmeshpro@4.0/manual/RichTextAlignment.html

Shows how to use <align> tags to set left, center, right, justified, and flush alignment. The closing </align> tag reverts to the object's overall alignment. Successive alignment scopes do not stack; the last tag on a line overrides the others.

```markup
<align="left"><b>Left-aligned</b>

<align="center"><b>Center-aligned</b>

<align="right"><b>Right-aligned</b>

<align="justified"><b>Justified:</b> stretched to fill the display area (except for the last line)

<align="flush"><b>Flush:</b> stretched to fill the display area (including the last line)
```

--------------------------------

### Closing color tag example

Source: https://docs.unity3d.com/Packages/com.unity.textmeshpro@4.0/manual/RichTextColor.html

Demonstrates using a closing </color> tag to end the current color's scope, returning to the previous color.

```markup
<color="red">Red, <color="blue">Blue,</color> and red again.
```

--------------------------------

### Adjusting margins with <margin> tag

Source: https://docs.unity3d.com/Packages/com.unity.textmeshpro@4.0/manual/RichTextMargins.html

Example showing how to increase horizontal margins using the <margin> tag. The closing tag </margin> reverts to the original margin.

```text
Our margins used to be very wide.
<margin=5em>But those days are long gone.
```

--------------------------------

### Adjust character spacing with <cspace>

Source: https://docs.unity3d.com/Packages/com.unity.textmeshpro@4.0/manual/RichTextCharacterSpacing.html

Example of using the <cspace> tag with positive and negative values to adjust character spacing. The closing </cspace> tag reverts to normal spacing.

```text
<cspace=1em>Spacing</cspace> is just as important as <cspace=-0.5em>timing.
```
Tokens:
Raw