mirror of
https://github.com/encounter/rust-sdl2.git
synced 2026-07-10 21:18:41 -07:00
33 lines
6.8 KiB
HTML
33 lines
6.8 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `ttf` mod in crate `sdl2`."><meta name="keywords" content="rust, rustlang, rust-lang, ttf"><title>sdl2::ttf - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../sdl2/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module ttf</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../index.html'>sdl2</a></p><script>window.sidebarCurrent = {name: 'ttf', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/sdl2/ttf/mod.rs.html#1-32' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>sdl2</a>::<wbr><a class="mod" href=''>ttf</a></span></h1><div class='docblock'><p>A binding for the library <code>SDL2_ttf</code></p>
|
||
<p>Note that you need to build with the
|
||
feature <code>ttf</code> for this module to be enabled,
|
||
like so:</p>
|
||
<pre><code class="language-bash">$ cargo build --features "ttf"
|
||
</code></pre>
|
||
<p>If you want to use this with from inside your own
|
||
crate, you will need to add this in your Cargo.toml</p>
|
||
<pre><code class="language-toml">[dependencies.sdl2]
|
||
version = ...
|
||
default-features = false
|
||
features = ["ttf"]
|
||
</code></pre>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.Font.html" title='sdl2::ttf::Font struct'>Font</a></td><td class='docblock-short'><p>A loaded TTF font.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.FontStyle.html" title='sdl2::ttf::FontStyle struct'>FontStyle</a></td><td class='docblock-short'><p>The styling of a font.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.GlyphMetrics.html" title='sdl2::ttf::GlyphMetrics struct'>GlyphMetrics</a></td><td class='docblock-short'><p>Information about a specific glyph (character) in a font face.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.PartialRendering.html" title='sdl2::ttf::PartialRendering struct'>PartialRendering</a></td><td class='docblock-short'><p>A builder for a font rendering.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Sdl2TtfContext.html" title='sdl2::ttf::Sdl2TtfContext struct'>Sdl2TtfContext</a></td><td class='docblock-short'><p>A context manager for <code>SDL2_TTF</code> to manage C code initialization and clean-up.</p>
|
||
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table><tr class='module-item'><td><a class="enum" href="enum.FontError.html" title='sdl2::ttf::FontError enum'>FontError</a></td><td class='docblock-short'><p>A font-related error.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Hinting.html" title='sdl2::ttf::Hinting enum'>Hinting</a></td><td class='docblock-short'><p>Information about the hinting of a font.
|
||
See <a href="https://en.wikipedia.org/wiki/Font_hinting">wikipedia</a></p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.InitError.html" title='sdl2::ttf::InitError enum'>InitError</a></td><td class='docblock-short'><p>An error for when <code>sdl2_ttf</code> is attempted initialized twice
|
||
Necessary for context management, unless we find a way to have a singleton</p>
|
||
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
||
<table><tr class='module-item'><td><a class="fn" href="fn.get_linked_version.html" title='sdl2::ttf::get_linked_version fn'>get_linked_version</a></td><td class='docblock-short'><p>Returns the version of the dynamically linked <code>SDL_TTF</code> library</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.has_been_initialized.html" title='sdl2::ttf::has_been_initialized fn'>has_been_initialized</a></td><td class='docblock-short'><p>Returns whether library has been initialized already.</p>
|
||
</td></tr><tr class='module-item'><td><a class="fn" href="fn.init.html" title='sdl2::ttf::init fn'>init</a></td><td class='docblock-short'><p>Initializes the truetype font API and returns a context manager which will
|
||
clean up the library once it goes out of scope.</p>
|
||
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
||
<table><tr class='module-item'><td><a class="type" href="type.FontResult.html" title='sdl2::ttf::FontResult type'>FontResult</a></td><td class='docblock-short'><p>The result of an <code>SDL2_TTF</code> font operation.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "sdl2";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |