45 lines
No EOL
9.4 KiB
HTML
45 lines
No EOL
9.4 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="Canvases can be leveraged to draw interactive 2D graphics."><title>cosmic::iced::widget::canvas - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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-aa0817cf.css"><meta name="rustdoc-vars" data-root-path="../../../../" data-static-root-path="../../../../static.files/" data-current-crate="cosmic" data-themes="" data-resource-suffix="" data-rustdoc-version="1.90.0-nightly (3048886e5 2025-07-30)" data-channel="nightly" data-search-js="search-fa3e91e5.js" data-settings-js="settings-5514c975.js" ><script src="../../../../static.files/storage-68b7e25d.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../../static.files/main-eebb9057.js"></script><noscript><link rel="stylesheet" href="../../../../static.files/noscript-32bb7600.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 mod"><!--[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="../../../../cosmic/index.html">cosmic</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module canvas</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example-drawing-a-simple-circle" title="Example: Drawing a Simple Circle">Example: Drawing a Simple Circle</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In cosmic::<wbr>iced::<wbr>widget</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../../index.html">cosmic</a>::<wbr><a href="../../index.html">iced</a>::<wbr><a href="../index.html">widget</a></div><h1>Module <span>canvas</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Canvases can be leveraged to draw interactive 2D graphics.</p>
|
|
<h2 id="example-drawing-a-simple-circle"><a class="doc-anchor" href="#example-drawing-a-simple-circle">§</a>Example: Drawing a Simple Circle</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>iced::mouse;
|
|
<span class="kw">use </span>iced::widget::canvas;
|
|
<span class="kw">use </span>iced::{Color, Rectangle, Renderer, Theme};
|
|
|
|
<span class="comment">// First, we define the data we need for drawing
|
|
</span><span class="attr">#[derive(Debug)]
|
|
</span><span class="kw">struct </span>Circle {
|
|
radius: f32,
|
|
}
|
|
|
|
<span class="comment">// Then, we implement the `Program` trait
|
|
</span><span class="kw">impl</span><Message> canvas::Program<Message> <span class="kw">for </span>Circle {
|
|
<span class="comment">// No internal state
|
|
</span><span class="kw">type </span>State = ();
|
|
|
|
<span class="kw">fn </span>draw(
|
|
<span class="kw-2">&</span><span class="self">self</span>,
|
|
_state: <span class="kw-2">&</span>(),
|
|
renderer: <span class="kw-2">&</span>Renderer,
|
|
_theme: <span class="kw-2">&</span>Theme,
|
|
bounds: Rectangle,
|
|
_cursor: mouse::Cursor
|
|
) -> Vec<canvas::Geometry> {
|
|
<span class="comment">// We prepare a new `Frame`
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>frame = canvas::Frame::new(renderer, bounds.size());
|
|
|
|
<span class="comment">// We create a `Path` representing a simple circle
|
|
</span><span class="kw">let </span>circle = canvas::Path::circle(frame.center(), <span class="self">self</span>.radius);
|
|
|
|
<span class="comment">// And fill it with some color
|
|
</span>frame.fill(<span class="kw-2">&</span>circle, Color::BLACK);
|
|
|
|
<span class="comment">// Then, we produce the geometry
|
|
</span><span class="macro">vec!</span>[frame.into_geometry()]
|
|
}
|
|
}
|
|
|
|
<span class="comment">// Finally, we simply use our `Circle` to create the `Canvas`!
|
|
</span><span class="kw">fn </span>view<<span class="lifetime">'a</span>, Message: <span class="lifetime">'a</span>>(_state: <span class="kw-2">&</span><span class="lifetime">'a </span>State) -> Element<<span class="lifetime">'a</span>, Message> {
|
|
canvas(Circle { radius: <span class="number">50.0 </span>}).into()
|
|
}</code></pre></div>
|
|
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Action.html" title="struct cosmic::iced::widget::canvas::Action">Action</a></dt><dd>A runtime action that can be performed by some widgets.</dd><dt><a class="struct" href="struct.Canvas.html" title="struct cosmic::iced::widget::canvas::Canvas">Canvas</a></dt><dd>A widget capable of drawing 2D graphics.</dd><dt><a class="struct" href="struct.Fill.html" title="struct cosmic::iced::widget::canvas::Fill">Fill</a></dt><dd>The style used to fill geometry.</dd><dt><a class="struct" href="struct.Group.html" title="struct cosmic::iced::widget::canvas::Group">Group</a></dt><dd>A cache group.</dd><dt><a class="struct" href="struct.Image.html" title="struct cosmic::iced::widget::canvas::Image">Image</a></dt><dd>A raster image that can be drawn.</dd><dt><a class="struct" href="struct.LineDash.html" title="struct cosmic::iced::widget::canvas::LineDash">Line<wbr>Dash</a></dt><dd>The dash pattern used when stroking the line.</dd><dt><a class="struct" href="struct.Path.html" title="struct cosmic::iced::widget::canvas::Path">Path</a></dt><dd>An immutable set of points that may or may not be connected.</dd><dt><a class="struct" href="struct.Stroke.html" title="struct cosmic::iced::widget::canvas::Stroke">Stroke</a></dt><dd>The style of a stroke.</dd><dt><a class="struct" href="struct.Text.html" title="struct cosmic::iced::widget::canvas::Text">Text</a></dt><dd>A bunch of text that can be drawn to a canvas</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.Event.html" title="enum cosmic::iced::widget::canvas::Event">Event</a></dt><dd>A user interface event.</dd><dt><a class="enum" href="enum.Gradient.html" title="enum cosmic::iced::widget::canvas::Gradient">Gradient</a></dt><dd>A fill which linearly interpolates colors along a direction.</dd><dt><a class="enum" href="enum.LineCap.html" title="enum cosmic::iced::widget::canvas::LineCap">LineCap</a></dt><dd>The shape used at the end of open subpaths when they are stroked.</dd><dt><a class="enum" href="enum.LineJoin.html" title="enum cosmic::iced::widget::canvas::LineJoin">Line<wbr>Join</a></dt><dd>The shape used at the corners of paths or basic shapes when they are
|
|
stroked.</dd><dt><a class="enum" href="enum.Style.html" title="enum cosmic::iced::widget::canvas::Style">Style</a></dt><dd>The coloring style of some drawing.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.Program.html" title="trait cosmic::iced::widget::canvas::Program">Program</a></dt><dd>The state and logic of a <a href="../../../widget/struct.Canvas.html" title="struct cosmic::widget::Canvas"><code>Canvas</code></a>.</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.Cache.html" title="type cosmic::iced::widget::canvas::Cache">Cache</a></dt><dd>A simple cache that stores generated <a href="../../../widget/canvas/type.Geometry.html" title="type cosmic::widget::canvas::Geometry"><code>Geometry</code></a> to avoid recomputation.</dd><dt><a class="type" href="type.Frame.html" title="type cosmic::iced::widget::canvas::Frame">Frame</a></dt><dd>The frame supported by a renderer.</dd><dt><a class="type" href="type.Geometry.html" title="type cosmic::iced::widget::canvas::Geometry">Geometry</a></dt><dd>The geometry supported by a renderer.</dd></dl></section></div></main></body></html> |