qrhi.h 41.9 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
struct QRhiResourceUpdateBatchPrivate;
61

62 63 64 65 66 67 68 69
// C++ object ownership rules:
//   1. new*() and create() return value owned by the caller.
//   2. next*() return value not owned by the caller.
//   3. Passing a pointer via set*() or the structs does not transfer ownership.
//   4. release() does not destroy the C++ object. releaseAndDestroy() does, and is equivalent to o->release(); delete o;
//
// Graphics resource ownership rules:
//   1. new*() does not create underlying graphics resources. build() does.
70 71 72
//   2. Except: new*Descriptor() implicitly "builds". (no build() for QRhiRenderPassDescriptor f.ex.)
//   3. release() schedules graphics resources for destruction. The C++ object is reusable immediately via build(), or can be destroyed.
//   4. build() on an already built object calls release() implicitly. Except swapchains. (buildOrResize - special semantics)
73 74 75 76 77
//   5. Ownership of resources imported via QRhi*InitParams is not taken.
//
// Other:
//   1. QRhiResourceUpdateBatch manages no graphics resources underneath. beginPass() implicitly calls release() on the batch.

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
struct Q_RHI_EXPORT QRhiColorClearValue
{
    QRhiColorClearValue() : rgba(0, 0, 0, 1) { }
    explicit QRhiColorClearValue(const QVector4D &rgba_) : rgba(rgba_) { }
    QRhiColorClearValue(float r, float g, float b, float a) : rgba(r, g, b, a) { }
    QVector4D rgba;
};

Q_DECLARE_TYPEINFO(QRhiColorClearValue, Q_MOVABLE_TYPE);

struct Q_RHI_EXPORT QRhiDepthStencilClearValue
{
    QRhiDepthStencilClearValue() : d(1), s(0) { }
    QRhiDepthStencilClearValue(float d_, quint32 s_) : d(d_), s(s_) { }
    float d;
    quint32 s;
};

Q_DECLARE_TYPEINFO(QRhiDepthStencilClearValue, Q_MOVABLE_TYPE);

struct Q_RHI_EXPORT QRhiViewport
{
    QRhiViewport() { }
    // x,y is bottom-left, like in OpenGL, regardless of what isYUpInFramebuffer() says
    QRhiViewport(float x, float y, float w, float h, float minDepth_ = 0.0f, float maxDepth_ = 1.0f)
        : r(x, y, w, h), minDepth(minDepth_), maxDepth(maxDepth_)
    { }
    QVector4D r;
    float minDepth;
    float maxDepth;
};

Q_DECLARE_TYPEINFO(QRhiViewport, Q_MOVABLE_TYPE);

struct Q_RHI_EXPORT QRhiScissor
{
    QRhiScissor() { }
    // x,y is bottom-left, like in OpenGL, regardless of what isYUpInFramebuffer() says
    QRhiScissor(int x, int y, int w, int h)
        : r(x, y, w, h)
    { }
    QVector4D r;
};

Q_DECLARE_TYPEINFO(QRhiScissor, Q_MOVABLE_TYPE);

struct Q_RHI_EXPORT QRhiVertexInputLayout
{
    struct Q_RHI_EXPORT Binding {
        enum Classification {
            PerVertex,
            PerInstance
        };
        Binding() { }
132 133
        Binding(quint32 stride_, Classification cls = PerVertex, int stepRate = 1)
            : stride(stride_), classification(cls), instanceStepRate(stepRate)
134
        { }
Laszlo Agocs's avatar
Laszlo Agocs committed
135
        quint32 stride; // must be a multiple of 4
136
        Classification classification;
137
        int instanceStepRate;
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
    };

    struct Q_RHI_EXPORT Attribute {
        enum Format {
            Float4,
            Float3,
            Float2,
            Float,
            UNormByte4,
            UNormByte2,
            UNormByte
        };
        Attribute() { }
        Attribute(int binding_, int location_, Format format_, quint32 offset_)
            : binding(binding_), location(location_), format(format_), offset(offset_)
        { }
        int binding;
        // With HLSL we assume the vertex shader uses TEXCOORD<location> as the
        // semantic for each input. Hence no separate semantic name and index.
        int location;
        Format format;
        quint32 offset;
    };

    QVector<Binding> bindings; // slots
    QVector<Attribute> attributes;
};

Q_DECLARE_TYPEINFO(QRhiVertexInputLayout::Binding, Q_MOVABLE_TYPE);
Q_DECLARE_TYPEINFO(QRhiVertexInputLayout::Attribute, Q_MOVABLE_TYPE);
Q_DECLARE_TYPEINFO(QRhiVertexInputLayout, Q_MOVABLE_TYPE);

struct Q_RHI_EXPORT QRhiGraphicsShaderStage
{
    enum Type {
        Vertex,
        Fragment,
        TessellationControl, // Hull
        TessellationEvaluation // Domain
177
        // yes, no geometry shaders (Metal does not have them)
178 179 180 181 182 183 184 185 186 187 188 189 190
    };

    QRhiGraphicsShaderStage() { }
    QRhiGraphicsShaderStage(Type type_, const QBakedShader &shader_)
        : type(type_), shader(shader_)
    { }

    Type type;
    QBakedShader shader;
};

Q_DECLARE_TYPEINFO(QRhiGraphicsShaderStage, Q_MOVABLE_TYPE);

Laszlo Agocs's avatar
Laszlo Agocs committed
191 192 193 194 195 196 197 198 199 200
struct Q_RHI_EXPORT QRhiShaderResourceBinding
{
    enum Type {
        UniformBuffer,
        SampledTexture
    };

    enum StageFlag {
        VertexStage = 1 << 0,
        FragmentStage = 1 << 1,
201 202
        TessellationControlStage = 1 << 2,
        TessellationEvaluationStage = 1 << 3
Laszlo Agocs's avatar
Laszlo Agocs committed
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
    };
    Q_DECLARE_FLAGS(StageFlags, StageFlag)

    static QRhiShaderResourceBinding uniformBuffer(int binding_, StageFlags stage_, QRhiBuffer *buf_);

    // Bind a region only. Up to the user to ensure offset is aligned to ubufAlignment.
    static QRhiShaderResourceBinding uniformBuffer(int binding_, StageFlags stage_, QRhiBuffer *buf_, int offset_, int size_);

    static QRhiShaderResourceBinding sampledTexture(int binding_, StageFlags stage_, QRhiTexture *tex_, QRhiSampler *sampler_);

    int binding;
    StageFlags stage;
    Type type;
    struct UniformBufferData {
        QRhiBuffer *buf;
        int offset;
        int maybeSize;
    };
    struct SampledTextureData {
        QRhiTexture *tex;
        QRhiSampler *sampler;
    };
    union {
        UniformBufferData ubuf;
        SampledTextureData stex;
    };
};

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

struct Q_RHI_EXPORT QRhiTextureRenderTargetDescription
{
    struct Q_RHI_EXPORT ColorAttachment {
        ColorAttachment() { }
238
        // either a texture or a renderbuffer
Laszlo Agocs's avatar
Laszlo Agocs committed
239
        ColorAttachment(QRhiTexture *texture_) : texture(texture_) { }
240 241
        ColorAttachment(QRhiRenderBuffer *renderBuffer_) : renderBuffer(renderBuffer_) { }

Laszlo Agocs's avatar
Laszlo Agocs committed
242
        QRhiTexture *texture = nullptr;
243
        QRhiRenderBuffer *renderBuffer = nullptr;
Laszlo Agocs's avatar
Laszlo Agocs committed
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
        int layer = 0; // face (0..5) for cubemaps
    };

    QRhiTextureRenderTargetDescription()
    { }
    QRhiTextureRenderTargetDescription(const ColorAttachment &colorAttachment)
    { colorAttachments.append(colorAttachment); }
    QRhiTextureRenderTargetDescription(const ColorAttachment &colorAttachment, QRhiRenderBuffer *depthStencilBuffer_)
        : depthStencilBuffer(depthStencilBuffer_)
    { colorAttachments.append(colorAttachment); }
    QRhiTextureRenderTargetDescription(const ColorAttachment &colorAttachment, QRhiTexture *depthTexture_)
        : depthTexture(depthTexture_)
    { colorAttachments.append(colorAttachment); }

    QVector<ColorAttachment> colorAttachments;
259
    // depth-stencil is is a renderbuffer, a texture, or none
Laszlo Agocs's avatar
Laszlo Agocs committed
260 261 262 263 264 265 266 267 268 269 270 271
    QRhiRenderBuffer *depthStencilBuffer = nullptr;
    QRhiTexture *depthTexture = nullptr;
};

Q_DECLARE_TYPEINFO(QRhiTextureRenderTargetDescription::ColorAttachment, Q_MOVABLE_TYPE);
Q_DECLARE_TYPEINFO(QRhiTextureRenderTargetDescription, Q_MOVABLE_TYPE);

struct Q_RHI_EXPORT QRhiTextureUploadDescription
{
    struct Q_RHI_EXPORT Layer {
        struct Q_RHI_EXPORT MipLevel {
            MipLevel() { }
272
            // either a QImage or compressed data (not both)
Laszlo Agocs's avatar
Laszlo Agocs committed
273
            MipLevel(const QImage &image_) : image(image_) { }
274
            MipLevel(const QByteArray &compressedData_) : compressedData(compressedData_) { }
275

Laszlo Agocs's avatar
Laszlo Agocs committed
276
            QImage image;
277
            QByteArray compressedData;
278

279
            QPoint destinationTopLeft;
280 281 282 283 284 285 286 287 288 289 290 291 292 293

            // Empty = entire subresource. For uncompressed this then means the
            // size of the source image must match the subresource. When
            // non-empty, this size is used.
            //
            // Works for compressed as well, but the first compressed upload
            // must always match the subresource size (and sourceSize can be
            // left unset) due to gfx api limitations with some backends.
            QSize sourceSize;

            // This is only supported for uncompressed. Setting sourceSize or
            // sourceTopLeft may trigger a QImage copy internally (depending on
            // the format and the gfx api).
            QPoint sourceTopLeft;
Laszlo Agocs's avatar
Laszlo Agocs committed
294
        };
295

Laszlo Agocs's avatar
Laszlo Agocs committed
296 297 298 299
        Layer() { }
        Layer(const QVector<MipLevel> &mipImages_) : mipImages(mipImages_) { }
        QVector<MipLevel> mipImages;
    };
300

Laszlo Agocs's avatar
Laszlo Agocs committed
301 302 303 304 305 306 307 308 309
    QRhiTextureUploadDescription() { }
    QRhiTextureUploadDescription(const QVector<Layer> &layers_) : layers(layers_) { }
    QVector<Layer> layers; // 6 layers for cubemaps, 1 otherwise
};

Q_DECLARE_TYPEINFO(QRhiTextureUploadDescription::Layer::MipLevel, Q_MOVABLE_TYPE);
Q_DECLARE_TYPEINFO(QRhiTextureUploadDescription::Layer, Q_MOVABLE_TYPE);
Q_DECLARE_TYPEINFO(QRhiTextureUploadDescription, Q_MOVABLE_TYPE);

310 311
struct Q_RHI_EXPORT QRhiTextureCopyDescription
{
312
    QSize pixelSize; // empty = entire subresource
313 314 315

    int sourceLayer = 0;
    int sourceLevel = 0;
Laszlo Agocs's avatar
Laszlo Agocs committed
316
    QPoint sourceTopLeft;
317 318 319

    int destinationLayer = 0;
    int destinationLevel = 0;
Laszlo Agocs's avatar
Laszlo Agocs committed
320
    QPoint destinationTopLeft;
321 322 323 324
};

Q_DECLARE_TYPEINFO(QRhiTextureCopyDescription, Q_MOVABLE_TYPE);

Laszlo Agocs's avatar
Laszlo Agocs committed
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
struct Q_RHI_EXPORT QRhiTextureResolveDescription
{
    QRhiTextureResolveDescription() { }
    QRhiTextureResolveDescription(QRhiTexture *src) : sourceTexture(src) { }
    QRhiTextureResolveDescription(QRhiRenderBuffer *src) : sourceRenderBuffer(src) { }

    // source is either a multisample texture or a multisample renderbuffer
    QRhiTexture *sourceTexture = nullptr;
    int sourceLayer = 0;
    QRhiRenderBuffer *sourceRenderBuffer = nullptr;

    int destinationLayer = 0;
    int destinationLevel = 0;
};

Q_DECLARE_TYPEINFO(QRhiTextureResolveDescription, Q_MOVABLE_TYPE);

342
struct Q_RHI_EXPORT QRhiReadbackDescription
Laszlo Agocs's avatar
Laszlo Agocs committed
343
{
344
    QRhiReadbackDescription() { } // source is the back buffer of the swapchain of the current frame (if the swapchain supports readback)
345
    QRhiReadbackDescription(QRhiTexture *texture_) : texture(texture_) { } // source is the specified texture
346 347 348
    QRhiTexture *texture = nullptr;
    int layer = 0;
    int level = 0;
Laszlo Agocs's avatar
Laszlo Agocs committed
349 350
};

351 352
Q_DECLARE_TYPEINFO(QRhiReadbackDescription, Q_MOVABLE_TYPE);

353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
class Q_RHI_EXPORT QRhiResource
{
public:
    virtual ~QRhiResource();
    virtual void release() = 0;
    void releaseAndDestroy();

protected:
    QRhiImplementation *rhi = nullptr;
    QRhiResource(QRhiImplementation *rhi_);
    Q_DISABLE_COPY(QRhiResource)
};

class Q_RHI_EXPORT QRhiBuffer : public QRhiResource
{
public:
    enum Type {
        Immutable, // data never changes after initial upload - under the hood typically in device local (GPU) memory
        Static,    // data changes infrequently - under the hood typically device local and updated via a separate, host visible staging buffer
        Dynamic    // data changes frequently - under the hood typically host visible
    };

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

Laszlo Agocs's avatar
Laszlo Agocs committed
382 383 384 385 386 387
    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; }

388 389
    // no restrictions here, up to the backend to round up if needed (that
    // won't be visible in the user-provided size reported here)
Laszlo Agocs's avatar
Laszlo Agocs committed
390 391
    int size() const { return m_size; }
    void setSize(int sz) { m_size = sz; }
392 393 394 395 396

    virtual bool build() = 0;

protected:
    QRhiBuffer(QRhiImplementation *rhi, Type type_, UsageFlags usage_, int size_);
Laszlo Agocs's avatar
Laszlo Agocs committed
397 398
    Type m_type;
    UsageFlags m_usage;
399
    int m_size;
Laszlo Agocs's avatar
Laszlo Agocs committed
400
    void *m_reserved;
401 402 403 404 405 406 407 408 409
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiBuffer::UsageFlags)

class Q_RHI_EXPORT QRhiTexture : public QRhiResource
{
public:
    enum Flag {
        RenderTarget = 1 << 0,
410
        ChangesFrequently = 1 << 1, // hint for backend to keep staging resources around
411
        CubeMap = 1 << 2,
412
        MipMapped = 1 << 3,
413
        sRGB = 1 << 4,
Laszlo Agocs's avatar
Laszlo Agocs committed
414
        UsedAsTransferSource = 1 << 5 // will (also) be used as the source of a readback or copy or resolve
415 416 417 418
    };
    Q_DECLARE_FLAGS(Flags, Flag)

    enum Format {
419 420
        UnknownFormat,

421 422 423 424 425 426
        RGBA8,
        BGRA8,
        R8,
        R16,

        D16,
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
        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
455 456
    };

Laszlo Agocs's avatar
Laszlo Agocs committed
457 458 459 460 461 462 463 464
    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; }
465

Laszlo Agocs's avatar
Laszlo Agocs committed
466 467 468
    int sampleCount() const { return m_sampleCount; }
    void setSampleCount(int s) { m_sampleCount = s; }

469 470 471
    virtual bool build() = 0;

protected:
Laszlo Agocs's avatar
Laszlo Agocs committed
472 473
    QRhiTexture(QRhiImplementation *rhi, Format format_, const QSize &pixelSize_,
                int sampleCount_, Flags flags_);
Laszlo Agocs's avatar
Laszlo Agocs committed
474 475 476
    Format m_format;
    QSize m_pixelSize;
    Flags m_flags;
Laszlo Agocs's avatar
Laszlo Agocs committed
477
    int m_sampleCount;
Laszlo Agocs's avatar
Laszlo Agocs committed
478
    void *m_reserved;
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiTexture::Flags)

class Q_RHI_EXPORT QRhiSampler : public QRhiResource
{
public:
    enum Filter {
        None, // for mipmapMode only
        Nearest,
        Linear
    };

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

Laszlo Agocs's avatar
Laszlo Agocs committed
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
    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; }
517 518 519 520 521 522 523

    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
524 525 526 527 528 529 530
    Filter m_magFilter;
    Filter m_minFilter;
    Filter m_mipmapMode;
    AddressMode m_addressU;
    AddressMode m_addressV;
    AddressMode m_addressW;
    void *m_reserved;
531 532
};

Laszlo Agocs's avatar
Laszlo Agocs committed
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
class Q_RHI_EXPORT QRhiRenderBuffer : public QRhiResource
{
public:
    enum Type {
        DepthStencil,
        Color
    };

    enum Flag {
        ToBeUsedWithSwapChainOnly = 1 << 0 // use implicit winsys buffers, don't create anything (GL)
    };
    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;
    void *m_reserved;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiRenderBuffer::Flags)

574
class Q_RHI_EXPORT QRhiRenderPassDescriptor : public QRhiResource
575 576
{
protected:
577
    QRhiRenderPassDescriptor(QRhiImplementation *rhi);
Laszlo Agocs's avatar
Laszlo Agocs committed
578
    void *m_reserved;
579 580 581 582 583 584 585 586 587 588 589 590
};

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
591

592 593
    QRhiRenderPassDescriptor *renderPassDescriptor() const { return m_renderPassDesc; }
    void setRenderPassDescriptor(QRhiRenderPassDescriptor *desc) { m_renderPassDesc = desc; }
594 595 596

protected:
    QRhiRenderTarget(QRhiImplementation *rhi);
597
    QRhiRenderPassDescriptor *m_renderPassDesc = nullptr;
Laszlo Agocs's avatar
Laszlo Agocs committed
598
    void *m_reserved;
599 600 601 602 603 604 605 606 607 608
};

class Q_RHI_EXPORT QRhiTextureRenderTarget : public QRhiRenderTarget
{
public:
    enum Flag {
        PreserveColorContents = 1 << 0
    };
    Q_DECLARE_FLAGS(Flags, Flag)

Laszlo Agocs's avatar
Laszlo Agocs committed
609 610
    QRhiTextureRenderTargetDescription description() const { return m_desc; }
    void setDescription(const QRhiTextureRenderTargetDescription &desc) { m_desc = desc; }
611

Laszlo Agocs's avatar
Laszlo Agocs committed
612 613 614
    Flags flags() const { return m_flags; }
    void setFlags(Flags f) { m_flags = f; }

Laszlo Agocs's avatar
Laszlo Agocs committed
615
    // To be called before build() with description and flags set.
616 617
    // Textures in desc must already be built.
    // Note setRenderPassDescriptor() in the base class, that must still be called afterwards (but before build()).
618
    virtual QRhiRenderPassDescriptor *newCompatibleRenderPassDescriptor() = 0;
Laszlo Agocs's avatar
Laszlo Agocs committed
619

Laszlo Agocs's avatar
Laszlo Agocs committed
620
    // as usual, textures in desc must be built before calling build() on the rt
621 622 623 624
    virtual bool build() = 0;

protected:
    QRhiTextureRenderTarget(QRhiImplementation *rhi, const QRhiTextureRenderTargetDescription &desc_, Flags flags_);
Laszlo Agocs's avatar
Laszlo Agocs committed
625 626
    QRhiTextureRenderTargetDescription m_desc;
    Flags m_flags;
627 628 629 630 631 632 633
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiTextureRenderTarget::Flags)

class Q_RHI_EXPORT QRhiShaderResourceBindings : public QRhiResource
{
public:
Laszlo Agocs's avatar
Laszlo Agocs committed
634 635
    QVector<QRhiShaderResourceBinding> bindings() const { return m_bindings; }
    void setBindings(const QVector<QRhiShaderResourceBinding> &b) { m_bindings = b; }
636 637 638 639 640

    virtual bool build() = 0;

protected:
    QRhiShaderResourceBindings(QRhiImplementation *rhi);
Laszlo Agocs's avatar
Laszlo Agocs committed
641 642
    QVector<QRhiShaderResourceBinding> m_bindings;
    void *m_reserved;
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 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 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
};

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

    enum CullMode { // not a bitmask since some apis use a mask, some don't
        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
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
    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; }

803 804
    QRhiRenderPassDescriptor *renderPassDescriptor() const { return m_renderPassDesc; }
    void setRenderPassDescriptor(QRhiRenderPassDescriptor *desc) { m_renderPassDesc = desc; }
805 806 807 808 809

    virtual bool build() = 0;

protected:
    QRhiGraphicsPipeline(QRhiImplementation *rhi);
Laszlo Agocs's avatar
Laszlo Agocs committed
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826
    Flags m_flags;
    Topology m_topology = Triangles;
    CullMode m_cullMode = None;
    FrontFace m_frontFace = CCW;
    QVector<TargetBlend> m_targetBlends; // no blend when empty
    bool m_depthTest = false;
    bool m_depthWrite = false;
    CompareOp m_depthOp = Less;
    bool m_stencilTest = false;
    StencilOpState m_stencilFront;
    StencilOpState m_stencilBack;
    quint32 m_stencilReadMask = 0xFF; // applies to both faces
    quint32 m_stencilWriteMask = 0xFF; // applies to both faces
    int m_sampleCount = 1; // MSAA, swapchain+depthstencil must match
    QVector<QRhiGraphicsShaderStage> m_shaderStages;
    QRhiVertexInputLayout m_vertexInputLayout;
    QRhiShaderResourceBindings *m_shaderResourceBindings = nullptr; // must be built by the time ps' build() is called
827
    QRhiRenderPassDescriptor *m_renderPassDesc = nullptr;
Laszlo Agocs's avatar
Laszlo Agocs committed
828
    void *m_reserved;
829 830 831 832 833 834 835 836 837 838 839
};

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:
    enum SurfaceImportFlag {
        SurfaceHasPreMulAlpha = 1 << 0,
840 841
        SurfaceHasNonPreMulAlpha = 1 << 1,
        sRGB = 1 << 2
842 843 844
    };
    Q_DECLARE_FLAGS(SurfaceImportFlags, SurfaceImportFlag)

Laszlo Agocs's avatar
Laszlo Agocs committed
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
    QWindow *window() const { return m_window; }
    void setWindow(QWindow *window) { m_window = window; }

    QSize requestedPixelSize() const { return m_requestedPixelSize; }
    void setRequestedPixelSize(const QSize &size) { m_requestedPixelSize = size; }

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

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

860 861
    QRhiRenderPassDescriptor *renderPassDescriptor() const { return m_renderPassDesc; }
    void setRenderPassDescriptor(QRhiRenderPassDescriptor *desc) { m_renderPassDesc = desc; }
Laszlo Agocs's avatar
Laszlo Agocs committed
862

Laszlo Agocs's avatar
Laszlo Agocs committed
863 864 865 866 867
    // Alternatively, integrate with an existing swapchain, f.ex.
    // QVulkanWindow. Other settings have no effect when this is set.
    QObject *target() const { return m_target; }
    void setTarget(QObject *obj) { m_target = obj; }

868 869 870
    virtual QRhiCommandBuffer *currentFrameCommandBuffer() = 0;
    virtual QRhiRenderTarget *currentFrameRenderTarget() = 0;

871 872 873 874 875 876 877 878
    // Applications are expected to use requestedPixelSize() for logic like "if
    // qwindow->size() * qwindow->dpr() != requestedPixelSize() then
    // resize_swapchain", and effectivePixelSize() for all graphics
    // calculations, like the viewport. On some platforms they may not be the
    // same, e.g. some Vulkan implementations on Windows were observed to make
    // the swapchain buffers' height off by one on high dpi screens, this is
    // then reflected in the effective size.
    virtual QSize effectivePixelSize() const = 0;
879

Laszlo Agocs's avatar
Laszlo Agocs committed
880
    // To be called before build() with relevant parameters like depthStencil and sampleCount set.
881 882
    // As an exception to the common rules, m_depthStencil is not required to be built yet.
    // Note setRenderPassDescriptor(), that must still be called afterwards (but before buildOrResize()).
883 884 885 886 887 888 889 890
    virtual QRhiRenderPassDescriptor *newCompatibleRenderPassDescriptor() = 0;

    // As the name suggests, this is slightly different from the typical
    // build+release pattern: buildOrResize - buildOrResize is not the same as
    // buildOrResize - release - buildOrResize. A swapchain is often able to,
    // depending on the underlying APIs, accomodate changed output sizes in a
    // manner that is more efficient than a full destroy - create. So use the
    // former when a window is resized.
Laszlo Agocs's avatar
Laszlo Agocs committed
891
    virtual bool buildOrResize() = 0;
892 893 894

protected:
    QRhiSwapChain(QRhiImplementation *rhi);
Laszlo Agocs's avatar
Laszlo Agocs committed
895 896 897 898 899
    QWindow *m_window = nullptr;
    QSize m_requestedPixelSize;
    SurfaceImportFlags m_flags;
    QRhiRenderBuffer *m_depthStencil = nullptr;
    int m_sampleCount = 1;
900
    QRhiRenderPassDescriptor *m_renderPassDesc = nullptr;
Laszlo Agocs's avatar
Laszlo Agocs committed
901
    QObject *m_target = nullptr;
Laszlo Agocs's avatar
Laszlo Agocs committed
902
    void *m_reserved;
903 904 905 906
};

Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiSwapChain::SurfaceImportFlags)

907 908 909 910 911 912 913 914
class Q_RHI_EXPORT QRhiCommandBuffer : public QRhiResource
{
public:
    enum IndexFormat {
        IndexUInt16,
        IndexUInt32
    };

915 916 917 918 919
    // Sometimes committing the updates is necessary without starting a render
    // pass. Not often needed, updates should typically be passed to beginPass
    // (or endPass, in case of readbacks) instead.
    void resourceUpdate(QRhiResourceUpdateBatch *resourceUpdates);

920 921 922 923
    void beginPass(QRhiRenderTarget *rt,
                   const QRhiColorClearValue &colorClearValue, // ignored when rt has PreserveColorContents
                   const QRhiDepthStencilClearValue &depthStencilClearValue, // ignored when no ds attachment
                   QRhiResourceUpdateBatch *resourceUpdates = nullptr);
924
    void endPass(QRhiResourceUpdateBatch *resourceUpdates = nullptr);
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 953 954 955 956 957 958 959 960 961

    // When specified, srb can be different from ps' srb but the layouts must
    // match. Basic tracking is included: no command is added to the cb when
    // the pipeline or desc.set are the same as in the last call in the same
    // frame; srb is updated automatically at this point whenever a referenced
    // buffer, texture, etc. is out of date internally (due to rebuilding since
    // the creation of the srb) - hence no need to manually recreate the srb in
    // case a QRhiBuffer is "resized" etc.
    void setGraphicsPipeline(QRhiGraphicsPipeline *ps,
                             QRhiShaderResourceBindings *srb = nullptr);

    // The set* and draw* functions expect to have the pipeline set before on
    // the command buffer. Otherwise, unspecified issues may arise depending on
    // the backend.

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

    // final offset (indexOffset + firstIndex * n) must be 4 byte aligned with some backends
    void drawIndexed(quint32 indexCount,
                     quint32 instanceCount = 1,
                     quint32 firstIndex = 0,
                     qint32 vertexOffset = 0,
                     quint32 firstInstance = 0);

962 963 964 965 966 967 968
protected:
    QRhiCommandBuffer(QRhiImplementation *rhi);
    void *m_reserved;
};

struct Q_RHI_EXPORT QRhiReadbackResult
{
969
    /*
970 971 972
      When doing a readback after a pass inside a begin-endFrame (not
      offscreen), the data may only be available in a future frame. Hence the
      completed callback:
973
          beginFrame(sc);
974
          beginPass
975 976 977 978 979 980 981 982 983 984 985 986
          ...
          QRhiReadbackResult *rbResult = new QRhiReadbackResult;
          rbResult->completed = [rbResult] {
              {
                  QImage::Format fmt = rbResult->format == QRhiTexture::BGRA8 ? QImage::Format_ARGB32_Premultiplied
                                                                              : QImage::Format_RGBA8888_Premultiplied;
                  const uchar *p = reinterpret_cast<const uchar *>(rbResult->data.constData());
                  QImage image(p, rbResult->pixelSize.width(), rbResult->pixelSize.height(), fmt);
                    ...
              }
              delete rbResult;
          };
987
          u = nextResourceUpdateBatch();
988
          QRhiReadbackDescription rb; // no texture -> backbuffer
989
          u->readBackTexture(rb, rbResult);
990
          endPass(u);
991 992
          endFrame(sc);
     */
993 994 995 996 997
    std::function<void()> completed = nullptr;
    QRhiTexture::Format format;
    QSize pixelSize;
    QByteArray data;
}; // non-movable due to the std::function
998

999 1000 1001
class Q_RHI_EXPORT QRhiResourceUpdateBatch // sort of a command buffer for copy type of operations
{
public:
1002 1003 1004 1005 1006 1007
    enum TexturePrepareFlag {
        TextureRead = 1 << 0,
        TextureWrite = 1 << 1
    };
    Q_DECLARE_FLAGS(TexturePrepareFlags, TexturePrepareFlag)

1008 1009 1010 1011
    ~QRhiResourceUpdateBatch();
    // Puts the batch back to the pool without any processing.
    void release();

1012 1013 1014 1015 1016 1017
    // Applications do not have to defer all upload preparation to the first
    // frame: an update batch can be prepared in advance during initialization,
    // and afterwards, if needed, merged into another that is then submitted to
    // beginPass(). (nb the one we merged from must be release()'d manually)
    void merge(QRhiResourceUpdateBatch *other);

1018 1019 1020
    // None of these execute anything. Deferred to
    // beginPass/endPass/resourceUpdate. What exactly then happens underneath
    // is hidden from the applications.
1021
    void updateDynamicBuffer(QRhiBuffer *buf, int offset, int size, const void *data);
1022
    void uploadStaticBuffer(QRhiBuffer *buf, int offset, int size, const void *data);
1023
    void uploadStaticBuffer(QRhiBuffer *buf, const void *data);
Laszlo Agocs's avatar
Laszlo Agocs committed
1024
    void uploadTexture(QRhiTexture *tex, const QRhiTextureUploadDescription &desc);
1025
    void uploadTexture(QRhiTexture *tex, const QImage &image); // shortcut
1026
    void copyTexture(QRhiTexture *dst, QRhiTexture *src, const QRhiTextureCopyDescription &desc = QRhiTextureCopyDescription());
Laszlo Agocs's avatar
Laszlo Agocs committed
1027
    void resolveTexture(QRhiTexture *dst, const QRhiTextureResolveDescription &desc);
1028
    void readBackTexture(const QRhiReadbackDescription &rb, QRhiReadbackResult *result);
1029

1030 1031 1032 1033
    // This is not normally needed, textures that have an upload or are used
    // with a TextureRenderTarget will be fine without it. May be more relevant later.
    void prepareTextureForUse(QRhiTexture *tex, TexturePrepareFlags flags);

1034 1035 1036 1037 1038 1039 1040 1041
private:
    QRhiResourceUpdateBatch(QRhiImplementation *rhi);
    Q_DISABLE_COPY(QRhiResourceUpdateBatch)
    QRhiResourceUpdateBatchPrivate *d;
    friend struct QRhiResourceUpdateBatchPrivate;
    friend class QRhi;
};

1042 1043
Q_DECLARE_OPERATORS_FOR_FLAGS(QRhiResourceUpdateBatch::TexturePrepareFlags)

1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
struct Q_RHI_EXPORT QRhiInitParams
{
};

class Q_RHI_EXPORT QRhi
{
public:
    enum Implementation {
        Vulkan,
        OpenGLES2,
        D3D11,
        Metal
    };

    enum FrameOpResult {
        FrameOpSuccess = 0,
        FrameOpError,
        FrameOpSwapChainOutOfDate,
        FrameOpDeviceLost
    };

1065 1066 1067 1068 1069
    enum Feature {
        MultisampleTexture = 1,
        MultisampleRenderBuffer
    };

1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
    ~QRhi();

    static QRhi *create(Implementation impl, QRhiInitParams *params);

    /*
       The underlying graphics resources are created when calling build() and
       put on the release queue by release() (so this is safe even when the
       resource is used by the still executing/pending frame(s)).

       The QRhi* instance itself is not destroyed by the release and it is safe
       to destroy it right away after calling release().

       Changing any value needs explicit release and rebuilding of the
       underlying resource before it can take effect.

       res->build(); <change something>; res->release(); res->build(); ...
       is therefore perfectly valid and can be used to recreate things (when
       buffer or texture size changes f.ex.)

       In addition, just doing res->build(); ...; res->build() is valid too and
       has the same effect due to an implicit release() call made by build()
       when invoked on an object with valid resources underneath.
     */

1094 1095
    QRhiGraphicsPipeline *newGraphicsPipeline();
    QRhiShaderResourceBindings *newShaderResourceBindings();
1096 1097 1098 1099 1100 1101 1102 1103

    // Buffers are immutable like other resources but the underlying data can
    // change. (its size cannot) Having multiple frames in flight is handled
    // transparently, with multiple allocations, recording updates, etc.
    // internally. The underlying memory type may differ for static and dynamic
    // buffers. For best performance, static buffers may be copied to device
    // local (not necessarily host visible) memory via a staging (host visible)
    // buffer. Hence separate update-dynamic and upload-static operations.
1104 1105 1106
    QRhiBuffer *newBuffer(QRhiBuffer::Type type,
                          QRhiBuffer::UsageFlags usage,
                          int size);
1107 1108

    // To be used for depth-stencil when no access is needed afterwards.
Laszlo Agocs's avatar
Laszlo Agocs committed
1109 1110
    // Transient image, backed by lazily allocated memory (on Vulkan at least,
    // ideal for tiled GPUs). May also be a dummy internally depending on the
Laszlo Agocs's avatar
Laszlo Agocs committed
1111
    // backend and the flags (OpenGL, where the winsys interface provides the
Laszlo Agocs's avatar
Laszlo Agocs committed
1112
    // depth-stencil buffer via the window surface).
1113 1114 1115 1116 1117
    //
    // Color is also supported. With some gfx apis (GL) this is different from
    // textures. (cannot be sampled, but can be rendered to and used in a
    // multisample resolve) This becomes important when doing msaa offscreen
    // and the gfx api has no multisample textures.
1118 1119 1120
    QRhiRenderBuffer *newRenderBuffer(QRhiRenderBuffer::Type type,
                                      const QSize &pixelSize,
                                      int sampleCount = 1,
Laszlo Agocs's avatar
Laszlo Agocs committed
1121
                                      QRhiRenderBuffer::Flags flags = QRhiRenderBuffer::Flags());
1122

1123 1124
    QRhiTexture *newTexture(QRhiTexture::Format format,
                            const QSize &pixelSize,
Laszlo Agocs's avatar
Laszlo Agocs committed
1125
                            int sampleCount = 1,
1126
                            QRhiTexture::Flags flags = QRhiTexture::Flags());
1127

1128 1129 1130
    QRhiSampler *newSampler(QRhiSampler::Filter magFilter, QRhiSampler::Filter minFilter,
                            QRhiSampler::Filter mipmapMode,
                            QRhiSampler::AddressMode u, QRhiSampler::AddressMode v, QRhiSampler::AddressMode w = QRhiSampler::ClampToEdge);
1131

1132 1133
    QRhiTextureRenderTarget *newTextureRenderTarget(const QRhiTextureRenderTargetDescription &desc,
                                                    QRhiTextureRenderTarget::Flags flags = QRhiTextureRenderTarget::Flags());
1134 1135

    /*
1136
      Rendering to a QWindow (must be Vulkan/Metal/OpenGLSurface as appropriate):
1137
        Create a swapchain.
1138 1139
        Call buildOrResize() on the swapchain whenever the size is different than before.
        Call release() on the swapchain on QPlatformSurfaceEvent::SurfaceAboutToBeDestroyed.
1140 1141
        Then on every frame:
           beginFrame(sc);
Laszlo Agocs's avatar
Laszlo Agocs committed
1142 1143
           updates = nextResourceUpdateBatch();
           updates->...
1144 1145
           QRhiCommandBuffer *cb = sc->currentFrameCommandBuffer();
           cb->beginPass(sc->currentFrameRenderTarget(), clearValues, updates);
1146
           ...
1147
           cb->endPass();
1148 1149
           endFrame(sc); // this queues the Present, begin/endFrame manages double buffering internally
     */
1150
    QRhiSwapChain *newSwapChain();
1151 1152 1153
    FrameOpResult beginFrame(QRhiSwapChain *swapChain);
    FrameOpResult endFrame(QRhiSwapChain *swapChain);

1154
    /*
1155 1156 1157 1158 1159 1160
      Rendering without a swapchain is possible as well. The typical use case
      is to use it in completely offscreen applications, e.g. to generate image
      sequences by rendering and reading back without ever showing a window.
      Usage in on-screen applications (so beginFrame, endFrame,
      beginOffscreenFrame, endOffscreenFrame, beginFrame, ...) is possible too but
      it does break parallelism so should be done only infrequently.
1161
          QRhiReadbackResult rbResult;
1162 1163
          QRhiCommandBuffer *cb; // not owned
          beginOffscreenFrame(&cb);
1164 1165 1166
          beginPass
          ...
          u = nextResourceUpdateBatch();
1167
          u->readBackTexture(rb, &rbResult);
1168
          endPass(u);
1169
          endOffscreenFrame();
1170
          // image data available in rbResult
1171 1172
     */
    FrameOpResult beginOffscreenFrame(QRhiCommandBuffer **cb);
1173 1174 1175
    FrameOpResult endOffscreenFrame();

    // Waits for any work on the graphics queue (where applicable) to complete,
1176 1177 1178 1179
    // then executes all deferred operations, like completing readbacks and
    // resource releases. Can be called inside and outside of a frame, but not
    // inside a pass. Inside a frame it implies submitting any work on the
    // command buffer.
1180
    QRhi::FrameOpResult finish();
1181

1182 1183 1184
    // Returns an instance to which updates can be queued. Batch instances are
    // pooled and never owned by the application. An instance is returned to
    // the pool after a beginPass() processes it or when it is "canceled" by
Laszlo Agocs's avatar
Laszlo Agocs committed
1185 1186
    // calling release(). Can be called outside begin-endFrame as well since
    // a batch instance just collects data on its own.
1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
    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;

    // Make Y up and allow using 0..1 as the depth range. This lets
    // applications keep using OpenGL-targeted vertex data and perspective
    // matrices regardless of the backend. (by passing this_matrix * mvp,
    // instead of just mvp, to their vertex shaders)
    QMatrix4x4 clipSpaceCorrMatrix() const;

1205
    bool isTextureFormatSupported(QRhiTexture::Format format, QRhiTexture::Flags flags = QRhiTexture::Flags()) const;
1206
    bool isFeatureSupported(QRhi::Feature feature) const;
1207

1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
protected:
    QRhi();

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

QT_END_NAMESPACE

#endif