fbb26c2b88
Having a simple Dear ImGui bridge is not just useful for the manual tests, which do not have any other means to displays GUIs, but is in itself an important exercise for the QRhi machinery. Have a new manual test that exercises the built-in ImGui demo window. Then use it in the displacement test for real, to replace the myriads of key presses with on-screen sliders and checkboxes (with less code). Change-Id: I296bafae2a5cce6fc7a447d97e68e5bcec15f451 Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
584 lines
17 KiB
C++
584 lines
17 KiB
C++
// Copyright (C) 2018 The Qt Company Ltd.
|
|
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
|
|
|
|
// Adapted from hellominimalcrossgfxtriangle with the frame rendering stripped out.
|
|
// Include this file and implement Window::customInit, release and render.
|
|
// Debug/validation layer is enabled for D3D and Vulkan.
|
|
|
|
#include <QGuiApplication>
|
|
#include <QCommandLineParser>
|
|
#include <QWindow>
|
|
#include <QPlatformSurfaceEvent>
|
|
#include <QElapsedTimer>
|
|
#include <QTimer>
|
|
#include <QLoggingCategory>
|
|
#include <QColorSpace>
|
|
|
|
#include <QtGui/private/qshader_p.h>
|
|
#include <QFile>
|
|
#include <QtGui/private/qrhinull_p.h>
|
|
|
|
#ifndef QT_NO_OPENGL
|
|
#include <QtGui/private/qrhigles2_p.h>
|
|
#include <QOffscreenSurface>
|
|
#endif
|
|
|
|
#if QT_CONFIG(vulkan)
|
|
#include <QtGui/private/qrhivulkan_p.h>
|
|
#endif
|
|
|
|
#ifdef Q_OS_WIN
|
|
#include <QtGui/private/qrhid3d11_p.h>
|
|
#include <QtGui/private/qrhid3d12_p.h>
|
|
#endif
|
|
|
|
#if defined(Q_OS_MACOS) || defined(Q_OS_IOS)
|
|
#include <QtGui/private/qrhimetal_p.h>
|
|
#endif
|
|
|
|
#ifdef EXAMPLEFW_IMGUI
|
|
#include "qrhiimgui_p.h"
|
|
#include "imgui.h"
|
|
#endif
|
|
|
|
QShader getShader(const QString &name)
|
|
{
|
|
QFile f(name);
|
|
if (f.open(QIODevice::ReadOnly))
|
|
return QShader::fromSerialized(f.readAll());
|
|
|
|
return QShader();
|
|
}
|
|
|
|
QByteArray getResource(const QString &name)
|
|
{
|
|
QFile f(name);
|
|
if (f.open(QIODevice::ReadOnly))
|
|
return f.readAll();
|
|
|
|
return QByteArray();
|
|
}
|
|
|
|
enum GraphicsApi
|
|
{
|
|
Null,
|
|
OpenGL,
|
|
Vulkan,
|
|
D3D11,
|
|
D3D12,
|
|
Metal
|
|
};
|
|
|
|
GraphicsApi graphicsApi;
|
|
|
|
QString graphicsApiName()
|
|
{
|
|
switch (graphicsApi) {
|
|
case Null:
|
|
return QLatin1String("Null (no output)");
|
|
case OpenGL:
|
|
return QLatin1String("OpenGL");
|
|
case Vulkan:
|
|
return QLatin1String("Vulkan");
|
|
case D3D11:
|
|
return QLatin1String("Direct3D 11");
|
|
case D3D12:
|
|
return QLatin1String("Direct3D 12");
|
|
case Metal:
|
|
return QLatin1String("Metal");
|
|
default:
|
|
break;
|
|
}
|
|
return QString();
|
|
}
|
|
|
|
QRhi::Flags rhiFlags = QRhi::EnableDebugMarkers;
|
|
int sampleCount = 1;
|
|
QRhiSwapChain::Flags scFlags;
|
|
QRhi::BeginFrameFlags beginFrameFlags;
|
|
QRhi::EndFrameFlags endFrameFlags;
|
|
bool transparentBackground = false;
|
|
bool debugLayer = true;
|
|
|
|
class Window : public QWindow
|
|
{
|
|
public:
|
|
Window();
|
|
~Window();
|
|
|
|
protected:
|
|
void init();
|
|
void releaseResources();
|
|
void resizeSwapChain();
|
|
void releaseSwapChain();
|
|
void render();
|
|
|
|
void customInit();
|
|
void customRelease();
|
|
void customRender();
|
|
#ifdef EXAMPLEFW_IMGUI
|
|
void customGui();
|
|
#endif
|
|
|
|
void exposeEvent(QExposeEvent *) override;
|
|
bool event(QEvent *) override;
|
|
#ifdef EXAMPLEFW_KEYPRESS_EVENTS
|
|
void keyPressEvent(QKeyEvent *e) override;
|
|
#endif
|
|
|
|
bool m_running = false;
|
|
bool m_notExposed = false;
|
|
bool m_newlyExposed = false;
|
|
|
|
QRhi *m_r = nullptr;
|
|
bool m_hasSwapChain = false;
|
|
QRhiSwapChain *m_sc = nullptr;
|
|
QRhiRenderBuffer *m_ds = nullptr;
|
|
QRhiRenderPassDescriptor *m_rp = nullptr;
|
|
|
|
QMatrix4x4 m_proj;
|
|
|
|
QElapsedTimer m_timer;
|
|
int m_frameCount;
|
|
|
|
#ifndef QT_NO_OPENGL
|
|
QOffscreenSurface *m_fallbackSurface = nullptr;
|
|
#endif
|
|
|
|
QColor m_clearColor;
|
|
|
|
#ifdef EXAMPLEFW_IMGUI
|
|
QRhiImguiRenderer *m_imguiRenderer;
|
|
QRhiImgui m_imgui;
|
|
#endif
|
|
|
|
friend int main(int, char**);
|
|
};
|
|
|
|
Window::Window()
|
|
{
|
|
// Tell the platform plugin what we want.
|
|
switch (graphicsApi) {
|
|
case OpenGL:
|
|
setSurfaceType(OpenGLSurface);
|
|
break;
|
|
case Vulkan:
|
|
setSurfaceType(VulkanSurface);
|
|
break;
|
|
case D3D11:
|
|
case D3D12:
|
|
setSurfaceType(Direct3DSurface);
|
|
break;
|
|
case Metal:
|
|
setSurfaceType(MetalSurface);
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
|
|
m_clearColor = transparentBackground ? Qt::transparent : QColor::fromRgbF(0.4f, 0.7f, 0.0f, 1.0f);
|
|
}
|
|
|
|
Window::~Window()
|
|
{
|
|
releaseResources();
|
|
}
|
|
|
|
void Window::exposeEvent(QExposeEvent *)
|
|
{
|
|
// initialize and start rendering when the window becomes usable for graphics purposes
|
|
if (isExposed() && !m_running) {
|
|
m_running = true;
|
|
init();
|
|
resizeSwapChain();
|
|
}
|
|
|
|
const QSize surfaceSize = m_hasSwapChain ? m_sc->surfacePixelSize() : QSize();
|
|
|
|
// stop pushing frames when not exposed (or size is 0)
|
|
if ((!isExposed() || (m_hasSwapChain && surfaceSize.isEmpty())) && m_running)
|
|
m_notExposed = true;
|
|
|
|
// continue when exposed again and the surface has a valid size.
|
|
// note that the surface size can be (0, 0) even though size() reports a valid one...
|
|
if (isExposed() && m_running && m_notExposed && !surfaceSize.isEmpty()) {
|
|
m_notExposed = false;
|
|
m_newlyExposed = true;
|
|
}
|
|
|
|
// always render a frame on exposeEvent() (when exposed) in order to update
|
|
// immediately on window resize.
|
|
if (isExposed() && !surfaceSize.isEmpty())
|
|
render();
|
|
}
|
|
|
|
bool Window::event(QEvent *e)
|
|
{
|
|
switch (e->type()) {
|
|
case QEvent::UpdateRequest:
|
|
render();
|
|
break;
|
|
|
|
case QEvent::PlatformSurface:
|
|
// this is the proper time to tear down the swapchain (while the native window and surface are still around)
|
|
if (static_cast<QPlatformSurfaceEvent *>(e)->surfaceEventType() == QPlatformSurfaceEvent::SurfaceAboutToBeDestroyed)
|
|
releaseSwapChain();
|
|
break;
|
|
|
|
default:
|
|
#ifdef EXAMPLEFW_IMGUI
|
|
if (m_imgui.processEvent(e))
|
|
return true;
|
|
#endif
|
|
break;
|
|
}
|
|
|
|
return QWindow::event(e);
|
|
}
|
|
|
|
void Window::init()
|
|
{
|
|
if (graphicsApi == Null) {
|
|
QRhiNullInitParams params;
|
|
m_r = QRhi::create(QRhi::Null, ¶ms, rhiFlags);
|
|
}
|
|
|
|
#ifndef QT_NO_OPENGL
|
|
if (graphicsApi == OpenGL) {
|
|
m_fallbackSurface = QRhiGles2InitParams::newFallbackSurface();
|
|
QRhiGles2InitParams params;
|
|
params.fallbackSurface = m_fallbackSurface;
|
|
params.window = this;
|
|
m_r = QRhi::create(QRhi::OpenGLES2, ¶ms, rhiFlags);
|
|
}
|
|
#endif
|
|
|
|
#if QT_CONFIG(vulkan)
|
|
if (graphicsApi == Vulkan) {
|
|
QRhiVulkanInitParams params;
|
|
params.inst = vulkanInstance();
|
|
params.window = this;
|
|
m_r = QRhi::create(QRhi::Vulkan, ¶ms, rhiFlags);
|
|
}
|
|
#endif
|
|
|
|
#ifdef Q_OS_WIN
|
|
if (graphicsApi == D3D11) {
|
|
QRhiD3D11InitParams params;
|
|
if (debugLayer)
|
|
qDebug("Enabling D3D11 debug layer");
|
|
params.enableDebugLayer = debugLayer;
|
|
m_r = QRhi::create(QRhi::D3D11, ¶ms, rhiFlags);
|
|
} else if (graphicsApi == D3D12) {
|
|
QRhiD3D12InitParams params;
|
|
if (debugLayer)
|
|
qDebug("Enabling D3D12 debug layer");
|
|
params.enableDebugLayer = debugLayer;
|
|
m_r = QRhi::create(QRhi::D3D12, ¶ms, rhiFlags);
|
|
}
|
|
#endif
|
|
|
|
#if defined(Q_OS_MACOS) || defined(Q_OS_IOS)
|
|
if (graphicsApi == Metal) {
|
|
QRhiMetalInitParams params;
|
|
m_r = QRhi::create(QRhi::Metal, ¶ms, rhiFlags);
|
|
}
|
|
#endif
|
|
|
|
if (!m_r)
|
|
qFatal("Failed to create RHI backend");
|
|
|
|
// now onto the backend-independent init
|
|
|
|
m_sc = m_r->newSwapChain();
|
|
m_ds = m_r->newRenderBuffer(QRhiRenderBuffer::DepthStencil,
|
|
QSize(), // no need to set the size here, due to UsedWithSwapChainOnly
|
|
sampleCount,
|
|
QRhiRenderBuffer::UsedWithSwapChainOnly);
|
|
m_sc->setWindow(this);
|
|
m_sc->setDepthStencil(m_ds);
|
|
m_sc->setSampleCount(sampleCount);
|
|
m_sc->setFlags(scFlags);
|
|
m_rp = m_sc->newCompatibleRenderPassDescriptor();
|
|
m_sc->setRenderPassDescriptor(m_rp);
|
|
|
|
#ifdef EXAMPLEFW_IMGUI
|
|
ImGuiIO &io(ImGui::GetIO());
|
|
io.FontAllowUserScaling = true; // enable ctrl+wheel on windows
|
|
io.IniFilename = nullptr; // no imgui.ini
|
|
|
|
QByteArray font = getResource(QLatin1String(":/fonts/RobotoMono-Medium.ttf"));
|
|
ImFontConfig fontCfg;
|
|
fontCfg.FontDataOwnedByAtlas = false;
|
|
io.Fonts->Clear();
|
|
io.Fonts->AddFontFromMemoryTTF(font.data(), font.size(), 20.0f, &fontCfg);
|
|
m_imgui.rebuildFontAtlas();
|
|
|
|
m_imguiRenderer = new QRhiImguiRenderer;
|
|
#endif
|
|
|
|
customInit();
|
|
}
|
|
|
|
void Window::releaseResources()
|
|
{
|
|
customRelease();
|
|
|
|
delete m_rp;
|
|
m_rp = nullptr;
|
|
|
|
delete m_ds;
|
|
m_ds = nullptr;
|
|
|
|
delete m_sc;
|
|
m_sc = nullptr;
|
|
|
|
#ifdef EXAMPLEFW_IMGUI
|
|
delete m_imguiRenderer;
|
|
m_imguiRenderer = nullptr;
|
|
#endif
|
|
|
|
delete m_r;
|
|
m_r = nullptr;
|
|
|
|
#ifndef QT_NO_OPENGL
|
|
delete m_fallbackSurface;
|
|
m_fallbackSurface = nullptr;
|
|
#endif
|
|
}
|
|
|
|
void Window::resizeSwapChain()
|
|
{
|
|
m_hasSwapChain = m_sc->createOrResize(); // also handles m_ds
|
|
|
|
m_frameCount = 0;
|
|
m_timer.restart();
|
|
|
|
const QSize outputSize = m_sc->currentPixelSize();
|
|
m_proj = m_r->clipSpaceCorrMatrix();
|
|
m_proj.perspective(45.0f, outputSize.width() / (float) outputSize.height(), 0.01f, 1000.0f);
|
|
m_proj.translate(0, 0, -4);
|
|
}
|
|
|
|
void Window::releaseSwapChain()
|
|
{
|
|
if (m_hasSwapChain) {
|
|
m_hasSwapChain = false;
|
|
m_sc->destroy();
|
|
}
|
|
}
|
|
|
|
void Window::render()
|
|
{
|
|
if (!m_hasSwapChain || m_notExposed)
|
|
return;
|
|
|
|
// If the window got resized or got newly exposed, resize the swapchain.
|
|
// (the newly-exposed case is not actually required by some
|
|
// platforms/backends, but f.ex. Vulkan on Windows seems to need it)
|
|
if (m_sc->currentPixelSize() != m_sc->surfacePixelSize() || m_newlyExposed) {
|
|
resizeSwapChain();
|
|
if (!m_hasSwapChain)
|
|
return;
|
|
m_newlyExposed = false;
|
|
}
|
|
|
|
// Start a new frame. This is where we block when too far ahead of
|
|
// GPU/present, and that's what throttles the thread to the refresh rate.
|
|
// (except for OpenGL where it happens either in endFrame or somewhere else
|
|
// depending on the GL implementation)
|
|
QRhi::FrameOpResult r = m_r->beginFrame(m_sc, beginFrameFlags);
|
|
if (r == QRhi::FrameOpSwapChainOutOfDate) {
|
|
resizeSwapChain();
|
|
if (!m_hasSwapChain)
|
|
return;
|
|
r = m_r->beginFrame(m_sc);
|
|
}
|
|
if (r != QRhi::FrameOpSuccess) {
|
|
requestUpdate();
|
|
return;
|
|
}
|
|
|
|
m_frameCount += 1;
|
|
if (m_timer.elapsed() > 1000) {
|
|
qDebug("ca. %d fps", m_frameCount);
|
|
m_timer.restart();
|
|
m_frameCount = 0;
|
|
}
|
|
|
|
#ifdef EXAMPLEFW_IMGUI
|
|
m_imgui.nextFrame(size(), devicePixelRatio(), QPointF(0, 0), std::bind(&Window::customGui, this));
|
|
m_imgui.syncRenderer(m_imguiRenderer);
|
|
|
|
QRhiCommandBuffer *cb = m_sc->currentFrameCommandBuffer();
|
|
QRhiRenderTarget *rt = m_sc->currentFrameRenderTarget();
|
|
const QSize outputSizeInPixels = m_sc->currentPixelSize();
|
|
const float dpr = devicePixelRatio();
|
|
|
|
QMatrix4x4 guiMvp = m_r->clipSpaceCorrMatrix();
|
|
guiMvp.ortho(0, outputSizeInPixels.width() / dpr, outputSizeInPixels.height() / dpr, 0, 1, -1);
|
|
m_imguiRenderer->prepare(m_r, rt, cb, guiMvp, 1.0f);
|
|
#endif
|
|
|
|
customRender();
|
|
|
|
m_r->endFrame(m_sc, endFrameFlags);
|
|
|
|
if (!scFlags.testFlag(QRhiSwapChain::NoVSync))
|
|
requestUpdate();
|
|
else // try prevent all delays when NoVSync
|
|
QCoreApplication::postEvent(this, new QEvent(QEvent::UpdateRequest));
|
|
}
|
|
|
|
int main(int argc, char **argv)
|
|
{
|
|
QGuiApplication app(argc, argv);
|
|
|
|
QLoggingCategory::setFilterRules(QLatin1String("qt.rhi.*=true"));
|
|
|
|
// Defaults.
|
|
#if defined(Q_OS_WIN)
|
|
graphicsApi = D3D11;
|
|
#elif defined(Q_OS_MACOS) || defined(Q_OS_IOS)
|
|
graphicsApi = Metal;
|
|
#elif QT_CONFIG(vulkan)
|
|
graphicsApi = Vulkan;
|
|
#else
|
|
graphicsApi = OpenGL;
|
|
#endif
|
|
|
|
// Allow overriding via the command line.
|
|
QCommandLineParser cmdLineParser;
|
|
cmdLineParser.addHelpOption();
|
|
QCommandLineOption nullOption({ "n", "null" }, QLatin1String("Null"));
|
|
cmdLineParser.addOption(nullOption);
|
|
QCommandLineOption glOption({ "g", "opengl" }, QLatin1String("OpenGL"));
|
|
cmdLineParser.addOption(glOption);
|
|
QCommandLineOption vkOption({ "v", "vulkan" }, QLatin1String("Vulkan"));
|
|
cmdLineParser.addOption(vkOption);
|
|
QCommandLineOption d3d11Option({ "d", "d3d11" }, QLatin1String("Direct3D 11"));
|
|
cmdLineParser.addOption(d3d11Option);
|
|
QCommandLineOption d3d12Option({ "D", "d3d12" }, QLatin1String("Direct3D 12"));
|
|
cmdLineParser.addOption(d3d12Option);
|
|
QCommandLineOption mtlOption({ "m", "metal" }, QLatin1String("Metal"));
|
|
cmdLineParser.addOption(mtlOption);
|
|
// Testing cleanup both with QWindow::close() (hitting X or Alt-F4) and
|
|
// QCoreApplication::quit() (e.g. what a menu widget would do) is important.
|
|
// Use this parameter for the latter.
|
|
QCommandLineOption sdOption({ "s", "self-destruct" }, QLatin1String("Self-destruct after 5 seconds."));
|
|
cmdLineParser.addOption(sdOption);
|
|
QCommandLineOption coreProfOption({ "c", "core" }, QLatin1String("Request a core profile context for OpenGL"));
|
|
cmdLineParser.addOption(coreProfOption);
|
|
// Allow testing preferring the software adapter (D3D, Vulkan).
|
|
QCommandLineOption swOption(QLatin1String("software"), QLatin1String("Prefer a software renderer when choosing the adapter. "
|
|
"Only applicable with some APIs and platforms."));
|
|
cmdLineParser.addOption(swOption);
|
|
// Allow testing having a semi-transparent window.
|
|
QCommandLineOption transparentOption(QLatin1String("transparent"), QLatin1String("Make background transparent"));
|
|
cmdLineParser.addOption(transparentOption);
|
|
|
|
cmdLineParser.process(app);
|
|
if (cmdLineParser.isSet(nullOption))
|
|
graphicsApi = Null;
|
|
if (cmdLineParser.isSet(glOption))
|
|
graphicsApi = OpenGL;
|
|
if (cmdLineParser.isSet(vkOption))
|
|
graphicsApi = Vulkan;
|
|
if (cmdLineParser.isSet(d3d11Option))
|
|
graphicsApi = D3D11;
|
|
if (cmdLineParser.isSet(d3d12Option))
|
|
graphicsApi = D3D12;
|
|
if (cmdLineParser.isSet(mtlOption))
|
|
graphicsApi = Metal;
|
|
|
|
qDebug("Selected graphics API is %s", qPrintable(graphicsApiName()));
|
|
qDebug("This is a multi-api example, use command line arguments to override:\n%s", qPrintable(cmdLineParser.helpText()));
|
|
|
|
if (cmdLineParser.isSet(transparentOption)) {
|
|
transparentBackground = true;
|
|
scFlags |= QRhiSwapChain::SurfaceHasPreMulAlpha;
|
|
}
|
|
|
|
#ifdef EXAMPLEFW_PREINIT
|
|
void preInit();
|
|
preInit();
|
|
#endif
|
|
|
|
// OpenGL specifics.
|
|
QSurfaceFormat fmt;
|
|
fmt.setDepthBufferSize(24);
|
|
fmt.setStencilBufferSize(8);
|
|
if (cmdLineParser.isSet(coreProfOption)) {
|
|
#ifdef Q_OS_DARWIN
|
|
fmt.setVersion(4, 1);
|
|
#else
|
|
fmt.setVersion(4, 3);
|
|
#endif
|
|
fmt.setProfile(QSurfaceFormat::CoreProfile);
|
|
}
|
|
if (sampleCount > 1)
|
|
fmt.setSamples(sampleCount);
|
|
if (scFlags.testFlag(QRhiSwapChain::NoVSync))
|
|
fmt.setSwapInterval(0);
|
|
if (scFlags.testFlag(QRhiSwapChain::sRGB))
|
|
fmt.setColorSpace(QColorSpace::SRgb);
|
|
// Exception: The alpha size is not necessarily OpenGL specific.
|
|
if (transparentBackground)
|
|
fmt.setAlphaBufferSize(8);
|
|
QSurfaceFormat::setDefaultFormat(fmt);
|
|
|
|
// Vulkan setup.
|
|
#if QT_CONFIG(vulkan)
|
|
QVulkanInstance inst;
|
|
if (graphicsApi == Vulkan) {
|
|
if (debugLayer) {
|
|
qDebug("Enabling Vulkan validation layer (if available)");
|
|
inst.setLayers({ "VK_LAYER_KHRONOS_validation" });
|
|
}
|
|
const QVersionNumber supportedVersion = inst.supportedApiVersion();
|
|
if (supportedVersion >= QVersionNumber(1, 3))
|
|
inst.setApiVersion(QVersionNumber(1, 3));
|
|
else if (supportedVersion >= QVersionNumber(1, 2))
|
|
inst.setApiVersion(QVersionNumber(1, 2));
|
|
else if (supportedVersion >= QVersionNumber(1, 1))
|
|
inst.setApiVersion(QVersionNumber(1, 1));
|
|
qDebug() << "Requesting Vulkan API" << inst.apiVersion().toString();
|
|
qDebug() << "Instance-level version was reported as" << supportedVersion.toString();
|
|
inst.setExtensions(QRhiVulkanInitParams::preferredInstanceExtensions());
|
|
if (!inst.create()) {
|
|
qWarning("Failed to create Vulkan instance, switching to OpenGL");
|
|
graphicsApi = OpenGL;
|
|
}
|
|
}
|
|
#endif
|
|
|
|
if (cmdLineParser.isSet(swOption))
|
|
rhiFlags |= QRhi::PreferSoftwareRenderer;
|
|
|
|
// Create and show the window.
|
|
Window w;
|
|
#if QT_CONFIG(vulkan)
|
|
if (graphicsApi == Vulkan)
|
|
w.setVulkanInstance(&inst);
|
|
#endif
|
|
w.resize(1280, 720);
|
|
w.setTitle(QCoreApplication::applicationName() + QLatin1String(" - ") + graphicsApiName());
|
|
w.show();
|
|
|
|
if (cmdLineParser.isSet(sdOption))
|
|
QTimer::singleShot(5000, qGuiApp, SLOT(quit()));
|
|
|
|
int ret = app.exec();
|
|
|
|
// Window::event() will not get invoked when the
|
|
// PlatformSurfaceAboutToBeDestroyed event is sent during the QWindow
|
|
// destruction. That happens only when exiting via app::quit() instead of
|
|
// the more common QWindow::close(). Take care of it: if the
|
|
// QPlatformWindow is still around (there was no close() yet), get rid of
|
|
// the swapchain while it's not too late.
|
|
if (w.handle())
|
|
w.releaseSwapChain();
|
|
|
|
return ret;
|
|
}
|