Skip to content

Commit

Permalink
Deploying to gh-pages from @ vizia/vizia@37ad557 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
geom3trik committed Feb 1, 2024
1 parent b6fc8b8 commit 41c7284
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion trait.impl/core/convert/trait.From.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion trait.impl/vizia_core/context/proxy/trait.EventProxy.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(function() {var implementors = {
"vizia":[],
"vizia_winit":[["impl <a class=\"trait\" href=\"vizia_core/context/proxy/trait.EventProxy.html\" title=\"trait vizia_core::context::proxy::EventProxy\">EventProxy</a> for <a class=\"struct\" href=\"vizia_winit/application/struct.WinitEventProxy.html\" title=\"struct vizia_winit::application::WinitEventProxy\">WinitEventProxy</a>"]]
"vizia_winit":[["impl EventProxy for <a class=\"struct\" href=\"vizia_winit/application/struct.WinitEventProxy.html\" title=\"struct vizia_winit::application::WinitEventProxy\">WinitEventProxy</a>"]]
};if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})()
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(function() {var implementors = {
"vizia":[],
"vizia_winit":[["impl <a class=\"trait\" href=\"vizia_core/window/window_modifiers/trait.WindowModifiers.html\" title=\"trait vizia_core::window::window_modifiers::WindowModifiers\">WindowModifiers</a> for <a class=\"struct\" href=\"vizia_winit/application/struct.Application.html\" title=\"struct vizia_winit::application::Application\">Application</a>"]]
"vizia_winit":[["impl WindowModifiers for <a class=\"struct\" href=\"vizia_winit/application/struct.Application.html\" title=\"struct vizia_winit::application::Application\">Application</a>"]]
};if (window.register_implementors) {window.register_implementors(implementors);} else {window.pending_implementors = implementors;}})()
6 changes: 3 additions & 3 deletions vizia_baseview/struct.Application.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!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="Creating a new application creates a root `Window` and a `Context`. Views declared within the closure passed to `Application::new()` are added to the context and rendered into the root window."><title>Application in vizia_baseview - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-9ee3a5e31a2afa3e.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="vizia_baseview" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0 (82e1608df 2023-12-21)" data-channel="1.75.0" data-search-js="search-8fbf244ebcf71464.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc struct"><!--[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">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../vizia_baseview/index.html">vizia_baseview</a><span class="version">0.1.0</span></h2></div><h2 class="location"><a href="#">Application</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.ignore_default_theme">ignore_default_theme</a></li><li><a href="#method.inner_size">inner_size</a></li><li><a href="#method.new">new</a></li><li><a href="#method.on_idle">on_idle</a></li><li><a href="#method.open_parented">open_parented</a></li><li><a href="#method.run">run</a></li><li><a href="#method.title">title</a></li><li><a href="#method.user_scale_factor">user_scale_factor</a></li><li><a href="#method.with_scale_policy">with_scale_policy</a></li><li><a href="#method.with_text_config">with_text_config</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-RefUnwindSafe-for-Application%3CF%3E">!RefUnwindSafe</a></li><li><a href="#impl-Sync-for-Application%3CF%3E">!Sync</a></li><li><a href="#impl-UnwindSafe-for-Application%3CF%3E">!UnwindSafe</a></li><li><a href="#impl-Send-for-Application%3CF%3E">Send</a></li><li><a href="#impl-Unpin-for-Application%3CF%3E">Unpin</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-T">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-T">Into&lt;U&gt;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto&lt;U&gt;</a></li></ul></section><h2><a href="index.html">In crate vizia_baseview</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="index.html">vizia_baseview</a>::<wbr><a class="struct" href="#">Application</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/vizia_baseview/application.rs.html#23-33">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub struct Application&lt;F&gt;<span class="where fmt-newline">where
F: <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&amp;mut <a class="struct" href="../vizia_core/context/struct.Context.html" title="struct vizia_core::context::Context">Context</a>) + <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,</span>{ /* private fields */ }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creating a new application creates a root <code>Window</code> and a <code>Context</code>. Views declared within the closure passed to <code>Application::new()</code> are added to the context and rendered into the root window.</p>
F: <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&amp;mut Context) + <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,</span>{ /* private fields */ }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creating a new application creates a root <code>Window</code> and a <code>Context</code>. Views declared within the closure passed to <code>Application::new()</code> are added to the context and rendered into the root window.</p>
<h2 id="example"><a href="#example">Example</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code>
Application::new(|cx|{
Expand All @@ -8,7 +8,7 @@ <h2 id="example"><a href="#example">Example</a></h2>
.run();</code></pre></div>
<p>Calling <code>run()</code> on the <code>Application</code> causes the program to enter the event loop and for the main window to display.</p>
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Application%3CF%3E" class="impl"><a class="src rightside" href="../src/vizia_baseview/application.rs.html#35-149">source</a><a href="#impl-Application%3CF%3E" class="anchor">§</a><h3 class="code-header">impl&lt;F&gt; <a class="struct" href="struct.Application.html" title="struct vizia_baseview::Application">Application</a>&lt;F&gt;<span class="where fmt-newline">where
F: <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&amp;mut <a class="struct" href="../vizia_core/context/struct.Context.html" title="struct vizia_core::context::Context">Context</a>) + 'static + <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</span></h3></section></summary><div class="impl-items"><section id="method.new" class="method"><a class="src rightside" href="../src/vizia_baseview/application.rs.html#40-49">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(app: F) -&gt; Self</h4></section><details class="toggle method-toggle" open><summary><section id="method.ignore_default_theme" class="method"><a class="src rightside" href="../src/vizia_baseview/application.rs.html#52-55">source</a><h4 class="code-header">pub fn <a href="#method.ignore_default_theme" class="fn">ignore_default_theme</a>(self) -&gt; Self</h4></section></summary><div class="docblock"><p>Sets the default built-in theming to be ignored.</p>
F: <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&amp;mut Context) + 'static + <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</span></h3></section></summary><div class="impl-items"><section id="method.new" class="method"><a class="src rightside" href="../src/vizia_baseview/application.rs.html#40-49">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(app: F) -&gt; Self</h4></section><details class="toggle method-toggle" open><summary><section id="method.ignore_default_theme" class="method"><a class="src rightside" href="../src/vizia_baseview/application.rs.html#52-55">source</a><h4 class="code-header">pub fn <a href="#method.ignore_default_theme" class="fn">ignore_default_theme</a>(self) -&gt; Self</h4></section></summary><div class="docblock"><p>Sets the default built-in theming to be ignored.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.with_scale_policy" class="method"><a class="src rightside" href="../src/vizia_baseview/application.rs.html#60-63">source</a><h4 class="code-header">pub fn <a href="#method.with_scale_policy" class="fn">with_scale_policy</a>(self, scale_policy: <a class="enum" href="enum.WindowScalePolicy.html" title="enum vizia_baseview::WindowScalePolicy">WindowScalePolicy</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Change the window’s scale policy. Not part of <a href="struct.Application.html#method.new" title="associated function vizia_baseview::Application::new"><code>new()</code></a> to keep the same
signature as the winit backend. This should only be used for HiDPI scaling, use
[<code>WindowDescription::scale_factor</code>] to set a separate arbitrary scale factor.</p>
Expand All @@ -26,7 +26,7 @@ <h2 id="example"><a href="#example">Example</a></h2>
<li><code>parent</code> - The parent window.</li>
<li><code>app</code> - The Vizia application builder.</li>
</ul>
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_idle" class="method"><a class="src rightside" href="../src/vizia_baseview/application.rs.html#144-148">source</a><h4 class="code-header">pub fn <a href="#method.on_idle" class="fn">on_idle</a>&lt;I: 'static + <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&amp;mut <a class="struct" href="../vizia_core/context/struct.Context.html" title="struct vizia_core::context::Context">Context</a>) + <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>&gt;(self, callback: I) -&gt; Self</h4></section></summary><div class="docblock"><p>Takes a closure which will be called at the end of every loop of the application.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_idle" class="method"><a class="src rightside" href="../src/vizia_baseview/application.rs.html#144-148">source</a><h4 class="code-header">pub fn <a href="#method.on_idle" class="fn">on_idle</a>&lt;I: 'static + <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(&amp;mut Context) + <a class="trait" href="https://doc.rust-lang.org/1.75.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>&gt;(self, callback: I) -&gt; Self</h4></section></summary><div class="docblock"><p>Takes a closure which will be called at the end of every loop of the application.</p>
<p>The callback provides a place to run ‘idle’ processing and happens at the end of each loop but before drawing.
If the callback pushes events into the queue in context then the event loop will re-run. Care must be taken not to
push events into the queue every time the callback runs unless this is intended.</p>
Expand Down
Loading

0 comments on commit 41c7284

Please sign in to comment.