tracy_full 1.1.2

Fully featured bindings for the Tracy profiler
Documentation 
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

#![allow(dead_code)]
#![allow(incomplete_features)]
#![allow(unused_imports)]
#![allow(unused_mut)]
#![allow(unused_variables)]
#![cfg_attr(feature = "allocator_api", feature(allocator_api))]
#![cfg_attr(feature = "allocator_api", feature(slice_ptr_len))]
#![cfg_attr(feature = "unstable", feature(const_intrinsic_copy))]
#![cfg_attr(feature = "unstable", feature(const_mut_refs))]
#![cfg_attr(feature = "unstable", feature(const_type_name))]
#![cfg_attr(feature = "unstable", feature(generic_const_exprs))]

use std::{error::Error, ffi::CString};

#[doc(hidden)]
pub use once_cell;

pub mod alloc;
#[cfg(feature = "bevy")]
pub mod bevy;
pub mod color;
pub mod frame;
#[cfg(feature = "futures")]
pub mod future;
pub mod plot;
#[cfg(feature = "tracing")]
pub mod tracing;
#[cfg(feature = "wgpu")]
pub mod wgpu;
pub mod zone;

#[cfg(all(feature = "enable", feature = "auto-init"))]
#[ctor::ctor]
unsafe fn startup_tracy() { sys::___tracy_startup_profiler(); }

#[cfg(all(feature = "enable", feature = "auto-init"))]
#[ctor::dtor]
unsafe fn shutdown_tracy() { sys::___tracy_shutdown_profiler(); }

/// Initialize the tracy profiler. Must be called before any other Tracy functions.
#[cfg(not(feature = "auto-init"))]
pub unsafe fn startup_tracy() {
	#[cfg(feature = "enable")]
	sys::___tracy_startup_profiler();
}

/// Shutdown the tracy profiler. Any other Tracy functions must not be called after this.
#[cfg(not(feature = "auto-init"))]
pub unsafe fn shutdown_tracy() {
	#[cfg(feature = "enable")]
	sys::___tracy_shutdown_profiler();
}

/// Set the current thread's name. Panics if the name contains interior nulls.
#[inline(always)]
pub fn set_thread_name<T>(name: T)
where
	T: TryInto<CString>,
	T::Error: Error,
{
	#[cfg(feature = "enable")]
	unsafe {
		let cstr = name.try_into().expect("name is not a valid string");
		sys::___tracy_set_thread_name(cstr.as_ptr());
	}
}

/// Clamp a requested callstack depth to the maximum supported by tracy (62).
#[inline(always)]
pub const fn clamp_callstack_depth(depth: u32) -> u32 {
	if depth < 62 {
		depth
	} else {
		62
	}
}

/// Create a `&'static CStr` from a string literal.
#[macro_export]
macro_rules! c_str {
	($str:literal) => {
		unsafe { ::std::ffi::CStr::from_bytes_with_nul_unchecked(concat!($str, "\0").as_bytes()) }
	};
}