📦 libsdl3-ttf-doc

133 pages

S

SDL_TTF_MAJOR_VERSION(3)Printable format: "%d.%d.%d", MAJOR, MINOR, MICRO✨
SDL_TTF_VERSION(3)This is the version number macro for the current SDL_ttf version.✨
SDL_TTF_VERSION_ATLEAST(3)This macro will evaluate to true if compiled with SDL_ttf at least X.Y.Z.✨

T

TTF_AddFallbackFont(3)Add a fallback font.✨
TTF_AppendTextString(3)Append UTF-8 text to a text object.✨
TTF_ClearFallbackFonts(3)Remove all fallback fonts.✨
TTF_CloseFont(3)Dispose of a previously-created font.✨
TTF_CopyFont(3)Create a copy of an existing font.✨
TTF_CreateGPUTextEngine(3)Create a text engine for drawing text with the SDL GPU API.✨
TTF_CreateGPUTextEngineWithProperties(3)Create a text engine for drawing text with the SDL GPU API, with the specified properties.✨
TTF_CreateRendererTextEngine(3)Create a text engine for drawing text on an SDL renderer.✨
TTF_CreateRendererTextEngineWithProperties(3)Create a text engine for drawing text on an SDL renderer, with the specified properties.✨
TTF_CreateSurfaceTextEngine(3)Create a text engine for drawing text on SDL surfaces.✨
TTF_CreateText(3)Create a text object from UTF-8 text and a text engine.✨
TTF_DeleteTextString(3)Delete UTF-8 text from a text object.✨
TTF_DestroyGPUTextEngine(3)Destroy a text engine created for drawing text with the SDL GPU API.✨
TTF_DestroyRendererTextEngine(3)Destroy a text engine created for drawing text on an SDL renderer.✨
TTF_DestroySurfaceTextEngine(3)Destroy a text engine created for drawing text on SDL surfaces.✨
TTF_DestroyText(3)Destroy a text object created by a text engine.✨
TTF_Direction(3type)Direction flags✨
TTF_DrawRendererText(3)Draw text to an SDL renderer.✨
TTF_DrawSurfaceText(3)Draw text to an SDL surface.✨
TTF_Font(3type)The internal structure containing font information.✨
TTF_FontHasGlyph(3)Check whether a glyph is provided by the font for a UNICODE codepoint.✨
TTF_FontIsFixedWidth(3)Query whether a font is fixed-width.✨
TTF_FontIsScalable(3)Query whether a font is scalable or not.✨
TTF_FontStyleFlags(3type)Font style flags for TTF_Font✨
TTF_GetFontAscent(3)Query the offset from the baseline to the top of a font.✨
TTF_GetFontDescent(3)Query the offset from the baseline to the bottom of a font.✨
TTF_GetFontDirection(3)Get the direction to be used for text shaping by a font.✨
TTF_GetFontDPI(3)Get font target resolutions, in dots per inch.✨
TTF_GetFontFamilyName(3)Query a font's family name.✨
TTF_GetFontGeneration(3)Get the font generation.✨
TTF_GetFontHeight(3)Query the total height of a font.✨
TTF_GetFontHinting(3)Query a font's current FreeType hinter setting.✨
TTF_GetFontKerning(3)Query whether or not kerning is enabled for a font.✨
TTF_GetFontLineSkip(3)Query the spacing between lines of text for a font.✨
TTF_GetFontOutline(3)Query a font's current outline.✨
TTF_GetFontProperties(3)Get the properties associated with a font.✨
TTF_GetFontScript(3)Get the script used for text shaping a font.✨
TTF_GetFontSDF(3)Query whether Signed Distance Field rendering is enabled for a font.✨
TTF_GetFontSize(3)Get the size of a font.✨
TTF_GetFontStyle(3)Query a font's current style.✨
TTF_GetFontStyleName(3)Query a font's style name.✨
TTF_GetFontWeight(3)Query a font's weight, in terms of the lightness/heaviness of the strokes.✨
TTF_GetFontWrapAlignment(3)Query a font's current wrap alignment option.✨
TTF_GetFreeTypeVersion(3)Query the version of the FreeType library in use.✨
TTF_GetGlyphImage(3)Get the pixel image for a UNICODE codepoint.✨
TTF_GetGlyphImageForIndex(3)Get the pixel image for a character index.✨
TTF_GetGlyphKerning(3)Query the kerning size between the glyphs of two UNICODE codepoints.✨
TTF_GetGlyphMetrics(3)Query the metrics (dimensions) of a font's glyph for a UNICODE codepoint.✨
TTF_GetGlyphScript(3)Get the script used by a 32-bit codepoint.✨
TTF_GetGPUTextDrawData(3)Get the geometry data needed for drawing the text.✨
TTF_GetGPUTextEngineWinding(3)Get the winding order of the vertices returned by TTF_GetGPUTextDrawData for a particular GPU text engine✨
TTF_GetHarfBuzzVersion(3)Query the version of the HarfBuzz library in use.✨
TTF_GetNextTextSubString(3)Get the next substring in a text object✨
TTF_GetNumFontFaces(3)Query the number of faces of a font.✨
TTF_GetPreviousTextSubString(3)Get the previous substring in a text object✨
TTF_GetStringSize(3)Calculate the dimensions of a rendered string of UTF-8 text.✨
TTF_GetStringSizeWrapped(3)Calculate the dimensions of a rendered string of UTF-8 text.✨
TTF_GetTextColor(3)Get the color of a text object.✨
TTF_GetTextColorFloat(3)Get the color of a text object.✨
TTF_GetTextDirection(3)Get the direction to be used for text shaping a text object.✨
TTF_GetTextEngine(3)Get the text engine used by a text object.✨
TTF_GetTextFont(3)Get the font used by a text object.✨
TTF_GetTextPosition(3)Get the position of a text object.✨
TTF_GetTextProperties(3)Get the properties associated with a text object.✨
TTF_GetTextScript(3)Get the script used for text shaping a text object.✨
TTF_GetTextSize(3)Get the size of a text object.✨
TTF_GetTextSubString(3)Get the substring of a text object that surrounds a text offset.✨
TTF_GetTextSubStringForLine(3)Get the substring of a text object that contains the given line.✨
TTF_GetTextSubStringForPoint(3)Get the portion of a text string that is closest to a point.✨
TTF_GetTextSubStringsForRange(3)Get the substrings of a text object that contain a range of text.✨
TTF_GetTextWrapWidth(3)Get whether wrapping is enabled on a text object.✨
TTF_GPUAtlasDrawSequence(3type)Draw sequence returned by TTF_GetGPUTextDrawData✨
TTF_GPUTextEngineWinding(3type)The winding order of the vertices returned by TTF_GetGPUTextDrawData✨
TTF_HintingFlags(3type)Hinting flags for TTF (TrueType Fonts)✨
TTF_HorizontalAlignment(3type)The horizontal alignment used when rendering wrapped text.✨
TTF_ImageType(3type)The type of data in a glyph image✨
TTF_Init(3)Initialize SDL_ttf.✨
TTF_InsertTextString(3)Insert UTF-8 text into a text object.✨
TTF_MeasureString(3)Calculate how much of a UTF-8 string will fit in a given width.✨
TTF_OpenFont(3)Create a font from a file, using a specified point size.✨
TTF_OpenFontIO(3)Create a font from an SDL_IOStream, using a specified point size.✨
TTF_OpenFontWithProperties(3)Create a font with the specified properties.✨
TTF_Quit(3)Deinitialize SDL_ttf.✨
TTF_RemoveFallbackFont(3)Remove a fallback font.✨
TTF_RenderGlyph_Blended(3)Render a single UNICODE codepoint at high quality to a new ARGB surface.✨
TTF_RenderGlyph_LCD(3)Render a single UNICODE codepoint at LCD subpixel quality to a new ARGB surface.✨
TTF_RenderGlyph_Shaded(3)Render a single UNICODE codepoint at high quality to a new 8-bit surface.✨
TTF_RenderGlyph_Solid(3)Render a single 32-bit glyph at fast 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_Blended_Wrapped(3)Render word-wrapped UTF-8 text at high quality to a new ARGB surface.✨
TTF_RenderText_LCD(3)Render UTF-8 text at LCD subpixel 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.✨
TTF_RenderText_Shaded(3)Render UTF-8 text at high quality to a new 8-bit surface.✨
TTF_RenderText_Shaded_Wrapped(3)Render word-wrapped UTF-8 text at high quality to a new 8-bit surface.✨
TTF_RenderText_Solid(3)Render UTF-8 text at fast quality to a new 8-bit surface.✨
TTF_RenderText_Solid_Wrapped(3)Render word-wrapped UTF-8 text at fast quality to a new 8-bit surface.✨
TTF_SetFontDirection(3)Set the direction to be used for text shaping by a font.✨
TTF_SetFontHinting(3)Set a font's current hinter setting.✨
TTF_SetFontKerning(3)Set if kerning is enabled for a font.✨
TTF_SetFontLanguage(3)Set language to be used for text shaping by a font.✨
TTF_SetFontLineSkip(3)Set the spacing between lines of text for a font.✨
TTF_SetFontOutline(3)Set a font's current outline.✨
TTF_SetFontScript(3)Set the script to be used for text shaping by a font.✨
TTF_SetFontSDF(3)Enable Signed Distance Field rendering for a font.✨
TTF_SetFontSize(3)Set a font's size dynamically.✨
TTF_SetFontSizeDPI(3)Set font size dynamically with target resolutions, in dots per inch.✨
TTF_SetFontStyle(3)Set a font's current style.✨
TTF_SetFontWrapAlignment(3)Set a font's current wrap alignment option.✨
TTF_SetGPUTextEngineWinding(3)Sets the winding order of the vertices returned by TTF_GetGPUTextDrawData for a particular GPU text engine.✨
TTF_SetTextColor(3)Set the color of a text object.✨
TTF_SetTextColorFloat(3)Set the color of a text object.✨
TTF_SetTextDirection(3)Set the direction to be used for text shaping a text object.✨
TTF_SetTextEngine(3)Set the text engine used by a text object.✨
TTF_SetTextFont(3)Set the font used by a text object.✨
TTF_SetTextPosition(3)Set the position of a text object.✨
TTF_SetTextScript(3)Set the script to be used for text shaping a text object.✨
TTF_SetTextString(3)Set the UTF-8 text used by a text object.✨
TTF_SetTextWrapWhitespaceVisible(3)Set whether whitespace should be visible when wrapping a text object.✨
TTF_SetTextWrapWidth(3)Set whether wrapping is enabled on a text object.✨
TTF_StringToTag(3)Convert from a 4 character string to a 32-bit tag.✨
TTF_SubString(3type)The representation of a substring within text.✨
TTF_SubStringFlags(3type)Flags for TTF_SubString✨
TTF_TagToString(3)Convert from a 32-bit tag to a 4 character string.✨
TTF_Text(3type)Text created with TTF_CreateText ()✨
TTF_TextData(3type)Internal data for TTF_Text✨
TTF_TextEngine(3type)A text engine used to create text objects.✨
TTF_TextWrapWhitespaceVisible(3)Return whether whitespace is shown when wrapping a text object.✨
TTF_UpdateText(3)Update the layout of a text object.✨
TTF_Version(3)This function gets the version of the dynamically linked SDL_ttf library.✨
TTF_WasInit(3)Check if SDL_ttf is initialized.✨