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

/// Errors that can occur during profiler creation.
#[cfg_attr(not(feature = "tracy"), derive(PartialEq))]
#[derive(thiserror::Error, Debug)]
pub enum CreationError {
    #[error(transparent)]
    InvalidSettings(#[from] SettingsError),

    #[cfg(feature = "tracy")]
    #[error("Tracy client doesn't run yet.")]
    TracyClientNotRunning,

    #[cfg(feature = "tracy")]
    #[error("Failed to create Tracy GPU context: {0}")]
    TracyGpuContextCreationError(#[from] tracy_client::GpuContextCreationError),
}

#[cfg(feature = "tracy")]
impl PartialEq for CreationError {
    fn eq(&self, other: &Self) -> bool {
        match self {
            CreationError::InvalidSettings(left) => match other {
                CreationError::InvalidSettings(right) => left == right,
                _ => false,
            },
            CreationError::TracyClientNotRunning => {
                matches!(other, CreationError::TracyClientNotRunning)
            }
            CreationError::TracyGpuContextCreationError(left) => match left {
                tracy_client::GpuContextCreationError::TooManyContextsCreated => matches!(
                    other,
                    CreationError::TracyGpuContextCreationError(
                        tracy_client::GpuContextCreationError::TooManyContextsCreated
                    )
                ),
            },
        }
    }
}

impl Eq for CreationError {}

/// Errors that can occur during settings validation and change.
#[derive(thiserror::Error, Debug, PartialEq, Eq)]
pub enum SettingsError {
    #[error("GpuProfilerSettings::max_num_pending_frames must be at least 1.")]
    InvalidMaxNumPendingFrames,
}

/// Errors that can occur during [`crate::GpuProfiler::end_frame`].
#[derive(thiserror::Error, Debug, PartialEq, Eq)]
pub enum EndFrameError {
    #[error("All profiling queries need to be closed before ending a frame. There were still {0} open queries.")]
    UnclosedQueries(u32),

    #[error(
        "Not all queries were resolved before ending a frame.\n
Call `GpuProfiler::resolve_queries` after all profiling queries have been closed and before ending the frame.\n
There were still {0} queries unresolved."
    )]
    UnresolvedQueries(u32),
}