Files
phy/winit/window/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

2 lines
9.1 KiB
HTML

<!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="The `Window` struct and associated types."><title>winit::window - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="winit" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../winit/index.html">winit</a><span class="version">0.30.8</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module window</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate winit</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">winit</a></span><h1>Module <span>window</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/winit/window.rs.html#1-1883">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The <a href="struct.Window.html" title="struct winit::window::Window"><code>Window</code></a> struct and associated types.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.ActivationToken.html" title="struct winit::window::ActivationToken">Activation<wbr>Token</a></div><div class="desc docblock-short">An opaque token used to activate the <a href="struct.Window.html" title="struct winit::window::Window"><code>Window</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.CursorIconParseError.html" title="struct winit::window::CursorIconParseError">Cursor<wbr>Icon<wbr>Parse<wbr>Error</a></div><div class="desc docblock-short">An error which could be returned when parsing <a href="enum.CursorIcon.html" title="enum winit::window::CursorIcon"><code>CursorIcon</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.CustomCursor.html" title="struct winit::window::CustomCursor">Custom<wbr>Cursor</a></div><div class="desc docblock-short">Use a custom image as a cursor (mouse pointer).</div></li><li><div class="item-name"><a class="struct" href="struct.CustomCursorSource.html" title="struct winit::window::CustomCursorSource">Custom<wbr>Cursor<wbr>Source</a></div><div class="desc docblock-short">Source for <a href="struct.CustomCursor.html" title="struct winit::window::CustomCursor"><code>CustomCursor</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Icon.html" title="struct winit::window::Icon">Icon</a></div><div class="desc docblock-short">An icon used for the window titlebar, taskbar, etc.</div></li><li><div class="item-name"><a class="struct" href="struct.Window.html" title="struct winit::window::Window">Window</a></div><div class="desc docblock-short">Represents a window.</div></li><li><div class="item-name"><a class="struct" href="struct.WindowAttributes.html" title="struct winit::window::WindowAttributes">Window<wbr>Attributes</a></div><div class="desc docblock-short">Attributes used when creating a window.</div></li><li><div class="item-name"><a class="struct" href="struct.WindowButtons.html" title="struct winit::window::WindowButtons">Window<wbr>Buttons</a></div></li><li><div class="item-name"><a class="struct" href="struct.WindowId.html" title="struct winit::window::WindowId">Window<wbr>Id</a></div><div class="desc docblock-short">Identifier of a window. Unique for each window.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.BadIcon.html" title="enum winit::window::BadIcon">BadIcon</a></div><div class="desc docblock-short">An error produced when using <a href="struct.Icon.html#method.from_rgba" title="associated function winit::window::Icon::from_rgba"><code>Icon::from_rgba</code></a> with invalid arguments.</div></li><li><div class="item-name"><a class="enum" href="enum.BadImage.html" title="enum winit::window::BadImage">BadImage</a></div><div class="desc docblock-short">An error produced when using <a href="struct.CustomCursor.html#method.from_rgba" title="associated function winit::window::CustomCursor::from_rgba"><code>CustomCursor::from_rgba</code></a> with invalid arguments.</div></li><li><div class="item-name"><a class="enum" href="enum.Cursor.html" title="enum winit::window::Cursor">Cursor</a></div><div class="desc docblock-short">See <a href="struct.Window.html#method.set_cursor" title="method winit::window::Window::set_cursor"><code>Window::set_cursor()</code></a> for more details.</div></li><li><div class="item-name"><a class="enum" href="enum.CursorGrabMode.html" title="enum winit::window::CursorGrabMode">Cursor<wbr>Grab<wbr>Mode</a></div><div class="desc docblock-short">The behavior of cursor grabbing.</div></li><li><div class="item-name"><a class="enum" href="enum.CursorIcon.html" title="enum winit::window::CursorIcon">Cursor<wbr>Icon</a></div><div class="desc docblock-short">Describes the appearance of the (usually mouse) cursor icon.</div></li><li><div class="item-name"><a class="enum" href="enum.Fullscreen.html" title="enum winit::window::Fullscreen">Fullscreen</a></div><div class="desc docblock-short">Fullscreen modes.</div></li><li><div class="item-name"><a class="enum" href="enum.ImePurpose.html" title="enum winit::window::ImePurpose">ImePurpose</a></div><div class="desc docblock-short">Generic IME purposes for use in <a href="struct.Window.html#method.set_ime_purpose" title="method winit::window::Window::set_ime_purpose"><code>Window::set_ime_purpose</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.ResizeDirection.html" title="enum winit::window::ResizeDirection">Resize<wbr>Direction</a></div><div class="desc docblock-short">Defines the orientation that a window resize will be performed.</div></li><li><div class="item-name"><a class="enum" href="enum.Theme.html" title="enum winit::window::Theme">Theme</a></div><div class="desc docblock-short">The theme variant to use.</div></li><li><div class="item-name"><a class="enum" href="enum.UserAttentionType.html" title="enum winit::window::UserAttentionType">User<wbr>Attention<wbr>Type</a></div><div class="desc docblock-short">Platform-specific</div></li><li><div class="item-name"><a class="enum" href="enum.WindowLevel.html" title="enum winit::window::WindowLevel">Window<wbr>Level</a></div><div class="desc docblock-short">A window level groups windows with respect to their z-position.</div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.MAX_CURSOR_SIZE.html" title="constant winit::window::MAX_CURSOR_SIZE">MAX_<wbr>CURSOR_<wbr>SIZE</a></div><div class="desc docblock-short">The maximum width and height for a cursor when using <a href="struct.CustomCursor.html#method.from_rgba" title="associated function winit::window::CustomCursor::from_rgba"><code>CustomCursor::from_rgba</code></a>.</div></li></ul></section></div></main></body></html>