diff options
| author | Laszlo Agocs <laszlo.agocs@qt.io> | 2023-04-27 13:16:29 +0200 |
|---|---|---|
| committer | Laszlo Agocs <laszlo.agocs@qt.io> | 2023-05-21 15:42:58 +0200 |
| commit | 1dd8b5ceec3a1cde987372a7f993c07f30e5af95 (patch) | |
| tree | 53e8b96c8a2bf104573a45958329255a5abcd4d9 /tests/manual/rhi/triquadcube | |
| parent | 30a8e79243084017d23f1c765d5f1cbb86564191 (diff) | |
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>
Diffstat (limited to 'tests/manual/rhi/triquadcube')
7 files changed, 7 insertions, 7 deletions
diff --git a/tests/manual/rhi/triquadcube/quadrenderer.cpp b/tests/manual/rhi/triquadcube/quadrenderer.cpp index 4536412309..09c2047c35 100644 --- a/tests/manual/rhi/triquadcube/quadrenderer.cpp +++ b/tests/manual/rhi/triquadcube/quadrenderer.cpp @@ -3,7 +3,7 @@ #include "quadrenderer.h" #include <QFile> -#include <QtGui/private/qshader_p.h> +#include <rhi/qshader.h> // Renders a quad using indexed drawing. No QRhiGraphicsPipeline is created, it // expects to reuse the one created by TriangleRenderer. A separate diff --git a/tests/manual/rhi/triquadcube/quadrenderer.h b/tests/manual/rhi/triquadcube/quadrenderer.h index a9f882fe54..f8757992ff 100644 --- a/tests/manual/rhi/triquadcube/quadrenderer.h +++ b/tests/manual/rhi/triquadcube/quadrenderer.h @@ -4,7 +4,7 @@ #ifndef QUADRENDERER_H #define QUADRENDERER_H -#include <QtGui/private/qrhi_p.h> +#include <rhi/qrhi.h> class QuadRenderer { diff --git a/tests/manual/rhi/triquadcube/texturedcuberenderer.cpp b/tests/manual/rhi/triquadcube/texturedcuberenderer.cpp index 23b3c5c7c5..8e73194fc8 100644 --- a/tests/manual/rhi/triquadcube/texturedcuberenderer.cpp +++ b/tests/manual/rhi/triquadcube/texturedcuberenderer.cpp @@ -3,7 +3,7 @@ #include "texturedcuberenderer.h" #include <QFile> -#include <QtGui/private/qshader_p.h> +#include <rhi/qshader.h> #include "../shared/cube.h" diff --git a/tests/manual/rhi/triquadcube/texturedcuberenderer.h b/tests/manual/rhi/triquadcube/texturedcuberenderer.h index 59517b2fef..0972ad6d46 100644 --- a/tests/manual/rhi/triquadcube/texturedcuberenderer.h +++ b/tests/manual/rhi/triquadcube/texturedcuberenderer.h @@ -4,7 +4,7 @@ #ifndef TEXTUREDCUBERENDERER_H #define TEXTUREDCUBERENDERER_H -#include <QtGui/private/qrhi_p.h> +#include <rhi/qrhi.h> class TexturedCubeRenderer { diff --git a/tests/manual/rhi/triquadcube/triangleoncuberenderer.cpp b/tests/manual/rhi/triquadcube/triangleoncuberenderer.cpp index b66d869642..683134589e 100644 --- a/tests/manual/rhi/triquadcube/triangleoncuberenderer.cpp +++ b/tests/manual/rhi/triquadcube/triangleoncuberenderer.cpp @@ -3,7 +3,7 @@ #include "triangleoncuberenderer.h" #include <QFile> -#include <QtGui/private/qshader_p.h> +#include <rhi/qshader.h> // toggle to test the preserved content (no clear) path const bool IMAGE_UNDER_OFFSCREEN_RENDERING = false; diff --git a/tests/manual/rhi/triquadcube/trianglerenderer.cpp b/tests/manual/rhi/triquadcube/trianglerenderer.cpp index 160a94ef46..46f6e0dec4 100644 --- a/tests/manual/rhi/triquadcube/trianglerenderer.cpp +++ b/tests/manual/rhi/triquadcube/trianglerenderer.cpp @@ -3,7 +3,7 @@ #include "trianglerenderer.h" #include <QFile> -#include <QtGui/private/qshader_p.h> +#include <rhi/qshader.h> //#define VBUF_IS_DYNAMIC diff --git a/tests/manual/rhi/triquadcube/trianglerenderer.h b/tests/manual/rhi/triquadcube/trianglerenderer.h index ec591eb284..e6e3d0c0a9 100644 --- a/tests/manual/rhi/triquadcube/trianglerenderer.h +++ b/tests/manual/rhi/triquadcube/trianglerenderer.h @@ -4,7 +4,7 @@ #ifndef TRIANGLERENDERER_H #define TRIANGLERENDERER_H -#include <QtGui/private/qrhi_p.h> +#include <rhi/qrhi.h> class TriangleRenderer { |