bstein/rusty_snek_gaem
1
0
Fork 0
mirror of https://github.com/neogeek23/rusty_snek_gaem.git synced 2026-02-04 11:08:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
rusty_snek_gaem/target/doc/glutin/struct.WindowAttributes.html
brad stein c73dd7a7d0 first commit
2018-10-28 21:14:05 -05:00

101 lines
22 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="API documentation for the Rust `WindowAttributes` struct in crate `glutin`."><meta name="keywords" content="rust, rustlang, rust-lang, WindowAttributes"><title>glutin::WindowAttributes - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><p class='location'>Struct WindowAttributes</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.dimensions">dimensions</a><a href="#structfield.min_dimensions">min_dimensions</a><a href="#structfield.max_dimensions">max_dimensions</a><a href="#structfield.resizable">resizable</a><a href="#structfield.fullscreen">fullscreen</a><a href="#structfield.title">title</a><a href="#structfield.maximized">maximized</a><a href="#structfield.visible">visible</a><a href="#structfield.transparent">transparent</a><a href="#structfield.decorations">decorations</a><a href="#structfield.always_on_top">always_on_top</a><a href="#structfield.window_icon">window_icon</a><a href="#structfield.multitouch">multitouch</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='index.html'>glutin</a></p><script>window.sidebarCurrent = {name: 'WindowAttributes', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>glutin</a>::<wbr><a class="struct" href=''>WindowAttributes</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../src/winit/lib.rs.html#397-463' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct WindowAttributes {
pub dimensions: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../glutin/dpi/struct.LogicalSize.html" title="struct glutin::dpi::LogicalSize">LogicalSize</a>&gt;,
pub min_dimensions: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../glutin/dpi/struct.LogicalSize.html" title="struct glutin::dpi::LogicalSize">LogicalSize</a>&gt;,
pub max_dimensions: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../glutin/dpi/struct.LogicalSize.html" title="struct glutin::dpi::LogicalSize">LogicalSize</a>&gt;,
pub resizable: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
pub fullscreen: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../glutin/struct.MonitorId.html" title="struct glutin::MonitorId">MonitorId</a>&gt;,
pub title: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
pub maximized: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
pub visible: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
pub transparent: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
pub decorations: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
pub always_on_top: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
pub window_icon: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../glutin/struct.Icon.html" title="struct glutin::Icon">Icon</a>&gt;,
pub multitouch: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>,
}</pre></div><div class='docblock'><p>Attributes to use when creating a window.</p>
</div><h2 id='fields' class='fields small-section-header'>
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.dimensions" class="structfield small-section-header">
<a href="#structfield.dimensions" class="anchor field"></a>
<span id="dimensions.v" class='invisible'>
<code>dimensions: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../glutin/dpi/struct.LogicalSize.html" title="struct glutin::dpi::LogicalSize">LogicalSize</a>&gt;</code>
</span></span><div class='docblock'><p>The dimensions of the window. If this is <code>None</code>, some platform-specific dimensions will be
used.</p>
<p>The default is <code>None</code>.</p>
</div><span id="structfield.min_dimensions" class="structfield small-section-header">
<a href="#structfield.min_dimensions" class="anchor field"></a>
<span id="min_dimensions.v" class='invisible'>
<code>min_dimensions: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../glutin/dpi/struct.LogicalSize.html" title="struct glutin::dpi::LogicalSize">LogicalSize</a>&gt;</code>
</span></span><div class='docblock'><p>The minimum dimensions a window can be, If this is <code>None</code>, the window will have no minimum dimensions (aside from reserved).</p>
<p>The default is <code>None</code>.</p>
</div><span id="structfield.max_dimensions" class="structfield small-section-header">
<a href="#structfield.max_dimensions" class="anchor field"></a>
<span id="max_dimensions.v" class='invisible'>
<code>max_dimensions: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../glutin/dpi/struct.LogicalSize.html" title="struct glutin::dpi::LogicalSize">LogicalSize</a>&gt;</code>
</span></span><div class='docblock'><p>The maximum dimensions a window can be, If this is <code>None</code>, the maximum will have no maximum or will be set to the primary monitor's dimensions by the platform.</p>
<p>The default is <code>None</code>.</p>
</div><span id="structfield.resizable" class="structfield small-section-header">
<a href="#structfield.resizable" class="anchor field"></a>
<span id="resizable.v" class='invisible'>
<code>resizable: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code>
</span></span><div class='docblock'><p>Whether the window is resizable or not.</p>
<p>The default is <code>true</code>.</p>
</div><span id="structfield.fullscreen" class="structfield small-section-header">
<a href="#structfield.fullscreen" class="anchor field"></a>
<span id="fullscreen.v" class='invisible'>
<code>fullscreen: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../glutin/struct.MonitorId.html" title="struct glutin::MonitorId">MonitorId</a>&gt;</code>
</span></span><div class='docblock'><p>Whether the window should be set as fullscreen upon creation.</p>
<p>The default is <code>None</code>.</p>
</div><span id="structfield.title" class="structfield small-section-header">
<a href="#structfield.title" class="anchor field"></a>
<span id="title.v" class='invisible'>
<code>title: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code>
</span></span><div class='docblock'><p>The title of the window in the title bar.</p>
<p>The default is <code>&quot;winit window&quot;</code>.</p>
</div><span id="structfield.maximized" class="structfield small-section-header">
<a href="#structfield.maximized" class="anchor field"></a>
<span id="maximized.v" class='invisible'>
<code>maximized: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code>
</span></span><div class='docblock'><p>Whether the window should be maximized upon creation.</p>
<p>The default is <code>false</code>.</p>
</div><span id="structfield.visible" class="structfield small-section-header">
<a href="#structfield.visible" class="anchor field"></a>
<span id="visible.v" class='invisible'>
<code>visible: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code>
</span></span><div class='docblock'><p>Whether the window should be immediately visible upon creation.</p>
<p>The default is <code>true</code>.</p>
</div><span id="structfield.transparent" class="structfield small-section-header">
<a href="#structfield.transparent" class="anchor field"></a>
<span id="transparent.v" class='invisible'>
<code>transparent: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code>
</span></span><div class='docblock'><p>Whether the the window should be transparent. If this is true, writing colors
with alpha values different than <code>1.0</code> will produce a transparent window.</p>
<p>The default is <code>false</code>.</p>
</div><span id="structfield.decorations" class="structfield small-section-header">
<a href="#structfield.decorations" class="anchor field"></a>
<span id="decorations.v" class='invisible'>
<code>decorations: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code>
</span></span><div class='docblock'><p>Whether the window should have borders and bars.</p>
<p>The default is <code>true</code>.</p>
</div><span id="structfield.always_on_top" class="structfield small-section-header">
<a href="#structfield.always_on_top" class="anchor field"></a>
<span id="always_on_top.v" class='invisible'>
<code>always_on_top: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code>
</span></span><div class='docblock'><p>Whether the window should always be on top of other windows.</p>
<p>The default is <code>false</code>.</p>
</div><span id="structfield.window_icon" class="structfield small-section-header">
<a href="#structfield.window_icon" class="anchor field"></a>
<span id="window_icon.v" class='invisible'>
<code>window_icon: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="struct" href="../glutin/struct.Icon.html" title="struct glutin::Icon">Icon</a>&gt;</code>
</span></span><div class='docblock'><p>The window icon.</p>
<p>The default is <code>None</code>.</p>
</div><span id="structfield.multitouch" class="structfield small-section-header">
<a href="#structfield.multitouch" class="anchor field"></a>
<span id="multitouch.v" class='invisible'>
<code>multitouch: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code>
</span></span><div class='docblock'><p>[iOS only] Enable multitouch,
see <a href="https://developer.apple.com/documentation/uikit/uiview/1622519-multipletouchenabled">multipleTouchEnabled</a></p>
</div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../glutin/struct.WindowAttributes.html" title="struct glutin::WindowAttributes">WindowAttributes</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/winit/lib.rs.html#396' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../glutin/struct.WindowAttributes.html" title="struct glutin::WindowAttributes">WindowAttributes</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/winit/lib.rs.html#396' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../glutin/struct.WindowAttributes.html" title="struct glutin::WindowAttributes">WindowAttributes</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/winit/lib.rs.html#396' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>&gt;</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/winit/lib.rs.html#396' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div><h3 id='impl-Default' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../glutin/struct.WindowAttributes.html" title="struct glutin::WindowAttributes">WindowAttributes</a></code><a href='#impl-Default' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/winit/lib.rs.html#465-484' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class="struct" href="../glutin/struct.WindowAttributes.html" title="struct glutin::WindowAttributes">WindowAttributes</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/winit/lib.rs.html#467-483' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the &quot;default value&quot; for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../glutin/struct.WindowAttributes.html" title="struct glutin::WindowAttributes">WindowAttributes</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../glutin/struct.WindowAttributes.html" title="struct glutin::WindowAttributes">WindowAttributes</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "glutin";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink