Files
phy/ttf_parser/colr/trait.Painter.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

23 lines
9.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="A trait for color glyph painting."><title>Painter in ttf_parser::colr - 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="ttf_parser" 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="../../ttf_parser/index.html">ttf_<wbr>parser</a><span class="version">0.25.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Painter</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.outline_glyph" title="outline_glyph">outline_glyph</a></li><li><a href="#tymethod.paint" title="paint">paint</a></li><li><a href="#tymethod.pop_clip" title="pop_clip">pop_clip</a></li><li><a href="#tymethod.pop_layer" title="pop_layer">pop_layer</a></li><li><a href="#tymethod.pop_transform" title="pop_transform">pop_transform</a></li><li><a href="#tymethod.push_clip" title="push_clip">push_clip</a></li><li><a href="#tymethod.push_clip_box" title="push_clip_box">push_clip_box</a></li><li><a href="#tymethod.push_layer" title="push_layer">push_layer</a></li><li><a href="#tymethod.push_transform" title="push_transform">push_transform</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In ttf_<wbr>parser::<wbr>colr</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">ttf_parser</a>::<wbr><a href="index.html">colr</a></span><h1>Trait <span class="trait">Painter</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/ttf_parser/tables/colr.rs.html#679-701">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Painter&lt;'a&gt; {
// Required methods
fn <a href="#tymethod.outline_glyph" class="fn">outline_glyph</a>(&amp;mut self, glyph_id: <a class="struct" href="../struct.GlyphId.html" title="struct ttf_parser::GlyphId">GlyphId</a>);
<span class="item-spacer"></span> fn <a href="#tymethod.paint" class="fn">paint</a>(&amp;mut self, paint: <a class="enum" href="enum.Paint.html" title="enum ttf_parser::colr::Paint">Paint</a>&lt;'a&gt;);
<span class="item-spacer"></span> fn <a href="#tymethod.push_clip" class="fn">push_clip</a>(&amp;mut self);
<span class="item-spacer"></span> fn <a href="#tymethod.push_clip_box" class="fn">push_clip_box</a>(&amp;mut self, clipbox: <a class="type" href="type.ClipBox.html" title="type ttf_parser::colr::ClipBox">ClipBox</a>);
<span class="item-spacer"></span> fn <a href="#tymethod.pop_clip" class="fn">pop_clip</a>(&amp;mut self);
<span class="item-spacer"></span> fn <a href="#tymethod.push_layer" class="fn">push_layer</a>(&amp;mut self, mode: <a class="enum" href="enum.CompositeMode.html" title="enum ttf_parser::colr::CompositeMode">CompositeMode</a>);
<span class="item-spacer"></span> fn <a href="#tymethod.pop_layer" class="fn">pop_layer</a>(&amp;mut self);
<span class="item-spacer"></span> fn <a href="#tymethod.push_transform" class="fn">push_transform</a>(&amp;mut self, transform: <a class="struct" href="../struct.Transform.html" title="struct ttf_parser::Transform">Transform</a>);
<span class="item-spacer"></span> fn <a href="#tymethod.pop_transform" class="fn">pop_transform</a>(&amp;mut self);
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait for color glyph painting.</p>
<p>See <a href="https://learn.microsoft.com/en-us/typography/opentype/spec/colr">COLR</a> for details.</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.outline_glyph" class="method"><a class="src rightside" href="../../src/ttf_parser/tables/colr.rs.html#681">Source</a><h4 class="code-header">fn <a href="#tymethod.outline_glyph" class="fn">outline_glyph</a>(&amp;mut self, glyph_id: <a class="struct" href="../struct.GlyphId.html" title="struct ttf_parser::GlyphId">GlyphId</a>)</h4></section></summary><div class="docblock"><p>Outline a glyph and store it.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.paint" class="method"><a class="src rightside" href="../../src/ttf_parser/tables/colr.rs.html#683">Source</a><h4 class="code-header">fn <a href="#tymethod.paint" class="fn">paint</a>(&amp;mut self, paint: <a class="enum" href="enum.Paint.html" title="enum ttf_parser::colr::Paint">Paint</a>&lt;'a&gt;)</h4></section></summary><div class="docblock"><p>Paint the stored outline using the provided color.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.push_clip" class="method"><a class="src rightside" href="../../src/ttf_parser/tables/colr.rs.html#686">Source</a><h4 class="code-header">fn <a href="#tymethod.push_clip" class="fn">push_clip</a>(&amp;mut self)</h4></section></summary><div class="docblock"><p>Push a new clip path using the currently stored outline.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.push_clip_box" class="method"><a class="src rightside" href="../../src/ttf_parser/tables/colr.rs.html#689">Source</a><h4 class="code-header">fn <a href="#tymethod.push_clip_box" class="fn">push_clip_box</a>(&amp;mut self, clipbox: <a class="type" href="type.ClipBox.html" title="type ttf_parser::colr::ClipBox">ClipBox</a>)</h4></section></summary><div class="docblock"><p>Push a new clip path using the clip box.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.pop_clip" class="method"><a class="src rightside" href="../../src/ttf_parser/tables/colr.rs.html#691">Source</a><h4 class="code-header">fn <a href="#tymethod.pop_clip" class="fn">pop_clip</a>(&amp;mut self)</h4></section></summary><div class="docblock"><p>Pop the last clip path.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.push_layer" class="method"><a class="src rightside" href="../../src/ttf_parser/tables/colr.rs.html#694">Source</a><h4 class="code-header">fn <a href="#tymethod.push_layer" class="fn">push_layer</a>(&amp;mut self, mode: <a class="enum" href="enum.CompositeMode.html" title="enum ttf_parser::colr::CompositeMode">CompositeMode</a>)</h4></section></summary><div class="docblock"><p>Push a new layer with the given composite mode.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.pop_layer" class="method"><a class="src rightside" href="../../src/ttf_parser/tables/colr.rs.html#696">Source</a><h4 class="code-header">fn <a href="#tymethod.pop_layer" class="fn">pop_layer</a>(&amp;mut self)</h4></section></summary><div class="docblock"><p>Pop the last layer.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.push_transform" class="method"><a class="src rightside" href="../../src/ttf_parser/tables/colr.rs.html#698">Source</a><h4 class="code-header">fn <a href="#tymethod.push_transform" class="fn">push_transform</a>(&amp;mut self, transform: <a class="struct" href="../struct.Transform.html" title="struct ttf_parser::Transform">Transform</a>)</h4></section></summary><div class="docblock"><p>Push a transform.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.pop_transform" class="method"><a class="src rightside" href="../../src/ttf_parser/tables/colr.rs.html#700">Source</a><h4 class="code-header">fn <a href="#tymethod.pop_transform" class="fn">pop_transform</a>(&amp;mut self)</h4></section></summary><div class="docblock"><p>Pop the last transform.</p>
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/ttf_parser/tables/colr/trait.Painter.js" async></script></section></div></main></body></html>