orion/phy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
doc
phy/bevy_diagnostic/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

6 lines
8.1 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="This crate provides a straightforward solution for integrating diagnostics in the Bevy game engine. It allows users to easily add diagnostic functionality to their Bevy applications, enhancing their ability to monitor and optimize their game’s."><title>bevy_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_diagnostic" 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="../crates.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 mod crate"><!--[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_diagnostic/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_diagnostic/index.html"><img src="https://bevyengine.org/assets/icon.png" alt="logo"></a><h2><a href="../bevy_diagnostic/index.html">bevy_<wbr>diagnostic</a><span class="version">0.15.1</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>bevy_diagnostic</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_diagnostic/lib.rs.html#2-47">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This crate provides a straightforward solution for integrating diagnostics in the <a href="https://bevyengine.org/">Bevy game engine</a>.
It allows users to easily add diagnostic functionality to their Bevy applications, enhancing
their ability to monitor and optimize their game’s.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Diagnostic.html" title="struct bevy_diagnostic::Diagnostic">Diagnostic</a></div><div class="desc docblock-short">A timeline of <a href="struct.DiagnosticMeasurement.html" title="struct bevy_diagnostic::DiagnosticMeasurement"><code>DiagnosticMeasurement</code></a>s of a specific type.
Diagnostic examples: frames per second, CPU usage, network latency</div></li><li><div class="item-name"><a class="struct" href="struct.DiagnosticMeasurement.html" title="struct bevy_diagnostic::DiagnosticMeasurement">Diagnostic<wbr>Measurement</a></div><div class="desc docblock-short">A single measurement of a <a href="struct.Diagnostic.html" title="struct bevy_diagnostic::Diagnostic"><code>Diagnostic</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.DiagnosticPath.html" title="struct bevy_diagnostic::DiagnosticPath">Diagnostic<wbr>Path</a></div><div class="desc docblock-short">Unique diagnostic path, separated by <code>/</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Diagnostics.html" title="struct bevy_diagnostic::Diagnostics">Diagnostics</a></div><div class="desc docblock-short">Record new <a href="struct.DiagnosticMeasurement.html" title="struct bevy_diagnostic::DiagnosticMeasurement"><code>DiagnosticMeasurement</code></a>’s.</div></li><li><div class="item-name"><a class="struct" href="struct.DiagnosticsPlugin.html" title="struct bevy_diagnostic::DiagnosticsPlugin">Diagnostics<wbr>Plugin</a></div><div class="desc docblock-short">Adds core diagnostics resources to an App.</div></li><li><div class="item-name"><a class="struct" href="struct.DiagnosticsStore.html" title="struct bevy_diagnostic::DiagnosticsStore">Diagnostics<wbr>Store</a></div><div class="desc docblock-short">A collection of <a href="struct.Diagnostic.html" title="struct bevy_diagnostic::Diagnostic"><code>Diagnostic</code></a>s.</div></li><li><div class="item-name"><a class="struct" href="struct.EntityCountDiagnosticsPlugin.html" title="struct bevy_diagnostic::EntityCountDiagnosticsPlugin">Entity<wbr>Count<wbr>Diagnostics<wbr>Plugin</a></div><div class="desc docblock-short">Adds “entity count” diagnostic to an App.</div></li><li><div class="item-name"><a class="struct" href="struct.FrameTimeDiagnosticsPlugin.html" title="struct bevy_diagnostic::FrameTimeDiagnosticsPlugin">Frame<wbr>Time<wbr>Diagnostics<wbr>Plugin</a></div><div class="desc docblock-short">Adds “frame time” diagnostic to an App, specifically “frame time”, “fps” and “frame count”</div></li><li><div class="item-name"><a class="struct" href="struct.LogDiagnosticsPlugin.html" title="struct bevy_diagnostic::LogDiagnosticsPlugin">LogDiagnostics<wbr>Plugin</a></div><div class="desc docblock-short">An App Plugin that logs diagnostics to the console.</div></li><li><div class="item-name"><a class="struct" href="struct.SystemInfo.html" title="struct bevy_diagnostic::SystemInfo">System<wbr>Info</a></div><div class="desc docblock-short">A resource that stores diagnostic information about the system.
This information can be useful for debugging and profiling purposes.</div></li><li><div class="item-name"><a class="struct" href="struct.SystemInformationDiagnosticsPlugin.html" title="struct bevy_diagnostic::SystemInformationDiagnosticsPlugin">System<wbr>Information<wbr>Diagnostics<wbr>Plugin</a></div><div class="desc docblock-short">Adds a System Information Diagnostic, specifically <code>cpu_usage</code> (in %) and <code>mem_usage</code> (in %)</div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.DEFAULT_MAX_HISTORY_LENGTH.html" title="constant bevy_diagnostic::DEFAULT_MAX_HISTORY_LENGTH">DEFAULT_<wbr>MAX_<wbr>HISTORY_<wbr>LENGTH</a></div><div class="desc docblock-short">Default max history length for new diagnostics.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.RegisterDiagnostic.html" title="trait bevy_diagnostic::RegisterDiagnostic">Register<wbr>Diagnostic</a></div><div class="desc docblock-short">Extend <a href="../bevy_app/app/struct.App.html" title="struct bevy_app::app::App"><code>App</code></a> with new <code>register_diagnostic</code> function.</div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink