# FontFamily.Builder

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# Builder

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/graphics/fonts/FontFamily.Builder "View this page in Java")  

```
class Builder
```

|---|----------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                         ||
| ↳ | [android.graphics.fonts.FontFamily.Builder](https://developer.android.com/reference/kotlin/android/graphics/fonts/FontFamily.Builder#) |

A builder class for creating new FontFamily.

## Summary

|                                                                                                                        Public constructors                                                                                                                        ||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| [Builder](https://developer.android.com/reference/kotlin/android/graphics/fonts/FontFamily.Builder#Builder(android.graphics.fonts.Font))`(`font:` `[Font](https://developer.android.com/reference/kotlin/android/graphics/fonts/Font)`)` Constructs a builder. |

|                                                                                                                                                                                            Public methods                                                                                                                                                                                            ||
|-----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [FontFamily.Builder](https://developer.android.com/reference/kotlin/android/graphics/fonts/FontFamily.Builder#) | [addFont](https://developer.android.com/reference/kotlin/android/graphics/fonts/FontFamily.Builder#addFont(android.graphics.fonts.Font))`(`font:` `[Font](https://developer.android.com/reference/kotlin/android/graphics/fonts/Font)`)` Adds different style font to the builder.  |
| [FontFamily](https://developer.android.com/reference/kotlin/android/graphics/fonts/FontFamily)                  | [build](https://developer.android.com/reference/kotlin/android/graphics/fonts/FontFamily.Builder#build())`()` Build the font family                                                                                                                                                 |
| [FontFamily](https://developer.android.com/reference/kotlin/android/graphics/fonts/FontFamily)?                 | [buildVariableFamily](https://developer.android.com/reference/kotlin/android/graphics/fonts/FontFamily.Builder#buildVariableFamily())`()` Build a variable font family that automatically adjust the \`wght\` and \`ital\` axes value for the requested weight/italic style values. |

## Public constructors

### Builder

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
Builder(font: Font)
```

Constructs a builder.

|                                                          Parameters                                                           ||
|--------|-----------------------------------------------------------------------------------------------------------------------|
| `font` | [Font](https://developer.android.com/reference/kotlin/android/graphics/fonts/Font):a font This value cannot be`null`. |

## Public methods

### addFont

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun addFont(font: Font): FontFamily.Builder
```

Adds different style font to the builder. System will select the font if the text style is closest to the font. If the same style font is already added to the builder, this method will fail with[IllegalArgumentException](https://developer.android.com/reference/kotlin/java/lang/IllegalArgumentException.html#). Note that system assumes all fonts bundled in FontFamily have the same coverage for the code points. For example, regular style font and bold style font must have the same code point coverage, otherwise some character may be shown as tofu.

|                                                          Parameters                                                           ||
|--------|-----------------------------------------------------------------------------------------------------------------------|
| `font` | [Font](https://developer.android.com/reference/kotlin/android/graphics/fonts/Font):a font This value cannot be`null`. |

|                                                                          Return                                                                           ||
|-----------------------------------------------------------------------------------------------------------------|------------------------------------------|
| [FontFamily.Builder](https://developer.android.com/reference/kotlin/android/graphics/fonts/FontFamily.Builder#) | this builder This value cannot be`null`. |

### build

Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun build(): FontFamily
```

Build the font family

|                                                                  Return                                                                   ||
|------------------------------------------------------------------------------------------------|-------------------------------------------|
| [FontFamily](https://developer.android.com/reference/kotlin/android/graphics/fonts/FontFamily) | a font family This value cannot be`null`. |

### buildVariableFamily

Added in[API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun buildVariableFamily(): FontFamily?
```

Build a variable font family that automatically adjust the \`wght\` and \`ital\` axes value for the requested weight/italic style values. To build a variable font family, added fonts must meet one of following conditions. If two font files are added, both font files must support \`wght\` axis and one font must support[FontStyle.FONT_SLANT_UPRIGHT](https://developer.android.com/reference/kotlin/android/graphics/fonts/FontStyle#FONT_SLANT_UPRIGHT:kotlin.Int)and another font must support[FontStyle.FONT_SLANT_ITALIC](https://developer.android.com/reference/kotlin/android/graphics/fonts/FontStyle#FONT_SLANT_ITALIC:kotlin.Int). If the requested weight value is lower than minimum value of the supported \`wght\` axis, the minimum supported \`wght\` value is used. If the requested weight value is larger than maximum value of the supported \`wght\` axis, the maximum supported \`wght\` value is used. The weight values of the fonts are ignored. If one font file is added, that font must support the \`wght\` axis. If that font support \`ital\` axis, that \`ital\` value is set to 1 when the italic style is requested. If that font doesn't support \`ital\` axis, synthetic italic may be used. If the requested weight value is lower than minimum value of the supported \`wght\` axis, the minimum supported \`wght\` value is used. If the requested weight value is larger than maximum value of the supported \`wght\`axis, the maximum supported \`wght\` value is used. The weight value of the font is ignored. If none of the above conditions are met, the provided font files cannot be used for variable font family and this function returns`null`. Even if this function returns`null`, you can still use[build()](https://developer.android.com/reference/kotlin/android/graphics/fonts/FontFamily.Builder#build())method for creating FontFamily instance with manually specifying variation settings by using[Font.Builder.setFontVariationSettings(String)](https://developer.android.com/reference/kotlin/android/graphics/fonts/Font.Builder#setFontVariationSettings(kotlin.String)).

|                                                                                         Return                                                                                         ||
|-------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|
| [FontFamily](https://developer.android.com/reference/kotlin/android/graphics/fonts/FontFamily)? | A variable font family. null if a variable font cannot be built from the given fonts. |