Migrating to SDL_ttf 3.0
This guide provides useful information for migrating applications from SDL_ttf 2.0 to SDL_ttf 3.0.
Functions that previously returned a negative error code now return bool.
Code that used to look like this:
if (TTF_Function() < 0 || TTF_Function() == -1) {
/* Failure... */
}
or
if (TTF_Function() == 0) {
/* Success... */
}
or
if (!TTF_Function()) {
/* Success... */
}
should be changed to:
if (TTF_Function()) {
/* Success... */
} else {
/* Failure... */
}
Several functions have been renamed. We have provided a handy semantic patch to migrate more easily to SDL3: SDL_migration.cocci
In general we have switched to using UTF8 in the API. Functions which had 3 variants, for Latin-1, UTF-8, and UCS2, now accept UTF-8 text. In addition, those functions now have an optional length parameter which allows you to render substrings.
The alpha in background colors is now transparent if it's equal to 0.
The following functions have been renamed:
- TTF_FontAscent() => TTF_GetFontAscent()
- TTF_FontDescent() => TTF_GetFontDescent()
- TTF_FontFaceFamilyName() => TTF_GetFontFamilyName()
- TTF_FontFaceIsFixedWidth() => TTF_FontIsFixedWidth()
- TTF_FontFaceStyleName() => TTF_GetFontStyleName()
- TTF_FontFaces() => TTF_GetNumFontFaces()
- TTF_FontHeight() => TTF_GetFontHeight()
- TTF_FontLineSkip() => TTF_GetFontLineSkip()
- TTF_GetFontWrappedAlign() => TTF_GetFontWrapAlignment()
- TTF_GlyphIsProvided() => TTF_FontHasGlyph()
- TTF_GlyphIsProvided32() => TTF_FontHasGlyph()
- TTF_GlyphMetrics() => TTF_GetGlyphMetrics()
- TTF_GlyphMetrics32() => TTF_GetGlyphMetrics()
- TTF_IsFontScalable() => TTF_FontIsScalable()
- TTF_RenderGlyph32_Blended() => TTF_RenderGlyph_Blended()
- TTF_RenderGlyph32_LCD() => TTF_RenderGlyph_LCD()
- TTF_RenderGlyph32_Shaded() => TTF_RenderGlyph_Shaded()
- TTF_RenderGlyph32_Solid() => TTF_RenderGlyph_Solid()
- TTF_RenderUTF8_Blended() => TTF_RenderText_Blended()
- TTF_RenderUTF8_Blended_Wrapped() => TTF_RenderText_Blended_Wrapped()
- TTF_RenderUTF8_LCD() => TTF_RenderText_LCD()
- TTF_RenderUTF8_LCD_Wrapped() => TTF_RenderText_LCD_Wrapped()
- TTF_RenderUTF8_Shaded() => TTF_RenderText_Shaded()
- TTF_RenderUTF8_Shaded_Wrapped() => TTF_RenderText_Shaded_Wrapped()
- TTF_RenderUTF8_Solid() => TTF_RenderText_Solid()
- TTF_RenderUTF8_Solid_Wrapped() => TTF_RenderText_Solid_Wrapped()
- TTF_SetFontScriptName() => TTF_SetFontScript()
- TTF_SetFontWrappedAlign() => TTF_SetFontWrapAlignment()
- TTF_SizeText() => TTF_GetStringSize()
- TTF_SizeUTF8() => TTF_GetStringSize()
The following functions have been removed:
- TTF_ByteSwappedUNICODE()
- TTF_GetFontKerningSizeGlyphs() - replaced with TTF_GetGlyphKerning()
- TTF_GetFontKerningSizeGlyphs32() - replaced with TTF_GetGlyphKerning()
- TTF_Linked_Version() - replaced with TTF_Version()
- TTF_MeasureText() - replaced with TTF_MeasureString()
- TTF_MeasureUNICODE() - replaced with TTF_MeasureString()
- TTF_MeasureUTF8() - replaced with TTF_MeasureString()
- TTF_OpenFontDPI() - replaced with TTF_OpenFontWithProperties()
- TTF_OpenFontDPIIO() - replaced with TTF_OpenFontWithProperties()
- TTF_OpenFontIndex() - replaced with TTF_OpenFontWithProperties()
- TTF_OpenFontIndexDPI() - replaced with TTF_OpenFontWithProperties()
- TTF_OpenFontIndexDPIIO() - replaced with TTF_OpenFontWithProperties()
- TTF_OpenFontIndexIO() - replaced with TTF_OpenFontWithProperties()
- TTF_RenderGlyph_Solid()
- TTF_RenderText_Solid()
- TTF_RenderText_Solid_Wrapped()
- TTF_RenderUNICODE_Blended()
- TTF_RenderUNICODE_Blended_Wrapped()
- TTF_RenderUNICODE_LCD()
- TTF_RenderUNICODE_LCD_Wrapped()
- TTF_RenderUNICODE_Shaded()
- TTF_RenderUNICODE_Shaded_Wrapped()
- TTF_RenderUNICODE_Solid()
- TTF_RenderUNICODE_Solid_Wrapped()
- TTF_SizeUNICODE()
The following macros have been removed:
- TTF_GetError() => SDL_GetError()
- TTF_SetError() => SDL_SetError()
The following symbols have been renamed:
- TTF_WRAPPED_ALIGN_CENTER => TTF_HORIZONTAL_ALIGN_CENTER
- TTF_WRAPPED_ALIGN_LEFT => TTF_HORIZONTAL_ALIGN_LEFT
- TTF_WRAPPED_ALIGN_RIGHT => TTF_HORIZONTAL_ALIGN_RIGHT