DX11: Integrated RenderDoc capture.
This commit is contained in:
Branimir Karadžić
parent
22614cf946
commit
4657f97c6f
240
3rdparty/renderdoc/renderdoc_app.h
vendored
Normal file
240
3rdparty/renderdoc/renderdoc_app.h
vendored
Normal file
@ -0,0 +1,240 @@
|
||||
/******************************************************************************
|
||||
* The MIT License (MIT)
|
||||
*
|
||||
* Copyright (c) 2014 Crytek
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in
|
||||
* all copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
******************************************************************************/
|
||||
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
#ifdef WIN32
|
||||
|
||||
#ifdef RENDERDOC_EXPORTS
|
||||
#define RENDERDOC_API __declspec(dllexport)
|
||||
#else
|
||||
#define RENDERDOC_API __declspec(dllimport)
|
||||
#endif
|
||||
#define RENDERDOC_CC __cdecl
|
||||
|
||||
#elif defined(LINUX)
|
||||
|
||||
#ifdef RENDERDOC_EXPORTS
|
||||
#define RENDERDOC_API __attribute__ ((visibility ("default")))
|
||||
#else
|
||||
#define RENDERDOC_API
|
||||
#endif
|
||||
|
||||
#define RENDERDOC_CC
|
||||
|
||||
#else
|
||||
|
||||
#error "Unknown platform"
|
||||
|
||||
#endif
|
||||
|
||||
struct CaptureOptions
|
||||
{
|
||||
CaptureOptions()
|
||||
: AllowVSync(true),
|
||||
AllowFullscreen(true),
|
||||
DebugDeviceMode(false),
|
||||
CaptureCallstacks(false),
|
||||
CaptureCallstacksOnlyDraws(false),
|
||||
DelayForDebugger(0),
|
||||
CacheStateObjects(false),
|
||||
HookIntoChildren(false),
|
||||
RefAllResources(false),
|
||||
SaveAllInitials(false),
|
||||
CaptureAllCmdLists(false)
|
||||
{}
|
||||
|
||||
// Whether or not to allow the application to enable vsync
|
||||
//
|
||||
// Enabled - allows the application to enable or disable vsync at will
|
||||
// Disabled - vsync is force disabled
|
||||
uint32_t AllowVSync;
|
||||
|
||||
// Whether or not to allow the application to enable fullscreen
|
||||
//
|
||||
// Enabled - allows the application to enable or disable fullscreen at will
|
||||
// Disabled - fullscreen is force disabled
|
||||
uint32_t AllowFullscreen;
|
||||
|
||||
// Enables in-built API debugging features and records the results into the
|
||||
// capture logfile, which is matched up with events on replay
|
||||
uint32_t DebugDeviceMode;
|
||||
|
||||
// Captures callstacks for every API event during capture
|
||||
uint32_t CaptureCallstacks;
|
||||
|
||||
// Only captures callstacks for drawcall type API events.
|
||||
// Ignored if CaptureCallstacks is disabled
|
||||
uint32_t CaptureCallstacksOnlyDraws;
|
||||
|
||||
// Specify a delay in seconds to wait for a debugger to attach after
|
||||
// creating or injecting into a process, before continuing to allow it to run.
|
||||
uint32_t DelayForDebugger;
|
||||
|
||||
// Deprecated, ignored.
|
||||
uint32_t CacheStateObjects;
|
||||
|
||||
// Hooks any system API events that create child processes, and injects
|
||||
// renderdoc into them recursively with the same options.
|
||||
uint32_t HookIntoChildren;
|
||||
|
||||
// By default renderdoc only includes resources in the final logfile necessary
|
||||
// for that frame, this allows you to override that behaviour
|
||||
//
|
||||
// Enabled - all live resources at the time of capture are included in the log
|
||||
// and available for inspection
|
||||
// Disabled - only the resources referenced by the captured frame are included
|
||||
uint32_t RefAllResources;
|
||||
|
||||
// By default renderdoc skips saving initial states for
|
||||
uint32_t SaveAllInitials;
|
||||
|
||||
// In APIs that allow for the recording of command lists to be replayed later,
|
||||
// renderdoc may choose to not capture command lists before a frame capture is
|
||||
// triggered, to reduce overheads. This means any command lists recorded once
|
||||
// and replayed many times will not be available and may cause a failure to
|
||||
// capture.
|
||||
//
|
||||
// Enabled - All command lists are captured from the start of the application
|
||||
// Disabled - Command lists are only captured if their recording begins during
|
||||
// the period when a frame capture is in progress.
|
||||
uint32_t CaptureAllCmdLists;
|
||||
};
|
||||
|
||||
enum KeyButton
|
||||
{
|
||||
eKey_0 = 0x30, // '0'
|
||||
// ...
|
||||
eKey_9 = 0x39, // '9'
|
||||
eKey_A = 0x41, // 'A'
|
||||
// ...
|
||||
eKey_Z = 0x5A, // 'Z'
|
||||
|
||||
eKey_Divide,
|
||||
eKey_Multiply,
|
||||
eKey_Subtract,
|
||||
eKey_Plus,
|
||||
|
||||
eKey_F1,
|
||||
eKey_F2,
|
||||
eKey_F3,
|
||||
eKey_F4,
|
||||
eKey_F5,
|
||||
eKey_F6,
|
||||
eKey_F7,
|
||||
eKey_F8,
|
||||
eKey_F9,
|
||||
eKey_F10,
|
||||
eKey_F11,
|
||||
eKey_F12,
|
||||
|
||||
eKey_Home,
|
||||
eKey_End,
|
||||
eKey_Insert,
|
||||
eKey_Delete,
|
||||
eKey_PageUp,
|
||||
eKey_PageDn,
|
||||
|
||||
eKey_Backspace,
|
||||
eKey_Tab,
|
||||
eKey_PrtScrn,
|
||||
eKey_Pause,
|
||||
|
||||
eKey_Max,
|
||||
};
|
||||
|
||||
enum InAppOverlay
|
||||
{
|
||||
eOverlay_Enabled = 0x1,
|
||||
eOverlay_FrameRate = 0x2,
|
||||
eOverlay_FrameNumber = 0x4,
|
||||
eOverlay_CaptureList = 0x8,
|
||||
|
||||
eOverlay_Default = (eOverlay_Enabled|eOverlay_FrameRate|eOverlay_FrameNumber|eOverlay_CaptureList),
|
||||
eOverlay_All = ~0U,
|
||||
eOverlay_None = 0,
|
||||
};
|
||||
|
||||
#define RENDERDOC_API_VERSION 1
|
||||
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
// In-program functions
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
|
||||
extern "C" RENDERDOC_API int RENDERDOC_CC RENDERDOC_GetAPIVersion();
|
||||
typedef int (RENDERDOC_CC *pRENDERDOC_GetAPIVersion)();
|
||||
|
||||
extern "C" RENDERDOC_API void RENDERDOC_CC RENDERDOC_SetLogFile(const wchar_t *logfile);
|
||||
typedef void (RENDERDOC_CC *pRENDERDOC_SetLogFile)(const wchar_t *logfile);
|
||||
|
||||
extern "C" RENDERDOC_API const wchar_t* RENDERDOC_CC RENDERDOC_GetLogFile();
|
||||
typedef const wchar_t* (RENDERDOC_CC *pRENDERDOC_GetLogFile)();
|
||||
|
||||
extern "C" RENDERDOC_API uint32_t RENDERDOC_CC RENDERDOC_GetCapture(uint32_t idx, wchar_t *logfile, uint32_t *pathlength, uint64_t *timestamp);
|
||||
typedef uint32_t (RENDERDOC_CC *pRENDERDOC_GetCapture)(uint32_t idx, wchar_t *logfile, uint32_t *pathlength, uint64_t *timestamp);
|
||||
|
||||
extern "C" RENDERDOC_API void RENDERDOC_CC RENDERDOC_SetCaptureOptions(const CaptureOptions *opts);
|
||||
typedef void (RENDERDOC_CC *pRENDERDOC_SetCaptureOptions)(const CaptureOptions *opts);
|
||||
|
||||
extern "C" RENDERDOC_API void RENDERDOC_CC RENDERDOC_SetActiveWindow(void *wndHandle);
|
||||
typedef void (RENDERDOC_CC *pRENDERDOC_SetActiveWindow)(void *wndHandle);
|
||||
|
||||
extern "C" RENDERDOC_API void RENDERDOC_CC RENDERDOC_TriggerCapture();
|
||||
typedef void (RENDERDOC_CC *pRENDERDOC_TriggerCapture)();
|
||||
|
||||
extern "C" RENDERDOC_API void RENDERDOC_CC RENDERDOC_StartFrameCapture(void *wndHandle);
|
||||
typedef void (RENDERDOC_CC *pRENDERDOC_StartFrameCapture)(void *wndHandle);
|
||||
|
||||
extern "C" RENDERDOC_API uint32_t RENDERDOC_CC RENDERDOC_EndFrameCapture(void *wndHandle);
|
||||
typedef uint32_t (RENDERDOC_CC *pRENDERDOC_EndFrameCapture)(void *wndHandle);
|
||||
|
||||
extern "C" RENDERDOC_API uint32_t RENDERDOC_CC RENDERDOC_GetOverlayBits();
|
||||
typedef uint32_t (RENDERDOC_CC *pRENDERDOC_GetOverlayBits)();
|
||||
|
||||
extern "C" RENDERDOC_API void RENDERDOC_CC RENDERDOC_MaskOverlayBits(uint32_t And, uint32_t Or);
|
||||
typedef void (RENDERDOC_CC *pRENDERDOC_MaskOverlayBits)(uint32_t And, uint32_t Or);
|
||||
|
||||
extern "C" RENDERDOC_API void RENDERDOC_CC RENDERDOC_SetFocusToggleKeys(KeyButton *keys, int num);
|
||||
typedef void (RENDERDOC_CC *pRENDERDOC_SetFocusToggleKeys)(KeyButton *keys, int num);
|
||||
|
||||
extern "C" RENDERDOC_API void RENDERDOC_CC RENDERDOC_SetCaptureKeys(KeyButton *keys, int num);
|
||||
typedef void (RENDERDOC_CC *pRENDERDOC_SetCaptureKeys)(KeyButton *keys, int num);
|
||||
|
||||
extern "C" RENDERDOC_API void RENDERDOC_CC RENDERDOC_InitRemoteAccess(uint32_t *ident);
|
||||
typedef void (RENDERDOC_CC *pRENDERDOC_InitRemoteAccess)(uint32_t *ident);
|
||||
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
// Injection/execution capture functions.
|
||||
//////////////////////////////////////////////////////////////////////////
|
||||
|
||||
extern "C" RENDERDOC_API uint32_t RENDERDOC_CC RENDERDOC_ExecuteAndInject(const wchar_t *app, const wchar_t *workingDir, const wchar_t *cmdLine,
|
||||
const wchar_t *logfile, const CaptureOptions *opts, uint32_t waitForExit);
|
||||
typedef uint32_t (RENDERDOC_CC *pRENDERDOC_ExecuteAndInject)(const wchar_t *app, const wchar_t *workingDir, const wchar_t *cmdLine,
|
||||
const wchar_t *logfile, const CaptureOptions *opts, uint32_t waitForExit);
|
||||
|
||||
extern "C" RENDERDOC_API uint32_t RENDERDOC_CC RENDERDOC_InjectIntoProcess(uint32_t pid, const wchar_t *logfile, const CaptureOptions *opts, uint32_t waitForExit);
|
||||
typedef uint32_t (RENDERDOC_CC *pRENDERDOC_InjectIntoProcess)(uint32_t pid, const wchar_t *logfile, const CaptureOptions *opts, uint32_t waitForExit);
|
||||
@ -16,6 +16,7 @@ function bgfxProject(_name, _kind, _defines)
|
||||
end
|
||||
|
||||
includedirs {
|
||||
BGFX_DIR .. "3rdparty",
|
||||
BGFX_DIR .. "../bx/include",
|
||||
}
|
||||
|
||||
|
||||
@ -7,6 +7,7 @@
|
||||
|
||||
#if BGFX_CONFIG_RENDERER_DIRECT3D11
|
||||
# include "renderer_d3d11.h"
|
||||
# include <renderdoc/renderdoc_app.h>
|
||||
|
||||
namespace bgfx
|
||||
{
|
||||
@ -402,6 +403,78 @@ namespace bgfx
|
||||
return false;
|
||||
};
|
||||
|
||||
#define RENDERDOC_IMPORT \
|
||||
RENDERDOC_IMPORT_FUNC(RENDERDOC_SetLogFile); \
|
||||
RENDERDOC_IMPORT_FUNC(RENDERDOC_GetCapture); \
|
||||
RENDERDOC_IMPORT_FUNC(RENDERDOC_SetCaptureOptions); \
|
||||
RENDERDOC_IMPORT_FUNC(RENDERDOC_SetActiveWindow); \
|
||||
RENDERDOC_IMPORT_FUNC(RENDERDOC_TriggerCapture); \
|
||||
RENDERDOC_IMPORT_FUNC(RENDERDOC_StartFrameCapture); \
|
||||
RENDERDOC_IMPORT_FUNC(RENDERDOC_EndFrameCapture); \
|
||||
RENDERDOC_IMPORT_FUNC(RENDERDOC_GetOverlayBits); \
|
||||
RENDERDOC_IMPORT_FUNC(RENDERDOC_MaskOverlayBits); \
|
||||
RENDERDOC_IMPORT_FUNC(RENDERDOC_SetFocusToggleKeys); \
|
||||
RENDERDOC_IMPORT_FUNC(RENDERDOC_SetCaptureKeys); \
|
||||
RENDERDOC_IMPORT_FUNC(RENDERDOC_InitRemoteAccess);
|
||||
|
||||
#define RENDERDOC_IMPORT_FUNC(_func) p##_func _func
|
||||
RENDERDOC_IMPORT
|
||||
#undef RENDERDOC_IMPORT_FUNC
|
||||
|
||||
pRENDERDOC_GetAPIVersion RENDERDOC_GetAPIVersion;
|
||||
|
||||
void* loadRenderDoc()
|
||||
{
|
||||
void* renderdocdll = bx::dlopen("renderdoc.dll");
|
||||
|
||||
if (NULL != renderdocdll)
|
||||
{
|
||||
RENDERDOC_GetAPIVersion = (pRENDERDOC_GetAPIVersion)bx::dlsym(renderdocdll, "RENDERDOC_GetAPIVersion");
|
||||
if (NULL != RENDERDOC_GetAPIVersion
|
||||
&& RENDERDOC_API_VERSION == RENDERDOC_GetAPIVersion() )
|
||||
{
|
||||
#define RENDERDOC_IMPORT_FUNC(_func) \
|
||||
_func = (p##_func)bx::dlsym(renderdocdll, #_func); \
|
||||
BX_TRACE("%p " #_func, _func);
|
||||
RENDERDOC_IMPORT
|
||||
#undef RENDERDOC_IMPORT_FUNC
|
||||
|
||||
RENDERDOC_SetLogFile(L"temp/bgfx");
|
||||
|
||||
RENDERDOC_SetFocusToggleKeys(NULL, 0);
|
||||
|
||||
KeyButton captureKey = eKey_F11;
|
||||
RENDERDOC_SetCaptureKeys(&captureKey, 1);
|
||||
|
||||
CaptureOptions opt;
|
||||
memset(&opt, 0, sizeof(opt) );
|
||||
opt.AllowVSync = 1;
|
||||
opt.SaveAllInitials = 1;
|
||||
RENDERDOC_SetCaptureOptions(&opt);
|
||||
|
||||
uint32_t ident = 0;
|
||||
RENDERDOC_InitRemoteAccess(&ident);
|
||||
|
||||
RENDERDOC_MaskOverlayBits(eOverlay_None, eOverlay_None);
|
||||
}
|
||||
else
|
||||
{
|
||||
bx::dlclose(renderdocdll);
|
||||
renderdocdll = NULL;
|
||||
}
|
||||
}
|
||||
|
||||
return renderdocdll;
|
||||
}
|
||||
|
||||
void unloadRenderDoc(void* _renderdocdll)
|
||||
{
|
||||
if (NULL != _renderdocdll)
|
||||
{
|
||||
// bx::dlclose(_renderdocdll);
|
||||
}
|
||||
}
|
||||
|
||||
struct RendererContextD3D11 : public RendererContextI
|
||||
{
|
||||
RendererContextD3D11()
|
||||
@ -413,6 +486,8 @@ namespace bgfx
|
||||
, m_fsChanges(0)
|
||||
, m_rtMsaa(false)
|
||||
{
|
||||
m_renderdocdll = loadRenderDoc();
|
||||
|
||||
m_fbh.idx = invalidHandle;
|
||||
memset(m_uniforms, 0, sizeof(m_uniforms) );
|
||||
memset(&m_resolution, 0, sizeof(m_resolution) );
|
||||
@ -544,9 +619,12 @@ namespace bgfx
|
||||
hr = device->GetParent(__uuidof(IDXGIAdapter), (void**)&adapter);
|
||||
BGFX_FATAL(SUCCEEDED(hr), Fatal::UnableToInitialize, "Unable to create Direct3D11 device.");
|
||||
|
||||
// GPA increases device ref count and triggers assert in debug
|
||||
// build. Set flag to disable reference count checks.
|
||||
setGraphicsDebuggerPresent(3 < getRefCount(device) );
|
||||
// GPA increases device ref count.
|
||||
// RenderDoc makes device ref count 0 here.
|
||||
//
|
||||
// This causes assert in debug. When debugger is present refcount
|
||||
// checks are off.
|
||||
setGraphicsDebuggerPresent(2 != getRefCount(device) );
|
||||
DX_RELEASE(device, 2);
|
||||
|
||||
hr = adapter->GetDesc(&m_adapterDesc);
|
||||
@ -658,6 +736,8 @@ namespace bgfx
|
||||
DX_RELEASE(m_device, 0);
|
||||
DX_RELEASE(m_factory, 0);
|
||||
|
||||
unloadRenderDoc(m_renderdocdll);
|
||||
|
||||
#if USE_D3D11_DYNAMIC_LIB
|
||||
bx::dlclose(m_dxgidll);
|
||||
bx::dlclose(m_d3d11dll);
|
||||
@ -1829,6 +1909,8 @@ namespace bgfx
|
||||
void* m_dxgidll;
|
||||
#endif // USE_D3D11_DYNAMIC_LIB
|
||||
|
||||
void* m_renderdocdll;
|
||||
|
||||
D3D_DRIVER_TYPE m_driverType;
|
||||
IDXGIAdapter* m_adapter;
|
||||
DXGI_ADAPTER_DESC m_adapterDesc;
|
||||
@ -3310,7 +3392,8 @@ namespace bgfx
|
||||
|
||||
tvm.clear();
|
||||
uint16_t pos = 0;
|
||||
tvm.printf(0, pos++, BGFX_CONFIG_DEBUG ? 0x89 : 0x8f, " %s / " BX_COMPILER_NAME " / " BX_CPU_NAME " / " BX_ARCH_NAME " / " BX_PLATFORM_NAME " "
|
||||
tvm.printf(0, pos++, BGFX_CONFIG_DEBUG ? 0x89 : 0x8f
|
||||
, " %s / " BX_COMPILER_NAME " / " BX_CPU_NAME " / " BX_ARCH_NAME " / " BX_PLATFORM_NAME " "
|
||||
, getRendererName()
|
||||
);
|
||||
|
||||
@ -3364,6 +3447,11 @@ namespace bgfx
|
||||
);
|
||||
}
|
||||
|
||||
if (NULL != m_renderdocdll)
|
||||
{
|
||||
tvm.printf(tvm.m_width-27, 0, 0x1f, " [F11 - RenderDoc capture] ");
|
||||
}
|
||||
|
||||
tvm.printf(10, pos++, 0x8e, " Indices: %7d", statsNumIndices);
|
||||
tvm.printf(10, pos++, 0x8e, " DVB size: %7d", _render->m_vboffset);
|
||||
tvm.printf(10, pos++, 0x8e, " DIB size: %7d", _render->m_iboffset);
|
||||
|
||||
Loading…
Reference in New Issue
Block a user