> For the complete documentation index, see [llms.txt](https://kinematicsoup.gitbook.io/scene-fusion/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kinematicsoup.gitbook.io/scene-fusion/api-reference/ks.scenefusion.client.unity/ks.scenefusion.client.unity.sftextmeshoutline.md).

# Class sfTextMeshOutline

Namespace: [KS.SceneFusion.Client.Unity](/scene-fusion/api-reference/ks.scenefusion.client.unity.md)\
Assembly: KSUnity-Source.dll

Creates an outline for a text mesh by creating 4 copies of the text. You must call CreateOutline to create the outline. You can call it again to refresh the outline if the properties of the TextMesh change.

```csharp
[RequireComponent(typeof(TextMesh))]
public class sfTextMeshOutline : MonoBehaviour
```

#### Inheritance

object ← Object ← Component ← Behaviour ← MonoBehaviour ← [sfTextMeshOutline](/scene-fusion/api-reference/ks.scenefusion.client.unity/ks.scenefusion.client.unity.sftextmeshoutline.md)

#### Extension Methods

[sfUnityUtils.IsDestroyed(Object)](/scene-fusion/api-reference/ks.scenefusion.client.unity.editor/ks.scenefusion.client.unity.editor.sfunityutils.md#ks_scenefusion_client_unity_editor_sfunityutils_isdestroyed_unityengine_object)

## Fields

### OffsetZ <a href="#ks_scenefusion_client_unity_sftextmeshoutline_offsetz" id="ks_scenefusion_client_unity_sftextmeshoutline_offsetz"></a>

Z-offset of the outline, to make the outline appear behind the text. For this to take affect, you must call CreateOutline after setting it.

```csharp
public float OffsetZ
```

#### Field Value

float

### Thickness <a href="#ks_scenefusion_client_unity_sftextmeshoutline_thickness" id="ks_scenefusion_client_unity_sftextmeshoutline_thickness"></a>

Thickness of the outline. For this to take affect, you must call CreateOutline after setting it.

```csharp
public float Thickness
```

#### Field Value

float

## Properties

### Color <a href="#ks_scenefusion_client_unity_sftextmeshoutline_color" id="ks_scenefusion_client_unity_sftextmeshoutline_color"></a>

Color of the outline.

```csharp
public Color Color { get; set; }
```

#### Property Value

Color

## Methods

### CreateOutline() <a href="#ks_scenefusion_client_unity_sftextmeshoutline_createoutline" id="ks_scenefusion_client_unity_sftextmeshoutline_createoutline"></a>

Creates the child TextMeshes that render the outline. If the outline was already created, destroys the existing outline TextMeshes and recreates them.

```csharp
public void CreateOutline()
```