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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
//! Scope types that wrap a `wgpu` encoder/pass and start a scope on creation. In most cases, they
//! then allow automatically ending the scope on drop.
use crate::{GpuProfiler, GpuProfilerQuery, ProfilerCommandRecorder};
/// Scope that takes a (mutable) reference to the encoder/pass.
///
/// Calls [`GpuProfiler::end_query()`] on drop.
pub struct Scope<'a, Recorder: ProfilerCommandRecorder> {
pub profiler: &'a GpuProfiler,
pub recorder: &'a mut Recorder,
pub scope: Option<GpuProfilerQuery>,
}
impl<'a, R: ProfilerCommandRecorder> Drop for Scope<'a, R> {
#[inline]
fn drop(&mut self) {
if let Some(scope) = self.scope.take() {
self.profiler.end_query(self.recorder, scope);
}
}
}
/// Scope that takes ownership of the encoder/pass.
///
/// Calls [`GpuProfiler::end_query()`] on drop.
pub struct OwningScope<'a, Recorder: ProfilerCommandRecorder> {
pub profiler: &'a GpuProfiler,
pub recorder: Recorder,
pub scope: Option<GpuProfilerQuery>,
}
impl<'a, R: ProfilerCommandRecorder> Drop for OwningScope<'a, R> {
#[inline]
fn drop(&mut self) {
if let Some(scope) = self.scope.take() {
self.profiler.end_query(&mut self.recorder, scope);
}
}
}
/// Scope that takes ownership of the encoder/pass.
///
/// Does NOT call [`GpuProfiler::end_query()`] on drop.
/// This construct is just for completeness in cases where working with scopes is preferred but one can't rely on the Drop call in the right place.
/// This is useful when the owned value needs to be recovered after the end of the scope.
/// In particular, to submit a [`wgpu::CommandEncoder`] to a queue, ownership of the encoder is necessary.
pub struct ManualOwningScope<'a, Recorder: ProfilerCommandRecorder> {
pub profiler: &'a GpuProfiler,
pub recorder: Recorder,
pub scope: Option<GpuProfilerQuery>,
}
impl<'a, R: ProfilerCommandRecorder> ManualOwningScope<'a, R> {
/// Ends the scope allowing the extraction of the owned [`ProfilerCommandRecorder`].
#[track_caller]
#[inline]
pub fn end_query(mut self) -> R {
// Can't fail since creation implies begin_query.
self.profiler
.end_query(&mut self.recorder, self.scope.take().unwrap());
self.recorder
}
}
/// Most implementation code of the different scope types is exactly the same.
///
/// This macro allows to avoid code duplication.
/// Another way of achieving this are extension traits, but this would mean that a user has to
/// import the extension trait to use all methods of the scope types which I found a bit annoying.
macro_rules! impl_scope_ext {
($scope:ident, $recorder_type:ty) => {
impl<'a, R: ProfilerCommandRecorder> $scope<'a, R> {
/// Starts a new profiler scope nested within this one.
#[must_use]
#[track_caller]
#[inline]
pub fn scope(
&mut self,
label: impl Into<String>,
device: &wgpu::Device,
) -> Scope<'_, R> {
let recorder: &mut R = &mut self.recorder;
let scope = self
.profiler
.begin_query(label, recorder, device)
.with_parent(self.scope.as_ref());
Scope {
profiler: self.profiler,
recorder,
scope: Some(scope),
}
}
}
impl<'a> $scope<'a, wgpu::CommandEncoder> {
/// Start a render pass wrapped in a [`OwningScope`].
///
/// Ignores passed `wgpu::RenderPassDescriptor::timestamp_writes` and replaces it with
/// `timestamp_writes` managed by `GpuProfiler`.
///
/// Note that in order to take measurements, this does not require the
/// [`wgpu::Features::TIMESTAMP_QUERY_INSIDE_PASSES`] feature, only [`wgpu::Features::TIMESTAMP_QUERY`].
#[track_caller]
pub fn scoped_render_pass<'b>(
&'b mut self,
label: impl Into<String>,
device: &wgpu::Device,
pass_descriptor: wgpu::RenderPassDescriptor<'b, '_>,
) -> OwningScope<'b, wgpu::RenderPass<'b>> {
let child_scope = self
.profiler
.begin_pass_query(label, &mut self.recorder, device)
.with_parent(self.scope.as_ref());
let render_pass = self
.recorder
.begin_render_pass(&wgpu::RenderPassDescriptor {
timestamp_writes: child_scope.render_pass_timestamp_writes(),
..pass_descriptor
});
OwningScope {
profiler: self.profiler,
recorder: render_pass,
scope: Some(child_scope),
}
}
/// Start a compute pass wrapped in a [`OwningScope`].
///
/// Uses passed label both for profiler scope and compute pass label.
/// `timestamp_writes` managed by `GpuProfiler`.
///
/// Note that in order to take measurements, this does not require the
/// [`wgpu::Features::TIMESTAMP_QUERY_INSIDE_PASSES`] feature, only [`wgpu::Features::TIMESTAMP_QUERY`].
#[track_caller]
pub fn scoped_compute_pass<'b>(
&'b mut self,
label: impl Into<String>,
device: &wgpu::Device,
) -> OwningScope<'b, wgpu::ComputePass<'b>> {
let child_scope = self
.profiler
.begin_pass_query(label, &mut self.recorder, device)
.with_parent(self.scope.as_ref());
let render_pass = self
.recorder
.begin_compute_pass(&wgpu::ComputePassDescriptor {
label: Some(&child_scope.label),
timestamp_writes: child_scope.compute_pass_timestamp_writes(),
});
OwningScope {
profiler: self.profiler,
recorder: render_pass,
scope: Some(child_scope),
}
}
}
impl<'a, R: ProfilerCommandRecorder> std::ops::Deref for $scope<'a, R> {
type Target = R;
#[inline]
fn deref(&self) -> &Self::Target {
&self.recorder
}
}
impl<'a, R: ProfilerCommandRecorder> std::ops::DerefMut for $scope<'a, R> {
#[inline]
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.recorder
}
}
};
}
impl_scope_ext!(Scope, &'a mut R);
impl_scope_ext!(OwningScope, R);
impl_scope_ext!(ManualOwningScope, R);