<!--
{
  "documentType" : "article",
  "framework" : "USD",
  "identifier" : "/documentation/USD/preliminary-text",
  "metadataVersion" : "0.1.0",
  "role" : "collectionGroup",
  "title" : "Preliminary_Text"
}
-->

# Preliminary_Text

A prim that renders 3D text in a scene.

## Discussion

Because `Preliminary_Text` prim is an `Xformable` prim, you define its position either by specifying an offset in world coordinates, or by specifying that the prim should inherit its parent transform.

Alternatively, you can request that the runtime anchor a text prim in the real world by inheriting `Preliminary_AnchoringAPI`. Many AR experiences include anchored text to add information or context about real-world objects or virtual content.

### Declaration

```other
class Preliminary_Text "Preliminary_Text" (
    inherits = </Gprim>
)
```

### Create single-line or flowing text

The following example demonstrates single-line text.

```other
def Preliminary_Text "heading"
{
    string content = "Units Sold"
    string[] font = [ "Helvetica", "Arial" ]
    token wrapMode = "singleLine"
    token horizontalAlignment = "left"
    token verticalAlignment = "baseline"
}
```

The following example shows text flowing in a rectangular region, with line breaks as needed.

```other
def Preliminary_Text "sign"
{
    string content = "Now is the time for all good people to come to the aid of their country."
    string[] font = [ "ZapfChancery", "Bradley Hand", "cursive" ]
    token wrapMode = "flowing"
    float width = 120
    float height = 100
    token horizontalAlignment = "center"
    token verticalAlignment = "top"
}
```

## Topics

### Properties

[content](/documentation/USD/content)

The characters that the text displays.

[font](/documentation/USD/font)

An array of font names.

[pointSize](/documentation/USD/pointsize)

The size of the text’s font.

[width](/documentation/USD/width)

The width of the text’s bounding box.

[height](/documentation/USD/height)

The height of the text’s bounding box.

[depth](/documentation/USD/depth)

A value that defines the depth, in scene units, of the text’s extrusion.

[wrapMode](/documentation/USD/wrapmode)

An option that determines the flow of the text.

[horizontalAlignment](/documentation/USD/horizontalalignment)

An option that controls the text’s horizontal placement within its bounding box.

[verticalAlignment](/documentation/USD/verticalalignment)

An option that controls the text’s vertical placement within its bounding rectangle.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)