13 lines
4.2 KiB
HTML
13 lines
4.2 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="Shapes the buffer content using the provided font and plan."><title>shape_with_plan in rustybuzz - 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="rustybuzz" 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 fn"><!--[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="../rustybuzz/index.html">rustybuzz</a><span class="version">0.14.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">shape_<wbr>with_<wbr>plan</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#panics" title="Panics">Panics</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate rustybuzz</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">rustybuzz</a></span><h1>Function <span class="fn">shape_with_plan</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/rustybuzz/hb/shape.rs.html#38-64">Source</a> </span></div><pre class="rust item-decl"><code>pub fn shape_with_plan(
|
|
face: &<a class="struct" href="struct.Face.html" title="struct rustybuzz::Face">hb_font_t</a><'_>,
|
|
plan: &<a class="struct" href="struct.ShapePlan.html" title="struct rustybuzz::ShapePlan">hb_ot_shape_plan_t</a>,
|
|
buffer: <a class="struct" href="struct.UnicodeBuffer.html" title="struct rustybuzz::UnicodeBuffer">UnicodeBuffer</a>,
|
|
) -> <a class="struct" href="struct.GlyphBuffer.html" title="struct rustybuzz::GlyphBuffer">GlyphBuffer</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Shapes the buffer content using the provided font and plan.</p>
|
|
<p>Consumes the buffer. You can then run <a href="struct.GlyphBuffer.html#method.clear" title="method rustybuzz::GlyphBuffer::clear"><code>GlyphBuffer::clear</code></a> to get the <a href="struct.UnicodeBuffer.html" title="struct rustybuzz::UnicodeBuffer"><code>UnicodeBuffer</code></a> back
|
|
without allocating a new one.</p>
|
|
<p>It is up to the caller to ensure that the shape plan matches the properties of the provided
|
|
buffer, otherwise the shaping result will likely be incorrect.</p>
|
|
<h2 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h2>
|
|
<p>Will panic when debugging assertions are enabled if the buffer and plan have mismatched
|
|
properties.</p>
|
|
</div></details></section></div></main></body></html> |