qt5base-lts/tests/manual/rhi/shared/imgui/qrhiimgui_p.h
Laszlo Agocs 1dd8b5ceec rhi: Make it a QPA-style private but semi-public API
qrhi.h, qshader.h, qshaderdescription.h (and qshaderbaker.h from
shadertools; done separately) become "RHI APIs", following the concept
of QPA APIs.

Mirror completely what is done for QPA headers, but using the "rhi"
prefix for the headers. This involves updating syncqt to handle the
new category of headers. (a note on the regex: matching everything
starting with "qrhi" is not acceptable due to incorrectly matching
existing and future headers, hence specifying the four header names
explicitly)

There is going to be one difference to QPA: the documentation for
everything RHI is going to be public and part of the regular docs, not
hidden with \internal.

In addition to the header renaming and adding the comments and
documentation notes and warnings, there is one significant change
here: there is no longer a need to do API-specific includes, such as
qrhid3d11[_p].h, qrhivulkan[_p].h, etc. These are simply merged into a
single header that is then included from qrhi.h. This means that users
within Qt, and any future applications can just do #include
<rhi/qrhi.h> (or rhi/qshader.h if the QRhi stuff is not relevant), no
other headers are needed.

There are no changes to functionality in this patch. Only the
documentation is expanded, quite a lot, to eliminate all qdoc warnings
and make the generated API docs complete. An example, with a quite
extensive doc page is added as well.

Task-number: QTBUG-113331
Change-Id: I91c749826348f14320cb335b1c83e9d1ea2b1d8b
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
2023-05-21 15:42:58 +02:00

94 lines
2.1 KiB
C++

// Copyright (C) 2022 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
#ifndef QRHIIMGUI_P_H
#define QRHIIMGUI_P_H
#include <rhi/qrhi.h>
QT_BEGIN_NAMESPACE
class QEvent;
class QRhiImguiRenderer
{
public:
~QRhiImguiRenderer();
struct CmdListBuffer {
quint32 offset;
QByteArray data;
};
struct DrawCmd {
int cmdListBufferIdx;
int textureIndex;
quint32 indexOffset;
quint32 elemCount;
QPointF itemPixelOffset;
QVector4D clipRect;
};
struct StaticRenderData {
QImage fontTextureData;
};
struct FrameRenderData {
quint32 totalVbufSize = 0;
quint32 totalIbufSize = 0;
QVarLengthArray<CmdListBuffer, 4> vbuf;
QVarLengthArray<CmdListBuffer, 4> ibuf;
QVarLengthArray<DrawCmd, 4> draw;
QSize outputPixelSize;
};
StaticRenderData sf;
FrameRenderData f;
void prepare(QRhi *rhi, QRhiRenderTarget *rt, QRhiCommandBuffer *cb, const QMatrix4x4 &mvp, float opacity);
void render();
void releaseResources();
private:
QRhi *m_rhi = nullptr;
QRhiRenderTarget *m_rt = nullptr;
QRhiCommandBuffer *m_cb = nullptr;
std::unique_ptr<QRhiBuffer> m_vbuf;
std::unique_ptr<QRhiBuffer> m_ibuf;
std::unique_ptr<QRhiBuffer> m_ubuf;
std::unique_ptr<QRhiGraphicsPipeline> m_ps;
QVector<quint32> m_renderPassFormat;
std::unique_ptr<QRhiSampler> m_sampler;
struct Texture {
QImage image;
QRhiTexture *tex = nullptr;
QRhiShaderResourceBindings *srb = nullptr;
};
QVector<Texture> m_textures;
};
class QRhiImgui
{
public:
QRhiImgui();
~QRhiImgui();
using FrameFunc = std::function<void()>;
void nextFrame(const QSizeF &logicalOutputSize, float dpr, const QPointF &logicalOffset, FrameFunc frameFunc);
void syncRenderer(QRhiImguiRenderer *renderer);
bool processEvent(QEvent *e);
void rebuildFontAtlas();
private:
QRhiImguiRenderer::StaticRenderData sf;
QRhiImguiRenderer::FrameRenderData f;
Qt::MouseButtons pressedMouseButtons;
};
QT_END_NAMESPACE
#endif