qrhi.h 35.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the Qt RHI module
**
** $QT_BEGIN_LICENSE:LGPL3$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPLv3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QRHI_H
#define QRHI_H

#include <QtRhi/qtrhiglobal.h>
#include <QVector4D>
#include <QVector2D>
#include <QSize>
#include <QMatrix4x4>
#include <QVector>
#include <QImage>
#include <QtShaderTools/QBakedShader>
48
#include <functional>
49 50 51 52

QT_BEGIN_NAMESPACE

class QWindow;
Laszlo Agocs's avatar
Laszlo Agocs committed
53 54 55 56 57
class QRhiImplementation;
class QRhiBuffer;
class QRhiRenderBuffer;
class QRhiTexture;
class QRhiSampler;
58 59
class QRhiCommandBuffer;
class QRhiResourceUpdateBatch;
Laszlo Agocs's avatar
Laszlo Agocs committed
60
class QRhiResourceUpdateBatchPrivate;
61
class QRhiProfiler;
62
class QRhiShaderResourceBindingPrivate;
63
class QRhiResourceSharingHostPrivate;
64

Laszlo Agocs's avatar
Laszlo Agocs committed
65
class Q_RHI_EXPORT QRhiColorClearValue
66
{
Laszlo Agocs's avatar
Laszlo Agocs committed
67
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
68 69 70
    QRhiColorClearValue();
    explicit QRhiColorClearValue(const QVector4D &c);
    QRhiColorClearValue(float r, float g, float b, float a);
Laszlo Agocs's avatar
Laszlo Agocs committed
71 72 73 74 75 76

    QVector4D rgba() const { return m_rgba; }
    void setRgba(const QVector4D &c) { m_rgba = c; }

private:
    QVector4D m_rgba;
77 78 79 80
};

Q_DECLARE_TYPEINFO(QRhiColorClearValue, Q_MOVABLE_TYPE);

Laszlo Agocs's avatar
Laszlo Agocs committed
81
class Q_RHI_EXPORT QRhiDepthStencilClearValue
82
{
Laszlo Agocs's avatar
Laszlo Agocs committed
83
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
84 85
    QRhiDepthStencilClearValue();
    QRhiDepthStencilClearValue(float d, quint32 s);
Laszlo Agocs's avatar
Laszlo Agocs committed
86 87 88 89 90 91 92 93 94 95

    float depthClearValue() const { return m_d; }
    void setDepthClearValue(float d) { m_d = d; }

    quint32 stencilClearValue() const { return m_s; }
    void setStencilClearValue(quint32 s) { m_s = s; }

private:
    float m_d;
    quint32 m_s;
96 97 98 99
};

Q_DECLARE_TYPEINFO(QRhiDepthStencilClearValue, Q_MOVABLE_TYPE);

Laszlo Agocs's avatar
Laszlo Agocs committed
100
class Q_RHI_EXPORT QRhiViewport
101
{
Laszlo Agocs's avatar
Laszlo Agocs committed
102
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
103 104
    QRhiViewport();
    QRhiViewport(float x, float y, float w, float h, float minDepth = 0.0f, float maxDepth = 1.0f);
Laszlo Agocs's avatar
Laszlo Agocs committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118

    QVector4D viewport() const { return m_rect; }
    void setViewport(const QVector4D &v) { m_rect = v; }

    float minDepth() const { return m_minDepth; }
    void setMinDepth(float minDepth) { m_minDepth = minDepth; }

    float maxDepth() const { return m_maxDepth; }
    void setMaxDepth(float maxDepth) { m_maxDepth = maxDepth; }

private:
    QVector4D m_rect;
    float m_minDepth;
    float m_maxDepth;
119 120 121 122
};

Q_DECLARE_TYPEINFO(QRhiViewport, Q_MOVABLE_TYPE);

Laszlo Agocs's avatar
Laszlo Agocs committed
123
class Q_RHI_EXPORT QRhiScissor
124
{
Laszlo Agocs's avatar
Laszlo Agocs committed
125
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
126 127
    QRhiScissor();
    QRhiScissor(int x, int y, int w, int h);
Laszlo Agocs's avatar
Laszlo Agocs committed
128 129 130 131 132 133

    QVector4D scissor() const { return m_rect; }
    void setScissor(const QVector4D &v) { m_rect = v; }

private:
    QVector4D m_rect;
134 135 136 137
};

Q_DECLARE_TYPEINFO(QRhiScissor, Q_MOVABLE_TYPE);

Laszlo Agocs's avatar
Laszlo Agocs committed
138
class Q_RHI_EXPORT QRhiVertexInputBinding
139
{
Laszlo Agocs's avatar
Laszlo Agocs committed
140 141 142 143 144 145
public:
    enum Classification {
        PerVertex,
        PerInstance
    };

Laszlo Agocs's avatar
Laszlo Agocs committed
146 147
    QRhiVertexInputBinding();
    QRhiVertexInputBinding(quint32 stride, Classification cls = PerVertex, int stepRate = 1);
Laszlo Agocs's avatar
Laszlo Agocs committed
148 149 150 151 152 153 154 155 156 157 158 159 160 161

    quint32 stride() const { return m_stride; }
    void setStride(quint32 s) { m_stride = s; }

    Classification classification() const { return m_classification; }
    void setClassification(Classification c) { m_classification = c; }

    int instanceStepRate() const { return m_instanceStepRate; }
    void setInstanceStepRate(int rate) { m_instanceStepRate = rate; }

private:
    quint32 m_stride;
    Classification m_classification;
    int m_instanceStepRate;
162
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
Laszlo Agocs's avatar
Laszlo Agocs committed
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
};

Q_DECLARE_TYPEINFO(QRhiVertexInputBinding, Q_MOVABLE_TYPE);

class Q_RHI_EXPORT QRhiVertexInputAttribute
{
public:
    enum Format {
        Float4,
        Float3,
        Float2,
        Float,
        UNormByte4,
        UNormByte2,
        UNormByte
    };

Laszlo Agocs's avatar
Laszlo Agocs committed
180 181
    QRhiVertexInputAttribute();
    QRhiVertexInputAttribute(int binding, int location, Format format, quint32 offset);
Laszlo Agocs's avatar
Laszlo Agocs committed
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199

    int binding() const { return m_binding; }
    void setBinding(int b) { m_binding = b; }

    int location() const { return m_location; }
    void setLocation(int loc) { m_location = loc; }

    Format format() const { return m_format; }
    void setFormt(Format f) { m_format = f; }

    quint32 offset() const { return m_offset; }
    void setOffset(quint32 ofs) { m_offset = ofs; }

private:
    int m_binding;
    int m_location;
    Format m_format;
    quint32 m_offset;
200
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
Laszlo Agocs's avatar
Laszlo Agocs committed
201 202 203 204 205 206 207
};

Q_DECLARE_TYPEINFO(QRhiVertexInputAttribute, Q_MOVABLE_TYPE);

class Q_RHI_EXPORT QRhiVertexInputLayout
{
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
208 209
    QRhiVertexInputLayout();

Laszlo Agocs's avatar
Laszlo Agocs committed
210 211 212 213 214 215 216 217 218
    QVector<QRhiVertexInputBinding> bindings() const { return m_bindings; }
    void setBindings(const QVector<QRhiVertexInputBinding> &v) { m_bindings = v; }

    QVector<QRhiVertexInputAttribute> attributes() const { return m_attributes; }
    void setAttributes(const QVector<QRhiVertexInputAttribute> &v) { m_attributes = v; }

private:
    QVector<QRhiVertexInputBinding> m_bindings;
    QVector<QRhiVertexInputAttribute> m_attributes;
219
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
220 221 222 223
};

Q_DECLARE_TYPEINFO(QRhiVertexInputLayout, Q_MOVABLE_TYPE);

Laszlo Agocs's avatar
Laszlo Agocs committed
224
class Q_RHI_EXPORT QRhiGraphicsShaderStage
225
{
Laszlo Agocs's avatar
Laszlo Agocs committed
226
public:
227 228 229
    enum Type {
        Vertex,
        Fragment,
230 231
        TessellationControl,
        TessellationEvaluation
232 233
    };

Laszlo Agocs's avatar
Laszlo Agocs committed
234 235
    QRhiGraphicsShaderStage();
    QRhiGraphicsShaderStage(Type type, const QBakedShader &shader);
236

Laszlo Agocs's avatar
Laszlo Agocs committed
237 238 239 240 241 242 243 244 245
    Type type() const { return m_type; }
    void setType(Type t) { m_type = t; }

    QBakedShader shader() const { return m_shader; }
    void setShader(const QBakedShader &s) { m_shader = s; }

private:
    Type m_type;
    QBakedShader m_shader;
246
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
247 248 249 250
};

Q_DECLARE_TYPEINFO(QRhiGraphicsShaderStage, Q_MOVABLE_TYPE);

251
class Q_RHI_EXPORT QRhiShaderResourceBinding
Laszlo Agocs's avatar
Laszlo Agocs committed
252
{
253
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
254 255 256 257 258 259 260 261
    enum Type {
        UniformBuffer,
        SampledTexture
    };

    enum StageFlag {
        VertexStage = 1 << 0,
        FragmentStage = 1 << 1,
262 263
        TessellationControlStage = 1 << 2,
        TessellationEvaluationStage = 1 << 3
Laszlo Agocs's avatar
Laszlo Agocs committed
264 265 266
    };
    Q_DECLARE_FLAGS(StageFlags, StageFlag)

267 268 269 270 271 272 273 274 275 276 277 278 279
    QRhiShaderResourceBinding();
    QRhiShaderResourceBinding(const QRhiShaderResourceBinding &other);
    QRhiShaderResourceBinding &operator=(const QRhiShaderResourceBinding &other);
    ~QRhiShaderResourceBinding();
    void detach();

    static QRhiShaderResourceBinding uniformBuffer(int binding, StageFlags stage, QRhiBuffer *buf);
    static QRhiShaderResourceBinding uniformBuffer(int binding, StageFlags stage, QRhiBuffer *buf, int offset, int size);
    static QRhiShaderResourceBinding sampledTexture(int binding, StageFlags stage, QRhiTexture *tex, QRhiSampler *sampler);

private:
    QRhiShaderResourceBindingPrivate *d;
    friend class QRhiShaderResourceBindingPrivate;
Laszlo Agocs's avatar
Laszlo Agocs committed
280 281 282 283
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiShaderResourceBinding::StageFlags)

Laszlo Agocs's avatar
Laszlo Agocs committed
284
class Q_RHI_EXPORT QRhiColorAttachment
Laszlo Agocs's avatar
Laszlo Agocs committed
285
{
Laszlo Agocs's avatar
Laszlo Agocs committed
286
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
287 288 289
    QRhiColorAttachment();
    QRhiColorAttachment(QRhiTexture *texture);
    QRhiColorAttachment(QRhiRenderBuffer *renderBuffer);
290

Laszlo Agocs's avatar
Laszlo Agocs committed
291 292
    QRhiTexture *texture() const { return m_texture; }
    void setTexture(QRhiTexture *tex) { m_texture = tex; }
293

Laszlo Agocs's avatar
Laszlo Agocs committed
294 295
    QRhiRenderBuffer *renderBuffer() const { return m_renderBuffer; }
    void setRenderBuffer(QRhiRenderBuffer *rb) { m_renderBuffer = rb; }
296

Laszlo Agocs's avatar
Laszlo Agocs committed
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
    int layer() const { return m_layer; }
    void setLayer(int layer) { m_layer = layer; }

    int level() const { return m_level; }
    void setLevel(int level) { m_level = level; }

    QRhiTexture *resolveTexture() const { return m_resolveTexture; }
    void setResolveTexture(QRhiTexture *tex) { m_resolveTexture = tex; }

    int resolveLayer() const { return m_resolveLayer; }
    void setResolveLayer(int layer) { m_resolveLayer = layer; }

    int resolveLevel() const { return m_resolveLevel; }
    void setResolveLevel(int level) { m_resolveLevel = level; }

private:
    QRhiTexture *m_texture = nullptr;
    QRhiRenderBuffer *m_renderBuffer = nullptr;
    int m_layer = 0;
    int m_level = 0;
    QRhiTexture *m_resolveTexture = nullptr;
    int m_resolveLayer = 0;
    int m_resolveLevel = 0;
320
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
Laszlo Agocs's avatar
Laszlo Agocs committed
321 322 323 324 325 326 327
};

Q_DECLARE_TYPEINFO(QRhiColorAttachment, Q_MOVABLE_TYPE);

class Q_RHI_EXPORT QRhiTextureRenderTargetDescription
{
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
328 329 330 331
    QRhiTextureRenderTargetDescription();
    QRhiTextureRenderTargetDescription(const QRhiColorAttachment &colorAttachment);
    QRhiTextureRenderTargetDescription(const QRhiColorAttachment &colorAttachment, QRhiRenderBuffer *depthStencilBuffer);
    QRhiTextureRenderTargetDescription(const QRhiColorAttachment &colorAttachment, QRhiTexture *depthTexture);
Laszlo Agocs's avatar
Laszlo Agocs committed
332 333 334 335 336 337 338 339 340 341 342 343 344 345

    QVector<QRhiColorAttachment> colorAttachments() const { return m_colorAttachments; }
    void setColorAttachments(const QVector<QRhiColorAttachment> &att) { m_colorAttachments = att; }

    QRhiRenderBuffer *depthStencilBuffer() const { return m_depthStencilBuffer; }
    void setDepthStencilBuffer(QRhiRenderBuffer *renderBuffer) { m_depthStencilBuffer = renderBuffer; }

    QRhiTexture *depthTexture() const { return m_depthTexture; }
    void setDepthTexture(QRhiTexture *texture) { m_depthTexture = texture; }

private:
    QVector<QRhiColorAttachment> m_colorAttachments;
    QRhiRenderBuffer *m_depthStencilBuffer = nullptr;
    QRhiTexture *m_depthTexture = nullptr;
346
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
Laszlo Agocs's avatar
Laszlo Agocs committed
347 348 349 350
};

Q_DECLARE_TYPEINFO(QRhiTextureRenderTargetDescription, Q_MOVABLE_TYPE);

351
class Q_RHI_EXPORT QRhiTextureMipLevel
Laszlo Agocs's avatar
Laszlo Agocs committed
352
{
353
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
354 355 356
    QRhiTextureMipLevel();
    QRhiTextureMipLevel(const QImage &image);
    QRhiTextureMipLevel(const QByteArray &compressedData);
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378

    QImage image() const { return m_image; }
    void setImage(const QImage &image) { m_image = image; }

    QByteArray compressedData() const { return m_compressedData; }
    void setCompressedData(const QByteArray &data) { m_compressedData = data; }

    QPoint destinationTopLeft() const { return m_destinationTopLeft; }
    void setDestinationTopLeft(const QPoint &p) { m_destinationTopLeft = p; }

    QSize sourceSize() const { return m_sourceSize; }
    void setSourceSize(const QSize &size) { m_sourceSize = size; }

    QPoint sourceTopLeft() const { return m_sourceTopLeft; }
    void setSourceTopLeft(const QPoint &p) { m_sourceTopLeft = p; }

private:
    QImage m_image;
    QByteArray m_compressedData;
    QPoint m_destinationTopLeft;
    QSize m_sourceSize;
    QPoint m_sourceTopLeft;
379
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
380 381 382 383 384 385 386
};

Q_DECLARE_TYPEINFO(QRhiTextureMipLevel, Q_MOVABLE_TYPE);

class Q_RHI_EXPORT QRhiTextureLayer
{
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
387 388
    QRhiTextureLayer();
    QRhiTextureLayer(const QVector<QRhiTextureMipLevel> &mipImages);
389 390 391 392 393 394

    QVector<QRhiTextureMipLevel> mipImages() const { return m_mipImages; }
    void setMipImages(const QVector<QRhiTextureMipLevel> &images) { m_mipImages = images; }

private:
    QVector<QRhiTextureMipLevel> m_mipImages;
395
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
396
};
397

398 399 400 401 402
Q_DECLARE_TYPEINFO(QRhiTextureLayer, Q_MOVABLE_TYPE);

class Q_RHI_EXPORT QRhiTextureUploadDescription
{
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
403 404
    QRhiTextureUploadDescription();
    QRhiTextureUploadDescription(const QVector<QRhiTextureLayer> &layers);
405 406 407 408 409 410

    QVector<QRhiTextureLayer> layers() const { return m_layers; }
    void setLayers(const QVector<QRhiTextureLayer> &layers) { m_layers = layers; }

private:
    QVector<QRhiTextureLayer> m_layers;
411
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
Laszlo Agocs's avatar
Laszlo Agocs committed
412 413 414 415
};

Q_DECLARE_TYPEINFO(QRhiTextureUploadDescription, Q_MOVABLE_TYPE);

416
class Q_RHI_EXPORT QRhiTextureCopyDescription
417
{
418
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
419
    QRhiTextureCopyDescription();
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434

    QSize pixelSize() const { return m_pixelSize; }
    void setPixelSize(const QSize &sz) { m_pixelSize = sz; }

    int sourceLayer() const { return m_sourceLayer; }
    void setSourceLayer(int layer) { m_sourceLayer = layer; }

    int sourceLevel() const { return m_sourceLevel; }
    void setSourceLevel(int level) { m_sourceLevel = level; }

    QPoint sourceTopLeft() const { return m_sourceTopLeft; }
    void setSourceTopLeft(const QPoint &p) { m_sourceTopLeft = p; }

    int destinationLayer() const { return m_destinationLayer; }
    void setDestinationLayer(int layer) { m_destinationLayer = layer; }
435

436 437 438 439 440 441 442 443 444 445 446 447 448 449
    int destinationLevel() const { return m_destinationLevel; }
    void setDestinationLevel(int level) { m_destinationLevel = level; }

    QPoint destinationTopLeft() const { return m_destinationTopLeft; }
    void setDestinationTopLeft(const QPoint &p) { m_destinationTopLeft = p; }

private:
    QSize m_pixelSize;
    int m_sourceLayer = 0;
    int m_sourceLevel = 0;
    QPoint m_sourceTopLeft;
    int m_destinationLayer = 0;
    int m_destinationLevel = 0;
    QPoint m_destinationTopLeft;
450
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
451 452 453 454
};

Q_DECLARE_TYPEINFO(QRhiTextureCopyDescription, Q_MOVABLE_TYPE);

455
class Q_RHI_EXPORT QRhiReadbackDescription
Laszlo Agocs's avatar
Laszlo Agocs committed
456
{
457
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
458 459
    QRhiReadbackDescription();
    QRhiReadbackDescription(QRhiTexture *texture);
460 461 462 463 464 465

    QRhiTexture *texture() const { return m_texture; }
    void setTexture(QRhiTexture *tex) { m_texture = tex; }

    int layer() const { return m_layer; }
    void setLayer(int layer) { m_layer = layer; }
466

467 468 469 470 471 472 473
    int level() const { return m_level; }
    void setLevel(int level) { m_level = level; }

private:
    QRhiTexture *m_texture = nullptr;
    int m_layer = 0;
    int m_level = 0;
474
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
Laszlo Agocs's avatar
Laszlo Agocs committed
475 476
};

477 478
Q_DECLARE_TYPEINFO(QRhiReadbackDescription, Q_MOVABLE_TYPE);

479 480 481 482
struct Q_RHI_EXPORT QRhiNativeHandles
{
};

483 484 485 486
class Q_RHI_EXPORT QRhiResource
{
public:
    virtual ~QRhiResource();
487

488 489 490
    virtual void release() = 0;
    void releaseAndDestroy();

491 492 493
    QByteArray name() const;
    void setName(const QByteArray &name);

494
    virtual bool isShareable() const;
Laszlo Agocs's avatar
Laszlo Agocs committed
495

496 497 498
protected:
    QRhiResource(QRhiImplementation *rhi_);
    Q_DISABLE_COPY(QRhiResource)
Laszlo Agocs's avatar
Laszlo Agocs committed
499
    friend class QRhiImplementation;
500 501
    QRhiImplementation *rhi = nullptr;
    QByteArray objectName;
Laszlo Agocs's avatar
Laszlo Agocs committed
502 503
    QRhiResourceSharingHostPrivate *orphanedWithRsh = nullptr;
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
504 505 506 507 508 509
};

class Q_RHI_EXPORT QRhiBuffer : public QRhiResource
{
public:
    enum Type {
510 511 512
        Immutable,
        Static,
        Dynamic
513 514 515 516 517 518 519 520 521
    };

    enum UsageFlag {
        VertexBuffer = 1 << 0,
        IndexBuffer = 1 << 1,
        UniformBuffer = 1 << 2
    };
    Q_DECLARE_FLAGS(UsageFlags, UsageFlag)

Laszlo Agocs's avatar
Laszlo Agocs committed
522 523 524 525 526 527 528 529
    Type type() const { return m_type; }
    void setType(Type t) { m_type = t; }

    UsageFlags usage() const { return m_usage; }
    void setUsage(UsageFlags u) { m_usage = u; }

    int size() const { return m_size; }
    void setSize(int sz) { m_size = sz; }
530 531 532 533 534

    virtual bool build() = 0;

protected:
    QRhiBuffer(QRhiImplementation *rhi, Type type_, UsageFlags usage_, int size_);
Laszlo Agocs's avatar
Laszlo Agocs committed
535 536
    Type m_type;
    UsageFlags m_usage;
537
    int m_size;
538
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
539 540 541 542 543 544 545 546 547
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiBuffer::UsageFlags)

class Q_RHI_EXPORT QRhiTexture : public QRhiResource
{
public:
    enum Flag {
        RenderTarget = 1 << 0,
548
        ChangesFrequently = 1 << 1,
549
        CubeMap = 1 << 2,
550
        MipMapped = 1 << 3,
551
        sRGB = 1 << 4,
552
        UsedAsTransferSource = 1 << 5,
553
        UsedWithGenerateMips = 1 << 6
554 555 556 557
    };
    Q_DECLARE_FLAGS(Flags, Flag)

    enum Format {
558 559
        UnknownFormat,

560 561 562 563 564 565
        RGBA8,
        BGRA8,
        R8,
        R16,

        D16,
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
        D32,

        BC1,
        BC2,
        BC3,
        BC4,
        BC5,
        BC6H,
        BC7,

        ETC2_RGB8,
        ETC2_RGB8A1,
        ETC2_RGBA8,

        ASTC_4x4,
        ASTC_5x4,
        ASTC_5x5,
        ASTC_6x5,
        ASTC_6x6,
        ASTC_8x5,
        ASTC_8x6,
        ASTC_8x8,
        ASTC_10x5,
        ASTC_10x6,
        ASTC_10x8,
        ASTC_10x10,
        ASTC_12x10,
        ASTC_12x12
594 595
    };

Laszlo Agocs's avatar
Laszlo Agocs committed
596 597 598 599 600 601 602 603
    Format format() const { return m_format; }
    void setFormat(Format fmt) { m_format = fmt; }

    QSize pixelSize() const { return m_pixelSize; }
    void setPixelSize(const QSize &sz) { m_pixelSize = sz; }

    Flags flags() const { return m_flags; }
    void setFlags(Flags f) { m_flags = f; }
604

Laszlo Agocs's avatar
Laszlo Agocs committed
605 606 607
    int sampleCount() const { return m_sampleCount; }
    void setSampleCount(int s) { m_sampleCount = s; }

608
    virtual bool build() = 0;
609 610
    virtual const QRhiNativeHandles *nativeHandles();
    virtual bool buildFrom(const QRhiNativeHandles *src);
611

612
protected:
Laszlo Agocs's avatar
Laszlo Agocs committed
613 614
    QRhiTexture(QRhiImplementation *rhi, Format format_, const QSize &pixelSize_,
                int sampleCount_, Flags flags_);
Laszlo Agocs's avatar
Laszlo Agocs committed
615 616
    Format m_format;
    QSize m_pixelSize;
Laszlo Agocs's avatar
Laszlo Agocs committed
617
    int m_sampleCount;
Laszlo Agocs's avatar
Laszlo Agocs committed
618
    Flags m_flags;
619
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
620 621 622 623 624 625 626 627
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiTexture::Flags)

class Q_RHI_EXPORT QRhiSampler : public QRhiResource
{
public:
    enum Filter {
628
        None,
629 630 631 632 633 634 635 636 637 638 639 640
        Nearest,
        Linear
    };

    enum AddressMode {
        Repeat,
        ClampToEdge,
        Border,
        Mirror,
        MirrorOnce
    };

Laszlo Agocs's avatar
Laszlo Agocs committed
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
    Filter magFilter() const { return m_magFilter; }
    void setMagFilter(Filter f) { m_magFilter = f; }

    Filter minFilter() const { return m_minFilter; }
    void setMinFilter(Filter f) { m_minFilter = f; }

    Filter mipmapMode() const { return m_mipmapMode; }
    void setMipmapMode(Filter f) { m_mipmapMode = f; }

    AddressMode addressU() const { return m_addressU; }
    void setAddressU(AddressMode mode) { m_addressU = mode; }

    AddressMode addressV() const { return m_addressV; }
    void setAddressV(AddressMode mode) { m_addressV = mode; }

    AddressMode addressW() const { return m_addressW; }
    void setAddressW(AddressMode mode) { m_addressW = mode; }
658 659 660 661 662 663 664

    virtual bool build() = 0;

protected:
    QRhiSampler(QRhiImplementation *rhi,
                Filter magFilter_, Filter minFilter_, Filter mipmapMode_,
                AddressMode u_, AddressMode v_, AddressMode w_);
Laszlo Agocs's avatar
Laszlo Agocs committed
665 666 667 668 669 670
    Filter m_magFilter;
    Filter m_minFilter;
    Filter m_mipmapMode;
    AddressMode m_addressU;
    AddressMode m_addressV;
    AddressMode m_addressW;
671
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
672 673
};

Laszlo Agocs's avatar
Laszlo Agocs committed
674 675 676 677 678 679 680 681 682
class Q_RHI_EXPORT QRhiRenderBuffer : public QRhiResource
{
public:
    enum Type {
        DepthStencil,
        Color
    };

    enum Flag {
683
        UsedWithSwapChainOnly = 1 << 0
Laszlo Agocs's avatar
Laszlo Agocs committed
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
    };
    Q_DECLARE_FLAGS(Flags, Flag)

    Type type() const { return m_type; }
    void setType(Type t) { m_type = t; }

    QSize pixelSize() const { return m_pixelSize; }
    void setPixelSize(const QSize &sz) { m_pixelSize = sz; }

    int sampleCount() const { return m_sampleCount; }
    void setSampleCount(int s) { m_sampleCount = s; }

    Flags flags() const { return m_flags; }
    void setFlags(Flags h) { m_flags = h; }

    virtual bool build() = 0;

    virtual QRhiTexture::Format backingFormat() const = 0;

protected:
    QRhiRenderBuffer(QRhiImplementation *rhi, Type type_, const QSize &pixelSize_,
                     int sampleCount_, Flags flags_);
    Type m_type;
    QSize m_pixelSize;
    int m_sampleCount;
    Flags m_flags;
710
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
Laszlo Agocs's avatar
Laszlo Agocs committed
711 712 713 714
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiRenderBuffer::Flags)

715
class Q_RHI_EXPORT QRhiRenderPassDescriptor : public QRhiResource
716 717
{
protected:
718
    QRhiRenderPassDescriptor(QRhiImplementation *rhi);
719
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
720 721 722 723 724 725 726 727 728 729 730 731
};

class Q_RHI_EXPORT QRhiRenderTarget : public QRhiResource
{
public:
    enum Type {
        RtRef,
        RtTexture
    };

    virtual Type type() const = 0;
    virtual QSize sizeInPixels() const = 0;
Laszlo Agocs's avatar
Laszlo Agocs committed
732
    virtual float devicePixelRatio() const = 0;
Laszlo Agocs's avatar
Laszlo Agocs committed
733

734 735
    QRhiRenderPassDescriptor *renderPassDescriptor() const { return m_renderPassDesc; }
    void setRenderPassDescriptor(QRhiRenderPassDescriptor *desc) { m_renderPassDesc = desc; }
736 737 738

protected:
    QRhiRenderTarget(QRhiImplementation *rhi);
739
    QRhiRenderPassDescriptor *m_renderPassDesc = nullptr;
740
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
741 742 743 744 745 746
};

class Q_RHI_EXPORT QRhiTextureRenderTarget : public QRhiRenderTarget
{
public:
    enum Flag {
747 748
        PreserveColorContents = 1 << 0,
        PreserveDepthStencilContents = 1 << 1
749 750 751
    };
    Q_DECLARE_FLAGS(Flags, Flag)

Laszlo Agocs's avatar
Laszlo Agocs committed
752 753
    QRhiTextureRenderTargetDescription description() const { return m_desc; }
    void setDescription(const QRhiTextureRenderTargetDescription &desc) { m_desc = desc; }
754

Laszlo Agocs's avatar
Laszlo Agocs committed
755 756 757
    Flags flags() const { return m_flags; }
    void setFlags(Flags f) { m_flags = f; }

758
    virtual QRhiRenderPassDescriptor *newCompatibleRenderPassDescriptor() = 0;
Laszlo Agocs's avatar
Laszlo Agocs committed
759

760 761 762 763
    virtual bool build() = 0;

protected:
    QRhiTextureRenderTarget(QRhiImplementation *rhi, const QRhiTextureRenderTargetDescription &desc_, Flags flags_);
Laszlo Agocs's avatar
Laszlo Agocs committed
764 765
    QRhiTextureRenderTargetDescription m_desc;
    Flags m_flags;
766 767 768 769 770 771 772
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiTextureRenderTarget::Flags)

class Q_RHI_EXPORT QRhiShaderResourceBindings : public QRhiResource
{
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
773 774
    QVector<QRhiShaderResourceBinding> bindings() const { return m_bindings; }
    void setBindings(const QVector<QRhiShaderResourceBinding> &b) { m_bindings = b; }
775 776 777 778 779

    virtual bool build() = 0;

protected:
    QRhiShaderResourceBindings(QRhiImplementation *rhi);
Laszlo Agocs's avatar
Laszlo Agocs committed
780
    QVector<QRhiShaderResourceBinding> m_bindings;
781
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
};

class Q_RHI_EXPORT QRhiGraphicsPipeline : public QRhiResource
{
public:
    enum Flag {
        UsesBlendConstants = 1 << 0,
        UsesStencilRef = 1 << 1,
        UsesScissor = 1 << 2
    };
    Q_DECLARE_FLAGS(Flags, Flag)

    enum Topology {
        Triangles,
        TriangleStrip,
        Lines,
        LineStrip,
        Points
    };

802
    enum CullMode {
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
        None,
        Front,
        Back
    };

    enum FrontFace {
        CCW,
        CW
    };

    enum ColorMaskComponent {
        R = 1 << 0,
        G = 1 << 1,
        B = 1 << 2,
        A = 1 << 3
    };
    Q_DECLARE_FLAGS(ColorMask, ColorMaskComponent)

    enum BlendFactor {
        Zero,
        One,
        SrcColor,
        OneMinusSrcColor,
        DstColor,
        OneMinusDstColor,
        SrcAlpha,
        OneMinusSrcAlpha,
        DstAlpha,
        OneMinusDstAlpha,
        ConstantColor,
        OneMinusConstantColor,
        ConstantAlpha,
        OneMinusConstantAlpha,
        SrcAlphaSaturate,
        Src1Color,
        OneMinusSrc1Color,
        Src1Alpha,
        OneMinusSrc1Alpha
    };

    enum BlendOp {
        Add,
        Subtract,
        ReverseSubtract,
        Min,
        Max
    };

    struct TargetBlend {
        ColorMask colorWrite = ColorMask(0xF); // R | G | B | A
        bool enable = false;
        BlendFactor srcColor = One;
        BlendFactor dstColor = OneMinusSrcAlpha;
        BlendOp opColor = Add;
        BlendFactor srcAlpha = One;
        BlendFactor dstAlpha = OneMinusSrcAlpha;
        BlendOp opAlpha = Add;
    };

    enum CompareOp {
        Never,
        Less,
        Equal,
        LessOrEqual,
        Greater,
        NotEqual,
        GreaterOrEqual,
        Always
    };

    enum StencilOp {
        StencilZero,
        Keep,
        Replace,
        IncrementAndClamp,
        DecrementAndClamp,
        Invert,
        IncrementAndWrap,
        DecrementAndWrap
    };

    struct StencilOpState {
        StencilOp failOp = Keep;
        StencilOp depthFailOp = Keep;
        StencilOp passOp = Keep;
        CompareOp compareOp = Always;
    };

Laszlo Agocs's avatar
Laszlo Agocs committed
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
    Flags flags() const { return m_flags; }
    void setFlags(Flags f) { m_flags = f; }

    Topology topology() const { return m_topology; }
    void setTopology(Topology t) { m_topology = t; }

    CullMode cullMode() const { return m_cullMode; }
    void setCullMode(CullMode mode) { m_cullMode = mode; }

    FrontFace frontFace() const { return m_frontFace; }
    void setFrontFace(FrontFace f) { m_frontFace = f; }

    QVector<TargetBlend> targetBlends() const { return m_targetBlends; }
    void setTargetBlends(const QVector<TargetBlend> &blends) { m_targetBlends = blends; }

    bool hasDepthTest() const { return m_depthTest; }
    void setDepthTest(bool enable) { m_depthTest = enable; }

    bool hasDepthWrite() const { return m_depthWrite; }
    void setDepthWrite(bool enable) { m_depthWrite = enable; }

    CompareOp depthOp() const { return m_depthOp; }
    void setDepthOp(CompareOp op) { m_depthOp = op; }

    bool hasStencilTest() const { return m_stencilTest; }
    void setStencilTest(bool enable) { m_stencilTest = enable; }

    StencilOpState stencilFront() const { return m_stencilFront; }
    void setStencilFront(const StencilOpState &state) { m_stencilFront = state; }

    StencilOpState stencilBack() const { return m_stencilBack; }
    void setStencilBack(const StencilOpState &state) { m_stencilBack = state; }

    quint32 stencilReadMask() const { return m_stencilReadMask; }
    void setStencilReadMask(quint32 mask) { m_stencilReadMask = mask; }

    quint32 stencilWriteMask() const { return m_stencilWriteMask; }
    void setStencilWriteMask(quint32 mask) { m_stencilWriteMask = mask; }

    int sampleCount() const { return m_sampleCount; }
    void setSampleCount(int s) { m_sampleCount = s; }

    QVector<QRhiGraphicsShaderStage> shaderStages() const { return m_shaderStages; }
    void setShaderStages(const QVector<QRhiGraphicsShaderStage> &stages) { m_shaderStages = stages; }

    QRhiVertexInputLayout vertexInputLayout() const { return m_vertexInputLayout; }
    void setVertexInputLayout(const QRhiVertexInputLayout &layout) { m_vertexInputLayout = layout; }

    QRhiShaderResourceBindings *shaderResourceBindings() const { return m_shaderResourceBindings; }
    void setShaderResourceBindings(QRhiShaderResourceBindings *srb) { m_shaderResourceBindings = srb; }

942 943
    QRhiRenderPassDescriptor *renderPassDescriptor() const { return m_renderPassDesc; }
    void setRenderPassDescriptor(QRhiRenderPassDescriptor *desc) { m_renderPassDesc = desc; }
944 945 946 947 948

    virtual bool build() = 0;

protected:
    QRhiGraphicsPipeline(QRhiImplementation *rhi);
Laszlo Agocs's avatar
Laszlo Agocs committed
949 950 951 952
    Flags m_flags;
    Topology m_topology = Triangles;
    CullMode m_cullMode = None;
    FrontFace m_frontFace = CCW;
953
    QVector<TargetBlend> m_targetBlends;
Laszlo Agocs's avatar
Laszlo Agocs committed
954 955 956 957 958 959
    bool m_depthTest = false;
    bool m_depthWrite = false;
    CompareOp m_depthOp = Less;
    bool m_stencilTest = false;
    StencilOpState m_stencilFront;
    StencilOpState m_stencilBack;
960 961 962
    quint32 m_stencilReadMask = 0xFF;
    quint32 m_stencilWriteMask = 0xFF;
    int m_sampleCount = 1;
Laszlo Agocs's avatar
Laszlo Agocs committed
963 964
    QVector<QRhiGraphicsShaderStage> m_shaderStages;
    QRhiVertexInputLayout m_vertexInputLayout;
965
    QRhiShaderResourceBindings *m_shaderResourceBindings = nullptr;
966
    QRhiRenderPassDescriptor *m_renderPassDesc = nullptr;
967
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
968 969 970 971 972 973 974 975 976
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiGraphicsPipeline::Flags)
Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiGraphicsPipeline::ColorMask)
Q_DECLARE_TYPEINFO(QRhiGraphicsPipeline::TargetBlend, Q_MOVABLE_TYPE);

class Q_RHI_EXPORT QRhiSwapChain : public QRhiResource
{
public:
977
    enum Flag {
978
        SurfaceHasPreMulAlpha = 1 << 0,
979
        SurfaceHasNonPreMulAlpha = 1 << 1,
980
        sRGB = 1 << 2,
981 982
        UsedAsTransferSource = 1 << 3,
        NoVSync = 1 << 4
983
    };
984
    Q_DECLARE_FLAGS(Flags, Flag)
985

Laszlo Agocs's avatar
Laszlo Agocs committed
986 987 988
    QWindow *window() const { return m_window; }
    void setWindow(QWindow *window) { m_window = window; }

989 990
    Flags flags() const { return m_flags; }
    void setFlags(Flags f) { m_flags = f; }
Laszlo Agocs's avatar
Laszlo Agocs committed
991 992 993 994 995 996 997

    QRhiRenderBuffer *depthStencil() const { return m_depthStencil; }
    void setDepthStencil(QRhiRenderBuffer *ds) { m_depthStencil = ds; }

    int sampleCount() const { return m_sampleCount; }
    void setSampleCount(int samples) { m_sampleCount = samples; }

998 999
    QRhiRenderPassDescriptor *renderPassDescriptor() const { return m_renderPassDesc; }
    void setRenderPassDescriptor(QRhiRenderPassDescriptor *desc) { m_renderPassDesc = desc; }
Laszlo Agocs's avatar
Laszlo Agocs committed
1000

Laszlo Agocs's avatar
Laszlo Agocs committed
1001 1002 1003
    QObject *target() const { return m_target; }
    void setTarget(QObject *obj) { m_target = obj; }

1004 1005
    QSize currentPixelSize() const { return m_currentPixelSize; }

1006 1007
    virtual QRhiCommandBuffer *currentFrameCommandBuffer() = 0;
    virtual QRhiRenderTarget *currentFrameRenderTarget() = 0;
1008
    virtual QSize surfacePixelSize() = 0;
1009
    virtual QRhiRenderPassDescriptor *newCompatibleRenderPassDescriptor() = 0;
Laszlo Agocs's avatar
Laszlo Agocs committed
1010
    virtual bool buildOrResize() = 0;
1011 1012 1013

protected:
    QRhiSwapChain(QRhiImplementation *rhi);
Laszlo Agocs's avatar
Laszlo Agocs committed
1014
    QWindow *m_window = nullptr;
1015
    Flags m_flags;
Laszlo Agocs's avatar
Laszlo Agocs committed
1016 1017
    QRhiRenderBuffer *m_depthStencil = nullptr;
    int m_sampleCount = 1;
1018
    QRhiRenderPassDescriptor *m_renderPassDesc = nullptr;
Laszlo Agocs's avatar
Laszlo Agocs committed
1019
    QObject *m_target = nullptr;
1020
    QSize m_currentPixelSize;
1021
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
1022 1023
};

1024
Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiSwapChain::Flags)
1025

1026 1027 1028 1029 1030 1031 1032 1033
class Q_RHI_EXPORT QRhiCommandBuffer : public QRhiResource
{
public:
    enum IndexFormat {
        IndexUInt16,
        IndexUInt32
    };

1034 1035
    void resourceUpdate(QRhiResourceUpdateBatch *resourceUpdates);

1036
    void beginPass(QRhiRenderTarget *rt,
1037 1038
                   const QRhiColorClearValue &colorClearValue,
                   const QRhiDepthStencilClearValue &depthStencilClearValue,
1039
                   QRhiResourceUpdateBatch *resourceUpdates = nullptr);
1040
    void endPass(QRhiResourceUpdateBatch *resourceUpdates = nullptr);
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065

    void setGraphicsPipeline(QRhiGraphicsPipeline *ps,
                             QRhiShaderResourceBindings *srb = nullptr);

    using VertexInput = QPair<QRhiBuffer *, quint32>; // buffer, offset
    void setVertexInput(int startBinding, const QVector<VertexInput> &bindings,
                        QRhiBuffer *indexBuf = nullptr, quint32 indexOffset = 0,
                        IndexFormat indexFormat = IndexUInt16);

    void setViewport(const QRhiViewport &viewport);
    void setScissor(const QRhiScissor &scissor);
    void setBlendConstants(const QVector4D &c);
    void setStencilRef(quint32 refValue);

    void draw(quint32 vertexCount,
              quint32 instanceCount = 1,
              quint32 firstVertex = 0,
              quint32 firstInstance = 0);

    void drawIndexed(quint32 indexCount,
                     quint32 instanceCount = 1,
                     quint32 firstIndex = 0,
                     qint32 vertexOffset = 0,
                     quint32 firstInstance = 0);

1066 1067 1068 1069
    void debugMarkBegin(const QByteArray &name);
    void debugMarkEnd();
    void debugMarkMsg(const QByteArray &msg);

1070 1071
protected:
    QRhiCommandBuffer(QRhiImplementation *rhi);
1072
    Q_DECL_UNUSED_MEMBER quint64 m_reserved;
1073 1074 1075 1076 1077 1078 1079 1080 1081
};

struct Q_RHI_EXPORT QRhiReadbackResult
{
    std::function<void()> completed = nullptr;
    QRhiTexture::Format format;
    QSize pixelSize;
    QByteArray data;
}; // non-movable due to the std::function
1082

1083
class Q_RHI_EXPORT QRhiResourceUpdateBatch
1084 1085 1086
{
public:
    ~QRhiResourceUpdateBatch();
1087

1088 1089
    void release();

1090 1091
    void merge(QRhiResourceUpdateBatch *other);

1092
    void updateDynamicBuffer(QRhiBuffer *buf, int offset, int size, const void *data);
1093
    void uploadStaticBuffer(QRhiBuffer *buf, int offset, int size, const void *data);
1094
    void uploadStaticBuffer(QRhiBuffer *buf, const void *data);
Laszlo Agocs's avatar
Laszlo Agocs committed
1095
    void uploadTexture(QRhiTexture *tex, const QRhiTextureUploadDescription &desc);
1096
    void uploadTexture(QRhiTexture *tex, const QImage &image);
1097
    void copyTexture(QRhiTexture *dst, QRhiTexture *src, const QRhiTextureCopyDescription &desc = QRhiTextureCopyDescription());
1098
    void readBackTexture(const QRhiReadbackDescription &rb, QRhiReadbackResult *result);
1099
    void generateMips(QRhiTexture *tex);
1100 1101 1102 1103 1104

private:
    QRhiResourceUpdateBatch(QRhiImplementation *rhi);
    Q_DISABLE_COPY(QRhiResourceUpdateBatch)
    QRhiResourceUpdateBatchPrivate *d;
Laszlo Agocs's avatar
Laszlo Agocs committed
1105
    friend class QRhiResourceUpdateBatchPrivate;
1106 1107 1108
    friend class QRhi;
};

1109 1110 1111 1112 1113 1114 1115 1116 1117
class Q_RHI_EXPORT QRhiResourceSharingHost
{
public:
    QRhiResourceSharingHost();
    ~QRhiResourceSharingHost();

private:
    Q_DISABLE_COPY(QRhiResourceSharingHost)
    QRhiResourceSharingHostPrivate *d;
Laszlo Agocs's avatar
Laszlo Agocs committed
1118
    friend class QRhiResourceSharingHostPrivate;
1119 1120
};

1121 1122
struct Q_RHI_EXPORT QRhiInitParams
{
1123
    QRhiResourceSharingHost *resourceSharingHost = nullptr;
1124 1125 1126 1127 1128 1129
};

class Q_RHI_EXPORT QRhi
{
public:
    enum Implementation {
Laszlo Agocs's avatar
Laszlo Agocs committed
1130
        Null,
1131 1132 1133 1134 1135 1136
        Vulkan,
        OpenGLES2,
        D3D11,
        Metal
    };

1137
    enum Flag {
1138 1139
        EnableProfiling = 1 << 0,
        EnableDebugMarkers = 1 << 1
1140 1141 1142
    };
    Q_DECLARE_FLAGS(Flags, Flag)

1143 1144 1145 1146 1147 1148 1149
    enum FrameOpResult {
        FrameOpSuccess = 0,
        FrameOpError,
        FrameOpSwapChainOutOfDate,
        FrameOpDeviceLost
    };

1150 1151
    enum Feature {
        MultisampleTexture = 1,
1152
        MultisampleRenderBuffer,
1153
        DebugMarkers,
1154 1155
        Timestamps,
        Instancing,
1156
        CustomInstanceStepRate,
1157
        PrimitiveRestart
1158 1159
    };

1160 1161 1162 1163 1164
    enum ResourceSizeLimit {
        TextureSizeMin = 1,
        TextureSizeMax
    };

1165 1166
    ~QRhi();

1167 1168 1169 1170
    static QRhi *create(Implementation impl,
                        QRhiInitParams *params,
                        Flags flags = Flags(),
                        QRhiNativeHandles *importDevice = nullptr);
1171

1172 1173
    QRhiGraphicsPipeline *newGraphicsPipeline();
    QRhiShaderResourceBindings *newShaderResourceBindings();
1174

1175 1176 1177
    QRhiBuffer *newBuffer(QRhiBuffer::Type type,
                          QRhiBuffer::UsageFlags usage,
                          int size);
1178

1179 1180 1181
    QRhiRenderBuffer *newRenderBuffer(QRhiRenderBuffer::Type type,
                                      const QSize &pixelSize,
                                      int sampleCount = 1,
Laszlo Agocs's avatar
Laszlo Agocs committed
1182
                                      QRhiRenderBuffer::Flags flags = QRhiRenderBuffer::Flags());
1183

1184 1185
    QRhiTexture *newTexture(QRhiTexture::Format format,
                            const QSize &pixelSize,
Laszlo Agocs's avatar
Laszlo Agocs committed
1186
                            int sampleCount = 1,
1187
                            QRhiTexture::Flags flags = QRhiTexture::Flags());
1188

1189 1190 1191
    QRhiSampler *newSampler(QRhiSampler::Filter magFilter, QRhiSampler::Filter minFilter,
                            QRhiSampler::Filter mipmapMode,
                            QRhiSampler::AddressMode u, QRhiSampler::AddressMode v, QRhiSampler::AddressMode w = QRhiSampler::ClampToEdge);
1192

1193 1194
    QRhiTextureRenderTarget *newTextureRenderTarget(const QRhiTextureRenderTargetDescription &desc,
                                                    QRhiTextureRenderTarget::Flags flags = QRhiTextureRenderTarget::Flags());
1195

1196
    QRhiSwapChain *newSwapChain();
1197 1198 1199
    FrameOpResult beginFrame(QRhiSwapChain *swapChain);
    FrameOpResult endFrame(QRhiSwapChain *swapChain);

1200
    FrameOpResult beginOffscreenFrame(QRhiCommandBuffer **cb);
1201 1202 1203
    FrameOpResult endOffscreenFrame();

    QRhi::FrameOpResult finish();
1204

1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
    QRhiResourceUpdateBatch *nextResourceUpdateBatch();

    QVector<int> supportedSampleCounts() const;

    int ubufAlignment() const;
    int ubufAligned(int v) const;

    int mipLevelsForSize(const QSize &size) const;
    QSize sizeForMipLevel(int mipLevel, const QSize &baseLevelSize) const;

    bool isYUpInFramebuffer() const;

    QMatrix4x4 clipSpaceCorrMatrix() const;

1219
    bool isTextureFormatSupported(QRhiTexture::Format format, QRhiTexture::Flags flags = QRhiTexture::Flags()) const;
1220
    bool isFeatureSupported(QRhi::Feature feature) const;
1221
    int resourceSizeLimit(ResourceSizeLimit limit) const;
1222

1223 1224
    const QRhiNativeHandles *nativeHandles();

1225
    QRhiProfiler *profiler();
1226

1227 1228 1229 1230 1231 1232 1233 1234
protected:
    QRhi();

private:
    Q_DISABLE_COPY(QRhi)
    QRhiImplementation *d = nullptr;
};

1235 1236
Q_DECLARE_OPERATORS_FOR_FLAGS(QRhi::Flags)

1237 1238 1239
QT_END_NAMESPACE

#endif