Lib.rs

› Rendering › Data formats
#true-type-font #sdl #font #bindings #sdl3 #rendering

sys no-std sdl3-ttf-sys

Low level Rust bindings for SDL3_ttf

by Maia and 2 contributors

4 releases

new 0.1.3+SDL3-ttf-3.2.2 Apr 20, 2025
0.1.2+SDL3-ttf-3.2.2 Apr 8, 2025
0.1.1+SDL3-ttf-3.2.2 Apr 1, 2025
0.1.0 Mar 3, 2025

#52 in Data formats

Download history 133/week @ 2025-02-25 278/week @ 2025-03-04 39/week @ 2025-03-11 105/week @ 2025-03-18 196/week @ 2025-03-25 298/week @ 2025-04-01 302/week @ 2025-04-08 416/week @ 2025-04-15

1,248 downloads per month
Used in 3 crates (via sdl3)

Zlib license

3MB
22K SLoC

Rust 17K SLoC // 0.0% comments C 3.5K SLoC // 0.2% comments C++ 1K SLoC // 0.3% comments Visual Studio Project 249 SLoC Python 153 SLoC // 0.5% comments Perl 70 SLoC // 0.1% comments M4 43 SLoC // 0.3% comments Automake 18 SLoC // 0.1% comments Shell 14 SLoC // 0.1% comments Visual Studio Solution 10 SLoC AWK 3 SLoC HLSL 1 SLoC

sdl3-ttf-sys: Low level Rust bindings for SDL3_ttf

These are low level Rust bindings for SDL3_ttf, an add-on library for SDL 3 for rendering text. This version of sdl3-ttf-sys has bindings for SDL_ttf versions 3.2.0 to 3.2.2, inclusive.

Most of the docs are generated directly from the C headers and document how SDL works in C. Using it from Rust might work differently in some cases. For example, macros in C are usually translated to constants or constant functions in Rust. Documentation specific to these Rust bindings are tagged with sdl3-sys.

Browse the API at docs.rs!

Usage

sdl3-ttf-sys requires SDL_ttf version 3.2.0 or later. Some APIs may require a later version. You can check availability in the documentation.

By default, sdl3-ttf-sys will attempt to link to a dynamic/shared library named SDL3_ttf in the default library search path, using the usual platform specific naming convention for libraries. You can change this behaviour with the following feature flags.

Feature Description
use-pkg-config Use pkg-config to find and link the SDL_ttf library.
use-vcpkg Use vcpkg to find and link the SDL_ttf library.
build-from-source Build and link SDL_ttf from source. You have to install any dependencies SDL needs to build for your target first. See below for build related features.
build-from-source-static Shortcut for enabling both the build-from-source and link-static features. This should no longer be necessary.
build-static-vendored Build and link SDL_ttf from source, use vendored libraries (see below), and link it all statically.
link-framework Link to a framework on Apple targets. This currently requires SDL3_ttf.xcframework to be located at /Library/Frameworks. The built executable has to be put in a signed app bundle to be able to run.
link-static Link SDL_ttf statically.

Building from source

When building from source with the build-from-source feature flag, you can use features to configure which backends and image formats to support. Features marked with "(cmake)" below all have an sdlttf- prefix and correspond to SDL_ttf's cmake variables. They're autodetected if not set. You can use a no- prefix to disable a cmake feature, for example no-sdlttf-harfbuzz disables harfbuzz support. Activated features override features disabled with the no- prefix.

Linking and vendoring

Feature (cmake) Description
vendored Build dependencies from source as part of building SDL_ttf

Rendering

Feature (cmake) Description
harfbuzz Use harfbuzz to improve text shaping
plutosvg Use plutosvg for color emoji support

Other features

Feature Description
debug-impls Implement the Debug trait for most SDL_ttf types.

Recent changes

  • 0.1.3: Add link-framework feature (doesn't work with build-from-source yet)
  • 0.1.2: Fix vendored build of Freetype with CMake 4
  • 0.1.1: Update SDL_ttf to 3.2.2
  • 0.1.0: First release

Dependencies