wgpu-profiler 0.27.0

Simple profiler scopes for wgpu using timer queries
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

use wgpu_profiler::GpuProfilerSettings;

use super::create_device;

#[test]
fn invalid_pending_frame_count() {
    let (_, device, _queue) = create_device(wgpu::Features::TIMESTAMP_QUERY).unwrap();

    let profiler = wgpu_profiler::GpuProfiler::new(
        &device,
        wgpu_profiler::GpuProfilerSettings {
            max_num_pending_frames: 0,
            ..Default::default()
        },
    );
    assert!(matches!(
        profiler,
        Err(wgpu_profiler::CreationError::InvalidSettings(
            wgpu_profiler::SettingsError::InvalidMaxNumPendingFrames
        ))
    ));
}

#[test]
fn end_frame_unclosed_query() {
    let (_, device, _queue) = create_device(
        wgpu::Features::TIMESTAMP_QUERY.union(wgpu::Features::TIMESTAMP_QUERY_INSIDE_ENCODERS),
    )
    .unwrap();

    let mut profiler =
        wgpu_profiler::GpuProfiler::new(&device, GpuProfilerSettings::default()).unwrap();
    let unclosed_query = {
        let mut encoder = device.create_command_encoder(&wgpu::CommandEncoderDescriptor::default());
        let query = profiler.begin_query("open query", &mut encoder);
        profiler.resolve_queries(&mut encoder);
        query
    };

    assert_eq!(
        profiler.end_frame(),
        Err(wgpu_profiler::EndFrameError::UnclosedQueries(1))
    );

    // Make sure we can recover from this.
    {
        let mut encoder = device.create_command_encoder(&wgpu::CommandEncoderDescriptor::default());
        profiler.end_query(&mut encoder, unclosed_query);
        profiler.resolve_queries(&mut encoder);
    }
    assert_eq!(profiler.end_frame(), Ok(()));
}

#[test]
fn end_frame_unresolved_query() {
    let (_, device, _queue) = create_device(
        wgpu::Features::TIMESTAMP_QUERY.union(wgpu::Features::TIMESTAMP_QUERY_INSIDE_ENCODERS),
    )
    .unwrap();

    let mut profiler =
        wgpu_profiler::GpuProfiler::new(&device, GpuProfilerSettings::default()).unwrap();
    {
        let mut encoder = device.create_command_encoder(&wgpu::CommandEncoderDescriptor::default());
        let query = profiler.begin_query("open query", &mut encoder);
        profiler.end_query(&mut encoder, query);
    }

    assert_eq!(
        profiler.end_frame(),
        Err(wgpu_profiler::EndFrameError::UnresolvedQueries(2))
    );

    // Make sure we can recover from this!
    {
        let mut encoder = device.create_command_encoder(&wgpu::CommandEncoderDescriptor::default());
        profiler.resolve_queries(&mut encoder);
    }
    assert_eq!(profiler.end_frame(), Ok(()));

    device.poll(wgpu::PollType::wait_indefinitely()).unwrap();
}

#[test]
fn change_settings_while_query_open() {
    let (_, device, _queue) = create_device(
        wgpu::Features::TIMESTAMP_QUERY.union(wgpu::Features::TIMESTAMP_QUERY_INSIDE_ENCODERS),
    )
    .unwrap();

    let mut profiler =
        wgpu_profiler::GpuProfiler::new(&device, GpuProfilerSettings::default()).unwrap();

    let mut encoder = device.create_command_encoder(&wgpu::CommandEncoderDescriptor::default());
    let query = profiler.begin_query("open query", &mut encoder);

    assert_eq!(
        profiler.change_settings(GpuProfilerSettings::default()),
        Ok(())
    );

    profiler.end_query(&mut encoder, query);
}