2018-10-28 21:14:05 -05:00

65 lines
17 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `OutputInfo` struct in crate `smithay_client_toolkit`."><meta name="keywords" content="rust, rustlang, rust-lang, OutputInfo"><title>smithay_client_toolkit::output::OutputInfo - 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></head><body class="rustdoc struct"><!--[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><p class='location'>Struct OutputInfo</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.model">model</a><a href="#structfield.make">make</a><a href="#structfield.location">location</a><a href="#structfield.physical_size">physical_size</a><a href="#structfield.subpixel">subpixel</a><a href="#structfield.transform">transform</a><a href="#structfield.scale_factor">scale_factor</a><a href="#structfield.modes">modes</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='../index.html'>smithay_client_toolkit</a>::<wbr><a href='index.html'>output</a></p><script>window.sidebarCurrent = {name: 'OutputInfo', ty: 'struct', 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"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press S to search, ? for more options…" type="search"><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='in-band'>Struct <a href='../index.html'>smithay_client_toolkit</a>::<wbr><a href='index.html'>output</a>::<wbr><a class="struct" href=''>OutputInfo</a></span><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/smithay_client_toolkit/output.rs.html#27-58' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct OutputInfo {
pub model: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
pub make: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>,
pub location: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>,
pub physical_size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>,
pub subpixel: <a class="enum" href="../../smithay_client_toolkit/output/enum.Subpixel.html" title="enum smithay_client_toolkit::output::Subpixel">Subpixel</a>,
pub transform: <a class="enum" href="../../smithay_client_toolkit/output/enum.Transform.html" title="enum smithay_client_toolkit::output::Transform">Transform</a>,
pub scale_factor: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>,
pub modes: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../smithay_client_toolkit/output/struct.Mode.html" title="struct smithay_client_toolkit::output::Mode">Mode</a>&gt;,
}</pre></div><div class='docblock'><p>Compiled information about an output</p>
</div><h2 id='fields' class='fields small-section-header'>
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.model" class="structfield small-section-header">
<a href="#structfield.model" class="anchor field"></a>
<span id="model.v" class='invisible'>
<code>model: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code>
</span></span><div class='docblock'><p>The model name of this output as advertized by the server</p>
</div><span id="structfield.make" class="structfield small-section-header">
<a href="#structfield.make" class="anchor field"></a>
<span id="make.v" class='invisible'>
<code>make: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code>
</span></span><div class='docblock'><p>The make name of this output as advertized by the server</p>
</div><span id="structfield.location" class="structfield small-section-header">
<a href="#structfield.location" class="anchor field"></a>
<span id="location.v" class='invisible'>
<code>location: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code>
</span></span><div class='docblock'><p>Location of the top-left corner of this output in compositor
space</p>
<p>Note that the compositor may decide to always report (0,0) if
it decides clients are not allowed to know this information.</p>
</div><span id="structfield.physical_size" class="structfield small-section-header">
<a href="#structfield.physical_size" class="anchor field"></a>
<span id="physical_size.v" class='invisible'>
<code>physical_size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code>
</span></span><div class='docblock'><p>Physical dimensions of this output, in unspecified units</p>
</div><span id="structfield.subpixel" class="structfield small-section-header">
<a href="#structfield.subpixel" class="anchor field"></a>
<span id="subpixel.v" class='invisible'>
<code>subpixel: <a class="enum" href="../../smithay_client_toolkit/output/enum.Subpixel.html" title="enum smithay_client_toolkit::output::Subpixel">Subpixel</a></code>
</span></span><div class='docblock'><p>The subpixel layout for this output</p>
</div><span id="structfield.transform" class="structfield small-section-header">
<a href="#structfield.transform" class="anchor field"></a>
<span id="transform.v" class='invisible'>
<code>transform: <a class="enum" href="../../smithay_client_toolkit/output/enum.Transform.html" title="enum smithay_client_toolkit::output::Transform">Transform</a></code>
</span></span><div class='docblock'><p>The current transformation applied to this output</p>
<p>You can pre-render your buffers taking this information
into account and advertizing it via <code>wl_buffer.set_tranform</code>
for better performances.</p>
</div><span id="structfield.scale_factor" class="structfield small-section-header">
<a href="#structfield.scale_factor" class="anchor field"></a>
<span id="scale_factor.v" class='invisible'>
<code>scale_factor: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code>
</span></span><div class='docblock'><p>The scaling factor of this output</p>
<p>Any buffer whose scaling factor does not match the one
of the output it is displayed on will be rescaled accordingly.</p>
<p>For example, a buffer of scaling factor 1 will be doubled in
size if the output scaling factor is 2.</p>
</div><span id="structfield.modes" class="structfield small-section-header">
<a href="#structfield.modes" class="anchor field"></a>
<span id="modes.v" class='invisible'>
<code>modes: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../smithay_client_toolkit/output/struct.Mode.html" title="struct smithay_client_toolkit::output::Mode">Mode</a>&gt;</code>
</span></span><div class='docblock'><p>Possible modes for an output</p>
</div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Clone' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../smithay_client_toolkit/output/struct.OutputInfo.html" title="struct smithay_client_toolkit::output::OutputInfo">OutputInfo</a></code><a href='#impl-Clone' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/output.rs.html#25' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../smithay_client_toolkit/output/struct.OutputInfo.html" title="struct smithay_client_toolkit::output::OutputInfo">OutputInfo</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/output.rs.html#25' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#130-132' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../smithay_client_toolkit/output/struct.OutputInfo.html" title="struct smithay_client_toolkit::output::OutputInfo">OutputInfo</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/output.rs.html#25' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/smithay_client_toolkit/output.rs.html#25' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../smithay_client_toolkit/output/struct.OutputInfo.html" title="struct smithay_client_toolkit::output::OutputInfo">OutputInfo</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../smithay_client_toolkit/output/struct.OutputInfo.html" title="struct smithay_client_toolkit::output::OutputInfo">OutputInfo</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></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>&#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 = "smithay_client_toolkit";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>