qrhi.h 36.4 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

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

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

private:
    QVector4D m_rgba;
76 77 78 79
};

Q_DECLARE_TYPEINFO(QRhiColorClearValue, Q_MOVABLE_TYPE);

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

    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;
95 96 97 98
};

Q_DECLARE_TYPEINFO(QRhiDepthStencilClearValue, Q_MOVABLE_TYPE);

Laszlo Agocs's avatar
Laszlo Agocs committed
99
class Q_RHI_EXPORT QRhiViewport
100
{
Laszlo Agocs's avatar
Laszlo Agocs committed
101
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
102
    QRhiViewport()
Laszlo Agocs's avatar
Laszlo Agocs committed
103
        : m_rect(0, 0, 1280, 720), m_minDepth(0), m_maxDepth(1)
Laszlo Agocs's avatar
Laszlo Agocs committed
104
    { }
Laszlo Agocs's avatar
Laszlo Agocs committed
105 106
    QRhiViewport(float x, float y, float w, float h, float minDepth = 0.0f, float maxDepth = 1.0f)
        : m_rect(x, y, w, h), m_minDepth(minDepth), m_maxDepth(maxDepth)
107
    { }
Laszlo Agocs's avatar
Laszlo Agocs committed
108 109 110 111 112 113 114 115 116 117 118 119 120 121

    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;
122 123 124 125
};

Q_DECLARE_TYPEINFO(QRhiViewport, Q_MOVABLE_TYPE);

Laszlo Agocs's avatar
Laszlo Agocs committed
126
class Q_RHI_EXPORT QRhiScissor
127
{
Laszlo Agocs's avatar
Laszlo Agocs committed
128
public:
129 130
    QRhiScissor() { }
    QRhiScissor(int x, int y, int w, int h)
Laszlo Agocs's avatar
Laszlo Agocs committed
131
        : m_rect(x, y, w, h)
132
    { }
Laszlo Agocs's avatar
Laszlo Agocs committed
133 134 135 136 137 138

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

private:
    QVector4D m_rect;
139 140 141 142
};

Q_DECLARE_TYPEINFO(QRhiScissor, Q_MOVABLE_TYPE);

Laszlo Agocs's avatar
Laszlo Agocs committed
143
class Q_RHI_EXPORT QRhiVertexInputBinding
144
{
Laszlo Agocs's avatar
Laszlo Agocs committed
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
public:
    enum Classification {
        PerVertex,
        PerInstance
    };

    QRhiVertexInputBinding() { }
    QRhiVertexInputBinding(quint32 stride, Classification cls = PerVertex, int stepRate = 1)
        : m_stride(stride), m_classification(cls), m_instanceStepRate(stepRate)
    { }

    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;
169
    Q_DECL_UNUSED_MEMBER void *m_reserved;
Laszlo Agocs's avatar
Laszlo Agocs committed
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
};

Q_DECLARE_TYPEINFO(QRhiVertexInputBinding, Q_MOVABLE_TYPE);

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

    QRhiVertexInputAttribute() { }
    QRhiVertexInputAttribute(int binding, int location, Format format, quint32 offset)
        : m_binding(binding), m_location(location), m_format(format), m_offset(offset)
    { }

    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;
209
    Q_DECL_UNUSED_MEMBER void *m_reserved;
Laszlo Agocs's avatar
Laszlo Agocs committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
};

Q_DECLARE_TYPEINFO(QRhiVertexInputAttribute, Q_MOVABLE_TYPE);

class Q_RHI_EXPORT QRhiVertexInputLayout
{
public:
    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;
226
    Q_DECL_UNUSED_MEMBER void *m_reserved;
227 228 229 230
};

Q_DECLARE_TYPEINFO(QRhiVertexInputLayout, Q_MOVABLE_TYPE);

Laszlo Agocs's avatar
Laszlo Agocs committed
231
class Q_RHI_EXPORT QRhiGraphicsShaderStage
232
{
Laszlo Agocs's avatar
Laszlo Agocs committed
233
public:
234 235 236
    enum Type {
        Vertex,
        Fragment,
237 238
        TessellationControl,
        TessellationEvaluation
239 240 241
    };

    QRhiGraphicsShaderStage() { }
Laszlo Agocs's avatar
Laszlo Agocs committed
242 243
    QRhiGraphicsShaderStage(Type type, const QBakedShader &shader)
        : m_type(type), m_shader(shader)
244 245
    { }

Laszlo Agocs's avatar
Laszlo Agocs committed
246 247 248 249 250 251 252 253 254
    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;
255
    Q_DECL_UNUSED_MEMBER void *m_reserved;
256 257 258 259
};

Q_DECLARE_TYPEINFO(QRhiGraphicsShaderStage, Q_MOVABLE_TYPE);

260
class Q_RHI_EXPORT QRhiShaderResourceBinding
Laszlo Agocs's avatar
Laszlo Agocs committed
261
{
262
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
263 264 265 266 267 268 269 270
    enum Type {
        UniformBuffer,
        SampledTexture
    };

    enum StageFlag {
        VertexStage = 1 << 0,
        FragmentStage = 1 << 1,
271 272
        TessellationControlStage = 1 << 2,
        TessellationEvaluationStage = 1 << 3
Laszlo Agocs's avatar
Laszlo Agocs committed
273 274 275
    };
    Q_DECLARE_FLAGS(StageFlags, StageFlag)

276 277 278 279 280 281 282 283 284 285 286 287 288
    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
289 290 291 292 293
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiShaderResourceBinding::StageFlags)
Q_DECLARE_TYPEINFO(QRhiShaderResourceBinding, Q_MOVABLE_TYPE);

Laszlo Agocs's avatar
Laszlo Agocs committed
294
class Q_RHI_EXPORT QRhiColorAttachment
Laszlo Agocs's avatar
Laszlo Agocs committed
295
{
Laszlo Agocs's avatar
Laszlo Agocs committed
296 297 298 299
public:
    QRhiColorAttachment() { }
    QRhiColorAttachment(QRhiTexture *texture) : m_texture(texture) { }
    QRhiColorAttachment(QRhiRenderBuffer *renderBuffer) : m_renderBuffer(renderBuffer) { }
300

Laszlo Agocs's avatar
Laszlo Agocs committed
301 302
    QRhiTexture *texture() const { return m_texture; }
    void setTexture(QRhiTexture *tex) { m_texture = tex; }
303

Laszlo Agocs's avatar
Laszlo Agocs committed
304 305
    QRhiRenderBuffer *renderBuffer() const { return m_renderBuffer; }
    void setRenderBuffer(QRhiRenderBuffer *rb) { m_renderBuffer = rb; }
306

Laszlo Agocs's avatar
Laszlo Agocs committed
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
    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;
330
    Q_DECL_UNUSED_MEMBER void *m_reserved;
Laszlo Agocs's avatar
Laszlo Agocs committed
331 332 333 334 335 336 337
};

Q_DECLARE_TYPEINFO(QRhiColorAttachment, Q_MOVABLE_TYPE);

class Q_RHI_EXPORT QRhiTextureRenderTargetDescription
{
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
338 339
    QRhiTextureRenderTargetDescription()
    { }
Laszlo Agocs's avatar
Laszlo Agocs committed
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
    QRhiTextureRenderTargetDescription(const QRhiColorAttachment &colorAttachment)
    { m_colorAttachments.append(colorAttachment); }
    QRhiTextureRenderTargetDescription(const QRhiColorAttachment &colorAttachment, QRhiRenderBuffer *depthStencilBuffer)
        : m_depthStencilBuffer(depthStencilBuffer)
    { m_colorAttachments.append(colorAttachment); }
    QRhiTextureRenderTargetDescription(const QRhiColorAttachment &colorAttachment, QRhiTexture *depthTexture)
        : m_depthTexture(depthTexture)
    { m_colorAttachments.append(colorAttachment); }

    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;
362
    Q_DECL_UNUSED_MEMBER void *m_reserved;
Laszlo Agocs's avatar
Laszlo Agocs committed
363 364 365 366
};

Q_DECLARE_TYPEINFO(QRhiTextureRenderTargetDescription, Q_MOVABLE_TYPE);

367
class Q_RHI_EXPORT QRhiTextureMipLevel
Laszlo Agocs's avatar
Laszlo Agocs committed
368
{
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
public:
    QRhiTextureMipLevel() { }
    QRhiTextureMipLevel(const QImage &image) : m_image(image) { }
    QRhiTextureMipLevel(const QByteArray &compressedData) : m_compressedData(compressedData) { }

    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;
395
    Q_DECL_UNUSED_MEMBER void *m_reserved;
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
};

Q_DECLARE_TYPEINFO(QRhiTextureMipLevel, Q_MOVABLE_TYPE);

class Q_RHI_EXPORT QRhiTextureLayer
{
public:
    QRhiTextureLayer() { }
    QRhiTextureLayer(const QVector<QRhiTextureMipLevel> &mipImages) : m_mipImages(mipImages) { }

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

private:
    QVector<QRhiTextureMipLevel> m_mipImages;
411
    Q_DECL_UNUSED_MEMBER void *m_reserved;
412
};
413

414 415 416 417 418
Q_DECLARE_TYPEINFO(QRhiTextureLayer, Q_MOVABLE_TYPE);

class Q_RHI_EXPORT QRhiTextureUploadDescription
{
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
419
    QRhiTextureUploadDescription() { }
420 421 422 423 424 425 426
    QRhiTextureUploadDescription(const QVector<QRhiTextureLayer> &layers) : m_layers(layers) { }

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

private:
    QVector<QRhiTextureLayer> m_layers;
427
    Q_DECL_UNUSED_MEMBER void *m_reserved;
Laszlo Agocs's avatar
Laszlo Agocs committed
428 429 430 431
};

Q_DECLARE_TYPEINFO(QRhiTextureUploadDescription, Q_MOVABLE_TYPE);

432
class Q_RHI_EXPORT QRhiTextureCopyDescription
433
{
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
public:
    QRhiTextureCopyDescription() { }

    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; }
451

452 453 454 455 456 457 458 459 460 461 462 463 464 465
    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;
466
    Q_DECL_UNUSED_MEMBER void *m_reserved;
467 468 469 470
};

Q_DECLARE_TYPEINFO(QRhiTextureCopyDescription, Q_MOVABLE_TYPE);

471
class Q_RHI_EXPORT QRhiReadbackDescription
Laszlo Agocs's avatar
Laszlo Agocs committed
472
{
473
public:
474
    QRhiReadbackDescription() { }
475 476 477 478 479 480 481
    QRhiReadbackDescription(QRhiTexture *texture) : m_texture(texture) { }

    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; }
482

483 484 485 486 487 488 489
    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;
490
    Q_DECL_UNUSED_MEMBER void *m_reserved;
Laszlo Agocs's avatar
Laszlo Agocs committed
491 492
};

493 494
Q_DECLARE_TYPEINFO(QRhiReadbackDescription, Q_MOVABLE_TYPE);

495 496 497 498
struct Q_RHI_EXPORT QRhiNativeHandles
{
};

499 500 501 502
class Q_RHI_EXPORT QRhiResource
{
public:
    virtual ~QRhiResource();
503

504 505 506
    virtual void release() = 0;
    void releaseAndDestroy();

507 508 509
    QByteArray name() const;
    void setName(const QByteArray &name);

510 511 512
protected:
    QRhiResource(QRhiImplementation *rhi_);
    Q_DISABLE_COPY(QRhiResource)
513 514
    QRhiImplementation *rhi = nullptr;
    QByteArray objectName;
515 516 517 518 519 520
};

class Q_RHI_EXPORT QRhiBuffer : public QRhiResource
{
public:
    enum Type {
521 522 523
        Immutable,
        Static,
        Dynamic
524 525 526 527 528 529 530 531 532
    };

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

Laszlo Agocs's avatar
Laszlo Agocs committed
533 534 535 536 537 538 539 540
    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; }
541 542 543 544 545

    virtual bool build() = 0;

protected:
    QRhiBuffer(QRhiImplementation *rhi, Type type_, UsageFlags usage_, int size_);
Laszlo Agocs's avatar
Laszlo Agocs committed
546 547
    Type m_type;
    UsageFlags m_usage;
548
    int m_size;
549
    Q_DECL_UNUSED_MEMBER void *m_reserved;
550 551 552 553 554 555 556 557 558
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiBuffer::UsageFlags)

class Q_RHI_EXPORT QRhiTexture : public QRhiResource
{
public:
    enum Flag {
        RenderTarget = 1 << 0,
559
        ChangesFrequently = 1 << 1,
560
        CubeMap = 1 << 2,
561
        MipMapped = 1 << 3,
562
        sRGB = 1 << 4,
563
        UsedAsTransferSource = 1 << 5,
564
        UsedWithGenerateMips = 1 << 6
565 566 567 568
    };
    Q_DECLARE_FLAGS(Flags, Flag)

    enum Format {
569 570
        UnknownFormat,

571 572 573 574 575 576
        RGBA8,
        BGRA8,
        R8,
        R16,

        D16,
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
        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
605 606
    };

Laszlo Agocs's avatar
Laszlo Agocs committed
607 608 609 610 611 612 613 614
    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; }
615

Laszlo Agocs's avatar
Laszlo Agocs committed
616 617 618
    int sampleCount() const { return m_sampleCount; }
    void setSampleCount(int s) { m_sampleCount = s; }

619
    virtual bool build() = 0;
620 621
    virtual const QRhiNativeHandles *nativeHandles();
    virtual bool buildFrom(const QRhiNativeHandles *src);
622

623
protected:
Laszlo Agocs's avatar
Laszlo Agocs committed
624 625
    QRhiTexture(QRhiImplementation *rhi, Format format_, const QSize &pixelSize_,
                int sampleCount_, Flags flags_);
Laszlo Agocs's avatar
Laszlo Agocs committed
626 627
    Format m_format;
    QSize m_pixelSize;
Laszlo Agocs's avatar
Laszlo Agocs committed
628
    int m_sampleCount;
Laszlo Agocs's avatar
Laszlo Agocs committed
629
    Flags m_flags;
630
    Q_DECL_UNUSED_MEMBER void *m_reserved;
631 632 633 634 635 636 637 638
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiTexture::Flags)

class Q_RHI_EXPORT QRhiSampler : public QRhiResource
{
public:
    enum Filter {
639
        None,
640 641 642 643 644 645 646 647 648 649 650 651
        Nearest,
        Linear
    };

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

Laszlo Agocs's avatar
Laszlo Agocs committed
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
    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; }
669 670 671 672 673 674 675

    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
676 677 678 679 680 681
    Filter m_magFilter;
    Filter m_minFilter;
    Filter m_mipmapMode;
    AddressMode m_addressU;
    AddressMode m_addressV;
    AddressMode m_addressW;
682
    Q_DECL_UNUSED_MEMBER void *m_reserved;
683 684
};

Laszlo Agocs's avatar
Laszlo Agocs committed
685 686 687 688 689 690 691 692 693
class Q_RHI_EXPORT QRhiRenderBuffer : public QRhiResource
{
public:
    enum Type {
        DepthStencil,
        Color
    };

    enum Flag {
694
        UsedWithSwapChainOnly = 1 << 0
Laszlo Agocs's avatar
Laszlo Agocs committed
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
    };
    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;
721
    Q_DECL_UNUSED_MEMBER void *m_reserved;
Laszlo Agocs's avatar
Laszlo Agocs committed
722 723 724 725
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiRenderBuffer::Flags)

726
class Q_RHI_EXPORT QRhiRenderPassDescriptor : public QRhiResource
727 728
{
protected:
729
    QRhiRenderPassDescriptor(QRhiImplementation *rhi);
730
    Q_DECL_UNUSED_MEMBER void *m_reserved;
731 732 733 734 735 736 737 738 739 740 741 742
};

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
743
    virtual float devicePixelRatio() const = 0;
Laszlo Agocs's avatar
Laszlo Agocs committed
744

745 746
    QRhiRenderPassDescriptor *renderPassDescriptor() const { return m_renderPassDesc; }
    void setRenderPassDescriptor(QRhiRenderPassDescriptor *desc) { m_renderPassDesc = desc; }
747 748 749

protected:
    QRhiRenderTarget(QRhiImplementation *rhi);
750
    QRhiRenderPassDescriptor *m_renderPassDesc = nullptr;
751
    Q_DECL_UNUSED_MEMBER void *m_reserved;
752 753 754 755 756 757
};

class Q_RHI_EXPORT QRhiTextureRenderTarget : public QRhiRenderTarget
{
public:
    enum Flag {
758 759
        PreserveColorContents = 1 << 0,
        PreserveDepthStencilContents = 1 << 1
760 761 762
    };
    Q_DECLARE_FLAGS(Flags, Flag)

Laszlo Agocs's avatar
Laszlo Agocs committed
763 764
    QRhiTextureRenderTargetDescription description() const { return m_desc; }
    void setDescription(const QRhiTextureRenderTargetDescription &desc) { m_desc = desc; }
765

Laszlo Agocs's avatar
Laszlo Agocs committed
766 767 768
    Flags flags() const { return m_flags; }
    void setFlags(Flags f) { m_flags = f; }

769
    virtual QRhiRenderPassDescriptor *newCompatibleRenderPassDescriptor() = 0;
Laszlo Agocs's avatar
Laszlo Agocs committed
770

771 772 773 774
    virtual bool build() = 0;

protected:
    QRhiTextureRenderTarget(QRhiImplementation *rhi, const QRhiTextureRenderTargetDescription &desc_, Flags flags_);
Laszlo Agocs's avatar
Laszlo Agocs committed
775 776
    QRhiTextureRenderTargetDescription m_desc;
    Flags m_flags;
777 778 779 780 781 782 783
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiTextureRenderTarget::Flags)

class Q_RHI_EXPORT QRhiShaderResourceBindings : public QRhiResource
{
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
784 785
    QVector<QRhiShaderResourceBinding> bindings() const { return m_bindings; }
    void setBindings(const QVector<QRhiShaderResourceBinding> &b) { m_bindings = b; }
786 787 788 789 790

    virtual bool build() = 0;

protected:
    QRhiShaderResourceBindings(QRhiImplementation *rhi);
Laszlo Agocs's avatar
Laszlo Agocs committed
791
    QVector<QRhiShaderResourceBinding> m_bindings;
792
    Q_DECL_UNUSED_MEMBER void *m_reserved;
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
};

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
    };

813
    enum CullMode {
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 891 892 893 894 895 896 897 898 899 900 901
        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
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 942 943 944 945 946 947 948 949 950 951 952
    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; }

953 954
    QRhiRenderPassDescriptor *renderPassDescriptor() const { return m_renderPassDesc; }
    void setRenderPassDescriptor(QRhiRenderPassDescriptor *desc) { m_renderPassDesc = desc; }
955 956 957 958 959

    virtual bool build() = 0;

protected:
    QRhiGraphicsPipeline(QRhiImplementation *rhi);
Laszlo Agocs's avatar
Laszlo Agocs committed
960 961 962 963
    Flags m_flags;
    Topology m_topology = Triangles;
    CullMode m_cullMode = None;
    FrontFace m_frontFace = CCW;
964
    QVector<TargetBlend> m_targetBlends;
Laszlo Agocs's avatar
Laszlo Agocs committed
965 966 967 968 969 970
    bool m_depthTest = false;
    bool m_depthWrite = false;
    CompareOp m_depthOp = Less;
    bool m_stencilTest = false;
    StencilOpState m_stencilFront;
    StencilOpState m_stencilBack;
971 972 973
    quint32 m_stencilReadMask = 0xFF;
    quint32 m_stencilWriteMask = 0xFF;
    int m_sampleCount = 1;
Laszlo Agocs's avatar
Laszlo Agocs committed
974 975
    QVector<QRhiGraphicsShaderStage> m_shaderStages;
    QRhiVertexInputLayout m_vertexInputLayout;
976
    QRhiShaderResourceBindings *m_shaderResourceBindings = nullptr;
977
    QRhiRenderPassDescriptor *m_renderPassDesc = nullptr;
978
    Q_DECL_UNUSED_MEMBER void *m_reserved;
979 980 981 982 983 984 985 986 987
};

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:
988
    enum Flag {
989
        SurfaceHasPreMulAlpha = 1 << 0,
990
        SurfaceHasNonPreMulAlpha = 1 << 1,
991
        sRGB = 1 << 2,
992 993
        UsedAsTransferSource = 1 << 3,
        NoVSync = 1 << 4
994
    };
995
    Q_DECLARE_FLAGS(Flags, Flag)
996

Laszlo Agocs's avatar
Laszlo Agocs committed
997 998 999
    QWindow *window() const { return m_window; }
    void setWindow(QWindow *window) { m_window = window; }

1000 1001
    Flags flags() const { return m_flags; }
    void setFlags(Flags f) { m_flags = f; }
Laszlo Agocs's avatar
Laszlo Agocs committed
1002 1003 1004 1005 1006 1007 1008

    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; }

1009 1010
    QRhiRenderPassDescriptor *renderPassDescriptor() const { return m_renderPassDesc; }
    void setRenderPassDescriptor(QRhiRenderPassDescriptor *desc) { m_renderPassDesc = desc; }
Laszlo Agocs's avatar
Laszlo Agocs committed
1011

Laszlo Agocs's avatar
Laszlo Agocs committed
1012 1013 1014
    QObject *target() const { return m_target; }
    void setTarget(QObject *obj) { m_target = obj; }

1015 1016
    QSize currentPixelSize() const { return m_currentPixelSize; }

1017 1018
    virtual QRhiCommandBuffer *currentFrameCommandBuffer() = 0;
    virtual QRhiRenderTarget *currentFrameRenderTarget() = 0;
1019
    virtual QSize surfacePixelSize() = 0;
1020
    virtual QRhiRenderPassDescriptor *newCompatibleRenderPassDescriptor() = 0;
Laszlo Agocs's avatar
Laszlo Agocs committed
1021
    virtual bool buildOrResize() = 0;
1022 1023 1024

protected:
    QRhiSwapChain(QRhiImplementation *rhi);
Laszlo Agocs's avatar
Laszlo Agocs committed
1025
    QWindow *m_window = nullptr;
1026
    Flags m_flags;
Laszlo Agocs's avatar
Laszlo Agocs committed
1027 1028
    QRhiRenderBuffer *m_depthStencil = nullptr;
    int m_sampleCount = 1;
1029
    QRhiRenderPassDescriptor *m_renderPassDesc = nullptr;
Laszlo Agocs's avatar
Laszlo Agocs committed
1030
    QObject *m_target = nullptr;
1031
    QSize m_currentPixelSize;
1032
    Q_DECL_UNUSED_MEMBER void *m_reserved;
1033 1034
};

1035
Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiSwapChain::Flags)
1036

1037 1038 1039 1040 1041 1042 1043 1044
class Q_RHI_EXPORT QRhiCommandBuffer : public QRhiResource
{
public:
    enum IndexFormat {
        IndexUInt16,
        IndexUInt32
    };

1045 1046
    void resourceUpdate(QRhiResourceUpdateBatch *resourceUpdates);

1047
    void beginPass(QRhiRenderTarget *rt,
1048 1049
                   const QRhiColorClearValue &colorClearValue,
                   const QRhiDepthStencilClearValue &depthStencilClearValue,
1050
                   QRhiResourceUpdateBatch *resourceUpdates = nullptr);
1051
    void endPass(QRhiResourceUpdateBatch *resourceUpdates = nullptr);
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076

    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);

1077 1078 1079 1080
    void debugMarkBegin(const QByteArray &name);
    void debugMarkEnd();
    void debugMarkMsg(const QByteArray &msg);

1081 1082
protected:
    QRhiCommandBuffer(QRhiImplementation *rhi);
1083
    Q_DECL_UNUSED_MEMBER void *m_reserved;
1084 1085 1086 1087 1088 1089 1090 1091 1092
};

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

1094
class Q_RHI_EXPORT QRhiResourceUpdateBatch
1095 1096
{
public:
1097 1098 1099 1100 1101 1102
    enum TexturePrepareFlag {
        TextureRead = 1 << 0,
        TextureWrite = 1 << 1
    };
    Q_DECLARE_FLAGS(TexturePrepareFlags, TexturePrepareFlag)

1103
    ~QRhiResourceUpdateBatch();
1104

1105 1106
    void release();

1107 1108
    void merge(QRhiResourceUpdateBatch *other);

1109
    void updateDynamicBuffer(QRhiBuffer *buf, int offset, int size, const void *data);
1110
    void uploadStaticBuffer(QRhiBuffer *buf, int offset, int size, const void *data);
1111
    void uploadStaticBuffer(QRhiBuffer *buf, const void *data);
Laszlo Agocs's avatar
Laszlo Agocs committed
1112
    void uploadTexture(QRhiTexture *tex, const QRhiTextureUploadDescription &desc);
1113
    void uploadTexture(QRhiTexture *tex, const QImage &image);
1114
    void copyTexture(QRhiTexture *dst, QRhiTexture *src, const QRhiTextureCopyDescription &desc = QRhiTextureCopyDescription());
1115
    void readBackTexture(const QRhiReadbackDescription &rb, QRhiReadbackResult *result);
1116
    void generateMips(QRhiTexture *tex);
1117

1118 1119
    void prepareTextureForUse(QRhiTexture *tex, TexturePrepareFlags flags);

1120 1121 1122 1123
private:
    QRhiResourceUpdateBatch(QRhiImplementation *rhi);
    Q_DISABLE_COPY(QRhiResourceUpdateBatch)
    QRhiResourceUpdateBatchPrivate *d;
Laszlo Agocs's avatar
Laszlo Agocs committed
1124
    friend class QRhiResourceUpdateBatchPrivate;
1125 1126 1127
    friend class QRhi;
};

1128 1129
Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiResourceUpdateBatch::TexturePrepareFlags)

1130 1131 1132 1133 1134 1135 1136 1137
struct Q_RHI_EXPORT QRhiInitParams
{
};

class Q_RHI_EXPORT QRhi
{
public:
    enum Implementation {
Laszlo Agocs's avatar
Laszlo Agocs committed
1138
        Null,
1139 1140 1141 1142 1143 1144
        Vulkan,
        OpenGLES2,
        D3D11,
        Metal
    };

1145
    enum Flag {
1146 1147
        EnableProfiling = 1 << 0,
        EnableDebugMarkers = 1 << 1
1148 1149 1150
    };
    Q_DECLARE_FLAGS(Flags, Flag)

1151 1152 1153 1154 1155 1156 1157
    enum FrameOpResult {
        FrameOpSuccess = 0,
        FrameOpError,
        FrameOpSwapChainOutOfDate,
        FrameOpDeviceLost
    };

1158 1159
    enum Feature {
        MultisampleTexture = 1,
1160
        MultisampleRenderBuffer,
1161
        DebugMarkers,
1162 1163
        Timestamps,
        Instancing,
1164 1165
        CustomInstanceStepRate,
        PrimitiveRestart
1166 1167
    };

1168 1169 1170 1171 1172
    enum ResourceSizeLimit {
        TextureSizeMin = 1,
        TextureSizeMax
    };

1173 1174
    ~QRhi();

1175
    static QRhi *create(Implementation impl, QRhiInitParams *params, Flags flags = Flags());
1176

1177 1178
    QRhiGraphicsPipeline *newGraphicsPipeline();
    QRhiShaderResourceBindings *newShaderResourceBindings();
1179

1180 1181 1182
    QRhiBuffer *newBuffer(QRhiBuffer::Type type,
                          QRhiBuffer::UsageFlags usage,
                          int size);
1183

1184 1185 1186
    QRhiRenderBuffer *newRenderBuffer(QRhiRenderBuffer::Type type,
                                      const QSize &pixelSize,
                                      int sampleCount = 1,
Laszlo Agocs's avatar
Laszlo Agocs committed
1187
                                      QRhiRenderBuffer::Flags flags = QRhiRenderBuffer::Flags());
1188

1189 1190
    QRhiTexture *newTexture(QRhiTexture::Format format,
                            const QSize &pixelSize,
Laszlo Agocs's avatar
Laszlo Agocs committed
1191
                            int sampleCount = 1,
1192
                            QRhiTexture::Flags flags = QRhiTexture::Flags());
1193

1194 1195 1196
    QRhiSampler *newSampler(QRhiSampler::Filter magFilter, QRhiSampler::Filter minFilter,
                            QRhiSampler::Filter mipmapMode,
                            QRhiSampler::AddressMode u, QRhiSampler::AddressMode v, QRhiSampler::AddressMode w = QRhiSampler::ClampToEdge);
1197

1198 1199
    QRhiTextureRenderTarget *newTextureRenderTarget(const QRhiTextureRenderTargetDescription &desc,
                                                    QRhiTextureRenderTarget::Flags flags = QRhiTextureRenderTarget::Flags());
1200

1201
    QRhiSwapChain *newSwapChain();
1202 1203 1204
    FrameOpResult beginFrame(QRhiSwapChain *swapChain);
    FrameOpResult endFrame(QRhiSwapChain *swapChain);

1205
    FrameOpResult beginOffscreenFrame(QRhiCommandBuffer **cb);
1206 1207 1208
    FrameOpResult endOffscreenFrame();

    QRhi::FrameOpResult finish();
1209

1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
    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;

1224
    bool isTextureFormatSupported(QRhiTexture::Format format, QRhiTexture::Flags flags = QRhiTexture::Flags()) const;
1225
    bool isFeatureSupported(QRhi::Feature feature) const;
1226
    int resourceSizeLimit(ResourceSizeLimit limit) const;
1227

1228 1229
    const QRhiNativeHandles *nativeHandles();

1230
    QRhiProfiler *profiler();
1231

1232 1233 1234 1235 1236 1237 1238 1239
protected:
    QRhi();

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

1240 1241
Q_DECLARE_OPERATORS_FOR_FLAGS(QRhi::Flags)

1242 1243 1244
QT_END_NAMESPACE

#endif