32 lines
8.8 KiB
HTML
32 lines
8.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="Logic for variable fonts."><title>VariableFont in ab_glyph - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="ab_glyph" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../ab_glyph/index.html">ab_<wbr>glyph</a><span class="version">0.2.29</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Variable<wbr>Font</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.set_variation" title="set_variation">set_variation</a></li><li><a href="#tymethod.variations" title="variations">variations</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate ab_<wbr>glyph</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">ab_glyph</a></span><h1>Trait <span class="trait">VariableFont</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/ab_glyph/variable.rs.html#9-50">Source</a> </span></div><pre class="rust item-decl"><code>pub trait VariableFont {
|
||
// Required methods
|
||
fn <a href="#tymethod.set_variation" class="fn">set_variation</a>(&mut self, tag: &[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">4</a>], value: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.variations" class="fn">variations</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="struct.VariationAxis.html" title="struct ab_glyph::VariationAxis">VariationAxis</a>>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Logic for variable fonts.</p>
|
||
<p>Requires feature <code>variable-fonts</code> (enabled by default).</p>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.set_variation" class="method"><a class="src rightside" href="../src/ab_glyph/variable.rs.html#28">Source</a><h4 class="code-header">fn <a href="#tymethod.set_variation" class="fn">set_variation</a>(&mut self, tag: &[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">4</a>], value: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Sets a variation axis coordinate value by it’s tag.</p>
|
||
<p>Returns false if there is no such axis tag.</p>
|
||
<h5 id="example"><a class="doc-anchor" href="#example">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ab_glyph::{FontRef, VariableFont};
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>font = FontRef::try_from_slice(<span class="macro">include_bytes!</span>(<span class="string">"../../dev/fonts/Cantarell-VF.otf"</span>))<span class="question-mark">?</span>;
|
||
|
||
<span class="comment">// set weight to 600
|
||
</span><span class="macro">assert!</span>(font.set_variation(<span class="string">b"wght"</span>, <span class="number">600.0</span>));
|
||
|
||
<span class="comment">// no such variation tag "foob" so return false
|
||
</span><span class="macro">assert!</span>(!font.set_variation(<span class="string">b"foob"</span>, <span class="number">200.0</span>));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.variations" class="method"><a class="src rightside" href="../src/ab_glyph/variable.rs.html#49">Source</a><h4 class="code-header">fn <a href="#tymethod.variations" class="fn">variations</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="struct" href="struct.VariationAxis.html" title="struct ab_glyph::VariationAxis">VariationAxis</a>></h4></section></summary><div class="docblock"><p>Returns variation axes.</p>
|
||
<h5 id="example-1"><a class="doc-anchor" href="#example-1">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ab_glyph::{FontRef, VariableFont};
|
||
|
||
<span class="kw">let </span>font = FontRef::try_from_slice(<span class="macro">include_bytes!</span>(<span class="string">"../../dev/fonts/Cantarell-VF.otf"</span>))<span class="question-mark">?</span>;
|
||
<span class="kw">let </span>var = <span class="kw-2">&</span>font.variations()[<span class="number">0</span>];
|
||
|
||
<span class="macro">assert_eq!</span>(var.tag, <span class="kw-2">*</span><span class="string">b"wght"</span>);
|
||
<span class="macro">assert_eq!</span>(var.name.as_deref(), <span class="prelude-val">Some</span>(<span class="string">"Weight"</span>));
|
||
<span class="macro">assert!</span>((var.min_value - <span class="number">100.0</span>).abs() < f32::EPSILON);
|
||
<span class="macro">assert!</span>((var.default_value - <span class="number">400.0</span>).abs() < f32::EPSILON);
|
||
<span class="macro">assert!</span>((var.max_value - <span class="number">800.0</span>).abs() < f32::EPSILON);
|
||
<span class="macro">assert!</span>(!var.hidden);</code></pre></div>
|
||
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-VariableFont-for-FontRef%3C'_%3E" class="impl"><a class="src rightside" href="../src/ab_glyph/ttfp/variable.rs.html#6-25">Source</a><a href="#impl-VariableFont-for-FontRef%3C'_%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.VariableFont.html" title="trait ab_glyph::VariableFont">VariableFont</a> for <a class="struct" href="struct.FontRef.html" title="struct ab_glyph::FontRef">FontRef</a><'_></h3></section><section id="impl-VariableFont-for-FontVec" class="impl"><a class="src rightside" href="../src/ab_glyph/ttfp/variable.rs.html#27-37">Source</a><a href="#impl-VariableFont-for-FontVec" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.VariableFont.html" title="trait ab_glyph::VariableFont">VariableFont</a> for <a class="struct" href="struct.FontVec.html" title="struct ab_glyph::FontVec">FontVec</a></h3></section></div><script src="../trait.impl/ab_glyph/variable/trait.VariableFont.js" async></script></section></div></main></body></html> |