Jeroen Bakker
fda65ad5ca
This PR uses renderdoc for frame capturing when enabled. It enabled an easier workflow for frame capturing. - Capture GPU API calls from test cases - Capture GPU API calls from background threads - Capture GPU API calls from background rendering. Renderdoc is an important GPU debugger used by the Eevee/ Viewport module. Previously we needed to change code in order to record background rendering, that could on its own lead to other side-effects. The integration with renderdoc can be enabled using `WITH_RENDERDOC=On` compiler option. `GPU_debug_capture_begin` and `GPU_debug_capture_end` can be added to the section of the code you want to debug. When running Blender inside renderdoc this part will automatically be captured. All GPU test cases are now guarded by these calls. In order to capture the test cases you need to start the test cases from renderdoc and the captured GPU API calls will appear where each capture is a single test case. Pull Request: blender/blender#105921
45 lines
1.2 KiB
C++
45 lines
1.2 KiB
C++
#pragma once
|
|
/* SPDX-License-Identifier: GPL-2.0-or-later
|
|
* Copyright 2023 Blender Foundation. All rights reserved. */
|
|
|
|
#include "renderdoc_app.h"
|
|
|
|
namespace renderdoc::api {
|
|
class Renderdoc {
|
|
private:
|
|
enum class State {
|
|
/**
|
|
* Initial state of the API indicating that the API hasn't checked if it can find renderdoc.
|
|
*/
|
|
UNINITIALIZED,
|
|
|
|
/**
|
|
* API has looked for renderdoc, but couldn't find it. This indicates that renderdoc isn't
|
|
* available on the platform, or wasn't registered correctly.
|
|
*/
|
|
NOT_FOUND,
|
|
|
|
/**
|
|
* API has loaded the symbols of renderdoc.
|
|
*/
|
|
LOADED,
|
|
};
|
|
State state_ = State::UNINITIALIZED;
|
|
RENDERDOC_API_1_6_0 *renderdoc_api_ = nullptr;
|
|
|
|
public:
|
|
bool start_frame_capture(RENDERDOC_DevicePointer device_handle,
|
|
RENDERDOC_WindowHandle window_handle);
|
|
void end_frame_capture(RENDERDOC_DevicePointer device_handle,
|
|
RENDERDOC_WindowHandle window_handle);
|
|
|
|
private:
|
|
/**
|
|
* Check if renderdoc has been loaded.
|
|
*
|
|
* When not loaded it tries to load the API, but only tries to do it once.
|
|
*/
|
|
bool check_loaded();
|
|
void load();
|
|
};
|
|
} // namespace renderdoc::api
|