|
|
|
|
|
<!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 `WindowExt` trait in crate `winit`."><meta name="keywords" content="rust, rustlang, rust-lang, WindowExt"><title>winit::os::unix::WindowExt - 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">☰</div><a href='../../../winit/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait WindowExt</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.get_wayland_surface">get_wayland_surface</a><a href="#tymethod.get_xcb_connection">get_xcb_connection</a><a href="#tymethod.get_xlib_display">get_xlib_display</a><a href="#tymethod.get_xlib_screen_id">get_xlib_screen_id</a><a href="#tymethod.get_xlib_window">get_xlib_window</a><a href="#tymethod.is_ready">is_ready</a><a href="#tymethod.set_urgent">set_urgent</a><a href="#tymethod.set_wayland_theme">set_wayland_theme</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: 'WindowExt', 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'>−</span>]</a></span><a class='srclink' href='../../../src/winit/os/unix.rs.html#173-226' 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=''>WindowExt</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait WindowExt {
|
|
|
|
|
|
fn <a href='#tymethod.get_xlib_window' class='fnname'>get_xlib_window</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_ulong.html" title="type std::os::raw::c_ulong">c_ulong</a>>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.get_xlib_display' class='fnname'>get_xlib_display</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.get_xlib_screen_id' class='fnname'>get_xlib_screen_id</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.set_urgent' class='fnname'>set_urgent</a>(&self, is_urgent: <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_xcb_connection' class='fnname'>get_xcb_connection</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.get_wayland_surface' class='fnname'>get_wayland_surface</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.get_wayland_display' class='fnname'>get_wayland_display</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.set_wayland_theme' class='fnname'>set_wayland_theme</a>(&self, theme: <a class="struct" href="../../../winit/os/unix/struct.WaylandTheme.html" title="struct winit::os::unix::WaylandTheme">WaylandTheme</a>);
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.is_ready' class='fnname'>is_ready</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Additional methods on <code>Window</code> that are specific to Unix.</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.get_xlib_window' class='method'><code id='get_xlib_window.v'>fn <a href='#tymethod.get_xlib_window' class='fnname'>get_xlib_window</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_ulong.html" title="type std::os::raw::c_ulong">c_ulong</a>></code></h3><div class='docblock'><p>Returns the ID of the <code>Window</code> xlib object that is used by this window.</p>
|
|
|
|
|
|
<p>Returns <code>None</code> if the window doesn't use xlib (if it uses wayland for example).</p>
|
|
|
|
|
|
</div><h3 id='tymethod.get_xlib_display' class='method'><code id='get_xlib_display.v'>fn <a href='#tymethod.get_xlib_display' class='fnname'>get_xlib_display</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>></code></h3><div class='docblock'><p>Returns a pointer to the <code>Display</code> object of xlib that is used by this window.</p>
|
|
|
|
|
|
<p>Returns <code>None</code> if the window doesn't use xlib (if it uses wayland for example).</p>
|
|
|
|
|
|
<p>The pointer will become invalid when the glutin <code>Window</code> is destroyed.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.get_xlib_screen_id' class='method'><code id='get_xlib_screen_id.v'>fn <a href='#tymethod.get_xlib_screen_id' class='fnname'>get_xlib_screen_id</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>></code></h3><h3 id='tymethod.set_urgent' class='method'><code id='set_urgent.v'>fn <a href='#tymethod.set_urgent' class='fnname'>set_urgent</a>(&self, is_urgent: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>)</code></h3><div class='docblock'><p>Set window urgency hint (<code>XUrgencyHint</code>). Only relevant on X.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.get_xcb_connection' class='method'><code id='get_xcb_connection.v'>fn <a href='#tymethod.get_xcb_connection' class='fnname'>get_xcb_connection</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>></code></h3><div class='docblock'><p>This function returns the underlying <code>xcb_connection_t</code> of an xlib <code>Display</code>.</p>
|
|
|
|
|
|
<p>Returns <code>None</code> if the window doesn't use xlib (if it uses wayland for example).</p>
|
|
|
|
|
|
<p>The pointer will become invalid when the glutin <code>Window</code> is destroyed.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.get_wayland_surface' class='method'><code id='get_wayland_surface.v'>fn <a href='#tymethod.get_wayland_surface' class='fnname'>get_wayland_surface</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>></code></h3><div class='docblock'><p>Returns a pointer to the <code>wl_surface</code> object of wayland that is used by this window.</p>
|
|
|
|
|
|
<p>Returns <code>None</code> if the window doesn't use wayland (if it uses xlib for example).</p>
|
|
|
|
|
|
<p>The pointer will become invalid when the glutin <code>Window</code> is destroyed.</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>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>></code></h3><div class='docblock'><p>Returns a pointer to the <code>wl_display</code> object of wayland that is used by this window.</p>
|
|
|
|
|
|
<p>Returns <code>None</code> if the window doesn't use wayland (if it uses xlib for example).</p>
|
|
|
|
|
|
<p>The pointer will become invalid when the glutin <code>Window</code> is destroyed.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.set_wayland_theme' class='method'><code id='set_wayland_theme.v'>fn <a href='#tymethod.set_wayland_theme' class='fnname'>set_wayland_theme</a>(&self, theme: <a class="struct" href="../../../winit/os/unix/struct.WaylandTheme.html" title="struct winit::os::unix::WaylandTheme">WaylandTheme</a>)</code></h3><div class='docblock'><p>Sets the color theme of the client side window decorations on wayland</p>
|
|
|
|
|
|
</div><h3 id='tymethod.is_ready' class='method'><code id='is_ready.v'>fn <a href='#tymethod.is_ready' class='fnname'>is_ready</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='stability'><div class='stab deprecated'>Deprecated</div></div><div class='docblock'><p>Check if the window is ready for drawing</p>
|
|
|
|
|
|
<p>It is a remnant of a previous implementation detail for the
|
|
|
|
|
|
wayland backend, and is no longer relevant.</p>
|
|
|
|
|
|
<p>Always return true.</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-WindowExt' class='impl'><code class='in-band'>impl WindowExt for <a class="struct" href="../../../winit/struct.Window.html" title="struct winit::Window">Window</a></code><a href='#impl-WindowExt' class='anchor'></a><a class='srclink' href='../../../src/winit/os/unix.rs.html#228-305' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.get_xlib_window' class="method hidden"><code id='get_xlib_window.v-1'>fn <a href='#method.get_xlib_window' class='fnname'>get_xlib_window</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_ulong.html" title="type std::os::raw::c_ulong">c_ulong</a>></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#230-235' title='goto source code'>[src]</a></h4><h4 id='method.get_xlib_display' class="method hidden"><code id='get_xlib_display.v-1'>fn <a href='#method.get_xlib_display' class='fnname'>get_xlib_display</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#238-243' title='goto source code'>[src]</a></h4><h4 id='method.get_xlib_screen_id' class="method hidden"><code id='get_xlib_screen_id.v-1'>fn <a href='#method.get_xlib_screen_id' class='fnname'>get_xlib_screen_id</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_int.html" title="type std::os::raw::c_int">c_int</a>></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#246-251' title='goto source code'>[src]</a></h4><h4 id='method.get_xcb_connection' class="method hidden"><code id='get_xcb_connection.v-1'>fn <a href='#method.get_xcb_connection' class='fnname'>get_xcb_connection</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#263-268' title='goto source code'>[src]</a></h4><h4 id='method.set_urgent' class="method hidden"><code id='set_urgent.v-1'>fn <a href='#method.set_urgent' class='fnname'>set_urgent</a>(&self, is_urgent: <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#271-275' title='goto source code'>[src]</a></h4><h4 id='method.get_wayland_surface' class="method hidden"><code id='get_wayland_surface.v-1'>fn <a href='#method.get_wayland_surface' class='fnname'>get_wayland_surface</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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>></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#278-283' title='goto source code'>[src]</a></h4><h4 id='method.get_wayland_display' class="method hidden"><code id='get_wayland_display.v-1'>f
|
|
|
|
|
|
src="../../../implementors/winit/os/unix/trait.WindowExt.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>⏎</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>
|
