|
|
<!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 `Surface` struct in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, Surface"><title>vulkano::swapchain::Surface - 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 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">☰</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'>Struct Surface</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.capabilities">capabilities</a><a href="#method.from_anativewindow">from_anativewindow</a><a href="#method.from_display_mode">from_display_mode</a><a href="#method.from_hwnd">from_hwnd</a><a href="#method.from_ios_moltenvk">from_ios_moltenvk</a><a href="#method.from_macos_moltenvk">from_macos_moltenvk</a><a href="#method.from_raw_surface">from_raw_surface</a><a href="#method.from_vi_surface">from_vi_surface</a><a href="#method.from_wayland">from_wayland</a><a href="#method.from_xcb">from_xcb</a><a href="#method.from_xlib">from_xlib</a><a href="#method.instance">instance</a><a href="#method.is_supported">is_supported</a><a href="#method.window">window</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Drop">Drop</a><a href="#impl-VulkanObject">VulkanObject</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-Content">Content</a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class='location'><a href='../index.html'>vulkano</a>::<wbr><a href='index.html'>swapchain</a></p><script>window.sidebarCurrent = {name: 'Surface', 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"><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/surface.rs.html#38-46' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='../index.html'>vulkano</a>::<wbr><a href='index.html'>swapchain</a>::<wbr><a class="struct" href=''>Surface</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct Surface<W> { /* fields omitted */ }</pre></div><div class='docblock'><p>Represents a surface on the screen.</p>
|
|
|
<p>Creating a <code>Surface</code> is platform-specific.</p>
|
|
|
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl<W> <a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W></code><a href='#impl' class='anchor'></a><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#48-569' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from_raw_surface' class="method"><code id='from_raw_surface.v'>pub unsafe fn <a href='#method.from_raw_surface' class='fnname'>from_raw_surface</a>(<br> instance: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/instance/struct.Instance.html" title="struct vulkano::instance::Instance">Instance</a>>, <br> surface: <a class="type" href="../../vk_sys/type.SurfaceKHR.html" title="type vk_sys::SurfaceKHR">SurfaceKHR</a>, <br> win: W<br>) -> <a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#53-62' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a <code>Surface</code> given the raw handler.</p>
|
|
|
<p>Be careful when using it</p>
|
|
|
</div><h4 id='method.from_display_mode' class="method"><code id='from_display_mode.v'>pub fn <a href='#method.from_display_mode' class='fnname'>from_display_mode</a>(<br> display_mode: &<a class="struct" href="../../vulkano/swapchain/display/struct.DisplayMode.html" title="struct vulkano::swapchain::display::DisplayMode">DisplayMode</a>, <br> plane: &<a class="struct" href="../../vulkano/swapchain/display/struct.DisplayPlane.html" title="struct vulkano::swapchain::display::DisplayPlane">DisplayPlane</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>>, <a class="enum" href="../../vulkano/swapchain/enum.SurfaceCreationError.html" title="enum vulkano::swapchain::SurfaceCreationError">SurfaceCreationError</a>></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#71-122' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a <code>Surface</code> that covers a display mode.</p>
|
|
|
<h1 id="panic" class="section-header"><a href="#panic">Panic</a></h1>
|
|
|
<ul>
|
|
|
<li>Panics if <code>display_mode</code> and <code>plane</code> don't belong to the same physical device.</li>
|
|
|
<li>Panics if <code>plane</code> doesn't support the display of <code>display_mode</code>.</li>
|
|
|
</ul>
|
|
|
</div><h4 id='method.from_hwnd' class="method"><code id='from_hwnd.v'>pub unsafe fn <a href='#method.from_hwnd' class='fnname'>from_hwnd</a><T, U>(<br> instance: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/instance/struct.Instance.html" title="struct vulkano::instance::Instance">Instance</a>>, <br> hinstance: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const T</a>, <br> hwnd: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const U</a>, <br> win: W<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W>>, <a class="enum" href="../../vulkano/swapchain/enum.SurfaceCreationError.html" title="enum vulkano::swapchain::SurfaceCreationError">SurfaceCreationError</a>></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#133-165' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a <code>Surface</code> from a Win32 window.</p>
|
|
|
<p>The surface's min, max and current extent will always match the window's dimensions.</p>
|
|
|
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
|
|
<p>The caller must ensure that the <code>hinstance</code> and the <code>hwnd</code> are both correct and stay
|
|
|
alive for the entire lifetime of the surface. The <code>win</code> parameter can be used to ensure this.</p>
|
|
|
</div><h4 id='method.from_xcb' class="method"><code id='from_xcb.v'>pub unsafe fn <a href='#method.from_xcb' class='fnname'>from_xcb</a><C>(<br> instance: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/instance/struct.Instance.html" title="struct vulkano::instance::Instance">Instance</a>>, <br> connection: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const C</a>, <br> window: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> win: W<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W>>, <a class="enum" href="../../vulkano/swapchain/enum.SurfaceCreationError.html" title="enum vulkano::swapchain::SurfaceCreationError">SurfaceCreationError</a>></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#175-207' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a <code>Surface</code> from an XCB window.</p>
|
|
|
<p>The surface's min, max and current extent will always match the window's dimensions.</p>
|
|
|
<h1 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h1>
|
|
|
<p>The caller must ensure that the <code>connection</code> and the <code>window</code> are both correct and stay
|
|
|
alive for the entire lifetime of the surface. The <code>win</code> parameter can be used to ensure this.</p>
|
|
|
</div><h4 id='method.from_xlib' class="method"><code id='from_xlib.v'>pub unsafe fn <a href='#method.from_xlib' class='fnname'>from_xlib</a><D>(<br> instance: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/instance/struct.Instance.html" title="struct vulkano::instance::Instance">Instance</a>>, <br> display: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const D</a>, <br> window: <a class="type" href="https://doc.rust-lang.org/nightly/std/os/raw/type.c_ulong.html" title="type std::os::raw::c_ulong">c_ulong</a>, <br> win: W<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W>>, <a class="enum" href="../../vulkano/swapchain/enum.SurfaceCreationError.html" title="enum vulkano::swapchain::SurfaceCreationError">SurfaceCreationError</a>></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#217-249' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a <code>Surface</code> from an Xlib window.</p>
|
|
|
<p>The surface's min, max and current extent will always match the window's dimensions.</p>
|
|
|
<h1 id="safety-2" class="section-header"><a href="#safety-2">Safety</a></h1>
|
|
|
<p>The caller must ensure that the <code>display</code> and the <code>window</code> are both correct and stay
|
|
|
alive for the entire lifetime of the surface. The <code>win</code> parameter can be used to ensure this.</p>
|
|
|
</div><h4 id='method.from_wayland' class="method"><code id='from_wayland.v'>pub unsafe fn <a href='#method.from_wayland' class='fnname'>from_wayland</a><D, S>(<br> instance: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/instance/struct.Instance.html" title="struct vulkano::instance::Instance">Instance</a>>, <br> display: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const D</a>, <br> surface: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const S</a>, <br> win: W<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W>>, <a class="enum" href="../../vulkano/swapchain/enum.SurfaceCreationError.html" title="enum vulkano::swapchain::SurfaceCreationError">SurfaceCreationError</a>></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#259-292' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a <code>Surface</code> from a Wayland window.</p>
|
|
|
<p>The window's dimensions will be set to the size of the swapchain.</p>
|
|
|
<h1 id="safety-3" class="section-header"><a href="#safety-3">Safety</a></h1>
|
|
|
<p>The caller must ensure that the <code>display</code> and the <code>surface</code> are both correct and stay
|
|
|
alive for the entire lifetime of the surface. The <code>win</code> parameter can be used to ensure this.</p>
|
|
|
</div><h4 id='method.from_anativewindow' class="method"><code id='from_anativewindow.v'>pub unsafe fn <a href='#method.from_anativewindow' class='fnname'>from_anativewindow</a><T>(<br> instance: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/instance/struct.Instance.html" title="struct vulkano::instance::Instance">Instance</a>>, <br> window: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const T</a>, <br> win: W<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W>>, <a class="enum" href="../../vulkano/swapchain/enum.SurfaceCreationError.html" title="enum vulkano::swapchain::SurfaceCreationError">SurfaceCreationError</a>></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#300-331' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a <code>Surface</code> from an Android window.</p>
|
|
|
<h1 id="safety-4" class="section-header"><a href="#safety-4">Safety</a></h1>
|
|
|
<p>The caller must ensure that the <code>window</code> is correct and stays alive for the entire
|
|
|
lifetime of the surface. The <code>win</code> parameter can be used to ensure this.</p>
|
|
|
</div><h4 id='method.from_ios_moltenvk' class="method"><code id='from_ios_moltenvk.v'>pub unsafe fn <a href='#method.from_ios_moltenvk' class='fnname'>from_ios_moltenvk</a><T>(<br> instance: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/instance/struct.Instance.html" title="struct vulkano::instance::Instance">Instance</a>>, <br> view: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const T</a>, <br> win: W<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W>>, <a class="enum" href="../../vulkano/swapchain/enum.SurfaceCreationError.html" title="enum vulkano::swapchain::SurfaceCreationError">SurfaceCreationError</a>></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#340-371' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a <code>Surface</code> from an iOS <code>UIView</code>.</p>
|
|
|
<h1 id="safety-5" class="section-header"><a href="#safety-5">Safety</a></h1>
|
|
|
<ul>
|
|
|
<li>The caller must ensure that the <code>view</code> is correct and stays alive for the entire
|
|
|
lifetime of the surface. The win parameter can be used to ensure this.</li>
|
|
|
<li>The <code>UIView</code> must be backed by a <code>CALayer</code> instance of type <code>CAMetalLayer</code>.</li>
|
|
|
</ul>
|
|
|
</div><h4 id='method.from_macos_moltenvk' class="method"><code id='from_macos_moltenvk.v'>pub unsafe fn <a href='#method.from_macos_moltenvk' class='fnname'>from_macos_moltenvk</a><T>(<br> instance: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/instance/struct.Instance.html" title="struct vulkano::instance::Instance">Instance</a>>, <br> view: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const T</a>, <br> win: W<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W>>, <a class="enum" href="../../vulkano/swapchain/enum.SurfaceCreationError.html" title="enum vulkano::swapchain::SurfaceCreationError">SurfaceCreationError</a>></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#380-411' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a <code>Surface</code> from a MacOS <code>NSView</code>.</p>
|
|
|
<h1 id="safety-6" class="section-header"><a href="#safety-6">Safety</a></h1>
|
|
|
<ul>
|
|
|
<li>The caller must ensure that the <code>view</code> is correct and stays alive for the entire
|
|
|
lifetime of the surface. The <code>win</code> parameter can be used to ensure this.</li>
|
|
|
<li>The <code>NSView</code> must be backed by a <code>CALayer</code> instance of type <code>CAMetalLayer</code>.</li>
|
|
|
</ul>
|
|
|
</div><h4 id='method.from_vi_surface' class="method"><code id='from_vi_surface.v'>pub unsafe fn <a href='#method.from_vi_surface' class='fnname'>from_vi_surface</a><T>(<br> instance: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/instance/struct.Instance.html" title="struct vulkano::instance::Instance">Instance</a>>, <br> window: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const T</a>, <br> win: W<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W>>, <a class="enum" href="../../vulkano/swapchain/enum.SurfaceCreationError.html" title="enum vulkano::swapchain::SurfaceCreationError">SurfaceCreationError</a>></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#419-450' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a <code>Surface</code> from a <code>code:nn::code:vi::code:Layer</code>.</p>
|
|
|
<h1 id="safety-7" class="section-header"><a href="#safety-7">Safety</a></h1>
|
|
|
<p>The caller must ensure that the <code>window</code> is correct and stays alive for the entire
|
|
|
lifetime of the surface. The <code>win</code> parameter can be used to ensure this.</p>
|
|
|
</div><h4 id='method.is_supported' class="method"><code id='is_supported.v'>pub fn <a href='#method.is_supported' class='fnname'>is_supported</a>(<br> &self, <br> queue: <a class="struct" href="../../vulkano/instance/struct.QueueFamily.html" title="struct vulkano::instance::QueueFamily">QueueFamily</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <a class="enum" href="../../vulkano/swapchain/enum.CapabilitiesError.html" title="enum vulkano::swapchain::CapabilitiesError">CapabilitiesError</a>></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#454-467' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns true if the given queue family can draw on this surface.</p>
|
|
|
</div><h4 id='method.capabilities' class="method"><code id='capabilities.v'>pub fn <a href='#method.capabilities' class='fnname'>capabilities</a>(<br> &self, <br> device: <a class="struct" href="../../vulkano/instance/struct.PhysicalDevice.html" title="struct vulkano::instance::PhysicalDevice">PhysicalDevice</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../vulkano/swapchain/struct.Capabilities.html" title="struct vulkano::swapchain::Capabilities">Capabilities</a>, <a class="enum" href="../../vulkano/swapchain/enum.CapabilitiesError.html" title="enum vulkano::swapchain::CapabilitiesError">CapabilitiesError</a>></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#475-556' title='goto source code'>[src]</a></h4><div class='docblock'><p>Retrieves the capabilities of a surface when used by a certain device.</p>
|
|
|
<h1 id="panic-1" class="section-header"><a href="#panic-1">Panic</a></h1>
|
|
|
<ul>
|
|
|
<li>Panics if the device and the surface don't belong to the same instance.</li>
|
|
|
</ul>
|
|
|
</div><h4 id='method.window' class="method"><code id='window.v'>pub fn <a href='#method.window' class='fnname'>window</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>W</code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#559-561' title='goto source code'>[src]</a></h4><h4 id='method.instance' class="method"><code id='instance.v'>pub fn <a href='#method.instance' class='fnname'>instance</a>(&self) -> &<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../vulkano/instance/struct.Instance.html" title="struct vulkano::instance::Instance">Instance</a>></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#566-568' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns the instance this surface was created with.</p>
|
|
|
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-VulkanObject' class='impl'><code class='in-band'>impl<W> <a class="trait" href="../../vulkano/trait.VulkanObject.html" title="trait vulkano::VulkanObject">VulkanObject</a> for <a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W></code><a href='#impl-VulkanObject' class='anchor'></a><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#578-587' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Object' class="type"><code id='Object.t'>type <a href='../../vulkano/trait.VulkanObject.html#associatedtype.Object' class="type">Object</a> = <a class="type" href="../../vk_sys/type.SurfaceKHR.html" title="type vk_sys::SurfaceKHR">SurfaceKHR</a></code></h4><div class='docblock'><p>The type of the object.</p>
|
|
|
</div><h4 id='associatedconstant.TYPE' class="associatedconstant hidden"><code id='TYPE.v'>const <a href='../../vulkano/trait.VulkanObject.html#associatedconstant.TYPE' class="constant"><b>TYPE</b></a>: <a class="type" href="../../vk_sys/type.DebugReportObjectTypeEXT.html" title="type vk_sys::DebugReportObjectTypeEXT">DebugReportObjectTypeEXT</a></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#581' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>The <code>DebugReportObjectTypeEXT</code> of the internal Vulkan handle.</p>
|
|
|
</div><h4 id='method.internal_object' class="method hidden"><code id='internal_object.v'>fn <a href='../../vulkano/trait.VulkanObject.html#tymethod.internal_object' class='fnname'>internal_object</a>(&self) -> <a class="type" href="../../vk_sys/type.SurfaceKHR.html" title="type vk_sys::SurfaceKHR">SurfaceKHR</a></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#584-586' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a reference to the object.</p>
|
|
|
</div></div><h3 id='impl-Drop' class='impl'><code class='in-band'>impl<W> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W></code><a href='#impl-Drop' class='anchor'></a><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#596-604' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.drop' class="method hidden"><code id='drop.v'>fn <a href='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&mut self)</code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#598-603' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl<W> <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="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#589-594' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code><a class='srclink' href='../../src/vulkano/swapchain/surface.rs.html#591-593' title='goto source code'>[src]</a></h4><div class='docblock hidden'><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'><code class='in-band'>impl<W> <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="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W> <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl<W> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W> <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl<W> <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="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W> <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl<W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W> <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl<W> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../vulkano/swapchain/struct.Surface.html" title="struct vulkano::swapchain::Surface">Surface</a><W> <span class="where fmt-newline">where<br> W: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a>, </span></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-Content' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../vulkano/memory/trait.Content.html" title="trait vulkano::memory::Content">Content</a> for T</code><a href='#impl-Content' class='anchor'></a><a class='srclink' href='../../src/vulkano/memory/mod.rs.html#171-190' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.ref_from_ptr' class="method hidden"><code id='ref_from_ptr.v'>fn <a href='../../vulkano/memory/trait.Content.html#tymethod.ref_from_ptr' class='fnname'>ref_from_ptr</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/core/ffi/enum.c_void.html" title="enum core::ffi::c_void">c_void</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut T</a>></code><a class='srclink' href='../../src/vulkano/memory/mod.rs.html#173-179' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Builds a pointer to this type from a raw pointer.</p>
|
|
|
</div><h4 id='method.is_size_suitable' class="method hidden"><code id='is_size_suitable.v'>fn <a href='../../vulkano/memory/trait.Content.html#tymethod.is_size_suitable' class='fnname'>is_size_suitable</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/vulkano/memory/mod.rs.html#182-184' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the size is suitable to store a type like this.</p>
|
|
|
</div><h4 id='method.indiv_size' class="method hidden"><code id='indiv_size.v'>fn <a href='../../vulkano/memory/trait.Content.html#tymethod.indiv_size' class='fnname'>indiv_size</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../../src/vulkano/memory/mod.rs.html#187-189' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the size of an individual element.</p>
|
|
|
</div></div><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#544-549' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#546-548' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-555' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#554' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#572-578' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#575-577' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#560-567' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#564-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
|
|
</div></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>⏎</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> |
