<!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="Source to the Rust file `/home/mrh/.cargo/registry/src/github.com-1ecc6299db9ec823/winit-0.19.1/src/window.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>window.rs.html -- source</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 source"><!--[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></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"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
</pre><div class="example-wrap"><pre class="rust ">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">collections</span>::<span class="ident">vec_deque</span>::<span class="ident">IntoIter</span> <span class="kw">as</span> <span class="ident">VecDequeIter</span>;
<span class="kw">use</span> {
<span class="ident">CreationError</span>,
<span class="ident">EventsLoop</span>,
<span class="ident">Icon</span>,
<span class="ident">LogicalPosition</span>,
<span class="ident">LogicalSize</span>,
<span class="ident">MouseCursor</span>,
<span class="ident">PhysicalPosition</span>,
<span class="ident">PhysicalSize</span>,
<span class="ident">platform</span>,
<span class="ident">Window</span>,
<span class="ident">WindowBuilder</span>,
<span class="ident">WindowId</span>,
};
<span class="kw">impl</span> <span class="ident">WindowBuilder</span> {
<span class="doccomment">/// Initializes a new `WindowBuilder` with default values.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">></span> <span class="ident">WindowBuilder</span> {
<span class="ident">WindowBuilder</span> {
<span class="ident">window</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
<span class="ident">platform_specific</span>: <span class="ident">Default</span>::<span class="ident">default</span>(),
}
}
<span class="doccomment">/// Requests the window to be of specific dimensions.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_dimensions</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">size</span>: <span class="ident">LogicalSize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">WindowBuilder</span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">dimensions</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">size</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Sets a minimum dimension size for the window</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_min_dimensions</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">min_size</span>: <span class="ident">LogicalSize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">WindowBuilder</span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">min_dimensions</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">min_size</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Sets a maximum dimension size for the window</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_max_dimensions</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">max_size</span>: <span class="ident">LogicalSize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">WindowBuilder</span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">max_dimensions</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">max_size</span>);
<span class="self">self</span>
}
<span class="doccomment">/// Sets whether the window is resizable or not</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that making the window unresizable doesn't exempt you from handling `Resized`, as that event can still be</span>
<span class="doccomment">/// triggered by DPI scaling, entering fullscreen mode, etc.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Platform-specific</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This only has an effect on desktop platforms.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Due to a bug in XFCE, this has no effect on Xfwm.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_resizable</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">resizable</span>: <span class="ident">bool</span>) <span class="op">-</span><span class="op">></span> <span class="ident">WindowBuilder</span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">resizable</span> <span class="op">=</span> <span class="ident">resizable</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Requests a specific title for the window.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_title</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">String</span><span class="op">></span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">title</span>: <span class="ident">T</span>) <span class="op">-</span><span class="op">></span> <span class="ident">WindowBuilder</span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">title</span> <span class="op">=</span> <span class="ident">title</span>.<span class="ident">into</span>();
<span class="self">self</span>
}
<span class="doccomment">/// Sets the window fullscreen state. None means a normal window, Some(MonitorId)</span>
<span class="doccomment">/// means a fullscreen window on that specific monitor</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_fullscreen</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">monitor</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">MonitorId</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">WindowBuilder</span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">fullscreen</span> <span class="op">=</span> <span class="ident">monitor</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Requests maximized mode.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_maximized</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">maximized</span>: <span class="ident">bool</span>) <span class="op">-</span><span class="op">></span> <span class="ident">WindowBuilder</span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">maximized</span> <span class="op">=</span> <span class="ident">maximized</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Sets whether the window will be initially hidden or visible.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_visibility</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">visible</span>: <span class="ident">bool</span>) <span class="op">-</span><span class="op">></span> <span class="ident">WindowBuilder</span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">visible</span> <span class="op">=</span> <span class="ident">visible</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Sets whether the background of the window should be transparent.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_transparency</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">transparent</span>: <span class="ident">bool</span>) <span class="op">-</span><span class="op">></span> <span class="ident">WindowBuilder</span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">transparent</span> <span class="op">=</span> <span class="ident">transparent</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Sets whether the window should have a border, a title bar, etc.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_decorations</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">decorations</span>: <span class="ident">bool</span>) <span class="op">-</span><span class="op">></span> <span class="ident">WindowBuilder</span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">decorations</span> <span class="op">=</span> <span class="ident">decorations</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Sets whether or not the window will always be on top of other windows.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_always_on_top</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">always_on_top</span>: <span class="ident">bool</span>) <span class="op">-</span><span class="op">></span> <span class="ident">WindowBuilder</span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">always_on_top</span> <span class="op">=</span> <span class="ident">always_on_top</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Sets the window icon. On Windows and X11, this is typically the small icon in the top-left</span>
<span class="doccomment">/// corner of the titlebar.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Platform-specific</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This only has an effect on Windows and X11.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// On Windows, this sets `ICON_SMALL`. The base size for a window icon is 16x16, but it's</span>
<span class="doccomment">/// recommended to account for screen scaling and pick a multiple of that, i.e. 32x32.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// X11 has no universal guidelines for icon sizes, so you're at the whims of the WM. That</span>
<span class="doccomment">/// said, it's usually in the same ballpark as on Windows.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_window_icon</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">window_icon</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Icon</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">WindowBuilder</span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">window_icon</span> <span class="op">=</span> <span class="ident">window_icon</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Enables multitouch.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_multitouch</span>(<span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">WindowBuilder</span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">multitouch</span> <span class="op">=</span> <span class="bool-val">true</span>;
<span class="self">self</span>
}
<span class="doccomment">/// Builds the window.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Error should be very rare and only occur in case of permission denied, incompatible system,</span>
<span class="doccomment">/// out of memory, etc.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">events_loop</span>: <span class="kw-2">&</span><span class="ident">EventsLoop</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Window</span>, <span class="ident">CreationError</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">dimensions</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">dimensions</span>.<span class="ident">unwrap_or_else</span>(<span class="op">|</span><span class="op">|</span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">monitor</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">window</span>.<span class="ident">fullscreen</span> {
<span class="comment">// resizing the window to the dimensions of the monitor when fullscreen</span>
<span class="ident">LogicalSize</span>::<span class="ident">from_physical</span>(<span class="ident">monitor</span>.<span class="ident">get_dimensions</span>(), <span class="number">1.0</span>)
} <span class="kw">else</span> {
<span class="comment">// default dimensions</span>
(<span class="number">1024</span>, <span class="number">768</span>).<span class="ident">into</span>()
}
}));
<span class="comment">// building</span>
<span class="ident">platform</span>::<span class="ident">Window</span>::<span class="ident">new</span>(
<span class="kw-2">&</span><span class="ident">events_loop</span>.<span class="ident">events_loop</span>,
<span class="self">self</span>.<span class="ident">window</span>,
<span class="self">self</span>.<span class="ident">platform_specific</span>,
).<span class="ident">map</span>(<span class="op">|</span><span class="ident">window</span><span class="op">|</span> <span class="ident">Window</span> { <span class="ident">window</span> })
}
}
<span class="kw">impl</span> <span class="ident">Window</span> {
<span class="doccomment">/// Creates a new Window for platforms where this is appropriate.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This function is equivalent to `WindowBuilder::new().build(events_loop)`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Error should be very rare and only occur in case of permission denied, incompatible system,</span>
<span class="doccomment">/// out of memory, etc.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">events_loop</span>: <span class="kw-2">&</span><span class="ident">EventsLoop</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Window</span>, <span class="ident">CreationError</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">WindowBuilder</span>::<span class="ident">new</span>();
<span class="ident">builder</span>.<span class="ident">build</span>(<span class="ident">events_loop</span>)
}
<span class="doccomment">/// Modifies the title of the window.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is a no-op if the window has already been closed.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_title</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">title</span>: <span class="kw-2">&</span><span class="ident">str</span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">set_title</span>(<span class="ident">title</span>)
}
<span class="doccomment">/// Shows the window if it was hidden.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Platform-specific</span>
<span class="doccomment">///</span>
<span class="doccomment">/// - Has no effect on Android</span>
<span class="doccomment">///</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">show</span>(<span class="kw-2">&</span><span class="self">self</span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">show</span>()
}
<span class="doccomment">/// Hides the window if it was visible.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Platform-specific</span>
<span class="doccomment">///</span>
<span class="doccomment">/// - Has no effect on Android</span>
<span class="doccomment">///</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">hide</span>(<span class="kw-2">&</span><span class="self">self</span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">hide</span>()
}
<span class="doccomment">/// Returns the position of the top-left hand corner of the window relative to the</span>
<span class="doccomment">/// top-left hand corner of the desktop.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that the top-left hand corner of the desktop is not necessarily the same as</span>
<span class="doccomment">/// the screen. If the user uses a desktop with multiple monitors, the top-left hand corner</span>
<span class="doccomment">/// of the desktop is the top-left hand corner of the monitor at the top-left of the desktop.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The coordinates can be negative if the top-left hand corner of the window is outside</span>
<span class="doccomment">/// of the visible screen region.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns `None` if the window no longer exists.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_position</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">LogicalPosition</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">get_position</span>()
}
<span class="doccomment">/// Returns the position of the top-left hand corner of the window's client area relative to the</span>
<span class="doccomment">/// top-left hand corner of the desktop.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The same conditions that apply to `get_position` apply to this method.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_inner_position</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">LogicalPosition</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">get_inner_position</span>()
}
<span class="doccomment">/// Modifies the position of the window.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See `get_position` for more information about the coordinates.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is a no-op if the window has already been closed.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_position</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">position</span>: <span class="ident">LogicalPosition</span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">set_position</span>(<span class="ident">position</span>)
}
<span class="doccomment">/// Returns the logical size of the window's client area.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The client area is the content of the window, excluding the title bar and borders.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Converting the returned `LogicalSize` to `PhysicalSize` produces the size your framebuffer should be.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns `None` if the window no longer exists.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_inner_size</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">LogicalSize</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">get_inner_size</span>()
}
<span class="doccomment">/// Returns the logical size of the entire window.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// These dimensions include the title bar and borders. If you don't want that (and you usually don't),</span>
<span class="doccomment">/// use `get_inner_size` instead.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns `None` if the window no longer exists.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_outer_size</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">LogicalSize</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">get_outer_size</span>()
}
<span class="doccomment">/// Modifies the inner size of the window.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See `get_inner_size` for more information about the values.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is a no-op if the window has already been closed.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_inner_size</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">size</span>: <span class="ident">LogicalSize</span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">set_inner_size</span>(<span class="ident">size</span>)
}
<span class="doccomment">/// Sets a minimum dimension size for the window.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_min_dimensions</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">dimensions</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">LogicalSize</span><span class="op">></span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">set_min_dimensions</span>(<span class="ident">dimensions</span>)
}
<span class="doccomment">/// Sets a maximum dimension size for the window.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_max_dimensions</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">dimensions</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">LogicalSize</span><span class="op">></span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">set_max_dimensions</span>(<span class="ident">dimensions</span>)
}
<span class="doccomment">/// Sets whether the window is resizable or not.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that making the window unresizable doesn't exempt you from handling `Resized`, as that event can still be</span>
<span class="doccomment">/// triggered by DPI scaling, entering fullscreen mode, etc.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Platform-specific</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This only has an effect on desktop platforms.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Due to a bug in XFCE, this has no effect on Xfwm.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_resizable</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">resizable</span>: <span class="ident">bool</span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">set_resizable</span>(<span class="ident">resizable</span>)
}
<span class="doccomment">/// Returns the DPI factor that can be used to map logical pixels to physical pixels, and vice versa.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See the [`dpi`](dpi/index.html) module for more information.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Note that this value can change depending on user action (for example if the window is</span>
<span class="doccomment">/// moved to another screen); as such, tracking `WindowEvent::HiDpiFactorChanged` events is</span>
<span class="doccomment">/// the most robust way to track the DPI you need to use to draw.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Platform-specific</span>
<span class="doccomment">///</span>
<span class="doccomment">/// - **X11:** Can be overridden using the `WINIT_HIDPI_FACTOR` environment variable.</span>
<span class="doccomment">/// - **Android:** Always returns 1.0.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_hidpi_factor</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">f64</span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">get_hidpi_factor</span>()
}
<span class="doccomment">/// Modifies the mouse cursor of the window.</span>
<span class="doccomment">/// Has no effect on Android.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_cursor</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">cursor</span>: <span class="ident">MouseCursor</span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">set_cursor</span>(<span class="ident">cursor</span>);
}
<span class="doccomment">/// Changes the position of the cursor in window coordinates.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_cursor_position</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">position</span>: <span class="ident">LogicalPosition</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">String</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">set_cursor_position</span>(<span class="ident">position</span>)
}
<span class="doccomment">/// Grabs the cursor, preventing it from leaving the window.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Platform-specific</span>
<span class="doccomment">///</span>
<span class="doccomment">/// On macOS, this presently merely locks the cursor in a fixed location, which looks visually awkward.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This has no effect on Android or iOS.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">grab_cursor</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">grab</span>: <span class="ident">bool</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">String</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">grab_cursor</span>(<span class="ident">grab</span>)
}
<span class="doccomment">/// Hides the cursor, making it invisible but still usable.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Platform-specific</span>
<span class="doccomment">///</span>
<span class="doccomment">/// On Windows and X11, the cursor is only hidden within the confines of the window.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// On macOS, the cursor is hidden as long as the window has input focus, even if the cursor is outside of the</span>
<span class="doccomment">/// window.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This has no effect on Android or iOS.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">hide_cursor</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">hide</span>: <span class="ident">bool</span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">hide_cursor</span>(<span class="ident">hide</span>)
}
<span class="doccomment">/// Sets the window to maximized or back</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_maximized</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">maximized</span>: <span class="ident">bool</span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">set_maximized</span>(<span class="ident">maximized</span>)
}
<span class="doccomment">/// Sets the window to fullscreen or back</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_fullscreen</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">monitor</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">MonitorId</span><span class="op">></span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">set_fullscreen</span>(<span class="ident">monitor</span>)
}
<span class="doccomment">/// Turn window decorations on or off.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_decorations</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">decorations</span>: <span class="ident">bool</span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">set_decorations</span>(<span class="ident">decorations</span>)
}
<span class="doccomment">/// Change whether or not the window will always be on top of other windows.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_always_on_top</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">always_on_top</span>: <span class="ident">bool</span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">set_always_on_top</span>(<span class="ident">always_on_top</span>)
}
<span class="doccomment">/// Sets the window icon. On Windows and X11, this is typically the small icon in the top-left</span>
<span class="doccomment">/// corner of the titlebar.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// For more usage notes, see `WindowBuilder::with_window_icon`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Platform-specific</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This only has an effect on Windows and X11.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_window_icon</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">window_icon</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Icon</span><span class="op">></span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">set_window_icon</span>(<span class="ident">window_icon</span>)
}
<span class="doccomment">/// Sets location of IME candidate box in client area coordinates relative to the top left.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">set_ime_spot</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">position</span>: <span class="ident">LogicalPosition</span>) {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">set_ime_spot</span>(<span class="ident">position</span>)
}
<span class="doccomment">/// Returns the monitor on which the window currently resides</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_current_monitor</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">MonitorId</span> {
<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">get_current_monitor</span>()
}
<span class="doccomment">/// Returns the list of all the monitors available on the system.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is the same as `EventsLoop::get_available_monitors`, and is provided for convenience.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_available_monitors</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">AvailableMonitorsIter</span> {
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">window</span>.<span class="ident">get_available_monitors</span>();
<span class="ident">AvailableMonitorsIter</span> { <span class="ident">data</span>: <span class="ident">data</span>.<span class="ident">into_iter</span>() }
}
<span class="doccomment">/// Returns the primary monitor of the system.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This is the same as `EventsLoop::get_primary_monitor`, and is provided for convenience.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_primary_monitor</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">MonitorId</span> {
<span class="ident">MonitorId</span> { <span class="ident">inner</span>: <span class="self">self</span>.<span class="ident">window</span>.<span class="ident">get_primary_monitor</span>() }
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">id</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">WindowId</span> {
<span class="ident">WindowId</span>(<span class="self">self</span>.<span class="ident">window</span>.<span class="ident">id</span>())
}
}
<span class="doccomment">/// An iterator for the list of available monitors.</span>
<span class="comment">// Implementation note: we retrieve the list once, then serve each element by one by one.</span>
<span class="comment">// This may change in the future.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">AvailableMonitorsIter</span> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">data</span>: <span class="ident">VecDequeIter</span><span class="op"><</span><span class="ident">platform</span>::<span class="ident">MonitorId</span><span class="op">></span>,
}
<span class="kw">impl</span> <span class="ident">Iterator</span> <span class="kw">for</span> <span class="ident">AvailableMonitorsIter</span> {
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="ident">MonitorId</span>;
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">next</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">MonitorId</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">data</span>.<span class="ident">next</span>().<span class="ident">map</span>(<span class="op">|</span><span class="ident">id</span><span class="op">|</span> <span class="ident">MonitorId</span> { <span class="ident">inner</span>: <span class="ident">id</span> })
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">size_hint</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> (<span class="ident">usize</span>, <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">usize</span><span class="op">></span>) {
<span class="self">self</span>.<span class="ident">data</span>.<span class="ident">size_hint</span>()
}
}
<span class="doccomment">/// Identifier for a monitor.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">MonitorId</span> {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">inner</span>: <span class="ident">platform</span>::<span class="ident">MonitorId</span>
}
<span class="kw">impl</span> <span class="ident">MonitorId</span> {
<span class="doccomment">/// Returns a human-readable name of the monitor.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns `None` if the monitor doesn't exist anymore.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_name</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">get_name</span>()
}
<span class="doccomment">/// Returns the monitor's resolution.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_dimensions</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">PhysicalSize</span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">get_dimensions</span>()
}
<span class="doccomment">/// Returns the top-left corner position of the monitor relative to the larger full</span>
<span class="doccomment">/// screen area.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_position</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">PhysicalPosition</span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">get_position</span>()
}
<span class="doccomment">/// Returns the DPI factor that can be used to map logical pixels to physical pixels, and vice versa.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See the [`dpi`](dpi/index.html) module for more information.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ## Platform-specific</span>
<span class="doccomment">///</span>
<span class="doccomment">/// - **X11:** This respects Xft.dpi XResource, and can be overridden using the `WINIT_HIDPI_FACTOR` environment variable.</span>
<span class="doccomment">/// - **Android:** Always returns 1.0.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_hidpi_factor</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">f64</span> {
<span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">get_hidpi_factor</span>()
}
}
</pre></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>⏎</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 src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>