Files
renderdoc/qrenderdoc/Code/CaptureContext.cpp
T
baldurk 3ac4bd0ebd Refactor custom shaders to abstract binding differences. Closes #2458
* Newly written shaders and any updated shaders can now use pre-defined macros
  to abstract away binding differences between APIs, so custom shaders will be
  more portable in particular shaders written in HLSL for D3D or GLSL on OpenGL
  won't break on vulkan because they refer to incorrect binds.
2022-01-31 19:14:08 +00:00

2810 lines
77 KiB
C++

/******************************************************************************
* The MIT License (MIT)
*
* Copyright (c) 2019-2021 Baldur Karlsson
*
* 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.
******************************************************************************/
#include "CaptureContext.h"
#include <QApplication>
#include <QDir>
#include <QDirIterator>
#include <QElapsedTimer>
#include <QFileInfo>
#include <QFileSystemWatcher>
#include <QLabel>
#include <QMenu>
#include <QMessageBox>
#include <QMetaObject>
#include <QProgressDialog>
#include <QRegularExpression>
#include <QTimer>
#include "Code/Resources.h"
#include "Code/pyrenderdoc/PythonContext.h"
#include "Windows/APIInspector.h"
#include "Windows/BufferViewer.h"
#include "Windows/CommentView.h"
#include "Windows/ConstantBufferPreviewer.h"
#include "Windows/DebugMessageView.h"
#include "Windows/Dialogs/CaptureDialog.h"
#include "Windows/Dialogs/CrashDialog.h"
#include "Windows/Dialogs/LiveCapture.h"
#include "Windows/Dialogs/SettingsDialog.h"
#include "Windows/EventBrowser.h"
#include "Windows/LogView.h"
#include "Windows/MainWindow.h"
#include "Windows/PerformanceCounterViewer.h"
#include "Windows/PipelineState/PipelineStateViewer.h"
#include "Windows/PixelHistoryView.h"
#include "Windows/PythonShell.h"
#include "Windows/ResourceInspector.h"
#include "Windows/ShaderMessageViewer.h"
#include "Windows/ShaderViewer.h"
#include "Windows/StatisticsViewer.h"
#include "Windows/TextureViewer.h"
#include "Windows/TimelineBar.h"
#include "MiniQtHelper.h"
#include "QRDUtils.h"
#include "RGPInterop.h"
#include "version.h"
#include "pipestate.inl"
CaptureContext::CaptureContext(PersistantConfig &cfg) : m_Config(cfg)
{
RENDERDOC_PROFILEFUNCTION();
m_CaptureLoaded = false;
m_LoadInProgress = false;
RENDERDOC_RegisterMemoryRegion(this, sizeof(CaptureContext));
memset(&m_APIProps, 0, sizeof(m_APIProps));
m_CurD3D11PipelineState = NULL;
m_CurD3D12PipelineState = NULL;
m_CurGLPipelineState = NULL;
m_CurVulkanPipelineState = NULL;
m_CurPipelineState = &m_DummyPipelineState;
m_Actions = &m_EmptyActions;
m_StructuredFile = &m_DummySDFile;
m_QtHelper = new MiniQtHelper(*this);
qApp->setApplicationVersion(QString::fromLatin1(RENDERDOC_GetVersionString()));
m_Icon = new QIcon();
m_Icon->addFile(QStringLiteral(":/logo.svg"), QSize(), QIcon::Normal, QIcon::Off);
m_MainWindow = new MainWindow(*this);
m_MainWindow->LoadInitialLayout();
m_Replay.SetFatalErrorCallback([this]() {
GUIInvoke::call(m_MainWindow, [this]() {
RefreshUIStatus({}, true, true);
ReplayStatus err = GetFatalError();
QString title;
QString text;
if(err == ReplayStatus::RemoteServerConnectionLost)
{
QString serverName = Replay().CurrentRemote().Name();
title = tr("Connection lost to %1").arg(serverName);
text =
tr("Connection to %1 was lost while analysing capture.\n"
"This is most commonly caused by a crash, but that can't be verified and it may be "
"a connection issue.")
.arg(serverName);
}
else if(err == ReplayStatus::ReplayDeviceLost)
{
title = tr("Device Lost error");
text =
tr("The capture analysis encountered a device lost error. This may be due to an "
"application bug, a RenderDoc bug, or insufficient resources on the system to "
"analyse the capture.\n\n"
"It is recommended that you run your application with API validation enabled, as "
"API use errors can cause this kind of problem.");
}
else if(err == ReplayStatus::ReplayOutOfMemory)
{
title = tr("Out of GPU memory");
text = tr(
"While analysing the capture it ran out of GPU memory. This is most likely caused by "
"insufficient resources on the system to analyse the capture, which is possible if "
"there is memory pressure from other applications or if the capture is heavyweight.");
}
else
{
title = tr("Unrecoverable error");
text = tr("While analysing the capture we encountered an unrecoverable error:\n\n%1")
.arg(QString(ToStr(err)));
}
text +=
tr("\n\n"
"This error is not recoverable and the analysis cannot continue. The UI will be "
"non-functional until the capture is closed and reloaded.\n\n");
bool add_report = false;
if(CrashDialog::HasCaptureReady(m_Config))
{
text += tr(
"If you think this may be a RenderDoc bug please click the button below to report it, "
"but note that this will require you to upload the capture for reproduction as "
"otherwise it is impossible to tell what the problem may be.");
add_report = true;
}
else if(CrashDialog::CaptureTooLarge(m_Config))
{
text +=
tr("<html>Your capture is too lage to upload as a crash report so this can't be "
"automatically reported. "
"Please email me at <a "
"href=\"mailto:baldurk@baldurk.org?subject=RenderDoc%20Unrecoverable%20error\">"
"baldurk@baldurk.org</a> with information and I can help investigate.</html>");
}
else
{
text += tr("The capture must be saved locally if you want to report this as a bug. ");
if(Replay().CurrentRemote().IsConnected())
{
text +=
tr("Before closing the capture you can save it to disk and manually report a bug. "
"Please include the capture, or else it will be impossible to tell what the "
"problem may be.");
}
else
{
text += tr("You will need to reconnect to the remote server to save the capture.");
}
}
QMessageBox mb(QMessageBox::Critical, title, text, QMessageBox::Ok, m_MainWindow);
mb.setDefaultButton(QMessageBox::NoButton);
QPushButton *report = NULL;
if(add_report)
report = mb.addButton(tr("Report bug"), QMessageBox::AcceptRole);
RDDialog::show(&mb);
if(mb.clickedButton() == (QAbstractButton *)report)
{
m_MainWindow->sendErrorReport(true);
}
});
});
{
QDir dir(ConfigFilePath("extensions"));
if(!dir.exists())
dir.mkpath(dir.absolutePath());
}
rdcarray<ExtensionMetadata> exts = CaptureContext::GetInstalledExtensions();
for(const ExtensionMetadata &e : exts)
{
if(cfg.AlwaysLoad_Extensions.contains(e.package))
{
qInfo() << "Automatically loading extension" << QString(e.package);
LoadExtension(e.package);
}
}
}
CaptureContext::~CaptureContext()
{
delete m_QtHelper;
RENDERDOC_UnregisterMemoryRegion(this);
delete m_Icon;
m_Replay.CloseThread();
delete m_MainWindow;
}
void CaptureContext::Begin(QString paramFilename, QString remoteHost, uint32_t remoteIdent,
bool temp, QString scriptFilename)
{
m_MainWindow->show();
if(remoteIdent != 0)
{
m_MainWindow->ShowLiveCapture(
new LiveCapture(*this, remoteHost, remoteHost, remoteIdent, m_MainWindow, m_MainWindow));
}
if(!paramFilename.isEmpty())
{
QFileInfo checkFile(paramFilename);
if(checkFile.exists() && checkFile.isFile())
{
m_MainWindow->LoadFromFilename(paramFilename, temp);
if(temp)
m_MainWindow->takeCaptureOwnership();
}
}
if(!scriptFilename.isEmpty())
{
ShowPythonShell();
if(GetPythonShell()->LoadScriptFromFilename(scriptFilename))
GetPythonShell()->RunScript();
}
}
bool CaptureContext::isRunning()
{
return m_MainWindow && m_MainWindow->isVisible();
}
rdcstr CaptureContext::TempCaptureFilename(const rdcstr &appname)
{
QString folder = Config().TemporaryCaptureDirectory;
QDir dir(folder);
if(folder.isEmpty() || !dir.exists())
{
dir = QDir(QDir::tempPath());
dir.mkdir(lit("RenderDoc"));
dir = QDir(dir.absoluteFilePath(lit("RenderDoc")));
}
return dir.absoluteFilePath(
QFormatStr("%1_%2.rdc")
.arg(appname)
.arg(QDateTime::currentDateTimeUtc().toString(lit("yyyy.MM.dd_HH.mm.ss"))));
}
rdcarray<ExtensionMetadata> CaptureContext::GetInstalledExtensions()
{
rdcarray<ExtensionMetadata> ret;
for(QString extensionFolder : PythonContext::GetApplicationExtensionsPaths())
{
QDirIterator it(extensionFolder, QDirIterator::Subdirectories);
while(it.hasNext())
{
QFileInfo fileinfo(it.next());
if(fileinfo.fileName().toLower() == lit("extension.json"))
{
QFile f(fileinfo.absoluteFilePath());
QString package = fileinfo.absolutePath()
.replace(extensionFolder, QString())
.replace(QLatin1Char('/'), QLatin1Char('.'));
while(package[0] == QLatin1Char('.'))
package.remove(0, 1);
while(package[package.size() - 1] == QLatin1Char('.'))
package.remove(package.size() - 1, 1);
if(f.exists() && f.open(QIODevice::ReadOnly | QIODevice::Text))
{
QVariantMap json = JSONToVariant(QString::fromUtf8(f.readAll()));
if(json.empty())
{
qCritical() << fileinfo.absoluteFilePath() << "is corrupt, cannot parse json";
continue;
}
ExtensionMetadata ext;
ext.package = package;
ext.filePath = fileinfo.absolutePath();
if(json.contains(lit("name")))
{
ext.name = json[lit("name")].toString();
}
else
{
qCritical() << "Extension" << package << "is corrupt, no name entry";
continue;
}
ext.extensionAPI = 1;
if(json.contains(lit("extension_api")))
{
ext.extensionAPI = json[lit("extension_api")].toInt();
}
else
{
qCritical() << "Extension" << QString(ext.name) << "is corrupt, no api version entry";
continue;
}
if(json.contains(lit("version")))
{
ext.version = json[lit("version")].toString();
}
else
{
qCritical() << "Extension" << QString(ext.name) << "is corrupt, no version entry";
continue;
}
if(json.contains(lit("description")))
{
ext.description = json[lit("description")].toString();
}
else
{
qCritical() << "Extension" << QString(ext.name) << "is corrupt, no description entry";
continue;
}
if(json.contains(lit("author")))
{
ext.author = json[lit("author")].toString();
}
else
{
qCritical() << "Extension" << QString(ext.name) << "is corrupt, no author entry";
continue;
}
if(json.contains(lit("url")))
{
ext.extensionURL = json[lit("url")].toString();
}
else
{
qCritical() << "Extension" << QString(ext.name) << "is corrupt, no URL entry";
continue;
}
if(json.contains(lit("minimum_renderdoc")))
{
QString minVer = json[lit("minimum_renderdoc")].toString();
QRegularExpression re(lit("([0-9]*).([0-9]*)"));
QRegularExpressionMatch match = re.match(minVer);
bool ok = false, badversion = false;
if(match.hasMatch())
{
int major = match.captured(1).toInt(&ok);
if(ok)
{
int minor = match.captured(2).toInt(&ok);
// if it needs a higher major version, we can't load it
if(major > RENDERDOC_VERSION_MAJOR)
badversion = true;
// if major versions are the same and it needs a higher minor, we can't load it
// either
if(major == RENDERDOC_VERSION_MAJOR && minor > RENDERDOC_VERSION_MINOR)
badversion = true;
}
}
if(!ok)
{
qCritical() << "Extension" << QString(ext.name)
<< "is corrupt, minimum_renderdoc doesn't match a MAJOR.MINOR version";
continue;
}
if(badversion)
{
qInfo() << "Extension" << QString(ext.name) << "declares minimum_renderdoc" << minVer
<< "so skipping";
continue;
}
}
ret.push_back(ext);
}
}
}
}
return ret;
}
bool CaptureContext::IsExtensionLoaded(rdcstr name)
{
return m_ExtensionObjects.contains(name);
}
bool CaptureContext::LoadExtension(rdcstr name)
{
bool ret = false;
PythonContext::ProcessExtensionWork([this, &ret, name]() {
for(QObject *o : m_ExtensionObjects[name])
delete o;
m_ExtensionObjects[name].clear();
ret = PythonContext::LoadExtension(*this, name);
if(ret)
{
m_ExtensionObjects[name].swap(m_PendingExtensionObjects);
}
else
{
m_ExtensionObjects.remove(name);
for(QObject *o : m_PendingExtensionObjects)
delete o;
m_PendingExtensionObjects.clear();
}
});
for(QAction *a : m_MainWindow->GetMenuActions())
CleanMenu(a);
m_RegisteredMenuItems.removeAll(NULL);
return ret;
}
void CaptureContext::RegisterWindowMenu(WindowMenu base, const rdcarray<rdcstr> &submenus,
ExtensionCallback callback)
{
if(base == WindowMenu::Unknown)
{
qCritical() << "Can't register menu for WindowMenu::Unknown";
return;
}
if(submenus.isEmpty())
{
qCritical() << "Empty list of submenus";
return;
}
if(base == WindowMenu::NewMenu && submenus.count() == 1)
{
qCritical() << "Need at least two items in submenus for WindowMenu::NewMenu";
return;
}
QMenu *menu = m_MainWindow->GetBaseMenu(base, submenus[0]);
if(!menu)
{
qCritical() << "Couldn't get base menu";
return;
}
std::function<void()> slotcallback = [this, callback]() { callback(this, {}); };
// if it's a new menu, GetBaseMenu already did the work, so skip the 0th element of submenus
if(base == WindowMenu::NewMenu)
{
rdcarray<rdcstr> items = submenus;
items.erase(0);
AddSortedMenuItem(menu, false, items, slotcallback);
}
else
{
AddSortedMenuItem(menu, false, submenus, slotcallback);
}
}
void CaptureContext::RegisterPanelMenu(PanelMenu base, const rdcarray<rdcstr> &submenus,
ExtensionCallback callback)
{
if(base == PanelMenu::Unknown)
{
qCritical() << "Can't register menu for PanelMenu::Unknown";
return;
}
RegisteredMenuItem *item = new RegisteredMenuItem();
item->panel = base;
item->submenus = submenus;
item->callback = callback;
m_RegisteredMenuItems.push_back(item);
m_PendingExtensionObjects.push_back(item);
}
void CaptureContext::RegisterContextMenu(ContextMenu base, const rdcarray<rdcstr> &submenus,
ExtensionCallback callback)
{
if(base == ContextMenu::Unknown)
{
qCritical() << "Can't register menu for ContextMenu::Unknown";
return;
}
RegisteredMenuItem *item = new RegisteredMenuItem();
item->context = base;
item->submenus = submenus;
item->callback = callback;
m_RegisteredMenuItems.push_back(item);
m_PendingExtensionObjects.push_back(item);
}
void CaptureContext::MenuDisplaying(ContextMenu contextMenu, QMenu *menu,
const ExtensionCallbackData &data)
{
ContextMenu contextMenuAlt = contextMenu;
switch(contextMenu)
{
case ContextMenu::MeshPreview_GSOutVertex:
case ContextMenu::MeshPreview_VSInVertex:
case ContextMenu::MeshPreview_VSOutVertex:
contextMenuAlt = ContextMenu::MeshPreview_Vertex;
break;
case ContextMenu::TextureViewer_InputThumbnail:
case ContextMenu::TextureViewer_OutputThumbnail:
contextMenuAlt = ContextMenu::TextureViewer_Thumbnail;
break;
default: break;
}
for(RegisteredMenuItem *item : m_RegisteredMenuItems)
{
if(item->context == contextMenu || item->context == contextMenuAlt)
{
AddSortedMenuItem(menu, true, item->submenus, [this, item, data]() {
rdcarray<rdcpair<rdcstr, PyObject *>> args;
PythonContext::ConvertPyArgs(data, args);
item->callback(this, args);
PythonContext::FreePyArgs(args);
});
}
}
}
void CaptureContext::MenuDisplaying(PanelMenu panelMenu, QMenu *menu, QWidget *extensionButton,
const ExtensionCallbackData &data)
{
for(RegisteredMenuItem *item : m_RegisteredMenuItems)
{
if(item->panel == panelMenu)
{
AddSortedMenuItem(menu, false, item->submenus, [this, item, data]() {
rdcarray<rdcpair<rdcstr, PyObject *>> args;
PythonContext::ConvertPyArgs(data, args);
item->callback(this, args);
PythonContext::FreePyArgs(args);
});
}
}
QAction *emptyAction = new QAction(tr("No extension commands configured"), menu);
if(menu->isEmpty())
{
menu->addAction(emptyAction);
QObject::connect(emptyAction, &QAction::triggered,
[this]() { m_MainWindow->showExtensionManager(); });
}
}
IMiniQtHelper &CaptureContext::GetMiniQtHelper()
{
return *m_QtHelper;
}
void CaptureContext::MessageDialog(const rdcstr &text, const rdcstr &title)
{
RDDialog::information(m_MainWindow, title, text);
}
void CaptureContext::ErrorDialog(const rdcstr &text, const rdcstr &title)
{
RDDialog::critical(m_MainWindow, title, text);
}
DialogButton CaptureContext::QuestionDialog(const rdcstr &text, const rdcarray<DialogButton> &options,
const rdcstr &title)
{
QMessageBox::StandardButtons buttons;
for(DialogButton b : options)
buttons |= (QMessageBox::StandardButton)b;
return (DialogButton)RDDialog::question(m_MainWindow, title, text, buttons);
}
rdcstr CaptureContext::OpenFileName(const rdcstr &caption, const rdcstr &dir, const rdcstr &filter)
{
return RDDialog::getOpenFileName(m_MainWindow, caption, dir, filter);
}
rdcstr CaptureContext::OpenDirectoryName(const rdcstr &caption, const rdcstr &dir)
{
return RDDialog::getExistingDirectory(m_MainWindow, caption, dir);
}
rdcstr CaptureContext::SaveFileName(const rdcstr &caption, const rdcstr &dir, const rdcstr &filter)
{
return RDDialog::getSaveFileName(m_MainWindow, caption, dir, filter);
}
void CaptureContext::AddSortedMenuItem(QMenu *menu, bool rootMenu, const rdcarray<rdcstr> &items,
std::function<void()> callback)
{
QAction *beforeAction = NULL;
bool addIcon = rootMenu;
// if we're inserting into a pre-existing menu, try to find an __examples__ action which tells us
// where
// to be inserting
{
QList<QAction *> children = menu->actions();
int idx = 0;
for(; idx < children.count(); idx++)
{
if(children[idx]->text() == lit("__extensions__"))
break;
}
// if we found it, set beforeAction
if(idx < children.count())
{
// search back to find the right place alphabetically to place this, if there are existing
// menus
for(; idx > 0;)
{
// if the previous child is a separator, break, there are no more previous menus
if(children[idx - 1]->isSeparator())
break;
// if we should be sorted before the previous child, move backwards
if(children[idx - 1]->text() > items[0])
{
idx--;
continue;
}
// if we found the right place, break
break;
}
beforeAction = children[idx];
addIcon = true;
}
}
for(int i = 0; i < items.count() - 1; i++)
{
QList<QAction *> children = menu->actions();
bool found = false;
// see if this submenu already exists, if so just iterate down to it
for(QAction *a : children)
{
if(a->text() == items[i])
{
menu = a->menu();
found = true;
break;
}
}
if(found)
{
addIcon = false;
beforeAction = NULL;
continue;
}
// create the new submenu
QMenu *submenu = new QMenu(items[i], m_MainWindow);
// if we don't have a beforeAction, find where to insert this to keep alphabetical order.
if(!beforeAction)
{
for(QAction *a : children)
{
if(submenu->menuAction()->text() < a->text())
{
beforeAction = a;
break;
}
}
}
if(beforeAction)
menu->insertMenu(beforeAction, submenu);
else
menu->addMenu(submenu);
if(addIcon)
submenu->setIcon(Icons::plugin());
addIcon = false;
beforeAction = NULL;
menu = submenu;
}
QAction *action = new QAction(m_MainWindow);
action->setText(items.back());
QObject::connect(action, &QAction::triggered, callback);
if(!beforeAction)
{
QList<QAction *> children = menu->actions();
for(QAction *a : children)
{
if(action->text() < a->text())
{
beforeAction = a;
break;
}
}
}
if(beforeAction)
menu->insertAction(beforeAction, action);
else
menu->addAction(action);
if(addIcon)
action->setIcon(Icons::plugin());
m_PendingExtensionObjects.push_back(action);
}
void CaptureContext::CleanMenu(QAction *action)
{
QMenu *menu = action->menu();
// if this isn't a menu, nothing to do - return
if(!menu)
return;
// first clean all our children
for(QAction *a : menu->actions())
CleanMenu(a);
// if we no longer have any children in this menu, delete it.
if(menu->actions().isEmpty())
delete menu;
}
void CaptureContext::LoadCapture(const rdcstr &captureFile, const ReplayOptions &opts,
const rdcstr &origFilename, bool temporary, bool local)
{
RENDERDOC_PROFILEFUNCTION();
CloseCapture();
PointerTypeRegistry::Init();
m_LoadInProgress = true;
if(local)
m_Config.CrashReport_LastOpenedCapture = origFilename;
else
m_Config.CrashReport_LastOpenedCapture = QString();
m_Config.Save();
bool newCapture = (!temporary && !Config().RecentCaptureFiles.contains(origFilename));
LambdaThread *thread =
new LambdaThread([this, captureFile, opts, origFilename, temporary, local]() {
LoadCaptureThreaded(captureFile, opts, origFilename, temporary, local);
});
thread->setName(lit("LoadCapture"));
thread->selfDelete(true);
thread->start();
QElapsedTimer loadTimer;
loadTimer.start();
ShowProgressDialog(m_MainWindow, tr("Loading Capture: %1").arg(QFileInfo(origFilename).fileName()),
[this]() { return !m_LoadInProgress; },
[this]() { return UpdateLoadProgress(); });
if(local)
{
m_Watcher = new QFileSystemWatcher({captureFile}, GetMainWindow()->Widget());
QObject::connect(m_Watcher, &QFileSystemWatcher::fileChanged, [this]() {
Replay().AsyncInvoke([this](IReplayController *r) {
r->FileChanged();
r->SetFrameEvent(m_EventID, true);
GUIInvoke::call(GetMainWindow()->Widget(), [this]() { RefreshUIStatus({}, true, true); });
});
});
}
#if defined(RELEASE)
ANALYTIC_ADDAVG(Performance.LoadTime, double(loadTimer.nsecsElapsed() * 1.0e-9));
#endif
if(m_APIProps.ShaderLinkage)
ANALYTIC_SET(CaptureFeatures.ShaderLinkage, true);
if(m_APIProps.YUVTextures)
ANALYTIC_SET(CaptureFeatures.YUVTextures, true);
if(m_APIProps.SparseResources)
ANALYTIC_SET(CaptureFeatures.SparseResources, true);
if(m_APIProps.MultiGPU)
ANALYTIC_SET(CaptureFeatures.MultiGPU, true);
if(m_APIProps.D3D12Bundle)
ANALYTIC_SET(CaptureFeatures.D3D12Bundle, true);
if(m_APIProps.DXILShaders)
ANALYTIC_SET(CaptureFeatures.DXILShaders, true);
if(m_APIProps.vendor != GPUVendor::Unknown)
{
ANALYTIC_ADDUNIQ(GPUVendors, ToQStr(m_APIProps.vendor));
}
m_MainWindow->setProgress(-1.0f);
if(m_CaptureLoaded)
{
m_CaptureTemporary = temporary;
BufferFormatter::Init(m_APIProps.pipelineType);
m_CaptureMods = CaptureModifications::NoModifications;
rdcarray<ICaptureViewer *> viewers(m_CaptureViewers);
// make sure we're on a consistent event before invoking viewer forms
if(m_LastAction)
SetEventID(viewers, m_LastAction->eventId, m_LastAction->eventId, true);
else if(!m_Actions->empty())
SetEventID(viewers, m_Actions->back().eventId, m_Actions->back().eventId, true);
GUIInvoke::blockcall(m_MainWindow, [&viewers]() {
// notify all the registers viewers that a capture has been loaded
for(ICaptureViewer *viewer : viewers)
{
if(viewer)
viewer->OnCaptureLoaded();
}
});
if(newCapture && m_Notes.contains(lit("comments")) && m_Config.Comments_ShowOnLoad)
{
if(!HasCommentView())
ShowCommentView();
RaiseDockWindow(GetCommentView()->Widget());
}
// refresh the UI without forcing the replay
SetEventID({}, m_SelectedEventID, m_EventID, false);
}
}
float CaptureContext::UpdateLoadProgress()
{
float val = 0.8f * m_LoadProgress + 0.19f * m_PostloadProgress + 0.01f;
m_MainWindow->setProgress(val);
return val;
}
void CaptureContext::LoadCaptureThreaded(const QString &captureFile, const ReplayOptions &opts,
const QString &origFilename, bool temporary, bool local)
{
m_CaptureFile = origFilename;
m_CaptureLocal = local;
Config().Save();
m_LoadProgress = 0.0f;
m_PostloadProgress = 0.0f;
// this function call will block until the capture is either loaded, or there's some failure
m_Replay.OpenCapture(captureFile, opts, [this](float p) { m_LoadProgress = p; });
// if the renderer isn't running, we hit a failure case so display an error message
if(!m_Replay.IsRunning())
{
QString errmsg = ToQStr(m_Replay.GetCreateStatus());
QString messageText = tr("%1\nFailed to open capture for replay: %2.\n\n"
"Check diagnostic log in Help menu for more details.")
.arg(captureFile)
.arg(errmsg);
RDDialog::critical(NULL, tr("Error opening capture"), messageText);
m_LoadInProgress = false;
return;
}
if(!temporary)
{
AddRecentFile(Config().RecentCaptureFiles, origFilename);
Config().Save();
}
m_EventID = 0;
m_FirstAction = m_LastAction = NULL;
// fetch initial data like actions, textures and buffers
m_Replay.BlockInvoke([this](IReplayController *r) {
if(Config().EventBrowser_AddFake)
r->AddFakeMarkers();
m_FrameInfo = r->GetFrameInfo();
m_APIProps = r->GetAPIProperties();
m_CustomEncodings = r->GetCustomShaderEncodings();
m_CustomPrefixes = r->GetCustomShaderSourcePrefixes();
m_TargetEncodings = r->GetTargetShaderEncodings();
m_PostloadProgress = 0.2f;
m_Actions = &r->GetRootActions();
m_FirstAction = &m_Actions->at(0);
while(!m_FirstAction->children.empty())
m_FirstAction = &m_FirstAction->children[0];
m_LastAction = &m_Actions->back();
while(!m_LastAction->children.empty())
m_LastAction = &m_LastAction->children.back();
m_PostloadProgress = 0.4f;
m_WinSystems = r->GetSupportedWindowSystems();
#if defined(RENDERDOC_PLATFORM_WIN32)
m_CurWinSystem = WindowingSystem::Win32;
#elif defined(RENDERDOC_PLATFORM_LINUX)
m_CurWinSystem = WindowingSystem::Unknown;
if(QGuiApplication::platformName() == lit("wayland"))
{
// if we're using Wayland we must use wayland since we can't get any other surface type
for(WindowingSystem sys : m_WinSystems)
{
if(sys == WindowingSystem::Wayland)
{
m_CurWinSystem = WindowingSystem::Wayland;
m_WaylandDisplay = (wl_display *)AccessWaylandPlatformInterface("display", NULL);
break;
}
}
if(m_CurWinSystem == WindowingSystem::Unknown)
{
RDDialog::critical(NULL, tr("No wayland support"),
tr("Replay doesn't support Wayland surfaces - check you compiled this "
"build of RenderDoc with Wayland support enabled."));
}
}
else
{
m_CurWinSystem = WindowingSystem::Xlib;
// prefer XCB, if supported
for(WindowingSystem sys : m_WinSystems)
{
if(sys == WindowingSystem::XCB)
{
m_CurWinSystem = WindowingSystem::XCB;
break;
}
}
if(m_CurWinSystem == WindowingSystem::XCB)
m_XCBConnection = QX11Info::connection();
else
m_X11Display = QX11Info::display();
}
#elif defined(RENDERDOC_PLATFORM_APPLE)
m_CurWinSystem = WindowingSystem::MacOS;
#elif defined(RENDERDOC_PLATFORM_GGP)
m_CurWinSystem = WindowingSystem::GGP;
#endif
m_StructuredFile = &r->GetStructuredFile();
m_ResourceList = r->GetResources();
CacheResources();
m_BufferList = r->GetBuffers();
for(BufferDescription &b : m_BufferList)
m_Buffers[b.resourceId] = &b;
m_PostloadProgress = 0.8f;
m_TextureList = r->GetTextures();
for(TextureDescription &t : m_TextureList)
m_Textures[t.resourceId] = &t;
m_PostloadProgress = 0.9f;
m_CurD3D11PipelineState = r->GetD3D11PipelineState();
m_CurD3D12PipelineState = r->GetD3D12PipelineState();
m_CurGLPipelineState = r->GetGLPipelineState();
m_CurVulkanPipelineState = r->GetVulkanPipelineState();
m_CurPipelineState = &r->GetPipelineState();
m_UnreadMessageCount = 0;
AddMessages(m_FrameInfo.debugMessages);
m_PostloadProgress = 1.0f;
});
QThread::msleep(20);
QDateTime today = QDateTime::currentDateTimeUtc();
QDateTime compare = today.addDays(-21);
if(compare > Config().DegradedCapture_LastUpdate && m_APIProps.degraded)
{
Config().DegradedCapture_LastUpdate = today;
RDDialog::critical(
NULL, tr("Degraded support of capture"),
tr("%1\nThis capture opened with degraded support - "
"this could mean missing hardware support caused a fallback to software rendering.\n\n"
"This warning will not appear every time this happens, "
"check debug errors/warnings window for more details.")
.arg(origFilename));
}
ICaptureAccess *access = Replay().GetCaptureAccess();
if(access)
{
int idx = access->FindSectionByType(SectionType::ResourceRenames);
if(idx >= 0)
{
bytebuf buf = access->GetSectionContents(idx);
LoadRenames(QString::fromUtf8((const char *)buf.data(), buf.count()));
}
idx = access->FindSectionByType(SectionType::Bookmarks);
if(idx >= 0)
{
bytebuf buf = access->GetSectionContents(idx);
LoadBookmarks(QString::fromUtf8((const char *)buf.data(), buf.count()));
}
idx = access->FindSectionByType(SectionType::Notes);
if(idx >= 0)
{
bytebuf buf = access->GetSectionContents(idx);
LoadNotes(QString::fromUtf8((const char *)buf.data(), buf.count()));
}
idx = access->FindSectionByType(SectionType::EditedShaders);
if(idx >= 0)
{
bytebuf buf = access->GetSectionContents(idx);
GUIInvoke::call(m_MainWindow, [this, buf]() {
LoadEdits(QString::fromUtf8((const char *)buf.data(), buf.count()));
});
}
QString driver = access->DriverName();
if(driver == lit("Image"))
{
ANALYTIC_SET(UIFeatures.ImageViewer, true);
}
else if(!driver.isEmpty())
{
ANALYTIC_ADDUNIQ(APIs, driver);
}
}
m_LoadInProgress = false;
m_CaptureLoaded = true;
}
void CaptureContext::CacheResources()
{
m_CustomNameCachedID++;
m_Resources.clear();
std::sort(m_ResourceList.begin(), m_ResourceList.end(),
[this](const ResourceDescription &a, const ResourceDescription &b) {
return GetResourceNameUnsuffixed(&a) < GetResourceNameUnsuffixed(&b);
});
for(ResourceDescription &res : m_ResourceList)
m_Resources[res.resourceId] = &res;
}
void CaptureContext::RecompressCapture()
{
QString destFilename = GetCaptureFilename();
QString tempFilename;
qint64 oldSize = QFile(destFilename).size();
ICaptureFile *cap = NULL;
ICaptureFile *tempCap = NULL;
bool inplace = false;
if(IsCaptureTemporary() || !IsCaptureLocal())
{
QMessageBox::StandardButton res =
RDDialog::question(m_MainWindow, tr("Unsaved capture"),
tr("To recompress a capture you must save it first. Save this capture?"),
QMessageBox::Yes | QMessageBox::No | QMessageBox::Cancel);
if(res == QMessageBox::Cancel || res == QMessageBox::No)
return;
destFilename = m_MainWindow->GetSavePath();
// if it's already local, we'll do the save as part of the recompression convert. If it's
// remote, we need to copy it first, but we copy it to a temporary so we can do the conversion
// to the target location
if(IsCaptureLocal())
{
tempFilename = GetCaptureFilename();
}
else
{
tempFilename = TempCaptureFilename(lit("recompress"));
Replay().CopyCaptureFromRemote(GetCaptureFilename(), tempFilename, m_MainWindow);
if(!QFile::exists(tempFilename))
{
RDDialog::critical(m_MainWindow, tr("Failed to save capture"),
tr("Capture couldn't be saved from remote."));
return;
}
}
}
else
{
// if we're doing this inplace on an already saved capture, then we need to recompress to a
// temporary and close/move it afterwards.
inplace = true;
destFilename = TempCaptureFilename(lit("recompress"));
}
if(IsCaptureLocal())
{
// for local files we already have a handle. We'll reuse it, then re-open
cap = m_Replay.GetCaptureFile();
}
else
{
// for remote files we open a new short-lived handle on the temporary file
tempCap = cap = RENDERDOC_OpenCaptureFile();
cap->OpenFile(tempFilename, "rdc", NULL);
}
if(!cap)
{
RDDialog::critical(m_MainWindow, tr("Unexpected missing handle"),
tr("Couldn't get open handle to file for recompression."));
return;
}
int index = cap->FindSectionByType(SectionType::FrameCapture);
SectionProperties props = cap->GetSectionProperties(index);
if(props.flags & SectionFlags::ZstdCompressed)
{
RDDialog::information(m_MainWindow, tr("Capture already compressed"),
tr("This capture is already compressed as much as is possible."));
if(tempCap)
tempCap->Shutdown();
if(!tempFilename.isEmpty())
{
m_MainWindow->RemoveRecentCapture(tempFilename);
QFile::remove(tempFilename);
}
return;
}
// convert from the currently open cap to the destination
float progress = 0.0f;
LambdaThread *th = new LambdaThread([cap, destFilename, &progress]() {
cap->Convert(destFilename, "rdc", NULL, [&progress](float p) { progress = p; });
});
th->setName(lit("RecompressCapture"));
th->start();
// wait a few ms before popping up a progress bar
th->wait(500);
if(th->isRunning())
{
ShowProgressDialog(m_MainWindow, tr("Recompressing file."), [th]() { return !th->isRunning(); },
[&progress]() { return progress; });
}
th->deleteLater();
if(inplace)
{
// if we're recompressing "in place", we need to close our capture, move the temporary over
// the original, then re-open.
// this releases the hold over the real desired location.
cap->OpenFile("", "", NULL);
// now remove the old capture
QFile::remove(GetCaptureFilename());
// move the recompressed one over
QFile::rename(destFilename, GetCaptureFilename());
// and re-open
cap->OpenFile(GetCaptureFilename(), "rdc", NULL);
}
else
{
// we've converted into the desired location. We don't have to do anything else but mark our
// new locally saved non-temporary status.
m_CaptureFile = destFilename;
m_CaptureLocal = true;
m_CaptureTemporary = false;
// open the saved capture file. This will let us remove the old file too
m_Replay.ReopenCaptureFile(m_CaptureFile);
m_CaptureMods = CaptureModifications::All;
SaveChanges();
}
// close any temporary resources
if(tempCap)
tempCap->Shutdown();
if(!tempFilename.isEmpty())
{
m_MainWindow->RemoveRecentCapture(tempFilename);
QFile::remove(tempFilename);
}
qint64 newSize = QFile(m_CaptureFile).size();
RDDialog::information(
m_MainWindow, tr("Capture recompressed"),
tr("Compression successful, capture is %1% of the original size: %2 MB -> %3 MB")
.arg(double(newSize * 100) / double(oldSize), 0, 'f', 2)
.arg(double(oldSize) / (1024.0 * 1024.0), 0, 'f', 1)
.arg(double(newSize) / (1024.0 * 1024.0), 0, 'f', 1));
}
bool CaptureContext::SaveCaptureTo(const rdcstr &captureFile)
{
bool success = false;
QString error;
if(IsCaptureLocal())
{
if(QFileInfo(GetCaptureFilename()).exists())
{
if(GetCaptureFilename() == captureFile)
{
success = true;
}
else
{
ICaptureFile *capFile = m_Replay.GetCaptureFile();
if(capFile)
{
// this will overwrite
success = capFile->CopyFileTo(captureFile);
}
else
{
// QFile::copy won't overwrite, so remove the destination first (the save dialog already
// prompted for overwrite)
QFile::remove(captureFile);
success = QFile::copy(GetCaptureFilename(), captureFile);
}
error = tr("Couldn't save to %1").arg(captureFile);
}
}
else
{
RDDialog::critical(
NULL, tr("File not found"),
error =
tr("Capture '%1' couldn't be found on disk, cannot save.").arg(GetCaptureFilename()));
success = false;
}
}
else
{
Replay().CopyCaptureFromRemote(GetCaptureFilename(), captureFile, m_MainWindow);
success = QFile::exists(captureFile);
error = tr("File couldn't be transferred from remote host");
}
if(!success)
{
RDDialog::critical(NULL, tr("Error Saving"), error);
return false;
}
// if it was a temporary capture, remove the old instnace
if(m_CaptureTemporary)
{
m_MainWindow->RemoveRecentCapture(m_CaptureFile);
QFile::remove(m_CaptureFile);
}
// Update the filename, and mark that it's local and not temporary now.
m_CaptureFile = captureFile;
m_CaptureLocal = true;
m_CaptureTemporary = false;
m_Replay.ReopenCaptureFile(captureFile);
SaveChanges();
return true;
}
void CaptureContext::CloseCapture()
{
if(!m_CaptureLoaded)
return;
delete m_Watcher;
m_Watcher = NULL;
delete m_RGP;
m_RGP = NULL;
m_Config.CrashReport_LastOpenedCapture = QString();
m_CaptureTemporary = false;
m_CaptureFile = QString();
m_APIProps = APIProperties();
m_FrameInfo = FrameDescription();
m_Buffers.clear();
m_BufferList.clear();
m_Textures.clear();
m_TextureList.clear();
m_Resources.clear();
m_ResourceList.clear();
m_OrigToReplacedResources.clear();
m_ReplacedToOrigResources.clear();
m_CustomNames.clear();
m_Bookmarks.clear();
m_Notes.clear();
m_Actions = &m_EmptyActions;
m_FirstAction = m_LastAction = NULL;
m_CurD3D11PipelineState = NULL;
m_CurD3D12PipelineState = NULL;
m_CurGLPipelineState = NULL;
m_CurVulkanPipelineState = NULL;
m_CurPipelineState = &m_DummyPipelineState;
m_StructuredFile = &m_DummySDFile;
m_DebugMessages.clear();
m_UnreadMessageCount = 0;
m_CaptureLoaded = false;
rdcarray<ICaptureViewer *> capviewers(m_CaptureViewers);
for(ICaptureViewer *viewer : capviewers)
{
if(viewer && m_CaptureViewers.contains(viewer))
viewer->OnCaptureClosed();
}
m_Replay.CloseThread();
}
bool CaptureContext::ImportCapture(const CaptureFileFormat &fmt, const rdcstr &importfile,
const rdcstr &rdcfile)
{
CloseCapture();
QString ext = fmt.extension;
ReplayStatus status = ReplayStatus::UnknownError;
QString message;
// shorten the filename after here for error messages
QString filename = QFileInfo(importfile).fileName();
float progress = 0.0f;
LambdaThread *th = new LambdaThread([rdcfile, importfile, ext, &message, &progress, &status]() {
ICaptureFile *file = RENDERDOC_OpenCaptureFile();
status = file->OpenFile(importfile, ext.toUtf8().data(),
[&progress](float p) { progress = p * 0.5f; });
if(status != ReplayStatus::Succeeded)
{
message = file->ErrorString();
file->Shutdown();
return;
}
status =
file->Convert(rdcfile, "rdc", NULL, [&progress](float p) { progress = 0.5f + p * 0.5f; });
file->Shutdown();
});
th->setName(lit("ImportCapture"));
th->start();
// wait a few ms before popping up a progress bar
th->wait(500);
if(th->isRunning())
{
ShowProgressDialog(m_MainWindow, tr("Importing from %1, please wait...").arg(filename),
[th]() { return !th->isRunning(); }, [&progress]() { return progress; });
}
th->deleteLater();
if(status != ReplayStatus::Succeeded)
{
QString text = tr("Couldn't convert file '%1'\n").arg(filename);
if(message.isEmpty())
text += tr("%1").arg(ToQStr(status));
else
text += tr("%1: %2").arg(ToQStr(status)).arg(message);
RDDialog::critical(m_MainWindow, tr("Error converting capture"), text);
return false;
}
return true;
}
void CaptureContext::ExportCapture(const CaptureFileFormat &fmt, const rdcstr &exportfile)
{
if(!m_CaptureLocal)
return;
QString ext = fmt.extension;
ICaptureFile *local = NULL;
ICaptureFile *file = NULL;
ReplayStatus status = ReplayStatus::Succeeded;
const SDFile *sdfile = NULL;
// if we don't need buffers, we can export directly from our existing capture file
if(!fmt.requiresBuffers)
{
file = m_Replay.GetCaptureFile();
sdfile = m_StructuredFile;
}
if(!file)
{
local = file = RENDERDOC_OpenCaptureFile();
status = file->OpenFile(m_CaptureFile, "rdc", NULL);
}
QString filename = QFileInfo(m_CaptureFile).fileName();
if(status != ReplayStatus::Succeeded)
{
QString text = tr("Couldn't open file '%1' for export\n").arg(filename);
QString message = file->ErrorString();
if(message.isEmpty())
text += tr("%1").arg(ToQStr(status));
else
text += tr("%1: %2").arg(ToQStr(status)).arg(message);
RDDialog::critical(m_MainWindow, tr("Error opening file"), text);
if(local)
local->Shutdown();
return;
}
float progress = 0.0f;
LambdaThread *th = new LambdaThread([file, sdfile, ext, exportfile, &progress, &status]() {
status = file->Convert(exportfile, ext, sdfile, [&progress](float p) { progress = p; });
});
th->setName(lit("ExportCapture"));
th->start();
// wait a few ms before popping up a progress bar
th->wait(500);
if(th->isRunning())
{
ShowProgressDialog(m_MainWindow,
tr("Exporting %1 to %2, please wait...").arg(filename).arg(QString(fmt.name)),
[th]() { return !th->isRunning(); }, [&progress]() { return progress; });
}
th->deleteLater();
QString message = file->ErrorString();
if(local)
local->Shutdown();
if(status != ReplayStatus::Succeeded)
{
QString text = tr("Couldn't convert file '%1'\n").arg(filename);
if(message.isEmpty())
text += tr("%1").arg(ToQStr(status));
else
text += tr("%1: %2").arg(ToQStr(status)).arg(message);
RDDialog::critical(m_MainWindow, tr("Error converting capture"), text);
}
}
void CaptureContext::SetEventID(const rdcarray<ICaptureViewer *> &exclude, uint32_t selectedEventID,
uint32_t eventId, bool force)
{
RENDERDOC_PROFILEFUNCTION();
if(!IsCaptureLoaded())
return;
if(eventId > m_LastAction->eventId)
{
qCritical() << "Invalid EID being selected " << eventId;
return;
}
uint32_t prevSelectedEventID = m_SelectedEventID;
m_SelectedEventID = selectedEventID;
uint32_t prevEventID = m_EventID;
m_EventID = eventId;
bool done = false;
QString tag = lit("replaySetEvent");
// we can't return until the event is selected, but a blocking invoke on the UI thread can cause
// the UI to stall. We ideally want to have at least an interactive UI and a progress bar.
m_Replay.AsyncInvoke(tag, [this, eventId, force, &done](IReplayController *r) {
r->SetFrameEvent(eventId, force);
m_CurD3D11PipelineState = r->GetD3D11PipelineState();
m_CurD3D12PipelineState = r->GetD3D12PipelineState();
m_CurGLPipelineState = r->GetGLPipelineState();
m_CurVulkanPipelineState = r->GetVulkanPipelineState();
m_CurPipelineState = &r->GetPipelineState();
done = true;
});
// wait a short while before displaying the progress dialog (which won't show if we're already
// done by the time we reach it).
// Keep waiting if the current tag is a set event, we don't want to be popping up progress bars
// when the user is browsing the frame if it's going slow. If that's the case we'll just block the
// UI thread. Instead only pop up the progress bar if some other large task is blocking.
for(int i = 0; !done && (i < 100 || m_Replay.GetCurrentProcessingTag().isEmpty() ||
m_Replay.GetCurrentProcessingTag() == tag);
i++)
QThread::msleep(5);
ShowProgressDialog(m_MainWindow->Widget(), tr("Please wait, working..."),
[&done]() { return done; });
bool updateSelectedEvent = force || prevSelectedEventID != selectedEventID;
bool updateEvent = force || prevEventID != eventId;
RefreshUIStatus(exclude, updateSelectedEvent, updateEvent);
}
void CaptureContext::ConnectToRemoteServer(RemoteHost host)
{
rdcarray<RemoteHost> hosts = Config().GetRemoteHosts();
int hostIdx = -1;
for(int32_t i = 0; i < hosts.count(); i++)
{
if(hosts[i].Hostname() == host.Hostname())
{
hostIdx = i;
break;
}
}
if(hostIdx >= 0)
m_MainWindow->setRemoteHost(hostIdx);
}
void CaptureContext::SetRemoteHost(int hostIdx)
{
m_MainWindow->setRemoteHost(hostIdx);
}
bool CaptureContext::IsResourceReplaced(ResourceId id)
{
return m_OrigToReplacedResources.contains(id);
}
ResourceId CaptureContext::GetResourceReplacement(ResourceId id)
{
auto it = m_OrigToReplacedResources.find(id);
if(it != m_OrigToReplacedResources.end())
return it.value();
return ResourceId();
}
void CaptureContext::RegisterReplacement(ResourceId from, ResourceId to)
{
m_OrigToReplacedResources[from] = to;
m_ReplacedToOrigResources[to] = from;
CacheResources();
RefreshUIStatus({}, true, true);
}
void CaptureContext::UnregisterReplacement(ResourceId id)
{
auto it = m_OrigToReplacedResources.find(id);
if(it != m_OrigToReplacedResources.end())
{
m_ReplacedToOrigResources.remove(it.value());
m_OrigToReplacedResources.remove(it.key());
}
CacheResources();
RefreshUIStatus({}, true, true);
}
void CaptureContext::RefreshUIStatus(const rdcarray<ICaptureViewer *> &exclude,
bool updateSelectedEvent, bool updateEvent)
{
// cache and assign pointer type IDs for any known pointer types in current shaders
for(ShaderStage stage : {ShaderStage::Vertex, ShaderStage::Hull, ShaderStage::Domain,
ShaderStage::Geometry, ShaderStage::Pixel, ShaderStage::Compute})
{
const ShaderReflection *refl = m_CurPipelineState->GetShaderReflection(stage);
if(refl)
PointerTypeRegistry::CacheShader(refl);
}
rdcarray<ICaptureViewer *> capviewers(m_CaptureViewers);
for(ICaptureViewer *viewer : capviewers)
{
if(!viewer || exclude.contains(viewer) || !m_CaptureViewers.contains(viewer))
continue;
if(updateSelectedEvent)
viewer->OnSelectedEventChanged(m_SelectedEventID);
if(updateEvent)
viewer->OnEventChanged(m_EventID);
}
}
void CaptureContext::AddMessages(const rdcarray<DebugMessage> &msgs)
{
m_UnreadMessageCount += msgs.count();
for(const DebugMessage &msg : msgs)
m_DebugMessages.push_back(msg);
if(m_DebugMessageView)
{
GUIInvoke::call(m_DebugMessageView, [this]() { m_DebugMessageView->RefreshMessageList(); });
}
}
void CaptureContext::SetNotes(const rdcstr &key, const rdcstr &contents)
{
// ignore no-op changes
if(m_Notes.contains(key) && m_Notes[key] == contents)
return;
m_Notes[key] = contents;
SetModification(CaptureModifications::Notes);
RefreshUIStatus({}, true, true);
}
void CaptureContext::SetBookmark(const EventBookmark &mark)
{
ANALYTIC_SET(UIFeatures.Bookmarks, true);
int index = m_Bookmarks.indexOf(mark);
if(index >= 0)
{
// ignore no-op bookmarks
if(m_Bookmarks[index].text == mark.text)
return;
m_Bookmarks[index] = mark;
}
else
{
m_Bookmarks.push_back(mark);
}
SetModification(CaptureModifications::Bookmarks);
RefreshUIStatus({}, true, true);
}
void CaptureContext::RemoveBookmark(uint32_t EID)
{
m_Bookmarks.removeOne(EventBookmark(EID));
SetModification(CaptureModifications::Bookmarks);
RefreshUIStatus({}, true, true);
}
void CaptureContext::SetModification(CaptureModifications mod)
{
m_CaptureMods |= mod;
m_MainWindow->captureModified();
}
void CaptureContext::SaveChanges()
{
bool success = true;
if(m_CaptureMods & CaptureModifications::Renames)
success &= SaveRenames();
if(m_CaptureMods & CaptureModifications::Bookmarks)
success &= SaveBookmarks();
if(m_CaptureMods & CaptureModifications::Notes)
success &= SaveNotes();
if(m_CaptureMods & CaptureModifications::EditedShaders)
success &= SaveEdits();
if(!success)
{
RDDialog::critical(m_MainWindow, tr("Can't save file"),
tr("Error saving file.\n"
"Check for permissions and that it's not open elsewhere"));
}
m_CaptureMods = CaptureModifications::NoModifications;
}
bool CaptureContext::SaveRenames()
{
QVariantMap resources;
for(ResourceId id : m_CustomNames.keys())
{
resources[ToQStr(id)] = m_CustomNames[id];
}
QVariantMap root;
root[lit("CustomResourceNames")] = resources;
QString json = VariantToJSON(root);
SectionProperties props;
props.type = SectionType::ResourceRenames;
props.version = 1;
return Replay().GetCaptureAccess()->WriteSection(props, json.toUtf8());
}
void CaptureContext::LoadRenames(const QString &data)
{
QVariantMap root = JSONToVariant(data);
if(root.contains(lit("CustomResourceNames")))
{
QVariantMap resources = root[lit("CustomResourceNames")].toMap();
for(const QString &str : resources.keys())
{
ResourceId id;
if(str.startsWith(lit("ResourceId::")))
{
qulonglong num = str.mid(sizeof("ResourceId::") - 1).toULongLong();
memcpy(&id, &num, sizeof(num));
}
else
{
qCritical() << "Unrecognised resourceid encoding" << str;
}
if(id != ResourceId())
m_CustomNames[id] = resources[str].toString();
}
}
}
bool CaptureContext::SaveBookmarks()
{
QVariantList bookmarks;
for(const EventBookmark &mark : m_Bookmarks)
{
QVariantMap variantmark;
variantmark[lit("eventId")] = mark.eventId;
variantmark[lit("text")] = mark.text;
bookmarks.push_back(variantmark);
}
QVariantMap root;
root[lit("Bookmarks")] = bookmarks;
QString json = VariantToJSON(root);
SectionProperties props;
props.type = SectionType::Bookmarks;
props.version = 1;
return Replay().GetCaptureAccess()->WriteSection(props, json.toUtf8());
}
void CaptureContext::LoadBookmarks(const QString &data)
{
QVariantMap root = JSONToVariant(data);
if(root.contains(lit("Bookmarks")))
{
QVariantList bookmarks = root[lit("Bookmarks")].toList();
for(QVariant v : bookmarks)
{
QVariantMap variantmark = v.toMap();
EventBookmark mark;
mark.eventId = variantmark[lit("eventId")].toUInt();
mark.text = variantmark[lit("text")].toString();
if(mark.eventId != 0)
m_Bookmarks.push_back(mark);
}
}
}
bool CaptureContext::SaveNotes()
{
// make sure this format matches SetCaptureFileComments in app_api.cpp if it changes
QVariantMap root;
for(const QString &key : m_Notes.keys())
root[key] = m_Notes[key];
QString json = VariantToJSON(root);
SectionProperties props;
props.type = SectionType::Notes;
props.version = 1;
ANALYTIC_SET(UIFeatures.CaptureComments, true);
return Replay().GetCaptureAccess()->WriteSection(props, json.toUtf8());
}
void CaptureContext::LoadNotes(const QString &data)
{
QVariantMap root = JSONToVariant(data);
for(QString key : root.keys())
{
if(!key.isEmpty())
m_Notes[key] = root[key].toString();
}
}
bool CaptureContext::SaveEdits()
{
// make sure this format matches SetCaptureFileComments in app_api.cpp if it changes
QVariantList editors;
for(ShaderViewer *e : m_ShaderEditors)
{
QVariantMap editor = e->SaveEditor();
if(!editor.isEmpty())
editors.push_back(e->SaveEditor());
}
QVariantMap root;
root[lit("editors")] = editors;
QString json = VariantToJSON(root);
SectionProperties props;
props.type = SectionType::EditedShaders;
props.version = 1;
return Replay().GetCaptureAccess()->WriteSection(props, json.toUtf8());
}
void CaptureContext::LoadEdits(const QString &data)
{
QVariantMap root = JSONToVariant(data);
QVariantList editors = root[lit("editors")].toList();
auto replaceSaveCallback = [this](ICaptureContext *ctx, IShaderViewer *viewer, ResourceId id,
ShaderStage stage, ShaderEncoding shaderEncoding,
ShaderCompileFlags flags, rdcstr entryFunc, bytebuf shaderBytes) {
ApplyShaderEdit(viewer, id, stage, shaderEncoding, flags, entryFunc, shaderBytes);
};
auto replaceRevertCallback = [this](ICaptureContext *ctx, IShaderViewer *view, ResourceId id) {
RevertShaderEdit(view, id);
};
for(QVariant e : editors)
{
ShaderViewer *edit =
ShaderViewer::LoadEditor(*this, e.toMap(), replaceSaveCallback, replaceRevertCallback,
[this](ShaderViewer *view, bool closed) {
SetModification(CaptureModifications::EditedShaders);
if(closed)
m_ShaderEditors.removeOne(view);
},
m_MainWindow->Widget());
if(edit)
{
AddDockWindow(edit->Widget(), DockReference::MainToolArea, NULL);
m_ShaderEditors.push_back(edit);
}
}
}
bool CaptureContext::OpenRGPProfile(const rdcstr &filename)
{
delete m_RGP;
m_RGP = NULL;
if(!m_CaptureLoaded)
{
RDDialog::critical(m_MainWindow, tr("Error opening RGP"),
tr("Can't open RGP profile with no capture open"));
return false;
}
if(!m_StructuredFile)
{
RDDialog::critical(m_MainWindow, tr("Error opening RGP"),
tr("Open capture has no structured data - can't initialise RGP interop."));
return false;
}
if(filename.isEmpty() || !QFileInfo(filename).exists())
{
RDDialog::critical(m_MainWindow, tr("Error opening RGP"),
tr("Invalid filename specified to open as RGP Profile\n%1\n"
"Please restart RenderDoc and try again.")
.arg(QString(filename)));
return false;
}
QString RGPPath = m_Config.ExternalTool_RadeonGPUProfiler;
while(!QFileInfo(RGPPath).exists())
{
QMessageBox::StandardButton res = RDDialog::question(
m_MainWindow, tr("Error opening RGP"),
tr("Path to RGP is incorrectly configured\n\nOpen settings window to configure path?"),
QMessageBox::Yes | QMessageBox::No | QMessageBox::Cancel);
if(res == QMessageBox::Cancel || res == QMessageBox::No)
return false;
SettingsDialog settings(*this, m_MainWindow);
settings.focusItem(lit("ExternalTool_RadeonGPUProfiler"));
RDDialog::show(&settings);
RGPPath = m_Config.ExternalTool_RadeonGPUProfiler;
}
// Make sure the version of RGP specified supports interop. If not, bail.
// Some older versions of RGP don't have command line support and will crash
if(!RGPInterop::RGPSupportsInterop(RGPPath))
{
QMessageBox::StandardButton res = RDDialog::question(
m_MainWindow, tr("RGP Version"),
tr("This version of RGP does not support interop. Please download RGP v1.2 or newer."),
QMessageBox::Ok);
return false;
}
QString portStr = QString::number(RGPInterop::Port);
if(!QProcess::startDetached(RGPPath, QStringList() << QString(filename) << portStr))
{
RDDialog::critical(m_MainWindow, tr("Error opening RGP"), tr("Failed to launch RGP."));
return false;
}
m_RGP = new RGPInterop(*this);
return true;
}
rdcstr CaptureContext::GetResourceNameUnsuffixed(ResourceId id)
{
if(id == ResourceId())
return tr("No Resource");
if(m_ReplacedToOrigResources.contains(id))
return GetResourceName(m_ReplacedToOrigResources[id]);
ResourceDescription *desc = GetResource(id);
if(desc)
return GetResourceNameUnsuffixed(desc);
uint64_t num;
memcpy(&num, &id, sizeof(num));
return tr("Unknown Resource %1").arg(num);
}
rdcstr CaptureContext::GetResourceNameUnsuffixed(const ResourceDescription *desc)
{
if(m_CustomNames.contains(desc->resourceId))
return m_CustomNames[desc->resourceId];
return desc->name;
}
rdcstr CaptureContext::GetResourceName(ResourceId id)
{
rdcstr ret = GetResourceNameUnsuffixed(id);
if(m_OrigToReplacedResources.contains(id))
ret += tr(" (Edited)");
return ret;
}
bool CaptureContext::IsAutogeneratedName(ResourceId id)
{
if(id == ResourceId())
return true;
if(m_CustomNames.contains(id))
return false;
ResourceDescription *desc = GetResource(id);
if(desc)
return desc->autogeneratedName;
return true;
}
bool CaptureContext::HasResourceCustomName(ResourceId id)
{
return m_CustomNames.contains(id);
}
void CaptureContext::SetResourceCustomName(ResourceId id, const rdcstr &name)
{
if(name.isEmpty())
{
if(m_CustomNames.contains(id))
m_CustomNames.remove(id);
}
else
{
m_CustomNames[id] = name;
}
SetModification(CaptureModifications::Renames);
CacheResources();
RefreshUIStatus({}, true, true);
}
#if defined(RENDERDOC_PLATFORM_APPLE)
extern "C" void *makeNSViewMetalCompatible(void *handle);
#endif
WindowingData CaptureContext::CreateWindowingData(QWidget *window)
{
if(!GUIInvoke::onUIThread())
qCritical() << "CreateWindowingData called on non-UI thread";
#if defined(WIN32)
return CreateWin32WindowingData((HWND)window->winId());
#elif defined(RENDERDOC_PLATFORM_LINUX)
if(m_CurWinSystem == WindowingSystem::Wayland)
{
// we don't need this, we just need to force creation of a window handle
window->winId();
wl_surface *surface =
(wl_surface *)AccessWaylandPlatformInterface("surface", window->windowHandle());
return CreateWaylandWindowingData(m_WaylandDisplay, surface);
}
else if(m_CurWinSystem == WindowingSystem::XCB)
{
return CreateXCBWindowingData(m_XCBConnection, (xcb_window_t)window->winId());
}
else if(m_CurWinSystem == WindowingSystem::Xlib)
{
return CreateXlibWindowingData(m_X11Display, (Drawable)window->winId());
}
else
{
return CreateHeadlessWindowingData(1, 1);
}
#elif defined(RENDERDOC_PLATFORM_APPLE)
void *view = (void *)window->winId();
void *layer = makeNSViewMetalCompatible(view);
return CreateMacOSWindowingData(view, layer);
#elif defined(RENDERDOC_PLATFORM_GGP)
WindowingData ret = {WindowingSystem::GGP};
return ret;
#else
#error "Unknown platform"
#endif
}
IMainWindow *CaptureContext::GetMainWindow()
{
return m_MainWindow;
}
IEventBrowser *CaptureContext::GetEventBrowser()
{
if(m_EventBrowser)
return m_EventBrowser;
m_EventBrowser = new EventBrowser(*this, m_MainWindow);
m_EventBrowser->setObjectName(lit("eventBrowser"));
setupDockWindow(m_EventBrowser);
return m_EventBrowser;
}
IAPIInspector *CaptureContext::GetAPIInspector()
{
if(m_APIInspector)
return m_APIInspector;
m_APIInspector = new APIInspector(*this, m_MainWindow);
m_APIInspector->setObjectName(lit("apiInspector"));
setupDockWindow(m_APIInspector);
return m_APIInspector;
}
ITextureViewer *CaptureContext::GetTextureViewer()
{
if(m_TextureViewer)
return m_TextureViewer;
m_TextureViewer = new TextureViewer(*this, m_MainWindow);
m_TextureViewer->setObjectName(lit("textureViewer"));
setupDockWindow(m_TextureViewer);
return m_TextureViewer;
}
IBufferViewer *CaptureContext::GetMeshPreview()
{
if(m_MeshPreview)
return m_MeshPreview;
m_MeshPreview = new BufferViewer(*this, true, m_MainWindow);
m_MeshPreview->setObjectName(lit("meshPreview"));
setupDockWindow(m_MeshPreview);
return m_MeshPreview;
}
IPipelineStateViewer *CaptureContext::GetPipelineViewer()
{
if(m_PipelineViewer)
return m_PipelineViewer;
m_PipelineViewer = new PipelineStateViewer(*this, m_MainWindow);
m_PipelineViewer->setObjectName(lit("pipelineViewer"));
setupDockWindow(m_PipelineViewer);
return m_PipelineViewer;
}
ICaptureDialog *CaptureContext::GetCaptureDialog()
{
if(m_CaptureDialog)
return m_CaptureDialog;
m_CaptureDialog = new CaptureDialog(
*this,
[this](const QString &exe, const QString &workingDir, const QString &cmdLine,
const rdcarray<EnvironmentModification> &env, CaptureOptions opts,
std::function<void(LiveCapture *)> callback) {
return m_MainWindow->OnCaptureTrigger(exe, workingDir, cmdLine, env, opts, callback);
},
[this](uint32_t PID, const rdcarray<EnvironmentModification> &env, const QString &name,
CaptureOptions opts, std::function<void(LiveCapture *)> callback) {
return m_MainWindow->OnInjectTrigger(PID, env, name, opts, callback);
},
m_MainWindow, m_MainWindow);
m_CaptureDialog->setObjectName(lit("capDialog"));
m_CaptureDialog->setWindowIcon(*m_Icon);
return m_CaptureDialog;
}
IDebugMessageView *CaptureContext::GetDebugMessageView()
{
if(m_DebugMessageView)
return m_DebugMessageView;
m_DebugMessageView = new DebugMessageView(*this, m_MainWindow);
m_DebugMessageView->setObjectName(lit("debugMessageView"));
setupDockWindow(m_DebugMessageView);
return m_DebugMessageView;
}
IDiagnosticLogView *CaptureContext::GetDiagnosticLogView()
{
if(m_DiagnosticLogView)
return m_DiagnosticLogView;
m_DiagnosticLogView = new LogView(*this, m_MainWindow);
m_DiagnosticLogView->setObjectName(lit("diagnosticLogView"));
setupDockWindow(m_DiagnosticLogView);
return m_DiagnosticLogView;
}
ICommentView *CaptureContext::GetCommentView()
{
if(m_CommentView)
return m_CommentView;
m_CommentView = new CommentView(*this, m_MainWindow);
m_CommentView->setObjectName(lit("commentView"));
setupDockWindow(m_CommentView);
return m_CommentView;
}
IPerformanceCounterViewer *CaptureContext::GetPerformanceCounterViewer()
{
if(m_PerformanceCounterViewer)
return m_PerformanceCounterViewer;
m_PerformanceCounterViewer = new PerformanceCounterViewer(*this, m_MainWindow);
m_PerformanceCounterViewer->setObjectName(lit("performanceCounterViewer"));
setupDockWindow(m_PerformanceCounterViewer);
return m_PerformanceCounterViewer;
}
IStatisticsViewer *CaptureContext::GetStatisticsViewer()
{
if(m_StatisticsViewer)
return m_StatisticsViewer;
m_StatisticsViewer = new StatisticsViewer(*this, m_MainWindow);
m_StatisticsViewer->setObjectName(lit("statisticsViewer"));
setupDockWindow(m_StatisticsViewer);
return m_StatisticsViewer;
}
ITimelineBar *CaptureContext::GetTimelineBar()
{
if(m_TimelineBar)
return m_TimelineBar;
m_TimelineBar = new TimelineBar(*this, m_MainWindow);
m_TimelineBar->setObjectName(lit("timelineBar"));
setupDockWindow(m_TimelineBar);
return m_TimelineBar;
}
IPythonShell *CaptureContext::GetPythonShell()
{
if(m_PythonShell)
return m_PythonShell;
m_PythonShell = new PythonShell(*this, m_MainWindow);
m_PythonShell->setObjectName(lit("pythonShell"));
setupDockWindow(m_PythonShell);
return m_PythonShell;
}
IResourceInspector *CaptureContext::GetResourceInspector()
{
if(m_ResourceInspector)
return m_ResourceInspector;
m_ResourceInspector = new ResourceInspector(*this, m_MainWindow);
m_ResourceInspector->setObjectName(lit("resourceInspector"));
setupDockWindow(m_ResourceInspector);
return m_ResourceInspector;
}
void CaptureContext::ShowEventBrowser()
{
m_MainWindow->showEventBrowser();
}
void CaptureContext::ShowAPIInspector()
{
m_MainWindow->showAPIInspector();
}
void CaptureContext::ShowTextureViewer()
{
m_MainWindow->showTextureViewer();
}
void CaptureContext::ShowMeshPreview()
{
m_MainWindow->showMeshPreview();
}
void CaptureContext::ShowPipelineViewer()
{
m_MainWindow->showPipelineViewer();
}
void CaptureContext::ShowCaptureDialog()
{
m_MainWindow->showCaptureDialog();
}
void CaptureContext::ShowDebugMessageView()
{
m_MainWindow->showDebugMessageView();
}
void CaptureContext::ShowDiagnosticLogView()
{
m_MainWindow->showDiagnosticLogView();
}
void CaptureContext::ShowCommentView()
{
m_MainWindow->showCommentView();
}
void CaptureContext::ShowPerformanceCounterViewer()
{
m_MainWindow->showPerformanceCounterViewer();
}
void CaptureContext::ShowStatisticsViewer()
{
m_MainWindow->showStatisticsViewer();
}
void CaptureContext::ShowTimelineBar()
{
m_MainWindow->showTimelineBar();
}
void CaptureContext::ShowPythonShell()
{
m_MainWindow->showPythonShell();
}
void CaptureContext::ShowResourceInspector()
{
m_MainWindow->showResourceInspector();
}
IShaderViewer *CaptureContext::EditShader(ResourceId id, ShaderStage stage,
const rdcstr &entryPoint, const rdcstrpairs &files,
ShaderEncoding shaderEncoding, ShaderCompileFlags flags,
IShaderViewer::SaveCallback saveCallback,
IShaderViewer::RevertCallback revertCallback)
{
ShaderViewer *viewer = NULL;
if(id != ResourceId())
{
auto replaceSaveCallback = [this, saveCallback](
ICaptureContext *ctx, IShaderViewer *viewer, ResourceId id, ShaderStage stage,
ShaderEncoding shaderEncoding, ShaderCompileFlags flags, rdcstr entryFunc,
bytebuf shaderBytes) {
ApplyShaderEdit(viewer, id, stage, shaderEncoding, flags, entryFunc, shaderBytes);
if(saveCallback)
saveCallback(ctx, viewer, id, stage, shaderEncoding, flags, entryFunc, shaderBytes);
};
auto replaceRevertCallback = [this, revertCallback](ICaptureContext *ctx, IShaderViewer *view,
ResourceId id) {
RevertShaderEdit(view, id);
if(revertCallback)
revertCallback(ctx, view, id);
};
viewer = ShaderViewer::EditShader(*this, id, stage, entryPoint, files, shaderEncoding, flags,
replaceSaveCallback, replaceRevertCallback,
[this](ShaderViewer *view, bool closed) {
SetModification(CaptureModifications::EditedShaders);
if(closed)
m_ShaderEditors.removeOne(view);
},
m_MainWindow->Widget());
m_ShaderEditors.push_back(viewer);
SetModification(CaptureModifications::EditedShaders);
}
else
{
viewer = ShaderViewer::EditShader(*this, id, stage, entryPoint, files, shaderEncoding, flags,
saveCallback, revertCallback, NULL, m_MainWindow->Widget());
}
return viewer;
}
void CaptureContext::ApplyShaderEdit(IShaderViewer *viewer, ResourceId id, ShaderStage stage,
ShaderEncoding shaderEncoding, ShaderCompileFlags flags,
const rdcstr &entryFunc, const bytebuf &shaderBytes)
{
if(shaderBytes.isEmpty())
return;
ANALYTIC_SET(UIFeatures.ShaderEditing, true);
QPointer<QObject> ptr(viewer->Widget());
// invoke off to the ReplayController to replace the capture's shader
// with our edited one
Replay().AsyncInvoke([this, entryFunc, shaderBytes, shaderEncoding, flags, stage, id, ptr,
viewer](IReplayController *r) {
rdcstr errs;
ResourceId from = id;
ResourceId to;
rdctie(to, errs) = r->BuildTargetShader(entryFunc, shaderEncoding, shaderBytes, flags, stage);
if(to == ResourceId())
{
r->RemoveReplacement(from);
// this GUIInvoke call always needs to go through even if the viewer has been closed.
GUIInvoke::call(GetMainWindow()->Widget(), [this, from]() { UnregisterReplacement(from); });
}
else
{
r->ReplaceResource(from, to);
GUIInvoke::call(GetMainWindow()->Widget(),
[this, from, to]() { RegisterReplacement(from, to); });
}
if(ptr)
GUIInvoke::call(ptr, [viewer, errs]() { viewer->ShowErrors(errs); });
});
}
void CaptureContext::RevertShaderEdit(IShaderViewer *viewer, ResourceId id)
{
QPointer<QObject> ptr(viewer->Widget());
// remove the replacement on close (we could make this more sophisticated if there
// was a place to control replaced resources/shaders).
Replay().AsyncInvoke([this, viewer, id, ptr](IReplayController *r) {
if(IsCaptureLoaded())
r->RemoveReplacement(id);
GUIInvoke::call(GetMainWindow()->Widget(), [this, viewer, id, ptr] {
UnregisterReplacement(id);
if(ptr)
viewer->ShowErrors(rdcstr());
});
});
}
IShaderViewer *CaptureContext::DebugShader(const ShaderBindpointMapping *bind,
const ShaderReflection *shader, ResourceId pipeline,
ShaderDebugTrace *trace, const rdcstr &debugContext)
{
return ShaderViewer::DebugShader(*this, bind, shader, pipeline, trace, debugContext,
m_MainWindow->Widget());
}
IShaderViewer *CaptureContext::ViewShader(const ShaderReflection *shader, ResourceId pipeline)
{
return ShaderViewer::ViewShader(*this, shader, pipeline, m_MainWindow->Widget());
}
IShaderMessageViewer *CaptureContext::ViewShaderMessages(ShaderStageMask stages)
{
return new ShaderMessageViewer(*this, stages, m_MainWindow);
}
IBufferViewer *CaptureContext::ViewBuffer(uint64_t byteOffset, uint64_t byteSize, ResourceId id,
const rdcstr &format)
{
BufferViewer *viewer = new BufferViewer(*this, false, m_MainWindow);
viewer->ViewBuffer(byteOffset, byteSize, id, format);
return viewer;
}
IBufferViewer *CaptureContext::ViewTextureAsBuffer(ResourceId id, const Subresource &sub,
const rdcstr &format)
{
BufferViewer *viewer = new BufferViewer(*this, false, m_MainWindow);
viewer->ViewTexture(id, sub, format);
return viewer;
}
IConstantBufferPreviewer *CaptureContext::ViewConstantBuffer(ShaderStage stage, uint32_t slot,
uint32_t idx)
{
ConstantBufferPreviewer *existing = ConstantBufferPreviewer::has(stage, slot, idx);
if(existing != NULL)
return existing;
return new ConstantBufferPreviewer(*this, stage, slot, idx, m_MainWindow);
}
IPixelHistoryView *CaptureContext::ViewPixelHistory(ResourceId texID, uint32_t x, uint32_t y,
const TextureDisplay &display)
{
return new PixelHistoryView(*this, texID, QPoint(x, y), display, m_MainWindow);
}
QWidget *CaptureContext::CreateBuiltinWindow(const rdcstr &objectName)
{
if(objectName == "textureViewer")
{
return GetTextureViewer()->Widget();
}
else if(objectName == "eventBrowser")
{
return GetEventBrowser()->Widget();
}
else if(objectName == "pipelineViewer")
{
return GetPipelineViewer()->Widget();
}
else if(objectName == "meshPreview")
{
return GetMeshPreview()->Widget();
}
else if(objectName == "apiInspector")
{
return GetAPIInspector()->Widget();
}
else if(objectName == "capDialog")
{
return GetCaptureDialog()->Widget();
}
else if(objectName == "debugMessageView")
{
return GetDebugMessageView()->Widget();
}
else if(objectName == "diagnosticLogView")
{
return GetDiagnosticLogView()->Widget();
}
else if(objectName == "commentView")
{
return GetCommentView()->Widget();
}
else if(objectName == "statisticsViewer")
{
return GetStatisticsViewer()->Widget();
}
else if(objectName == "timelineBar")
{
return GetTimelineBar()->Widget();
}
else if(objectName == "pythonShell")
{
return GetPythonShell()->Widget();
}
else if(objectName == "resourceInspector")
{
return GetResourceInspector()->Widget();
}
else if(objectName == "performanceCounterViewer")
{
return GetPerformanceCounterViewer()->Widget();
}
return NULL;
}
void CaptureContext::BuiltinWindowClosed(QWidget *window)
{
if(m_EventBrowser && m_EventBrowser->Widget() == window)
m_EventBrowser = NULL;
else if(m_TextureViewer && m_TextureViewer->Widget() == window)
m_TextureViewer = NULL;
else if(m_CaptureDialog && m_CaptureDialog->Widget() == window)
m_CaptureDialog = NULL;
else if(m_APIInspector && m_APIInspector->Widget() == window)
m_APIInspector = NULL;
else if(m_PipelineViewer && m_PipelineViewer->Widget() == window)
m_PipelineViewer = NULL;
else if(m_MeshPreview && m_MeshPreview->Widget() == window)
m_MeshPreview = NULL;
else if(m_DebugMessageView && m_DebugMessageView->Widget() == window)
m_DebugMessageView = NULL;
else if(m_DiagnosticLogView && m_DiagnosticLogView->Widget() == window)
m_DiagnosticLogView = NULL;
else if(m_CommentView && m_CommentView->Widget() == window)
m_CommentView = NULL;
else if(m_StatisticsViewer && m_StatisticsViewer->Widget() == window)
m_StatisticsViewer = NULL;
else if(m_TimelineBar && m_TimelineBar->Widget() == window)
m_TimelineBar = NULL;
else if(m_PythonShell && m_PythonShell->Widget() == window)
m_PythonShell = NULL;
else if(m_ResourceInspector && m_ResourceInspector->Widget() == window)
m_ResourceInspector = NULL;
else if(m_PerformanceCounterViewer && m_PerformanceCounterViewer->Widget() == window)
m_PerformanceCounterViewer = NULL;
else
qCritical() << "Unrecognised window being closed: " << window;
}
void CaptureContext::setupDockWindow(QWidget *shad)
{
shad->setWindowIcon(*m_Icon);
}
void CaptureContext::RaiseDockWindow(QWidget *dockWindow)
{
ToolWindowManager::raiseToolWindow(dockWindow);
}
void CaptureContext::AddDockWindow(QWidget *newWindow, DockReference ref, QWidget *refWindow,
float percentage)
{
if(!newWindow)
{
qCritical() << "Unexpected NULL newWindow in AddDockWindow";
return;
}
setupDockWindow(newWindow);
if(ref == DockReference::MainToolArea)
{
m_MainWindow->mainToolManager()->addToolWindow(newWindow, m_MainWindow->mainToolArea());
return;
}
else if(ref == DockReference::LeftToolArea)
{
m_MainWindow->mainToolManager()->addToolWindow(newWindow, m_MainWindow->leftToolArea());
return;
}
else if(ref == DockReference::NewFloatingArea)
{
m_MainWindow->mainToolManager()->addToolWindow(
newWindow, ToolWindowManager::AreaReference(ToolWindowManager::NewFloatingArea));
return;
}
else if(ref == DockReference::LastUsedArea)
{
m_MainWindow->mainToolManager()->addToolWindow(
newWindow, ToolWindowManager::AreaReference(ToolWindowManager::LastUsedArea));
return;
}
if(!refWindow)
{
qCritical() << "Unexpected NULL refWindow in AddDockWindow";
return;
}
if(ref == DockReference::TransientPopupArea)
{
if(qobject_cast<ConstantBufferPreviewer *>(newWindow))
{
ToolWindowManager *manager = ToolWindowManager::managerOf(refWindow);
ConstantBufferPreviewer *cb = manager->findChild<ConstantBufferPreviewer *>();
if(cb)
{
manager->addToolWindow(newWindow, ToolWindowManager::AreaReference(ToolWindowManager::AddTo,
manager->areaOf(cb)));
return;
}
}
if(qobject_cast<PixelHistoryView *>(newWindow))
{
ToolWindowManager *manager = ToolWindowManager::managerOf(refWindow);
PixelHistoryView *hist = manager->findChild<PixelHistoryView *>();
if(hist)
{
manager->addToolWindow(newWindow, ToolWindowManager::AreaReference(ToolWindowManager::AddTo,
manager->areaOf(hist)));
return;
}
}
ref = DockReference::RightOf;
}
ToolWindowManager *manager = ToolWindowManager::managerOf(refWindow);
ToolWindowManager::AreaReference areaRef((ToolWindowManager::AreaReferenceType)ref,
manager->areaOf(refWindow), percentage);
manager->addToolWindow(newWindow, areaRef);
}