31 lines
9.9 KiB
HTML
31 lines
9.9 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="Allows recording diagnostic spans."><title>RecordDiagnostics in bevy_render::diagnostic - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bevy_render" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="icon" href="https://bevyengine.org/assets/icon.png"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../../bevy_render/index.html"><img src="https://bevyengine.org/assets/icon.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../bevy_render/index.html"><img src="https://bevyengine.org/assets/icon.png" alt="logo"></a><h2><a href="../../bevy_render/index.html">bevy_<wbr>render</a><span class="version">0.15.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Record<wbr>Diagnostics</a></h2><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.pass_span" title="pass_span">pass_span</a></li><li><a href="#method.time_span" title="time_span">time_span</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-RecordDiagnostics-for-Option%3CArc%3CT%3E%3E" title="Option<Arc<T>>">Option<Arc<T>></a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In bevy_<wbr>render::<wbr>diagnostic</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">bevy_render</a>::<wbr><a href="index.html">diagnostic</a></span><h1>Trait <span class="trait">RecordDiagnostics</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/bevy_render/diagnostic/mod.rs.html#73-116">Source</a> </span></div><pre class="rust item-decl"><code>pub trait RecordDiagnostics: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
|
|
// Provided methods
|
|
fn <a href="#method.time_span" class="fn">time_span</a><E, N>(
|
|
&self,
|
|
encoder: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut E</a>,
|
|
name: N,
|
|
) -> <a class="struct" href="struct.TimeSpanGuard.html" title="struct bevy_render::diagnostic::TimeSpanGuard">TimeSpanGuard</a><'_, Self, E>
|
|
<span class="where">where E: WriteTimestamp,
|
|
N: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/1.84.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'static, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>>></span> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.pass_span" class="fn">pass_span</a><P, N>(
|
|
&self,
|
|
pass: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut P</a>,
|
|
name: N,
|
|
) -> <a class="struct" href="struct.PassSpanGuard.html" title="struct bevy_render::diagnostic::PassSpanGuard">PassSpanGuard</a><'_, Self, P>
|
|
<span class="where">where P: Pass,
|
|
N: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/1.84.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'static, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>>></span> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Allows recording diagnostic spans.</p>
|
|
</div></details><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.time_span" class="method"><a class="src rightside" href="../../src/bevy_render/diagnostic/mod.rs.html#77-87">Source</a><h4 class="code-header">fn <a href="#method.time_span" class="fn">time_span</a><E, N>(
|
|
&self,
|
|
encoder: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut E</a>,
|
|
name: N,
|
|
) -> <a class="struct" href="struct.TimeSpanGuard.html" title="struct bevy_render::diagnostic::TimeSpanGuard">TimeSpanGuard</a><'_, Self, E><div class="where">where
|
|
E: WriteTimestamp,
|
|
N: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/1.84.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'static, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>>>,</div></h4></section></summary><div class="docblock"><p>Begin a time span, which will record elapsed CPU and GPU time.</p>
|
|
<p>Returns a guard, which will panic on drop unless you end the span.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.pass_span" class="method"><a class="src rightside" href="../../src/bevy_render/diagnostic/mod.rs.html#93-103">Source</a><h4 class="code-header">fn <a href="#method.pass_span" class="fn">pass_span</a><P, N>(&self, pass: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut P</a>, name: N) -> <a class="struct" href="struct.PassSpanGuard.html" title="struct bevy_render::diagnostic::PassSpanGuard">PassSpanGuard</a><'_, Self, P><div class="where">where
|
|
P: Pass,
|
|
N: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/1.84.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'static, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.str.html">str</a>>>,</div></h4></section></summary><div class="docblock"><p>Begin a pass span, which will record elapsed CPU and GPU time,
|
|
as well as pipeline statistics on supported platforms.</p>
|
|
<p>Returns a guard, which will panic on drop unless you end the span.</p>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.0/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><section id="impl-RecordDiagnostics-for-Option%3CArc%3CT%3E%3E" class="impl"><a class="src rightside" href="../../src/bevy_render/diagnostic/mod.rs.html#162-186">Source</a><a href="#impl-RecordDiagnostics-for-Option%3CArc%3CT%3E%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="trait.RecordDiagnostics.html" title="trait bevy_render::diagnostic::RecordDiagnostics">RecordDiagnostics</a>> <a class="trait" href="trait.RecordDiagnostics.html" title="trait bevy_render::diagnostic::RecordDiagnostics">RecordDiagnostics</a> for <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><T>></h3></section><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/bevy_render/diagnostic/trait.RecordDiagnostics.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html> |