---
name: "TTF_RenderText_Shaded"
section: "3"
platform: "linux"
package: "libsdl3-ttf-doc"
version: "3.2.2+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/TTF_RenderText_Shaded"
---

# TTF\_RenderText\_Shaded(3)

Render UTF-8 text at high quality to a new 8-bit surface.

## NAME

TTF\_RenderText\_Shaded - Render UTF-8 text at high quality to a new 8-bit surface.

## HEADER FILE

Defined in SDL3\_ttf/SDL\_ttf.h

## SYNOPSIS

```
#include "SDL3_ttf/SDL_ttf.h"
```

**SDL\_Surface \* TTF\_RenderText\_Shaded(TTF\_Font \*font, const char \*text, size\_t length, SDL\_Color fg, SDL\_Color bg);**

## DESCRIPTION

This function will allocate a new 8-bit, palettized surface. The surface's 0 pixel will be the specified background color, while other pixels have varying degrees of the foreground color. This function returns the new surface, or NULL if there was an error.

This will not word-wrap the string; you'll get a surface with a single line of text, as long as the string requires. You can use

**TTF\_RenderText\_Shaded\_Wrapped** () instead if you need to wrap the output to multiple lines.

This will not wrap on newline characters.

You can render at other quality levels with

**TTF\_RenderText\_Solid** ,

**TTF\_RenderText\_Blended** , and

**TTF\_RenderText\_LCD** .

## FUNCTION PARAMETERS

- *font*

  the font to render with.

- *text*

  text to render, in UTF-8 encoding.

- *length*

  the length of the text, in bytes, or 0 for null terminated text.

- *fg*

  the foreground color for the text.

- *bg*

  the background color for the text.

## RETURN VALUE

Returns a new 8-bit, palettized surface, or NULL if there was an error.

## THREAD SAFETY

This function should be called on the thread that created the font.

## AVAILABILITY

This function is available since SDL\_ttf 3.0.0.

## SEE ALSO

**•**(3), [**TTF\_RenderText\_Blended**(3)](/TTF_RenderText_Blended/3.md), **•**(3), [**TTF\_RenderText\_LCD**(3)](/TTF_RenderText_LCD/3.md), **•**(3), [**TTF\_RenderText\_Shaded\_Wrapped**(3)](/TTF_RenderText_Shaded_Wrapped/3.md), **•**(3), [**TTF\_RenderText\_Solid**(3)](/TTF_RenderText_Solid/3.md)