1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
/// Opens a scope. Two variants:
/// - profiling::scope!(name: &str) - Opens a scope with the given name
/// - profiling::scope!(name: &str, data: &str) - Opens a scope with the given name and an extra
/// datafield. Details of this depend on the API, but it should be a &str. If the extra data is
/// named, it will be named "tag". Some APIs support adding more data (for example, `optic::tag!`)
///
/// ```
/// profiling::scope!("outer");
/// for _ in 0..10 {
/// profiling::scope!("inner", format!("iteration {}").as_str());
/// }
/// ```
/// Opens a scope automatically named after the current function.
/// - profiling::function_scope!() - Opens a scope with the current function name
/// - profiling::function_scope!(data: &str) - Opens a scope with the current function name and an extra data field.
///
/// ```
/// fn function_a(){
/// profiling::function_scope!();
/// }
/// fn function_b(iteration: u32){
/// profiling::function_scope!(format!("iteration {}", iteration).as_str());
/// }
/// ```
/// Registers a thread with the profiler API(s). This is usually setting a name for the thread.
/// Two variants:
/// - register_thread!() - Tries to get the name of the thread, or an ID if no name is set
/// - register_thread!(name: &str) - Registers the thread using the given name
/// Finishes the frame. This isn't strictly necessary for some kinds of applications but a pretty
/// normal thing to track in games.