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.WindowBuilderExt.html

26 lines
20 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!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 `WindowBuilderExt` trait in crate `winit`."><meta name="keywords" content="rust, rustlang, rust-lang, WindowBuilderExt"><title>winit::os::unix::WindowBuilderExt - 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 WindowBuilderExt</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.with_app_id">with_app_id</a><a href="#tymethod.with_base_size">with_base_size</a><a href="#tymethod.with_class">with_class</a><a href="#tymethod.with_gtk_theme_variant">with_gtk_theme_variant</a><a href="#tymethod.with_override_redirect">with_override_redirect</a><a href="#tymethod.with_resize_increments">with_resize_increments</a><a href="#tymethod.with_x11_screen">with_x11_screen</a><a href="#tymethod.with_x11_visual">with_x11_visual</a><a href="#tymethod.with_x11_window_type">with_x11_window_type</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: 'WindowBuilderExt', 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#308-331' 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=''>WindowBuilderExt</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait WindowBuilderExt {
fn <a href='#tymethod.with_x11_visual' class='fnname'>with_x11_visual</a>&lt;T&gt;(self, visual_infos: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const T</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.with_x11_screen' class='fnname'>with_x11_screen</a>(self, screen_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.with_class' class='fnname'>with_class</a>(self, class: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, instance: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.with_override_redirect' class='fnname'>with_override_redirect</a>(self, override_redirect: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.with_x11_window_type' class='fnname'>with_x11_window_type</a>(self, x11_window_type: <a class="enum" href="../../../winit/os/unix/enum.XWindowType.html" title="enum winit::os::unix::XWindowType">XWindowType</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.with_gtk_theme_variant' class='fnname'>with_gtk_theme_variant</a>(self, variant: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.with_resize_increments' class='fnname'>with_resize_increments</a>(self, increments: <a class="struct" href="../../../winit/dpi/struct.LogicalSize.html" title="struct winit::dpi::LogicalSize">LogicalSize</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.with_base_size' class='fnname'>with_base_size</a>(self, base_size: <a class="struct" href="../../../winit/dpi/struct.LogicalSize.html" title="struct winit::dpi::LogicalSize">LogicalSize</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.with_app_id' class='fnname'>with_app_id</a>(self, app_id: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a>;
}</pre></div><div class='docblock'><p>Additional methods on <code>WindowBuilder</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.with_x11_visual' class='method'><code id='with_x11_visual.v'>fn <a href='#tymethod.with_x11_visual' class='fnname'>with_x11_visual</a>&lt;T&gt;(self, visual_infos: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const T</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code></h3><h3 id='tymethod.with_x11_screen' class='method'><code id='with_x11_screen.v'>fn <a href='#tymethod.with_x11_screen' class='fnname'>with_x11_screen</a>(self, screen_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code></h3><h3 id='tymethod.with_class' class='method'><code id='with_class.v'>fn <a href='#tymethod.with_class' class='fnname'>with_class</a>(self, class: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, instance: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code></h3><div class='docblock'><p>Build window with <code>WM_CLASS</code> hint; defaults to the name of the binary. Only relevant on X11.</p>
</div><h3 id='tymethod.with_override_redirect' class='method'><code id='with_override_redirect.v'>fn <a href='#tymethod.with_override_redirect' class='fnname'>with_override_redirect</a>(self, override_redirect: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code></h3><div class='docblock'><p>Build window with override-redirect flag; defaults to false. Only relevant on X11.</p>
</div><h3 id='tymethod.with_x11_window_type' class='method'><code id='with_x11_window_type.v'>fn <a href='#tymethod.with_x11_window_type' class='fnname'>with_x11_window_type</a>(self, x11_window_type: <a class="enum" href="../../../winit/os/unix/enum.XWindowType.html" title="enum winit::os::unix::XWindowType">XWindowType</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code></h3><div class='docblock'><p>Build window with <code>_NET_WM_WINDOW_TYPE</code> hint; defaults to <code>Normal</code>. Only relevant on X11.</p>
</div><h3 id='tymethod.with_gtk_theme_variant' class='method'><code id='with_gtk_theme_variant.v'>fn <a href='#tymethod.with_gtk_theme_variant' class='fnname'>with_gtk_theme_variant</a>(self, variant: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code></h3><div class='docblock'><p>Build window with <code>_GTK_THEME_VARIANT</code> hint set to the specified value. Currently only relevant on X11.</p>
</div><h3 id='tymethod.with_resize_increments' class='method'><code id='with_resize_increments.v'>fn <a href='#tymethod.with_resize_increments' class='fnname'>with_resize_increments</a>(self, increments: <a class="struct" href="../../../winit/dpi/struct.LogicalSize.html" title="struct winit::dpi::LogicalSize">LogicalSize</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code></h3><div class='docblock'><p>Build window with resize increment hint. Only implemented on X11.</p>
</div><h3 id='tymethod.with_base_size' class='method'><code id='with_base_size.v'>fn <a href='#tymethod.with_base_size' class='fnname'>with_base_size</a>(self, base_size: <a class="struct" href="../../../winit/dpi/struct.LogicalSize.html" title="struct winit::dpi::LogicalSize">LogicalSize</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code></h3><div class='docblock'><p>Build window with base size hint. Only implemented on X11.</p>
</div><h3 id='tymethod.with_app_id' class='method'><code id='with_app_id.v'>fn <a href='#tymethod.with_app_id' class='fnname'>with_app_id</a>(self, app_id: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code></h3><div class='docblock'><p>Build window with a given application ID. It should match the <code>.desktop</code> file distributed with
your program. Only relevant on Wayland.</p>
<p>For details about application ID conventions, see the
<a href="https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#desktop-file-id">Desktop Entry Spec</a></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-WindowBuilderExt' class='impl'><code class='in-band'>impl WindowBuilderExt for <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code><a href='#impl-WindowBuilderExt' class='anchor'></a><a class='srclink' href='../../../src/winit/os/unix.rs.html#333-389' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.with_x11_visual' class="method hidden"><code id='with_x11_visual.v-1'>fn <a href='#method.with_x11_visual' class='fnname'>with_x11_visual</a>&lt;T&gt;(self, visual_infos: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const T</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#335-340' title='goto source code'>[src]</a></h4><h4 id='method.with_x11_screen' class="method hidden"><code id='with_x11_screen.v-1'>fn <a href='#method.with_x11_screen' class='fnname'>with_x11_screen</a>(self, screen_id: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#343-346' title='goto source code'>[src]</a></h4><h4 id='method.with_class' class="method hidden"><code id='with_class.v-1'>fn <a href='#method.with_class' class='fnname'>with_class</a>(self, instance: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, class: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#349-352' title='goto source code'>[src]</a></h4><h4 id='method.with_override_redirect' class="method hidden"><code id='with_override_redirect.v-1'>fn <a href='#method.with_override_redirect' class='fnname'>with_override_redirect</a>(self, override_redirect: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#355-358' title='goto source code'>[src]</a></h4><h4 id='method.with_x11_window_type' class="method hidden"><code id='with_x11_window_type.v-1'>fn <a href='#method.with_x11_window_type' class='fnname'>with_x11_window_type</a>(self, x11_window_type: <a class="enum" href="../../../winit/os/unix/enum.XWindowType.html" title="enum winit::os::unix::XWindowType">XWindowType</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#361-364' title='goto source code'>[src]</a></h4><h4 id='method.with_resize_increments' class="method hidden"><code id='with_resize_increments.v-1'>fn <a href='#method.with_resize_increments' class='fnname'>with_resize_increments</a>(self, increments: <a class="struct" href="../../../winit/dpi/struct.LogicalSize.html" title="struct winit::dpi::LogicalSize">LogicalSize</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#367-370' title='goto source code'>[src]</a></h4><h4 id='method.with_base_size' class="method hidden"><code id='with_base_size.v-1'>fn <a href='#method.with_base_size' class='fnname'>with_base_size</a>(self, base_size: <a class="struct" href="../../../winit/dpi/struct.LogicalSize.html" title="struct winit::dpi::LogicalSize">LogicalSize</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#373-376' title='goto source code'>[src]</a></h4><h4 id='method.with_gtk_theme_variant' class="method hidden"><code id='with_gtk_theme_variant.v-1'>fn <a href='#method.with_gtk_theme_variant' class='fnname'>with_gtk_theme_variant</a>(self, variant: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#379-382' title='goto source code'>[src]</a></h4><h4 id='method.with_app_id' class="method hidden"><code id='with_app_id.v-1'>fn <a href='#method.with_app_id' class='fnname'>with_app_id</a>(self, app_id: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -&gt; <a class="struct" href="../../../winit/struct.WindowBuilder.html" title="struct winit::WindowBuilder">WindowBuilder</a></code><a class='srclink' href='../../../src/winit/os/unix.rs.html#385-388' 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.WindowBuilderExt.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>