21 lines
6.3 KiB
HTML
21 lines
6.3 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="API documentation for the Rust `display` mod in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, display"><title>vulkano::swapchain::display - 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 mod"><!--[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='../../../vulkano/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/vulkano-rs/vulkano/master/logo.png' alt='logo'></div></a><p class='location'>Module display</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class='location'><a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>swapchain</a></p><script>window.sidebarCurrent = {name: 'display', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../../src/vulkano/swapchain/display.rs.html#10-389' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>swapchain</a>::<wbr><a class="mod" href=''>display</a></span></h1><div class='docblock'><p>Allows you to create surfaces that fill a whole display, outside of the windowing system.</p>
|
||
<p><strong>As far as the author knows, no existing device supports these features. Therefore the code
|
||
here is mostly a draft and needs rework in both the API and the implementation.</strong></p>
|
||
<p>The purpose of the objects in this module is to let you create a <code>Surface</code> object that
|
||
represents a location on the screen. This is done in four steps:</p>
|
||
<ul>
|
||
<li>Choose a <code>Display</code> where the surface will be located. A <code>Display</code> represents a display
|
||
display, usually a monitor. The available displays can be enumerated with
|
||
<code>Display::enumerate</code>.</li>
|
||
<li>Choose a <code>DisplayMode</code>, which is the combination of a display, a resolution and a refresh
|
||
rate. You can enumerate the modes available on a display with <code>Display::display_modes</code>, or
|
||
attempt to create your own mode with <code>TODO</code>.</li>
|
||
<li>Choose a <code>DisplayPlane</code>. A display can show multiple planes in a stacking fashion.</li>
|
||
<li>Create a <code>Surface</code> object with <code>Surface::from_display_mode</code> and pass the chosen <code>DisplayMode</code>
|
||
and <code>DisplayPlane</code>.</li>
|
||
</ul>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.Display.html" title='vulkano::swapchain::display::Display struct'>Display</a></td><td class='docblock-short'><p>Represents a monitor connected to a physical device.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.DisplayMode.html" title='vulkano::swapchain::display::DisplayMode struct'>DisplayMode</a></td><td class='docblock-short'><p>Represents a mode on a specific display.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.DisplayPlane.html" title='vulkano::swapchain::display::DisplayPlane struct'>DisplayPlane</a></td><td class='docblock-short'><p>?</p>
|
||
</td></tr></table></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 = "vulkano";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |