You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Trac3r-rust/doc/winit/os/unix/trait.EventsLoopExt.html

19 lines
13 KiB

5 years ago
<!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 `EventsLoopExt` trait in crate `winit`."><meta name="keywords" content="rust, rustlang, rust-lang, EventsLoopExt"><title>winit::os::unix::EventsLoopExt - 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><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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><a href='../../../winit/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait EventsLoopExt</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.get_wayland_display">get_wayland_display</a><a href="#tymethod.is_wayland">is_wayland</a><a href="#tymethod.is_x11">is_x11</a><a href="#tymethod.new_wayland">new_wayland</a><a href="#tymethod.new_x11">new_x11</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../index.html'>winit</a>::<wbr><a href='../index.html'>os</a>::<wbr><a href='index.html'>unix</a></p><script>window.sidebarCurrent = {name: 'EventsLoopExt', ty: 'trait', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><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='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/os/unix.rs.html#99-123' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../index.html'>winit</a>::<wbr><a href='../index.html'>os</a>::<wbr><a href='index.html'>unix</a>::<wbr><a class="trait" href=''>EventsLoopExt</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait EventsLoopExt {
fn <a href='#tymethod.new_x11' class='fnname'>new_x11</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;Self, <a class="enum" href="../../../winit/os/unix/enum.XNotSupported.html" title="enum winit::os::unix::XNotSupported">XNotSupported</a>&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>;
<div class='item-spacer'></div> fn <a href='#tymethod.new_wayland' class='fnname'>new_wayland</a>() -&gt; Self<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>;
<div class='item-spacer'></div> fn <a href='#tymethod.is_wayland' class='fnname'>is_wayland</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.is_x11' class='fnname'>is_x11</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.get_wayland_display' class='fnname'>get_wayland_display</a>(&amp;self) -&gt; <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/core/ffi/enum.c_void.html" title="enum core::ffi::c_void">c_void</a>&gt;;
}</pre></div><div class='docblock'><p>Additional methods on <code>EventsLoop</code> that are specific to Linux.</p>
</div>
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.new_x11' class='method'><code id='new_x11.v'>fn <a href='#tymethod.new_x11' class='fnname'>new_x11</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;Self, <a class="enum" href="../../../winit/os/unix/enum.XNotSupported.html" title="enum winit::os::unix::XNotSupported">XNotSupported</a>&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code></h3><div class='docblock'><p>Builds a new <code>EventsLoop</code> that is forced to use X11.</p>
</div><h3 id='tymethod.new_wayland' class='method'><code id='new_wayland.v'>fn <a href='#tymethod.new_wayland' class='fnname'>new_wayland</a>() -&gt; Self <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code></h3><div class='docblock'><p>Builds a new <code>EventsLoop</code> that is forced to use Wayland.</p>
</div><h3 id='tymethod.is_wayland' class='method'><code id='is_wayland.v'>fn <a href='#tymethod.is_wayland' class='fnname'>is_wayland</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>True if the <code>EventsLoop</code> uses Wayland.</p>
</div><h3 id='tymethod.is_x11' class='method'><code id='is_x11.v'>fn <a href='#tymethod.is_x11' class='fnname'>is_x11</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>True if the <code>EventsLoop</code> uses X11.</p>
</div><h3 id='tymethod.get_wayland_display' class='method'><code id='get_wayland_display.v'>fn <a href='#tymethod.get_wayland_display' class='fnname'>get_wayland_display</a>(&amp;self) -&gt; <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/core/ffi/enum.c_void.html" title="enum core::ffi::c_void">c_void</a>&gt;</code></h3><div class='docblock'><p>Returns a pointer to the <code>wl_display</code> object of wayland that is used by this <code>EventsLoop</code>.</p>
<p>Returns <code>None</code> if the <code>EventsLoop</code> doesn't use wayland (if it uses xlib for example).</p>
<p>The pointer will become invalid when the glutin <code>EventsLoop</code> is destroyed.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-EventsLoopExt' class='impl'><code class='in-band'>impl EventsLoopExt for <a class="struct" href="../../../winit/struct.EventsLoop.html" title="struct winit::EventsLoop">EventsLoop</a></code><a href='#impl-EventsLoopExt' class='anchor'></a><a class='srclink' href='../../../src/winit/os/unix.rs.html#125-170' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new_x11' class="method hidden"><code id='new_x11.v-1'>fn <a href='#method.new_x11' class='fnname'>new_x11</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;Self, <a class="enum" href="../../../winit/os/unix/enum.XNotSupported.html" title="enum winit::os::unix::XNotSupported">XNotSupported</a>&gt;</code><a class='srclink' href='../../../src/winit/os/unix.rs.html#127-134' title='goto source code'>[src]</a></h4><h4 id='method.new_wayland' class="method hidden"><code id='new_wayland.v-1'>fn <a href='#method.new_wayland' class='fnname'>new_wayland</a>() -&gt; Self</code><a class='srclink' href='../../../src/winit/os/unix.rs.html#137-145' title='goto source code'>[src]</a></h4><h4 id='method.is_wayland' class="method hidden"><code id='is_wayland.v-1'>fn <a href='#method.is_wayland' class='fnname'>is_wayland</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#148-150' title='goto source code'>[src]</a></h4><h4 id='method.is_x11' class="method hidden"><code id='is_x11.v-1'>fn <a href='#method.is_x11' class='fnname'>is_x11</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#153-155' title='goto source code'>[src]</a></h4><h4 id='method.get_wayland_display' class="method hidden"><code id='get_wayland_display.v-1'>fn <a href='#method.get_wayland_display' class='fnname'>get_wayland_display</a>(&amp;self) -&gt; <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/core/ffi/enum.c_void.html" title="enum core::ffi::c_void">c_void</a>&gt;</code><a class='srclink' href='../../../src/winit/os/unix.rs.html#164-169' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../../../implementors/winit/os/unix/trait.EventsLoopExt.js">
</script></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 = "winit";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>