TTF_RenderText_LCD(3)

Usage

#include "SDL3_ttf/SDL_ttf.h"

SDL_Surface * TTF_RenderText_LCD(TTF_Font *font, const char *text, size_t length, SDL_Color fg, SDL_Color bg);

Header file

Defined in SDL3_ttf/SDL_ttf.h

Overview

This function will allocate a new 32-bit, ARGB surface, and render alpha-blended text using FreeType's LCD subpixel rendering. 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_LCD_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_Shaded , and

TTF_RenderText_Blended .

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 32-bit, ARGB surface, or NULL if there was an error.

Thread safety

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

Referred to by

TTF_RenderText_Solid(3) Render UTF-8 text at fast quality to a new 8-bit surface. TTF_RenderText_Shaded(3) Render UTF-8 text at high quality to a new 8-bit surface. TTF_RenderText_Blended(3) Render UTF-8 text at high quality to a new ARGB surface. TTF_RenderText_LCD_Wrapped(3) Render word-wrapped UTF-8 text at LCD subpixel quality to a new ARGB surface.