|
|
<!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 `debug` mod in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, debug"><title>vulkano::instance::debug - 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 debug</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'><a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>instance</a></p><script>window.sidebarCurrent = {name: 'debug', 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/instance/debug.rs.html#10-280' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>instance</a>::<wbr><a class="mod" href=''>debug</a></span></h1><div class='docblock'><p>Debug callback called by intermediate layers or by the driver.</p>
|
|
|
<p>When working on an application, it is recommended to register a debug callback. For example if
|
|
|
you enable the validation layers provided by the official Vulkan SDK, they will warn you about
|
|
|
invalid API usages or performance problems by calling this callback. The callback can also
|
|
|
be called by the driver or by whatever intermediate layer is activated.</p>
|
|
|
<p>Note that the vulkano library can also emit messages to warn you about performance issues.
|
|
|
TODO: ^ that's not the case yet, need to choose whether we keep this idea</p>
|
|
|
<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="ident">debug</span>::<span class="ident">DebugCallback</span>;
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">_callback</span> <span class="op">=</span> <span class="ident">DebugCallback</span>::<span class="ident">errors_and_warnings</span>(<span class="kw-2">&</span><span class="ident">instance</span>, <span class="op">|</span><span class="ident">msg</span><span class="op">|</span> {
|
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Debug callback: {:?}"</span>, <span class="ident">msg</span>.<span class="ident">description</span>);
|
|
|
}).<span class="ident">ok</span>();</pre></div>
|
|
|
<p>The type of <code>msg</code> in the callback is <a href="struct.Message.html"><code>Message</code></a>.</p>
|
|
|
<p>Note that you must keep the <code>_callback</code> object alive for as long as you want your callback to
|
|
|
be callable. If you don't store the return value of <code>DebugCallback</code>'s constructor in a
|
|
|
variable, it will be immediately destroyed and your callback will not work.</p>
|
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.DebugCallback.html" title='vulkano::instance::debug::DebugCallback struct'>DebugCallback</a></td><td class='docblock-short'><p>Registration of a callback called by validation layers.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Message.html" title='vulkano::instance::debug::Message struct'>Message</a></td><td class='docblock-short'><p>A message received by the callback.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.MessageTypes.html" title='vulkano::instance::debug::MessageTypes struct'>MessageTypes</a></td><td class='docblock-short'><p>Type of message.</p>
|
|
|
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="enum" href="enum.DebugCallbackCreationError.html" title='vulkano::instance::debug::DebugCallbackCreationError enum'>DebugCallbackCreationError</a></td><td class='docblock-short'><p>Error that can happen when creating a debug callback.</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> |
