|
|
|
|
|
<!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 `layers_list` fn in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, layers_list"><title>vulkano::instance::layers_list - 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 fn"><!--[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><div class="sidebar-elems"><p class='location'><a href='../index.html'>vulkano</a>::<wbr><a href='index.html'>instance</a></p><script>window.sidebarCurrent = {name: 'layers_list', ty: 'fn', 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/instance/layers.rs.html#47-49' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../index.html'>vulkano</a>::<wbr><a href='index.html'>instance</a>::<wbr><a class="fn" href=''>layers_list</a></span></h1><pre class='rust fn'>pub fn layers_list() -> <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/instance/struct.LayersIterator.html" title="struct vulkano::instance::LayersIterator">LayersIterator</a>, <a class="enum" href="../../vulkano/instance/enum.LayersListError.html" title="enum vulkano::instance::LayersListError">LayersListError</a>></pre><div class='docblock'><p>Queries the list of layers that are available when creating an instance.</p>
|
|
|
|
|
|
<p>On success, this function returns an iterator that produces
|
|
|
|
|
|
<a href="struct.LayerProperties.html"><code>LayerProperties</code></a> objects. In order to enable a layer, you need
|
|
|
|
|
|
to pass its name (returned by <code>LayerProperties::name()</code>) when creating the
|
|
|
|
|
|
<a href="struct.Instance.html"><code>Instance</code></a>.</p>
|
|
|
|
|
|
<p>This function returns an error if it failed to load the Vulkan library.</p>
|
|
|
|
|
|
<blockquote>
|
|
|
|
|
|
<p><strong>Note</strong>: It is possible that one of the layers enumerated here is no longer available when
|
|
|
|
|
|
you create the <code>Instance</code>. This will lead to an error when calling <code>Instance::new</code>. The
|
|
|
|
|
|
author isn't aware of any situation where this would happen, but it is theoretically possible
|
|
|
|
|
|
according to the specifications.</p>
|
|
|
|
|
|
</blockquote>
|
|
|
|
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">vulkano</span>::<span class="ident">instance</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">for</span> <span class="ident">layer</span> <span class="kw">in</span> <span class="ident">instance</span>::<span class="ident">layers_list</span>().<span class="ident">unwrap</span>() {
|
|
|
|
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Available layer: {}"</span>, <span class="ident">layer</span>.<span class="ident">name</span>());
|
|
|
|
|
|
}</pre></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>
|
