sdl3/generated/lib_sdl_ttf library

Properties

libSdl3Ttf DynamicLibrary
final

Functions

ttfAppendTextString(Pointer<TtfText> text, String? string, int length) bool
Append UTF-8 text to a text object.
ttfCloseFont(Pointer<TtfFont> font) → void
Dispose of a previously-created font.
ttfCreateGpuTextEngine(Pointer<SdlGpuDevice> device) Pointer<TtfTextEngine>
Create a text engine for drawing text with the SDL GPU API.
ttfCreateRendererTextEngine(Pointer<SdlRenderer> renderer) Pointer<TtfTextEngine>
Create a text engine for drawing text on an SDL renderer.
ttfCreateSurfaceTextEngine() Pointer<TtfTextEngine>
Create a text engine for drawing text on SDL surfaces.
ttfCreateText(Pointer<TtfTextEngine> engine, Pointer<TtfFont> font, String? text, int length) Pointer<TtfText>
Create a text object from UTF-8 text and a text engine.
ttfDeleteTextString(Pointer<TtfText> text, int offset, int length) bool
Delete UTF-8 text from a text object.
ttfDestroyGpuTextEngine(Pointer<TtfTextEngine> engine) → void
Destroy a text engine created for drawing text with the SDL GPU API.
ttfDestroyRendererTextEngine(Pointer<TtfTextEngine> engine) → void
Destroy a text engine created for drawing text on an SDL renderer.
ttfDestroySurfaceTextEngine(Pointer<TtfTextEngine> engine) → void
Destroy a text engine created for drawing text on SDL surfaces.
ttfDestroyText(Pointer<TtfText> text) → void
Destroy a text object created by a text engine.
ttfDrawRendererText(Pointer<TtfText> text, double x, double y) bool
Draw text to an SDL renderer.
ttfDrawSurfaceText(Pointer<TtfText> text, int x, int y, Pointer<SdlSurface> surface) bool
Draw text to an SDL surface.
ttfFontHasGlyph(Pointer<TtfFont> font, int ch) bool
Check whether a glyph is provided by the font for a UNICODE codepoint.
ttfFontIsFixedWidth(Pointer<TtfFont> font) bool
Query whether a font is fixed-width.
ttfFontIsScalable(Pointer<TtfFont> font) bool
Query whether a font is scalable or not.
ttfGetFontAscent(Pointer<TtfFont> font) int
Query the offset from the baseline to the top of a font.
ttfGetFontDescent(Pointer<TtfFont> font) int
Query the offset from the baseline to the bottom of a font.
ttfGetFontDirection(Pointer<TtfFont> font) int
Get direction to be used for text shaping by a font.
ttfGetFontDpi(Pointer<TtfFont> font, Pointer<Int32> hdpi, Pointer<Int32> vdpi) bool
Get font target resolutions, in dots per inch.
ttfGetFontFamilyName(Pointer<TtfFont> font) String?
Query a font's family name.
ttfGetFontGeneration(Pointer<TtfFont> font) int
Get the font generation.
ttfGetFontHeight(Pointer<TtfFont> font) int
Query the total height of a font.
ttfGetFontHinting(Pointer<TtfFont> font) int
Query a font's current FreeType hinter setting.
ttfGetFontKerning(Pointer<TtfFont> font) bool
Query whether or not kerning is enabled for a font.
ttfGetFontLineSkip(Pointer<TtfFont> font) int
Query the spacing between lines of text for a font.
ttfGetFontOutline(Pointer<TtfFont> font) int
Query a font's current outline.
ttfGetFontProperties(Pointer<TtfFont> font) int
Get the properties associated with a font.
ttfGetFontSdf(Pointer<TtfFont> font) bool
Query whether Signed Distance Field rendering is enabled for a font.
ttfGetFontSize(Pointer<TtfFont> font) double
Get the size of a font.
ttfGetFontStyle(Pointer<TtfFont> font) int
Query a font's current style.
ttfGetFontStyleName(Pointer<TtfFont> font) String?
Query a font's style name.
ttfGetFontWrapAlignment(Pointer<TtfFont> font) int
Query a font's current wrap alignment option.
ttfGetFreeTypeVersion(Pointer<Int32> major, Pointer<Int32> minor, Pointer<Int32> patch) → void
Query the version of the FreeType library in use.
ttfGetGlyphImage(Pointer<TtfFont> font, int ch) Pointer<SdlSurface>
Get the pixel image for a UNICODE codepoint.
ttfGetGlyphImageForIndex(Pointer<TtfFont> font, int glyphIndex) Pointer<SdlSurface>
Get the pixel image for a character index.
ttfGetGlyphKerning(Pointer<TtfFont> font, int previousCh, int ch, Pointer<Int32> kerning) bool
Query the kerning size between the glyphs of two UNICODE codepoints.
ttfGetGlyphMetrics(Pointer<TtfFont> font, int ch, Pointer<Int32> minx, Pointer<Int32> maxx, Pointer<Int32> miny, Pointer<Int32> maxy, Pointer<Int32> advance) bool
Query the metrics (dimensions) of a font's glyph for a UNICODE codepoint.
ttfGetGlyphScript(int ch, Pointer<Int8> script, int scriptSize) bool
Get the script used by a 32-bit codepoint.
ttfGetGpuTextDrawData(Pointer<TtfText> text) Pointer<TtfGpuAtlasDrawSequence>
Get the geometry data needed for drawing the text.
ttfGetHarfBuzzVersion(Pointer<Int32> major, Pointer<Int32> minor, Pointer<Int32> patch) → void
Query the version of the HarfBuzz library in use.
ttfGetNextTextSubString(Pointer<TtfText> text, Pointer<TtfSubString> substring, Pointer<TtfSubString> next) bool
Get the next substring in a text object
ttfGetPreviousTextSubString(Pointer<TtfText> text, Pointer<TtfSubString> substring, Pointer<TtfSubString> previous) bool
Get the previous substring in a text object
ttfGetStringSize(Pointer<TtfFont> font, String? text, int length, Pointer<Int32> w, Pointer<Int32> h) bool
Calculate the dimensions of a rendered string of UTF-8 text.
ttfGetStringSizeWrapped(Pointer<TtfFont> font, String? text, int length, int wrapWidth, Pointer<Int32> w, Pointer<Int32> h) bool
Calculate the dimensions of a rendered string of UTF-8 text.
ttfGetTextColor(Pointer<TtfText> text, Pointer<Uint8> r, Pointer<Uint8> g, Pointer<Uint8> b, Pointer<Uint8> a) bool
Get the color of a text object.
ttfGetTextColorFloat(Pointer<TtfText> text, Pointer<Float> r, Pointer<Float> g, Pointer<Float> b, Pointer<Float> a) bool
Get the color of a text object.
ttfGetTextEngine(Pointer<TtfText> text) Pointer<TtfTextEngine>
Get the text engine used by a text object.
ttfGetTextFont(Pointer<TtfText> text) Pointer<TtfFont>
Get the font used by a text object.
ttfGetTextPosition(Pointer<TtfText> text, Pointer<Int32> x, Pointer<Int32> y) bool
Get the position of a text object.
ttfGetTextProperties(Pointer<TtfText> text) int
Get the properties associated with a text object.
ttfGetTextSize(Pointer<TtfText> text, Pointer<Int32> w, Pointer<Int32> h) bool
Get the size of a text object.
ttfGetTextSubString(Pointer<TtfText> text, int offset, Pointer<TtfSubString> substring) bool
Get the substring of a text object that surrounds a text offset.
ttfGetTextSubStringForLine(Pointer<TtfText> text, int line, Pointer<TtfSubString> substring) bool
Get the substring of a text object that contains the given line.
ttfGetTextSubStringForPoint(Pointer<TtfText> text, int x, int y, Pointer<TtfSubString> substring) bool
Get the portion of a text string that is closest to a point.
ttfGetTextSubStringsForRange(Pointer<TtfText> text, int offset, int length, Pointer<Int32> count) Pointer<Pointer<TtfSubString>>
Get the substrings of a text object that contain a range of text.
ttfGetTextWrapWidth(Pointer<TtfText> text, Pointer<Int32> wrapWidth) bool
Get whether wrapping is enabled on a text object.
ttfInit() bool
Initialize SDL_ttf.
ttfInsertTextString(Pointer<TtfText> text, int offset, String? string, int length) bool
Insert UTF-8 text into a text object.
ttfMeasureString(Pointer<TtfFont> font, String? text, int length, int maxWidth, Pointer<Int32> measuredWidth, Pointer<Uint32> measuredLength) bool
Calculate how much of a UTF-8 string will fit in a given width.
ttfOpenFont(String? file, double ptsize) Pointer<TtfFont>
Create a font from a file, using a specified point size.
ttfOpenFontIo(Pointer<SdlIoStream> src, bool closeio, double ptsize) Pointer<TtfFont>
Create a font from an SDL_IOStream, using a specified point size.
ttfOpenFontWithProperties(int props) Pointer<TtfFont>
Create a font with the specified properties.
ttfQuit() → void
Deinitialize SDL_ttf.
ttfRenderGlyphBlended(Pointer<TtfFont> font, int ch, SdlColor fg) Pointer<SdlSurface>
Render a single UNICODE codepoint at high quality to a new ARGB surface.
ttfRenderGlyphLcd(Pointer<TtfFont> font, int ch, SdlColor fg, SdlColor bg) Pointer<SdlSurface>
Render a single UNICODE codepoint at LCD subpixel quality to a new ARGB surface.
ttfRenderGlyphShaded(Pointer<TtfFont> font, int ch, SdlColor fg, SdlColor bg) Pointer<SdlSurface>
Render a single UNICODE codepoint at high quality to a new 8-bit surface.
ttfRenderGlyphSolid(Pointer<TtfFont> font, int ch, SdlColor fg) Pointer<SdlSurface>
Render a single 32-bit glyph at fast quality to a new 8-bit surface.
ttfRenderTextBlended(Pointer<TtfFont> font, String? text, int length, SdlColor fg) Pointer<SdlSurface>
Render UTF-8 text at high quality to a new ARGB surface.
ttfRenderTextBlendedWrapped(Pointer<TtfFont> font, String? text, int length, SdlColor fg, int wrapWidth) Pointer<SdlSurface>
Render word-wrapped UTF-8 text at high quality to a new ARGB surface.
ttfRenderTextLcd(Pointer<TtfFont> font, String? text, int length, SdlColor fg, SdlColor bg) Pointer<SdlSurface>
Render UTF-8 text at LCD subpixel quality to a new ARGB surface.
ttfRenderTextLcdWrapped(Pointer<TtfFont> font, String? text, int length, SdlColor fg, SdlColor bg, int wrapWidth) Pointer<SdlSurface>
Render word-wrapped UTF-8 text at LCD subpixel quality to a new ARGB surface.
ttfRenderTextShaded(Pointer<TtfFont> font, String? text, int length, SdlColor fg, SdlColor bg) Pointer<SdlSurface>
Render UTF-8 text at high quality to a new 8-bit surface.
ttfRenderTextShadedWrapped(Pointer<TtfFont> font, String? text, int length, SdlColor fg, SdlColor bg, int wrapWidth) Pointer<SdlSurface>
Render word-wrapped UTF-8 text at high quality to a new 8-bit surface.
ttfRenderTextSolid(Pointer<TtfFont> font, String? text, int length, SdlColor fg) Pointer<SdlSurface>
Render UTF-8 text at fast quality to a new 8-bit surface.
ttfRenderTextSolidWrapped(Pointer<TtfFont> font, String? text, int length, SdlColor fg, int wrapLength) Pointer<SdlSurface>
Render word-wrapped UTF-8 text at fast quality to a new 8-bit surface.
ttfSetFontDirection(Pointer<TtfFont> font, int direction) bool
Set direction to be used for text shaping by a font.
ttfSetFontHinting(Pointer<TtfFont> font, int hinting) → void
Set a font's current hinter setting.
ttfSetFontKerning(Pointer<TtfFont> font, bool enabled) → void
Set if kerning is enabled for a font.
ttfSetFontLanguage(Pointer<TtfFont> font, String? languageBcp47) bool
Set language to be used for text shaping by a font.
ttfSetFontLineSkip(Pointer<TtfFont> font, int lineskip) → void
Set the spacing between lines of text for a font.
ttfSetFontOutline(Pointer<TtfFont> font, int outline) bool
Set a font's current outline.
ttfSetFontScript(Pointer<TtfFont> font, String? script) bool
Set script to be used for text shaping by a font.
ttfSetFontSdf(Pointer<TtfFont> font, bool enabled) bool
Enable Signed Distance Field rendering for a font.
ttfSetFontSize(Pointer<TtfFont> font, double ptsize) bool
Set a font's size dynamically.
ttfSetFontSizeDpi(Pointer<TtfFont> font, double ptsize, int hdpi, int vdpi) bool
Set font size dynamically with target resolutions, in dots per inch.
ttfSetFontStyle(Pointer<TtfFont> font, int style) → void
Set a font's current style.
ttfSetFontWrapAlignment(Pointer<TtfFont> font, int align) → void
Set a font's current wrap alignment option.
ttfSetTextColor(Pointer<TtfText> text, int r, int g, int b, int a) bool
Set the color of a text object.
ttfSetTextColorFloat(Pointer<TtfText> text, double r, double g, double b, double a) bool
Set the color of a text object.
ttfSetTextEngine(Pointer<TtfText> text, Pointer<TtfTextEngine> engine) bool
Set the text engine used by a text object.
ttfSetTextFont(Pointer<TtfText> text, Pointer<TtfFont> font) bool
Set the font used by a text object.
ttfSetTextPosition(Pointer<TtfText> text, int x, int y) bool
Set the position of a text object.
ttfSetTextString(Pointer<TtfText> text, String? string, int length) bool
Set the UTF-8 text used by a text object.
ttfSetTextWrapWhitespaceVisible(Pointer<TtfText> text, bool visible) bool
Set whether whitespace should be visible when wrapping a text object.
ttfSetTextWrapWidth(Pointer<TtfText> text, int wrapWidth) bool
Set whether wrapping is enabled on a text object.
ttfTextWrapWhitespaceVisible(Pointer<TtfText> text) bool
Return whether whitespace is shown when wrapping a text object.
ttfUpdateText(Pointer<TtfText> text) bool
Update the layout of a text object.
ttfVersion() int
This function gets the version of the dynamically linked SDL_ttf library.
ttfWasInit() int
Check if SDL_ttf is initialized.