Files
phy/profiling/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

4 lines
4.7 KiB
HTML
Raw 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="API documentation for the Rust `profiling` crate."><title>profiling - 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="profiling" 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="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../profiling/index.html">profiling</a><span class="version">1.0.16</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="#macros">Crate Items</a></h3><ul class="block"><li><a href="#macros" title="Macros">Macros</a></li><li><a href="#attributes" title="Attribute Macros">Attribute Macros</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>profiling</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/profiling/lib.rs.html#8-167">Source</a> </span></div><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.finish_frame.html" title="macro profiling::finish_frame">finish_<wbr>frame</a></div><div class="desc docblock-short">Finishes the frame. This isnt strictly necessary for some kinds of applications but a pretty
normal thing to track in games.</div></li><li><div class="item-name"><a class="macro" href="macro.function_scope.html" title="macro profiling::function_scope">function_<wbr>scope</a></div><div class="desc docblock-short">Opens a scope automatically named after the current function.</div></li><li><div class="item-name"><a class="macro" href="macro.register_thread.html" title="macro profiling::register_thread">register_<wbr>thread</a></div><div class="desc docblock-short">Registers a thread with the profiler API(s). This is usually setting a name for the thread.
Two variants:</div></li><li><div class="item-name"><a class="macro" href="macro.scope.html" title="macro profiling::scope">scope</a></div><div class="desc docblock-short">Opens a scope. Two variants:</div></li></ul><h2 id="attributes" class="section-header">Attribute Macros<a href="#attributes" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="attr" href="attr.all_functions.html" title="attr profiling::all_functions">all_<wbr>functions</a></div><div class="desc docblock-short">Proc macro for creating a scope around each function under struct impl block</div></li><li><div class="item-name"><a class="attr" href="attr.function.html" title="attr profiling::function">function</a></div><div class="desc docblock-short">Proc macro for creating a scope around the function, using the name of the function for the
scopes name</div></li><li><div class="item-name"><a class="attr" href="attr.skip.html" title="attr profiling::skip">skip</a></div><div class="desc docblock-short">Proc macro to skip the auto_impl for the function</div></li></ul></section></div></main></body></html>