qrhi.cpp 143 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
/****************************************************************************
**
** 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$
**
****************************************************************************/

#include "qrhi_p.h"
#include <qmath.h>

Laszlo Agocs's avatar
Laszlo Agocs committed
40
#include "qrhinull_p.h"
41
#ifndef QT_NO_OPENGL
42
#include "qrhigles2_p.h"
43
#endif
44 45 46 47 48 49 50 51 52 53 54 55
#if QT_CONFIG(vulkan)
#include "qrhivulkan_p.h"
#endif
#ifdef Q_OS_WIN
#include "qrhid3d11_p.h"
#endif
#ifdef Q_OS_DARWIN
#include "qrhimetal_p.h"
#endif

QT_BEGIN_NAMESPACE

Laszlo Agocs's avatar
Laszlo Agocs committed
56 57 58
/*!
    \class QRhi
    \inmodule QtRhi
Laszlo Agocs's avatar
Laszlo Agocs committed
59 60

    \brief Accelerated 2D/3D graphics API abstraction.
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88

     QRhi is an abstraction for hardware accelerated graphics APIs, such as,
     \l{https://www.khronos.org/opengl/}{OpenGL},
     \l{https://www.khronos.org/opengles/}{OpenGL ES},
     \l{https://docs.microsoft.com/en-us/windows/desktop/direct3d}{Direct3D},
     \l{https://developer.apple.com/metal/}{Metal}, and
     \l{https://www.khronos.org/vulkan/}{Vulkan}.

    Each QRhi instance is backed by a backend for a specific graphics API. The
    selection of the backend is a run time choice and is up to the application
    or library that creates the QRhi instance. Some backends are available on
    multiple platforms (OpenGL, Vulkan, Null), while APIs specific to a given
    platform are only available when running on the platform in question (Metal
    on macOS/iOS/tvOS, Direct3D on Windows).

    \section2 Design Fundamentals

    A QRhi cannot be instantiated directly. Instead, use the create()
    function. Delete the QRhi instance normally to release the graphics device.

    \section3 Resources

    Instances of classes deriving from QRhiResource, such as, QRhiBuffer,
    QRhiTexture, etc., encapsulate zero, one, or more native graphics
    resources. Instances of such classes are always created via the \c new
    functions of the QRhi, such as, newBuffer(), newTexture(),
    newTextureRenderTarget(), newSwapChain().

89 90 91 92 93 94 95
    \badcode
        vbuf = rhi->newBuffer(QRhiBuffer::Immutable, QRhiBuffer::VertexBuffer, sizeof(vertexData));
        if (!vbuf->build()) { error }
        ...
        vbuf->releaseAndDestroy();
    \endcode

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
    \list

    \li The returned value from both create() and functions like newBuffer() is
    owned by the caller.

    \li Unlike QRhi, subclasses of QRhiResource should not be destroyed
    directly via delete without calling QRhiResource::release(). The typical
    approach is to call QRhiResource::releaseAndDestroy(). This is equivalent
    to QRhiResource::release() followed by \c delete.

    \li Just creating a QRhiResource subclass never allocates or initalizes any
    native resources. That is only done when calling the \c build function of a
    subclass, for example, QRhiBuffer::build() or QRhiTexture::build().

    \li The exception is
    QRhiTextureRenderTarget::newCompatibleRenderPassDescriptor() and
    QRhiSwapChain::newCompatibleRenderPassDescriptor(). There is no \c build
    operation for these and the returned object is immediately active.

    \li The resource objects themselves are treated as immutable: once a
    resource is built, changing any parameters via the setters, such as,
    QRhiTexture::setPixelSize(), has no effect, unless the underlying native
    resource is released and \c build is called again. See more about resource
    reuse in the sections below.

    \li The underlying native resources are scheduled for releasing by calling
    QRhiResource::release(). Backends often queue release requests and defer
    executing them to an unspecified time, this is hidden from the
    applications. This way applications do not have to worry about releasing a
125 126 127 128 129 130 131
    native resource that may still be in use by an in-flight frame.

    \li Note that this does not mean that resources can freely be released
    within a frame (that is, in a
    \l{QRhiCommandBuffer::beginFrame()}{beginFrame()} -
    \l{QRhiCommandBuffer::endFrame()}{endFrame()} section). As a general rule,
    all referenced QRhiResource objects must stay unchanged until the frame is
132 133 134 135
    submitted by calling \l{QRhiCommandBuffer::endFrame()}{endFrame()}. To ease
    this, QRhiResource::releaseAndDestroyLater() is provided as a convenience.
    This allows applications to safely issue a (defered) releaseAndDestroy()
    while recording a frame.
136 137 138

    \endlist

139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
    \section3 Command buffers and defered command execution

    Regardless of the design and capabilities of the underlying graphics API,
    all QRhi backends implement some level of command buffers. No
    QRhiCommandBuffer function issues any native bind or draw command (such as,
    \c glDrawElements) directly. Commands are always recorded in a queue,
    either native or provided by the QRhi backend. The command buffer is
    submitted, and so execution starts only upon QRhi::endFrame() or
    QRhi::finish().

    The defered nature has consequences for some types of objects. For example,
    writing to a dynamic buffer multiple times within a frame, in case such
    buffers are backed by host-visible memory, will result in making the
    results of all writes are visible to all draw calls in the command buffer
    of the frame, regardless of when the dynamic buffer update was recorded
    relative to a draw call.

    Furthermore, instances of QRhiResource subclasses must be treated immutable
    within a frame in which they are referenced in any way. Create or rebuild
    all resources upfront, before starting to record commands for the next
    frame. Reusing a QRhiResource instance within a frame (by rebuilding it and
    then referencing it again in the same \c{beginFrame - endFrame} section)
    should be avoided as it may lead to unexpected results, depending on the
162 163 164 165 166 167 168 169 170 171
    backend.

    As a general rule, all referenced QRhiResource objects must stay valid and
    unmodified until the frame is submitted by calling
    \l{QRhiCommandBuffer::endFrame()}{endFrame()}. On the other hand,
    \l{QRhiResource::release()}{release()} or
    \l{QRhiResource::releaseAndDestroy()}{releaseAndDestroy()} are always safe
    to call once the frame is submitted, regardless of the status of the
    underlying native resources (which may still be in use by the GPU - but
    that is taken care of internally).
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187

    Unlike APIs like OpenGL, upload and copy type of commands cannot be mixed
    with draw commands. The typical renderer will involve a sequence similar to
    the following: \c{(re)build resources} - \c{begin frame} - \c{record
    uploads and copies} - \c{start renderpass} - \c{record draw calls} - \c{end
    renderpass} - \c{end frame}. Recording copy type of operations happens via
    QRhiResourceUpdateBatch. Such operations are committed typically on
    \l{QRhiCommandBuffer::beginPass()}{beginPass()}.

    When working with legacy rendering engines designed for OpenGL, the
    migration to QRhi often involves redesigning from having a single \c render
    step (that performs copies and uploads, clears buffers, and issues draw
    calls, all mixed together) to a clearly separated, two phase \c prepare -
    \c render setup where the \c render step only starts a renderpass and
    records draw calls, while all resource creation and queuing of updates,
    uploads and copies happens beforehand, in the \c prepare step.
188 189 190

    \section3 Resource reuse

191 192 193
    From the user's point of view a QRhiResource is reusable immediately after
    calling QRhiResource::release(). With the exception of swapchains, calling
    \c build() on an already built object does an implicit \c release(). This
194
    provides a handy shortcut to reuse a QRhiResource instance with different
195
    parameters, with a new native graphics object underneath.
196 197 198

    The importance of reusing the same object lies in the fact that some
    objects reference other objects: for example, a QRhiShaderResourceBindings
199 200 201 202 203 204 205 206 207
    can reference QRhiBuffer, QRhiTexture, and QRhiSampler instances. If in a
    later frame one of these buffers need to be resized or a sampler parameter
    needs changing, destroying and creating a whole new QRhiBuffer or
    QRhiSampler would invalidate all references to the old instance. By just
    changing the appropriate parameters via QRhiBuffer::setSize() or similar
    and then calling QRhiBuffer::build(), everything works as expected and
    there is no need to touch the QRhiShaderResourceBindings at all, even
    though there is a good chance that under the hood the QRhiBuffer is now
    backed by a whole new native buffer.
208 209 210 211 212

    \badcode
        ubuf = rhi->newBuffer(QRhiBuffer::Dynamic, QRhiBuffer::UniformBuffer, 256);
        ubuf->build();

213
        srb = rhi->newShaderResourceBindings()
214 215 216 217 218 219 220
        srb->setBindings({
            QRhiShaderResourceBinding::uniformBuffer(0, QRhiShaderResourceBinding::VertexStage | QRhiShaderResourceBinding::FragmentStage, ubuf)
        });
        srb->build();

        ...

221
        // now in a later frame we need to grow the buffer to a larger size
222 223 224 225 226 227 228 229
        ubuf->setSize(512);
        ubuf->build(); // same as ubuf->release(); ubuf->build();

        // that's it, srb needs no changes whatsoever
    \endcode

    \section3 Pooled objects

230 231 232 233 234 235 236 237 238
    In addition to resources, there are pooled objects as well, such as,
    QRhiResourceUpdateBatch. An instance is retrieved via a \c next function,
    such as, nextResourceUpdateBatch(). The caller does not own the returned
    instance in this case. The only valid way of operating here is calling
    functions on the QRhiResourceUpdateBatch and then passing it to
    QRhiCommandBuffer::beginPass() or QRhiCommandBuffer::endPass(). These
    functions take care of returning the batch to the pool. Alternatively, a
    batch can be "canceled" and returned to the pool without processing by
    calling QRhiResourceUpdateBatch::release().
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286

    A typical pattern is thus:

    \badcode
        QRhiResourceUpdateBatch *resUpdates = rhi->nextResourceUpdateBatch();
        ...
        resUpdates->updateDynamicBuffer(ubuf, 0, 64, mvp.constData());
        if (!image.isNull()) {
            resUpdates->uploadTexture(texture, image);
            image = QImage();
        }
        ...
        QRhiCommandBuffer *cb = m_sc->currentFrameCommandBuffer();
        cb->beginPass(swapchain->currentFrameRenderTarget(), clearCol, clearDs, resUpdates);
    \endcode

    \section3 Swapchain specifics

    QRhiSwapChain features some special semantics due to the peculiar nature of
    swapchains.

    \list

    \li It has no \c build but rather a QRhiSwapChain::buildOrResize().
    Repeatedly calling this function is \b not the same as calling
    QRhiSwapChain::release() followed by QRhiSwapChain::buildOrResize(). This
    is because swapchains often have ways to handle the case where buffers need
    to be resized in a manner that is more efficient than a brute force
    destroying and recreating from scratch.

    \li An active QRhiSwapChain must be released by calling
    QRhiSwapChain::release() whenever the targeted QWindow sends the
    QPlatformSurfaceEvent::SurfaceAboutToBeDestroyed event. It should not be
    postponed since releasing the swapchain may become problematic when the
    native window is not around anymore (e.g. because the QPlatformWindow got
    destroyed already when getting a QWindow::close())

    \endlist

    \section3 Ownership

    The general rule is no ownership transfer. Creating a QRhi with an already
    existing graphics device does not mean the QRhi takes ownership of the
    device object. Similarly, ownership is not given away when a device or
    texture object is "exported" via QRhi::nativeHandles() or
    QRhiTexture::nativeHandles(). Most importantly, passing pointers in structs
    and via setters does not transfer ownership.

287
    \section3 Threading
288

289 290 291 292 293
    A QRhi instance and the associated resources can be created and used on any
    thread but all usage must be limited to that one single thread. When
    rendering to multiple QWindows in an application, having a dedicated thread
    and QRhi instance for each window is often advisable, as this can eliminate
    issues with unexpected throttling caused by presenting to multiple windows.
294

Laszlo Agocs's avatar
Laszlo Agocs committed
295 296 297 298
    When it comes to externally created native objects, such as OpenGL contexts
    passed in via QRhiGles2NativeHandles, it is up to the application to ensure
    they are not misused by other threads.

299 300 301 302 303 304
    Resources are not shareable between QRhi instances. This is an intentional
    choice since QRhi hides most queue, command buffer, and resource
    synchronization related tasks, and provides no API for them. Safe and
    efficient concurrent use of graphics resources from multiple threads is
    tied deeply to those concepts, however, and is thus a topic that is
    currently out of scope, but may be introduced in the future.
Laszlo Agocs's avatar
Laszlo Agocs committed
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
 */

/*!
    \enum QRhi::Implementation
    Describes which graphics API-specific backend gets used by a QRhi instance.

    \value Null
    \value Vulkan
    \value OpenGLES2
    \value D3D11
    \value Metal
 */

/*!
    \enum QRhi::Flag
    Describes what special features to enable.

    \value EnableProfiling Enables gathering timing (CPU, GPU) and resource
    (QRhiBuffer, QRhiTexture, etc.) information and additional metadata. See
    QRhiProfiler. Avoid enabling in production builds as it may involve a
    performance penalty.

    \value EnableDebugMarkers Enables debug marker groups. Without this frame
    debugging features like making debug groups and custom resource name
    visible in external GPU debugging tools will not be available and functions
    like QRhiCommandBuffer::debugMarkBegin() will become a no-op. Avoid
    enabling in production builds as it may involve a performance penalty.
 */

/*!
    \enum QRhi::FrameOpResult
    Describes the result of operations that can have a soft failure.

    \value FrameOpSuccess Success

    \value FrameOpError Unspecified error

    \value FrameOpSwapChainOutOfDate The swapchain is in an inconsistent state
    internally. This can be recoverable by attempting to repeat the operation
    (such as, beginFrame()) later.

    \value FrameOpDeviceLost The graphics device was lost. This can be
    recoverable by attempting to repeat the operation (such as, beginFrame())
    and releasing and reinitializing all objects backed by native graphics
    resources.
 */

/*!
    \enum QRhi::Feature
    Flag values to indicate what features are supported by the backend currently in use.

356 357
    \value MultisampleTexture Indicates that textures with a sample count larger
    than 1 are supported.
358

359 360
    \value MultisampleRenderBuffer Indicates that renderbuffers with a sample
    count larger than 1 are supported.
361

362
    \value DebugMarkers Indicates that debug marker groups (and so
363 364
    QRhiCommandBuffer::debugMarkBegin()) are supported.

365 366
    \value Timestamps Indicates that command buffer timestamps are supported.
    Relevant for QRhiProfiler::gpuFrameTimes().
367

368
    \value Instancing Indicates that instanced drawing is supported.
369

370 371
    \value CustomInstanceStepRate Indicates that instance step rates other than
    1 are supported.
372

373 374
    \value PrimitiveRestart Indicates that restarting the assembly of
    primitives when encountering an index value of 0xFFFF
375
    (\l{QRhiCommandBuffer::IndexUInt16}{IndexUInt16}) or 0xFFFFFFFF
376 377 378 379 380
    (\l{QRhiCommandBuffer::IndexUInt32}{IndexUInt32}) is enabled, for certain
    primitive topologies at least. QRhi will try to enable this with all
    backends, but in some cases it will not be supported. Dynamically
    controlling primitive restart is not possible since with some APIs
    primitive restart with a fixed index is always on. Applications must assume
381 382 383 384 385 386
    that whenever this feature is reported as supported, the above mentioned
    index values \c may be treated specially, depending on the topology. The
    only two topologies where primitive restart is guaranteed to behave
    identically across backends, as long as this feature is reported as
    supported, are \l{QRhiGraphicsPipeline::LineStrip}{LineStrip} and
    \l{QRhiGraphicsPipeline::TriangleStrip}{TriangleStrip}.
387 388 389 390 391

    \value GeometryShaders Indicates that geometry shaders are supported.

    \value TessellationShaders Indicates that tessellation control and
    evaluation shaders are supported.
392 393 394 395 396 397 398

    \value NonDynamicUniformBuffers Indicates that creating buffers with the
    usage \l{QRhiBuffer::UniformBuffer}{UniformBuffer} and the types
    \l{QRhiBuffer::Immutable}{Immutable} or \l{QRhiBuffer::Static}{Static} is
    supported. When reported as unsupported, uniform (constant) buffers must be
    created as \l{QRhiBuffer::Dynamic}{Dynamic}. (which is recommended
    regardless)
399 400 401 402 403 404

    \value NonFourAlignedEffectiveIndexBufferOffset Indicates that effective
    index buffer offsets (\c{indexOffset + firstIndex * indexComponentSize})
    that are not 4 byte aligned are supported. When not supported, attempting
    to issue a \l{QRhiCommandBuffer::drawIndexed()}{drawIndexed()} with a
    non-aligned effective offset may lead to unspecified behavior.
405 406 407

    \value NPOTTextureRepeat Indicates that the \l{QRhiSampler::Repeat}{Repeat}
    mode is supported for textures with a non-power-of-two size.
408 409 410 411 412 413

    \value RedOrAlpha8IsRed Indicates that the
    \l{QRhiTexture::RED_OR_ALPHA8}{RED_OR_ALPHA8} format maps to a one
    component 8-bit \c red format. This is the case for all backends except
    OpenGL, where \c{GL_ALPHA}, a one component 8-bit \c alpha format, is used
    instead. This is relevant for shader code that samples from the texture.
Laszlo Agocs's avatar
Laszlo Agocs committed
414 415
 */

416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
/*!
    \enum QRhi::BeginFrameFlag
    Flag values for QRhi::beginFrame()
 */

/*!
    \enum QRhi::EndFrameFlag
    Flag values for QRhi::endFrame()

    \value SkipPresent Specifies that no present command is to be queued or no
    swapBuffers call is to be made. This way no image is presented. Generating
    multiple frames with all having this flag set is not recommended (except,
    for example, for benchmarking purposes - but keep in mind that backends may
    behave differently when it comes to waiting for command completion without
    presenting so the results are not comparable between them)
 */

Laszlo Agocs's avatar
Laszlo Agocs committed
433 434 435 436 437 438 439 440 441 442 443 444 445
/*!
    \enum QRhi::ResourceSizeLimit
    Describes the resource limit to query.

    \value TextureSizeMin Minimum texture width and height. This is typically
    1. The minimum texture size is handled gracefully, meaning attempting to
    create a texture with an empty size will instead create a texture with the
    minimum size.

    \value TextureSizeMax Maximum texture width and height. This depends on the
    graphics API and sometimes the platform or implementation as well.
    Typically the value is in the range 4096 - 16384. Attempting to create
    textures larger than this is expected to fail.
Laszlo Agocs's avatar
Laszlo Agocs committed
446 447 448 449 450
 */

/*!
    \class QRhiInitParams
    \inmodule QtRhi
451
    \brief Base class for backend-specific initialization parameters.
452 453

    Contains fields that are relevant to all backends.
Laszlo Agocs's avatar
Laszlo Agocs committed
454 455 456 457 458
 */

/*!
    \class QRhiColorClearValue
    \inmodule QtRhi
459
    \brief Specifies a clear color for a color buffer.
Laszlo Agocs's avatar
Laszlo Agocs committed
460 461
 */

462 463 464
/*!
    Constructs a color clear value with \c{(0, 0, 0, 1)} (opaque black).
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
465 466 467 468 469
QRhiColorClearValue::QRhiColorClearValue()
    : m_rgba(0, 0, 0, 1)
{
}

470 471 472 473
/*!
    Constructs a color clear value with the floating point color components
    (\c{0.0f - 1.0f}) specified in \a c.
  */
Laszlo Agocs's avatar
Laszlo Agocs committed
474 475 476 477 478
QRhiColorClearValue::QRhiColorClearValue(const QVector4D &c)
    : m_rgba(c)
{
}

479 480 481 482
/*!
    Constructs a color clear value with the floating point color components
    (\c{0.0f - 1.0f}) specified in \a r, \a g, \a b, and \a a.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
483 484 485 486 487
QRhiColorClearValue::QRhiColorClearValue(float r, float g, float b, float a)
    : m_rgba(r, g, b, a)
{
}

488
/*!
489
    \return \c true if the colors in the two QRhiColorClearValue objects \a a
490 491 492 493 494 495 496 497 498 499
    and \a b are equal.

    \relates QRhiColorClearValue
 */
bool operator==(const QRhiColorClearValue &a, const QRhiColorClearValue &b) Q_DECL_NOTHROW
{
    return a.rgba() == b.rgba();
}

/*!
500
    \return \c false if the colors in the two QRhiColorClearValue objects \a a
501 502 503 504 505 506 507 508 509 510
    and \a b are equal; otherwise returns \c true.

    \relates QRhiColorClearValue
*/
bool operator!=(const QRhiColorClearValue &a, const QRhiColorClearValue &b) Q_DECL_NOTHROW
{
    return !(a == b);
}

/*!
511
    \return the hash value for \a v, using \a seed to seed the calculation.
512 513 514 515 516 517 518 519 520

    \relates QRhiColorClearValue
 */
uint qHash(const QRhiColorClearValue &v, uint seed) Q_DECL_NOTHROW
{
    const QVector4D c = v.rgba();
    return qFloor((c.x() + c.y() + c.z() + c.w()) * 1000) + seed;
}

521 522 523 524 525 526 527 528 529 530 531 532 533 534
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug dbg, const QRhiColorClearValue &v)
{
    QDebugStateSaver saver(dbg);
    const QVector4D c = v.rgba();
    dbg.nospace() << "QRhiColorClearValue(r=" << c.x()
                  << " g=" << c.y()
                  << " b=" << c.z()
                  << " a=" << c.w()
                  << ')';
    return dbg;
}
#endif

Laszlo Agocs's avatar
Laszlo Agocs committed
535 536 537
/*!
    \class QRhiDepthStencilClearValue
    \inmodule QtRhi
538
    \brief Specifies clear values for a depth or stencil buffer.
Laszlo Agocs's avatar
Laszlo Agocs committed
539 540
 */

541 542 543 544
/*!
    Constructs a depth/stencil clear value with depth clear value 1.0f and
    stencil clear value 0.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
545 546 547 548 549 550
QRhiDepthStencilClearValue::QRhiDepthStencilClearValue()
    : m_d(1),
      m_s(0)
{
}

551 552 553 554
/*!
    Constructs a depth/stencil clear value with depth clear value \a d and
    stencil clear value \a s.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
555 556 557 558 559 560
QRhiDepthStencilClearValue::QRhiDepthStencilClearValue(float d, quint32 s)
    : m_d(d),
      m_s(s)
{
}

561
/*!
562
    \return \c true if the values in the two QRhiDepthStencilClearValue objects
563 564 565 566 567 568 569 570 571 572 573
    \a a and \a b are equal.

    \relates QRhiDepthStencilClearValue
 */
bool operator==(const QRhiDepthStencilClearValue &a, const QRhiDepthStencilClearValue &b) Q_DECL_NOTHROW
{
    return a.depthClearValue() == b.depthClearValue()
            && a.stencilClearValue() == b.stencilClearValue();
}

/*!
574
    \return \c false if the values in the two QRhiDepthStencilClearValue
575 576 577 578 579 580 581 582 583 584
    objects \a a and \a b are equal; otherwise returns \c true.

    \relates QRhiDepthStencilClearValue
*/
bool operator!=(const QRhiDepthStencilClearValue &a, const QRhiDepthStencilClearValue &b) Q_DECL_NOTHROW
{
    return !(a == b);
}

/*!
585
    \return the hash value for \a v, using \a seed to seed the calculation.
586 587 588 589 590 591 592 593

    \relates QRhiDepthStencilClearValue
 */
uint qHash(const QRhiDepthStencilClearValue &v, uint seed) Q_DECL_NOTHROW
{
    return seed * (qFloor(v.depthClearValue() * 100) + v.stencilClearValue());
}

594 595 596 597 598 599 600 601 602 603 604
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug dbg, const QRhiDepthStencilClearValue &v)
{
    QDebugStateSaver saver(dbg);
    dbg.nospace() << "QRhiDepthStencilClearValue(depth-clear=" << v.depthClearValue()
                  << " stencil-clear=" << v.stencilClearValue()
                  << ')';
    return dbg;
}
#endif

Laszlo Agocs's avatar
Laszlo Agocs committed
605 606 607
/*!
    \class QRhiViewport
    \inmodule QtRhi
608
    \brief Specifies a viewport rectangle.
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626

    Used with QRhiCommandBuffer::setViewport().

    \note QRhi assumes OpenGL-style viewport coordinates, meaning x and y are
    bottom-left.

    Typical usage is like the following:

    \badcode
      const QSize outputSizeInPixels = swapchain->currentPixelSize();
      const QRhiViewport viewport(0, 0, outputSizeInPixels.width(), outputSizeInPixels.height());
      cb->beginPass(swapchain->currentFrameRenderTarget(), { 0, 0, 0, 1 }, { 1, 0 });
      cb->setGraphicsPipeline(ps);
      cb->setViewport(viewport);
      ...
    \endcode

    \sa QRhiCommandBuffer::setViewport(), QRhi::clipSpaceCorrMatrix(), QRhiScissor
Laszlo Agocs's avatar
Laszlo Agocs committed
627 628
 */

629 630 631 632 633 634
/*!
    Constructs a viewport description with a default rectangle and depth range.
    The default depth range is 0.0f - 1.0f.

    \sa QRhi::clipSpaceCorrMatrix()
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
635 636 637 638 639 640 641
QRhiViewport::QRhiViewport()
    : m_rect(0, 0, 1280, 720),
      m_minDepth(0),
      m_maxDepth(1)
{
}

642 643 644 645 646 647 648 649
/*!
    Constructs a viewport description with the rectangle specified by \a x, \a
    y, \a w, \a h and the depth range \a minDepth and \a maxDepth.

    \note x and y are assumed to be the bottom-left position.

    \sa QRhi::clipSpaceCorrMatrix()
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
650 651 652 653 654 655 656
QRhiViewport::QRhiViewport(float x, float y, float w, float h, float minDepth, float maxDepth)
    : m_rect(x, y, w, h),
      m_minDepth(minDepth),
      m_maxDepth(maxDepth)
{
}

657
/*!
658
    \return \c true if the values in the two QRhiViewport objects
659 660 661 662 663 664 665 666 667 668 669 670
    \a a and \a b are equal.

    \relates QRhiViewport
 */
bool operator==(const QRhiViewport &a, const QRhiViewport &b) Q_DECL_NOTHROW
{
    return a.viewport() == b.viewport()
            && a.minDepth() == b.minDepth()
            && a.maxDepth() == b.maxDepth();
}

/*!
671
    \return \c false if the values in the two QRhiViewport
672 673 674 675 676 677 678 679 680 681
    objects \a a and \a b are equal; otherwise returns \c true.

    \relates QRhiViewport
*/
bool operator!=(const QRhiViewport &a, const QRhiViewport &b) Q_DECL_NOTHROW
{
    return !(a == b);
}

/*!
682
    \return the hash value for \a v, using \a seed to seed the calculation.
683 684 685 686 687 688 689 690 691

    \relates QRhiViewport
 */
uint qHash(const QRhiViewport &v, uint seed) Q_DECL_NOTHROW
{
    const QVector4D r = v.viewport();
    return seed + r.x() + r.y() + r.z() + r.w() + qFloor(v.minDepth() * 100) + qFloor(v.maxDepth() * 100);
}

692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug dbg, const QRhiViewport &v)
{
    QDebugStateSaver saver(dbg);
    const QVector4D r = v.viewport();
    dbg.nospace() << "QRhiViewport(bottom-left-x=" << r.x()
                  << " bottom-left-y=" << r.y()
                  << " width=" << r.z()
                  << " height=" << r.w()
                  << " minDepth=" << v.minDepth()
                  << " maxDepth=" << v.maxDepth()
                  << ')';
    return dbg;
}
#endif

Laszlo Agocs's avatar
Laszlo Agocs committed
708 709 710
/*!
    \class QRhiScissor
    \inmodule QtRhi
711
    \brief Specifies a scissor rectangle.
712 713 714 715 716

    Used with QRhiCommandBuffer::setScissor(). Setting a scissor rectangle is
    only possible with a QRhiGraphicsPipeline that has
    QRhiGraphicsPipeline::UsesScissor set.

717
    \note QRhi assumes OpenGL-style scissor coordinates, meaning x and y are
718 719 720
    bottom-left.

    \sa QRhiCommandBuffer::setScissor(), QRhiViewport
Laszlo Agocs's avatar
Laszlo Agocs committed
721 722
 */

723 724 725
/*!
    Constructs an empty scissor.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
726 727 728 729
QRhiScissor::QRhiScissor()
{
}

730 731 732 733 734 735
/*!
    Constructs a scissor with the rectangle specified by \a x, \a y, \a w, and
    \a h.

    \note x and y are assumed to be the bottom-left position.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
736 737 738 739
QRhiScissor::QRhiScissor(int x, int y, int w, int h)
    : m_rect(x, y, w, h)
{
}
Laszlo Agocs's avatar
Laszlo Agocs committed
740

741
/*!
742
    \return \c true if the values in the two QRhiScissor objects
743 744 745 746 747 748 749 750 751 752
    \a a and \a b are equal.

    \relates QRhiScissor
 */
bool operator==(const QRhiScissor &a, const QRhiScissor &b) Q_DECL_NOTHROW
{
    return a.scissor() == b.scissor();
}

/*!
753
    \return \c false if the values in the two QRhiScissor
754 755 756 757 758 759 760 761 762 763
    objects \a a and \a b are equal; otherwise returns \c true.

    \relates QRhiScissor
*/
bool operator!=(const QRhiScissor &a, const QRhiScissor &b) Q_DECL_NOTHROW
{
    return !(a == b);
}

/*!
764
    \return the hash value for \a v, using \a seed to seed the calculation.
765 766 767 768 769 770 771 772 773

    \relates QRhiScissor
 */
uint qHash(const QRhiScissor &v, uint seed) Q_DECL_NOTHROW
{
    const QVector4D r = v.scissor();
    return seed + r.x() + r.y() + r.z() + r.w();
}

774 775 776 777 778 779 780 781 782 783 784 785 786 787
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug dbg, const QRhiScissor &s)
{
    QDebugStateSaver saver(dbg);
    const QVector4D r = s.scissor();
    dbg.nospace() << "QRhiScissor(bottom-left-x=" << r.x()
                  << " bottom-left-y=" << r.y()
                  << " width=" << r.z()
                  << " height=" << r.w()
                  << ')';
    return dbg;
}
#endif

Laszlo Agocs's avatar
Laszlo Agocs committed
788
/*!
789
    \class QRhiVertexInputBinding
Laszlo Agocs's avatar
Laszlo Agocs committed
790
    \inmodule QtRhi
791
    \brief Describes a vertex input binding.
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809

    Specifies the stride (in bytes, must be a multiple of 4), the
    classification and optionally the instance step rate.

    As an example, assume a vertex shader with the following inputs:

    \badcode
        layout(location = 0) in vec4 position;
        layout(location = 1) in vec2 texcoord;
    \endcode

    Now let's assume also that 3 component vertex positions \c{(x, y, z)} and 2
    component texture coordinates \c{(u, v)} are provided in a non-interleaved
    format in a buffer (or separate buffers even). Definining two bindings
    could then be done like this:

    \badcode
        QRhiVertexInputLayout inputLayout;
810
        inputLayout.setBindings({
811 812
            { 3 * sizeof(float) },
            { 2 * sizeof(float) }
813
        });
814 815 816
    \endcode

    Only the stride is interesting here since instancing is not used. The
817
    binding number is given by the index of the QRhiVertexInputBinding
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
    element in the bindings vector of the QRhiVertexInputLayout.

    Once a graphics pipeline with this vertex input layout is bound, the vertex
    inputs could be set up like the following for drawing a cube with 36
    vertices, assuming we have a single buffer with first the positions and
    then the texture coordinates:

    \badcode
        cb->setVertexInput(0, { { cubeBuf, 0 }, { cubeBuf, 36 * 3 * sizeof(float) } });
    \endcode

    Note how the index defined by \c {startBinding + i}, where \c i is the
    index in the second argument of
    \l{QRhiCommandBuffer::setVertexInput()}{setVertexInput()}, matches the
    index of the corresponding entry in the \c bindings vector of the
    QRhiVertexInputLayout.

    \note the stride must always be a multiple of 4.

    \sa QRhiCommandBuffer::setVertexInput()
Laszlo Agocs's avatar
Laszlo Agocs committed
838 839
 */

840
/*!
841
    \enum QRhiVertexInputBinding::Classification
842 843 844 845 846 847
    Describes the input data classification.

    \value PerVertex Data is per-vertex
    \value PerInstance Data is per-instance
 */

848 849 850
/*!
    Constructs an empty vertex input binding description.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
851 852 853 854
QRhiVertexInputBinding::QRhiVertexInputBinding()
{
}

855 856 857 858 859 860 861
/*!
    Constructs a vertex input binding description with the specified \a stride,
    classification \a cls, and instance step rate \a stepRate.

    \note \a stepRate other than 1 is only supported when
    QRhi::CustomInstanceStepRate is reported to be supported.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
862 863 864 865 866 867 868
QRhiVertexInputBinding::QRhiVertexInputBinding(quint32 stride, Classification cls, int stepRate)
    : m_stride(stride),
      m_classification(cls),
      m_instanceStepRate(stepRate)
{
}

869
/*!
870
    \return \c true if the values in the two QRhiVertexInputBinding objects
871 872 873 874 875 876 877 878 879 880 881 882
    \a a and \a b are equal.

    \relates QRhiVertexInputBinding
 */
bool operator==(const QRhiVertexInputBinding &a, const QRhiVertexInputBinding &b) Q_DECL_NOTHROW
{
    return a.stride() == b.stride()
            && a.classification() == b.classification()
            && a.instanceStepRate() == b.instanceStepRate();
}

/*!
883
    \return \c false if the values in the two QRhiVertexInputBinding
884 885 886 887 888 889 890 891 892 893
    objects \a a and \a b are equal; otherwise returns \c true.

    \relates QRhiVertexInputBinding
*/
bool operator!=(const QRhiVertexInputBinding &a, const QRhiVertexInputBinding &b) Q_DECL_NOTHROW
{
    return !(a == b);
}

/*!
894
    \return the hash value for \a v, using \a seed to seed the calculation.
895 896 897 898 899 900 901 902

    \relates QRhiVertexInputBinding
 */
uint qHash(const QRhiVertexInputBinding &v, uint seed) Q_DECL_NOTHROW
{
    return seed + v.stride() + v.classification();
}

903 904 905 906 907 908 909 910 911 912 913 914
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug dbg, const QRhiVertexInputBinding &b)
{
    QDebugStateSaver saver(dbg);
    dbg.nospace() << "QRhiVertexInputBinding(stride=" << b.stride()
                  << " cls=" << b.classification()
                  << " step-rate=" << b.instanceStepRate()
                  << ')';
    return dbg;
}
#endif

Laszlo Agocs's avatar
Laszlo Agocs committed
915
/*!
916
    \class QRhiVertexInputAttribute
Laszlo Agocs's avatar
Laszlo Agocs committed
917
    \inmodule QtRhi
918
    \brief Describes a single vertex input element.
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940

    The members specify the binding number, location, format, and offset for a
    single vertex input element.

    \note For HLSL it is assumed that the vertex shader uses
    \c{TEXCOORD<location>} as the semantic for each input. Hence no separate
    semantic name and index.

    As an example, assume a vertex shader with the following inputs:

    \badcode
        layout(location = 0) in vec4 position;
        layout(location = 1) in vec2 texcoord;
    \endcode

    Now let's assume that we have 3 component vertex positions \c{(x, y, z)}
    and 2 component texture coordinates \c{(u, v)} are provided in a
    non-interleaved format in a buffer (or separate buffers even). Once two
    bindings are defined, the attributes could be specified as:

    \badcode
        QRhiVertexInputLayout inputLayout;
941
        inputLayout.setBindings({
942 943
            { 3 * sizeof(float) },
            { 2 * sizeof(float) }
944 945 946 947 948
        });
        inputLayout.setAttributes({
            { 0, 0, QRhiVertexInputAttribute::Float3, 0 },
            { 1, 1, QRhiVertexInputAttribute::Float2, 0 }
        });
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965
    \endcode

    Once a graphics pipeline with this vertex input layout is bound, the vertex
    inputs could be set up like the following for drawing a cube with 36
    vertices, assuming we have a single buffer with first the positions and
    then the texture coordinates:

    \badcode
        cb->setVertexInput(0, { { cubeBuf, 0 }, { cubeBuf, 36 * 3 * sizeof(float) } });
    \endcode

    When working with interleaved data, there will typically be just one
    binding, with multiple attributes refering to that same buffer binding
    point:

    \badcode
        QRhiVertexInputLayout inputLayout;
966
        inputLayout.setBindings({
967
            { 5 * sizeof(float) }
968 969 970 971 972
        });
        inputLayout.setAttributes({
            { 0, 0, QRhiVertexInputAttribute::Float3, 0 },
            { 0, 1, QRhiVertexInputAttribute::Float2, 3 * sizeof(float) }
        });
973 974 975 976 977 978 979 980 981
    \endcode

    and then:

    \badcode
        cb->setVertexInput(0, { { interleavedCubeBuf, 0 } });
    \endcode

    \sa QRhiCommandBuffer::setVertexInput()
Laszlo Agocs's avatar
Laszlo Agocs committed
982 983
 */

984
/*!
985
    \enum QRhiVertexInputAttribute::Format
986 987 988 989 990 991 992 993 994 995 996
    Specifies the type of the element data.

    \value Float4 Four component float vector
    \value Float3 Three component float vector
    \value Float2 Two component float vector
    \value Float Float
    \value UNormByte4 Four component normalized unsigned byte vector
    \value UNormByte2 Two component normalized unsigned byte vector
    \value UNormByte Normalized unsigned byte
 */

997 998 999
/*!
    Constructs an empty vertex input attribute description.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1000 1001 1002 1003
QRhiVertexInputAttribute::QRhiVertexInputAttribute()
{
}

1004 1005 1006 1007
/*!
    Constructs a vertex input attribute description with the specified \a
    binding number, \a location, \a format, and \a offset.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1008 1009 1010 1011 1012 1013 1014 1015
QRhiVertexInputAttribute::QRhiVertexInputAttribute(int binding, int location, Format format, quint32 offset)
    : m_binding(binding),
      m_location(location),
      m_format(format),
      m_offset(offset)
{
}

1016
/*!
1017
    \return \c true if the values in the two QRhiVertexInputAttribute objects
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
    \a a and \a b are equal.

    \relates QRhiVertexInputAttribute
 */
bool operator==(const QRhiVertexInputAttribute &a, const QRhiVertexInputAttribute &b) Q_DECL_NOTHROW
{
    return a.binding() == b.binding()
            && a.location() == b.location()
            && a.format() == b.format()
            && a.offset() == b.offset();
}

/*!
1031
    \return \c false if the values in the two QRhiVertexInputAttribute
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
    objects \a a and \a b are equal; otherwise returns \c true.

    \relates QRhiVertexInputAttribute
*/
bool operator!=(const QRhiVertexInputAttribute &a, const QRhiVertexInputAttribute &b) Q_DECL_NOTHROW
{
    return !(a == b);
}

/*!
1042
    \return the hash value for \a v, using \a seed to seed the calculation.
1043 1044 1045 1046 1047 1048 1049 1050

    \relates QRhiVertexInputAttribute
 */
uint qHash(const QRhiVertexInputAttribute &v, uint seed) Q_DECL_NOTHROW
{
    return seed + v.binding() + v.location() + v.format() + v.offset();
}

1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug dbg, const QRhiVertexInputAttribute &a)
{
    QDebugStateSaver saver(dbg);
    dbg.nospace() << "QRhiVertexInputAttribute(binding=" << a.binding()
                  << " location=" << a.location()
                  << " format=" << a.format()
                  << " offset=" << a.offset()
                  << ')';
    return dbg;
}
#endif

Laszlo Agocs's avatar
Laszlo Agocs committed
1064 1065 1066 1067
/*!
    \class QRhiVertexInputLayout
    \inmodule QtRhi
    \brief Describes the layout of vertex inputs consumed by a vertex shader.
1068 1069 1070

    The vertex input layout is defined by the collections of
    QRhiVertexInputBinding and QRhiVertexInputAttribute.
Laszlo Agocs's avatar
Laszlo Agocs committed
1071 1072
 */

1073 1074 1075
/*!
    Constructs an empty vertex input layout description.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1076 1077 1078 1079
QRhiVertexInputLayout::QRhiVertexInputLayout()
{
}

1080
/*!
1081
    \return \c true if the values in the two QRhiVertexInputLayout objects
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
    \a a and \a b are equal.

    \relates QRhiVertexInputLayout
 */
bool operator==(const QRhiVertexInputLayout &a, const QRhiVertexInputLayout &b) Q_DECL_NOTHROW
{
    return a.bindings() == b.bindings()
            && a.attributes() == b.attributes();
}

/*!
1093
    \return \c false if the values in the two QRhiVertexInputLayout
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
    objects \a a and \a b are equal; otherwise returns \c true.

    \relates QRhiVertexInputLayout
*/
bool operator!=(const QRhiVertexInputLayout &a, const QRhiVertexInputLayout &b) Q_DECL_NOTHROW
{
    return !(a == b);
}

/*!
1104
    \return the hash value for \a v, using \a seed to seed the calculation.
1105 1106 1107 1108 1109 1110 1111 1112

    \relates QRhiVertexInputLayout
 */
uint qHash(const QRhiVertexInputLayout &v, uint seed) Q_DECL_NOTHROW
{
    return qHash(v.bindings(), seed) + qHash(v.attributes(), seed);
}

1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug dbg, const QRhiVertexInputLayout &v)
{
    QDebugStateSaver saver(dbg);
    dbg.nospace() << "QRhiVertexInputLayout(bindings=" << v.bindings()
                  << " attributes=" << v.attributes()
                  << ')';
    return dbg;
}
#endif

Laszlo Agocs's avatar
Laszlo Agocs committed
1124 1125 1126
/*!
    \class QRhiGraphicsShaderStage
    \inmodule QtRhi
1127
    \brief Specifies the type and the shader code for a shader stage in the graphics pipeline.
1128

1129 1130 1131 1132
    \note Some backends only support a subset of the stages. Use
    QRhi::isFeatureSupported() to query for support at runtime. For example,
    Metal has no geometry shader support, while the OpenGL 2.x backend only
    supports the vertex and fragment stages.
Laszlo Agocs's avatar
Laszlo Agocs committed
1133 1134
 */

1135 1136 1137 1138 1139 1140
/*!
    \enum QRhiGraphicsShaderStage::Type
    Specifies the type of the shader stage.

    \value Vertex Vertex stage
    \value Fragment Fragment (pixel) stage
1141
    \value Geometry Geometry stage
1142 1143 1144 1145
    \value TessellationControl Tessellation control (hull) stage
    \value TessellationEvaluation Tessellation evaluation (domain) stage
 */

1146 1147 1148
/*!
    Constructs an empty shader stage description.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1149 1150 1151
QRhiGraphicsShaderStage::QRhiGraphicsShaderStage()
{
}
1152

1153 1154 1155
/*!
    Constructs a shader stage description with the \a type of the stage and the
    \a shader.
1156 1157 1158 1159 1160

    The shader variant \a v defaults to QBakedShaderKey::StandardShader. A
    QBakedShader pack contains multiple source and binary versions of a shader.
    In addition, it can also contain variants of the shader with slightly
    modified code. \a v can then be used to select the desired variant.
1161
 */
1162
QRhiGraphicsShaderStage::QRhiGraphicsShaderStage(Type type, const QBakedShader &shader, QBakedShaderKey::ShaderVariant v)
Laszlo Agocs's avatar
Laszlo Agocs committed
1163
    : m_type(type),
1164 1165
      m_shader(shader),
      m_shaderVariant(v)
Laszlo Agocs's avatar
Laszlo Agocs committed
1166 1167
{
}
Laszlo Agocs's avatar
Laszlo Agocs committed
1168

1169
/*!
1170
    \return \c true if the values in the two QRhiGraphicsShaderStage objects
1171 1172 1173 1174 1175 1176 1177
    \a a and \a b are equal.

    \relates QRhiGraphicsShaderStage
 */
bool operator==(const QRhiGraphicsShaderStage &a, const QRhiGraphicsShaderStage &b) Q_DECL_NOTHROW
{
    return a.type() == b.type()
1178 1179
            && a.shader() == b.shader()
            && a.shaderVariant() == b.shaderVariant();
1180 1181 1182
}

/*!
1183
    \return \c false if the values in the two QRhiGraphicsShaderStage
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
    objects \a a and \a b are equal; otherwise returns \c true.

    \relates QRhiGraphicsShaderStage
*/
bool operator!=(const QRhiGraphicsShaderStage &a, const QRhiGraphicsShaderStage &b) Q_DECL_NOTHROW
{
    return !(a == b);
}

/*!
1194
    \return the hash value for \a v, using \a seed to seed the calculation.
1195 1196 1197 1198 1199

    \relates QRhiGraphicsShaderStage
 */
uint qHash(const QRhiGraphicsShaderStage &v, uint seed) Q_DECL_NOTHROW
{
1200
    return v.type() + qHash(v.shader(), seed) + v.shaderVariant();
1201 1202
}

1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug dbg, const QRhiGraphicsShaderStage &s)
{
    QDebugStateSaver saver(dbg);
    dbg.nospace() << "QRhiGraphicsShaderStage(type=" << s.type()
                  << " shader=" << s.shader()
                  << " variant=" << s.shaderVariant()
                  << ')';
    return dbg;
}
#endif

Laszlo Agocs's avatar
Laszlo Agocs committed
1215
/*!
1216
    \class QRhiColorAttachment
Laszlo Agocs's avatar
Laszlo Agocs committed
1217
    \inmodule QtRhi
1218 1219 1220
    \brief Describes the a single color attachment of a render target.

    A color attachment is either a QRhiTexture or a QRhiRenderBuffer. The
1221
    former, when texture() is set, is used in most cases.
1222

1223 1224
    \note texture() and renderBuffer() cannot be both set (be non-null at the
    same time).
1225 1226 1227 1228 1229 1230 1231 1232

    Setting renderBuffer instead is recommended only when multisampling is
    needed. Relying on QRhi::MultisampleRenderBuffer is a better choice than
    QRhi::MultisampleTexture in practice since the former is available in more
    run time configurations (e.g. when running on OpenGL ES 3.0 which has no
    support for multisample textures, but does support multisample
    renderbuffers).

1233
    When targeting a non-multisample texture, the layer() and level()
1234 1235 1236
    indicate the targeted layer (face index \c{0-5} for cubemaps) and mip
    level.

1237
    When texture() or renderBuffer() is multisample, resolveTexture() can be
1238 1239 1240 1241 1242 1243 1244
    set optionally. When set, samples are resolved automatically into that
    (non-multisample) texture at the end of the render pass. When rendering
    into a multisample renderbuffers, this is the only way to get resolved,
    non-multisample content out of them. Multisample textures allow sampling in
    shaders so for them this is just one option.

    \note when resolving is enabled, the multisample data may not be written
1245 1246
    out at all. This means that the multisample texture() must not be used
    afterwards with shaders for sampling when resolveTexture() is set.
Laszlo Agocs's avatar
Laszlo Agocs committed
1247 1248
 */

1249 1250 1251
/*!
    Constructs an empty color attachment description.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1252 1253 1254 1255
QRhiColorAttachment::QRhiColorAttachment()
{
}

1256 1257 1258 1259
/*!
    Constructs a color attachment description that specifies \a texture as the
    associated color buffer.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1260 1261 1262 1263 1264
QRhiColorAttachment::QRhiColorAttachment(QRhiTexture *texture)
    : m_texture(texture)
{
}

1265 1266 1267 1268
/*!
    Constructs a color attachment description that specifies \a renderBuffer as
    the associated color buffer.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
QRhiColorAttachment::QRhiColorAttachment(QRhiRenderBuffer *renderBuffer)
    : m_renderBuffer(renderBuffer)
{
}

/*!
    \class QRhiTextureRenderTargetDescription
    \inmodule QtRhi
    \brief Describes the color and depth or depth/stencil attachments of a render target.

    A texture render target has zero or more textures as color attachments,
    zero or one renderbuffer as combined depth/stencil buffer or zero or one
    texture as depth buffer.

    \note depthStencilBuffer() and depthTexture() cannot be both set (cannot be
    non-null at the same time).
 */

1287 1288 1289
/*!
    Constructs an empty texture render target description.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1290 1291 1292 1293
QRhiTextureRenderTargetDescription::QRhiTextureRenderTargetDescription()
{
}

1294 1295 1296 1297
/*!
    Constructs a texture render target description with one attachment
    described by \a colorAttachment.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1298 1299 1300 1301 1302
QRhiTextureRenderTargetDescription::QRhiTextureRenderTargetDescription(const QRhiColorAttachment &colorAttachment)
{
    m_colorAttachments.append(colorAttachment);
}

1303 1304 1305 1306 1307
/*!
    Constructs a texture render target description with two attachments, a
    color attachment described by \a colorAttachment, and a depth/stencil
    attachment with \a depthStencilBuffer.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1308 1309 1310 1311 1312 1313 1314
QRhiTextureRenderTargetDescription::QRhiTextureRenderTargetDescription(const QRhiColorAttachment &colorAttachment,
                                                                       QRhiRenderBuffer *depthStencilBuffer)
    : m_depthStencilBuffer(depthStencilBuffer)
{
    m_colorAttachments.append(colorAttachment);
}

1315 1316 1317 1318 1319 1320 1321 1322
/*!
    Constructs a texture render target description with two attachments, a
    color attachment described by \a colorAttachment, and a depth attachment
    with \a depthTexture.

    \note \a depthTexture must have a suitable format, such as QRhiTexture::D16
    or QRhiTexture::D32.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335
QRhiTextureRenderTargetDescription::QRhiTextureRenderTargetDescription(const QRhiColorAttachment &colorAttachment,
                                                                       QRhiTexture *depthTexture)
    : m_depthTexture(depthTexture)
{
    m_colorAttachments.append(colorAttachment);
}

/*!
    \class QRhiTextureMipLevel
    \inmodule QtRhi
    \brief Describes one mip level in a layer in a texture upload operation.

    The source content is specified either as a QImage or as a raw blob. The
1336 1337 1338
    former is only allowed for uncompressed textures with a format that can be
    mapped to QImage, while the latter is only supported for floating point and
    compressed textures.
Laszlo Agocs's avatar
Laszlo Agocs committed
1339

1340
    \note image() and data() cannot be both set at the same time.
Laszlo Agocs's avatar
Laszlo Agocs committed
1341 1342 1343 1344 1345 1346

    destinationTopLeft() specifies the top-left corner of the target
    rectangle. Defaults to (0, 0).

    An empty sourceSize() (the default) indicates that size is assumed to be
    the size of the subresource. For uncompressed textures this implies that
1347 1348 1349
    the size of the source image() must match the subresource. For floating
    point and compressed textures sufficient amount of data must be provided in
    data().
Laszlo Agocs's avatar
Laszlo Agocs committed
1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360

    \note With compressed textures the first upload must always match the
    subresource size due to graphics API limitations with some backends.

    sourceTopLeft() is is only supported for uncompressed textures, and
    specifies the top-left corner of the source rectangle.

    \note Setting sourceSize() or sourceTopLeft() may trigger a QImage copy
    internally, depending on the format and the backend.
 */

1361 1362 1363
/*!
    Constructs an empty mip level description.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1364 1365 1366 1367
QRhiTextureMipLevel::QRhiTextureMipLevel()
{
}

1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379
/*!
    Constructs a mip level description with a \a image.

    The \l{QImage::size()}{size} of \a image must match the size of the mip
    level. For level 0 that is the \l{QRhiTexture::pixelSize()}{texture size}.

    The bit depth of \a image must be compatible with the
    \l{QRhiTexture::Format}{texture format}.

    To describe a partial upload, call setSourceSize(), setSourceTopLeft(), or
    setDestinationTopLeft() afterwards.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1380 1381 1382 1383 1384
QRhiTextureMipLevel::QRhiTextureMipLevel(const QImage &image)
    : m_image(image)
{
}

1385
/*!
1386 1387 1388
    Constructs a mip level description suitable for textures with a format that
    does not map to QImage. The floating point or compressed data is specified
    in \a data.
1389
 */
1390 1391
QRhiTextureMipLevel::QRhiTextureMipLevel(const QByteArray &data)
    : m_data(data)
Laszlo Agocs's avatar
Laszlo Agocs committed
1392 1393 1394 1395 1396 1397 1398 1399 1400
{
}

/*!
    \class QRhiTextureLayer
    \inmodule QtRhi
    \brief Describes one layer (face for cubemaps) in a texture upload operation.
 */

1401 1402 1403
/*!
    Constructs an empty texture layer description.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1404 1405 1406 1407
QRhiTextureLayer::QRhiTextureLayer()
{
}

1408 1409 1410 1411
/*!
    Constructs a texture layer description with the specified list of \a
    mipImages.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1412 1413 1414 1415 1416
QRhiTextureLayer::QRhiTextureLayer(const QVector<QRhiTextureMipLevel> &mipImages)
    : m_mipImages(mipImages)
{
}

Laszlo Agocs's avatar
Laszlo Agocs committed
1417 1418 1419
/*!
    \class QRhiTextureUploadDescription
    \inmodule QtRhi
1420
    \brief Describes a texture upload operation.
1421

1422 1423 1424 1425 1426 1427 1428 1429
    Used with QRhiResourceUpdateBatch::uploadTexture(). That function has two
    variants: one taking a QImage and one taking a
    QRhiTextureUploadDescription. The former is a convenience version,
    internally creating a QRhiTextureUploadDescription with a single layer and
    a single image in that layer. However, when cubemaps, pre-generated mip
    images, or compressed textures are involved, applications will have to work
    directly with this class instead.

1430 1431
    \note Cubemaps have one layer for each of the six faces in the order +X,
    -X, +Y, -Y, +Z, -Z.
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457

    For example, specifying the faces of a cubemap could look like the following:

    \badcode
        QImage faces[6];
        ...
        QVector<QRhiTextureLayer> layers;
        for (int i = 0; i < 6; ++i)
          layers.append(QRhiTextureLayer({ QRhiTextureMipLevel(faces[i]) });
        QRhiTextureUploadDescription desc(layers);
        resourceUpdates->uploadTexture(texture, desc);
    \endcode

    Another example that specifies mip images for a compressed texture:

    \badcode
        QVector<QRhiTextureMipLevel> mipImages;
        const int mipCount = rhi->mipLevelsForSize(compressedTexture->pixelSize());
        for (int level = 0; level < mipCount; ++level) {
            const QByteArray compressedDataForLevel = ...
            mipImages.append(QRhiTextureMipLevel(compressedDataForLevel));
        }
        QRhiTextureLayer layer(mipImages);
        QRhiTextureUploadDescription desc({ layer });
        resourceUpdates->uploadTexture(compressedTexture, desc);
    \endcode
Laszlo Agocs's avatar
Laszlo Agocs committed
1458 1459
 */

1460 1461 1462
/*!
    Constructs an empty texture upload description.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1463 1464 1465
QRhiTextureUploadDescription::QRhiTextureUploadDescription()
{
}
1466

1467 1468 1469 1470
/*!
    Constructs a texture upload description with the specified list of \a
    layers.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1471 1472 1473 1474
QRhiTextureUploadDescription::QRhiTextureUploadDescription(const QVector<QRhiTextureLayer> &layers)
    : m_layers(layers)
{
}
Laszlo Agocs's avatar
Laszlo Agocs committed
1475 1476 1477 1478

/*!
    \class QRhiTextureCopyDescription
    \inmodule QtRhi
1479
    \brief Describes a texture-to-texture copy operation.
1480

1481 1482 1483
    An empty pixelSize() indicates that the entire subresource is to be copied.
    A default constructed copy description therefore leads to copying the
    entire subresource at level 0 of layer 0.
1484 1485 1486

    \note The source texture must be created with
    QRhiTexture::UsedAsTransferSource.
1487 1488 1489 1490

    \note The source and destination rectangles defined by pixelSize(),
    sourceTopLeft(), and destinationTopLeft() must fit the source and
    destination textures, respectively. The behavior is undefined otherwise.
Laszlo Agocs's avatar
Laszlo Agocs committed
1491 1492
 */

1493 1494 1495
/*!
    Constructs an empty texture copy description.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1496 1497 1498 1499
QRhiTextureCopyDescription::QRhiTextureCopyDescription()
{
}

Laszlo Agocs's avatar
Laszlo Agocs committed
1500 1501 1502
/*!
    \class QRhiReadbackDescription
    \inmodule QtRhi
1503
    \brief Describes a readback (reading back texture contents from possibly GPU-only memory) operation.
1504 1505

    The source of the readback operation is either a QRhiTexture or the
1506 1507
    current backbuffer of the currently targeted QRhiSwapChain. When
    texture() is not set, the swapchain is used. Otherwise the specified
1508 1509 1510 1511 1512 1513 1514 1515
    QRhiTexture is treated as the source.

    \note Textures used in readbacks must be created with
    QRhiTexture::UsedAsTransferSource.

    \note Swapchains used in readbacks must be created with
    QRhiSwapChain::UsedAsTransferSource.

1516
    layer() and level() are only applicable when the source is a QRhiTexture.
1517 1518 1519

    \note Multisample textures cannot be read back. Readbacks are supported for
    multisample swapchain buffers however.
Laszlo Agocs's avatar
Laszlo Agocs committed
1520 1521
 */

1522 1523 1524 1525 1526 1527 1528 1529 1530
/*!
    Constructs an empty texture readback description.

    \note The source texture is set to null by default, which is still a valid
    readback: it specifies that the backbuffer of the current swapchain is to
    be read back. (current meaning the frame's target swapchain at the time of
    committing the QRhiResourceUpdateBatch with the
    \l{QRhiResourceUpdateBatch::readBackTexture()}{texture readback} on it)
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1531 1532 1533 1534
QRhiReadbackDescription::QRhiReadbackDescription()
{
}

1535 1536 1537 1538 1539 1540 1541
/*!
    Constructs an texture readback description that specifies that level 0 of
    layer 0 of \a texture is to be read back.

    \note \a texture can also be null in which case this constructor is
    identical to the argumentless variant.
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1542 1543 1544 1545 1546
QRhiReadbackDescription::QRhiReadbackDescription(QRhiTexture *texture)
    : m_texture(texture)
{
}

Laszlo Agocs's avatar
Laszlo Agocs committed
1547 1548 1549
/*!
    \class QRhiReadbackResult
    \inmodule QtRhi
1550
    \brief Describes the results of a potentially asynchronous readback operation.
1551 1552 1553 1554

    When \l completed is set, the function is invoked when the \l data is
    available. \l format and \l pixelSize are set upon completion together with
    \l data.
Laszlo Agocs's avatar
Laszlo Agocs committed
1555 1556 1557 1558 1559
 */

/*!
    \class QRhiNativeHandles
    \inmodule QtRhi
1560
    \brief Base class for classes exposing backend-specific collections of native resource objects.
Laszlo Agocs's avatar
Laszlo Agocs committed
1561 1562 1563 1564 1565
 */

/*!
    \class QRhiResource
    \inmodule QtRhi
1566
    \brief Base class for classes encapsulating native resource objects.
Laszlo Agocs's avatar
Laszlo Agocs committed
1567 1568 1569
 */

/*!
Laszlo Agocs's avatar
Laszlo Agocs committed
1570
    \internal
Laszlo Agocs's avatar
Laszlo Agocs committed
1571
 */
1572 1573
QRhiResource::QRhiResource(QRhiImplementation *rhi)
    : m_rhi(rhi)
Laszlo Agocs's avatar
Laszlo Agocs committed
1574
{
1575
    m_id = QRhiGlobalObjectIdGenerator::newId();
Laszlo Agocs's avatar
Laszlo Agocs committed
1576
}
Laszlo Agocs's avatar
Laszlo Agocs committed
1577

1578
/*!
Laszlo Agocs's avatar
Laszlo Agocs committed
1579
   Destructor.
1580
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
1581 1582 1583
QRhiResource::~QRhiResource()
{
}
1584

1585
/*!
Laszlo Agocs's avatar
Laszlo Agocs committed
1586
    \fn void QRhiResource::release()
1587

1588 1589 1590
    Releases (or requests defered releasing of) the underlying native graphics
    resources. Safe to call multiple times, subsequent invocations will be a
    no-op then.
Laszlo Agocs's avatar
Laszlo Agocs committed
1591 1592 1593

    Once release() is called, the QRhiResource instance can be reused, by
    calling the appropriate \c build() function again, or destroyed.
1594 1595 1596 1597 1598

    \note Resources referenced by commands for the current frame should not be
    released until the frame is submitted by QRhi::endFrame().

    \sa releaseAndDestroy(), releaseAndDestroyLater()
Laszlo Agocs's avatar
Laszlo Agocs committed
1599 1600 1601
 */

/*!
1602 1603 1604 1605 1606 1607 1608 1609
    Releases (or requests defered releasing of) the native graphics resources,
    if there are any, and destroys the QRhiResource. Equivalent to
    \c{r->release(); delete r; }.

    \note Resources referenced by commands for the current frame should not be
    released until the frame is submitted by QRhi::endFrame().

    \sa release(), releaseAndDestroyLater()
Laszlo Agocs's avatar
Laszlo Agocs committed
1610 1611 1612 1613 1614 1615 1616
 */
void QRhiResource::releaseAndDestroy()
{
    release();
    delete this;
}

1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631
/*!
    When called without a frame being recorded, this function is equivalent to
    releaseAndDestroy(). Between a QRhi::beginFrame() and QRhi::endFrame()
    however the behavior is different: the QRhiResource will not be destroyed
    until the frame is submitted via QRhi::endFrame(), thus satisfying the QRhi
    requirement of not altering QRhiResource objects that are referenced by the
    frame being recorded.

    \sa release(), releaseAndDestroy()
 */
void QRhiResource::releaseAndDestroyLater()
{
    m_rhi->addReleaseAndDestroyLater(this);
}

Laszlo Agocs's avatar
Laszlo Agocs committed
1632 1633 1634 1635 1636
/*!
    \return the currently set object name. By default the name is empty.
 */
QByteArray QRhiResource::name() const
{
1637
    return m_objectName;
Laszlo Agocs's avatar
Laszlo Agocs committed
1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
}

/*!
    Sets a \a name for the object.

    This has two uses: to get descriptive names for the native graphics
    resources visible in graphics debugging tools, such as
    \l{https://renderdoc.org/}{RenderDoc} and
    \l{https://developer.apple.com/xcode/}{XCode}, and in the output stream of
    QRhiProfiler.

    When it comes to naming native objects by relaying the name via the
    appropriate graphics API, note that the name is ignored when
    QRhi::DebugMarkers are not supported, and may, depending on the backend,
    also be ignored when QRhi::EnableDebugMarkers is not set.

    \note The name may be ignored for objects other than buffers,
    renderbuffers, and textures, depending on the backend.

    \note The name may be modified. For slotted resources, such as a QRhiBuffer
    backed by multiple native buffers, QRhi will append a suffix to make the
    underlying native buffers easily distinguishable from each other.
 */
void QRhiResource::setName(const QByteArray &name)
{
1663 1664
    m_objectName = name;
    m_objectName.replace(',', '_'); // cannot contain comma for QRhiProfiler
Laszlo Agocs's avatar
Laszlo Agocs committed
1665 1666
}

1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677
/*!
    \return the global, unique identifier of this QRhiResource.

    User code rarely needs to deal with the value directly. It is used
    internally for tracking and bookkeeping purposes.
 */
quint64 QRhiResource::globalResourceId() const
{
    return m_id;
}

Laszlo Agocs's avatar
Laszlo Agocs committed
1678 1679 1680 1681 1682 1683 1684 1685
/*!
    \class QRhiBuffer
    \inmodule QtRhi
    \brief Vertex, index, or uniform (constant) buffer resource.
 */

/*!
    \enum QRhiBuffer::Type
1686
    Specifies storage type of buffer resource.
Laszlo Agocs's avatar
Laszlo Agocs committed
1687 1688 1689 1690

    \value Immutable Indicates that the data is not expected to change ever
    after the initial upload. Under the hood such buffer resources are
    typically placed in device local (GPU) memory (on systems where
1691 1692 1693 1694
    applicable). Uploading new data is possible, but may be expensive. The
    upload typically happens by copying to a separate, host visible staging
    buffer from which a GPU buffer-to-buffer copy is issued into the actual
    GPU-only buffer.
1695 1696 1697 1698 1699 1700

    \value Static Indicates that the data is expected to change only
    infrequently. Typically placed in device local (GPU) memory, where
    applicable. On backends where host visible staging buffers are used for
    uploading, the staging buffers are kept around for this type, unlike with
    Immutable, so subsequent uploads do not suffer in performance. Frequent
1701
    updates, especially updates in consecutive frames, should be avoided.
1702 1703 1704 1705 1706

    \value Dynamic Indicates that the data is expected to change frequently.
    Not recommended for large buffers. Typically backed by host visible memory
    in 2 copies in order to allow for changing without stalling the graphics
    pipeline. The double buffering is managed transparently to the applications
1707 1708 1709
    and is not exposed in the API here in any form. This is the recommended,
    and, with some backends, the only possible, type for buffers with
    UniformBuffer usage.
1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720
 */

/*!
    \enum QRhiBuffer::UsageFlag
    Flag values to specify how the buffer is going to be used.

    \value VertexBuffer Vertex buffer
    \value IndexBuffer Index buffer
    \value UniformBuffer Uniform (constant) buffer
 */

Laszlo Agocs's avatar
Laszlo Agocs committed
1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816
/*!
    \fn void QRhiBuffer::setSize(int sz)

    Sets the size of the buffer in bytes. The size is normally specified in
    QRhi::newBuffer() so this function is only used when the size has to be
    changed. As with other setters, the size only takes effect when calling
    build(), and for already built buffers this involves releasing the previous
    native resource and creating new ones under the hood.

    Backends may choose to allocate buffers bigger than \a sz in order to
    fulfill alignment requirements. This is hidden from the applications and
    size() will always report the size requested in \a sz.
 */

/*!
    \internal
 */
QRhiBuffer::QRhiBuffer(QRhiImplementation *rhi, Type type_, UsageFlags usage_, int size_)
    : QRhiResource(rhi),
      m_type(type_), m_usage(usage_), m_size(size_)
{
}

/*!
    \fn bool QRhiBuffer::build()

    Creates the corresponding native graphics resources. If there are already
    resources present due to an earlier build() with no corresponding
    release(), then release() is called implicitly first.

    \return \c true when successful, \c false when a graphics operation failed.
    Regardless of the return value, calling release() is always safe.
 */

/*!
    \class QRhiRenderBuffer
    \inmodule QtRhi
    \brief Renderbuffer resource.

    Renderbuffers cannot be sampled or read but have some benefits over
    textures in some cases:

    A DepthStencil renderbuffer may be lazily allocated and be backed by
    transient memory with some APIs. On some platforms this may mean the
    depth/stencil buffer uses no physical backing at all.

    Color renderbuffers are useful since QRhi::MultisampleRenderBuffer may be
    supported even when QRhi::MultisampleTexture is not.

    How the renderbuffer is implemented by a backend is not exposed to the
    applications. In some cases it may be backed by ordinary textures, while in
    others there may be a different kind of native resource used.
 */

/*!
    \enum QRhiRenderBuffer::Type
    Specifies the type of the renderbuffer

    \value DepthStencil Combined depth/stencil
    \value Color Color
 */

/*!
    \enum QRhiRenderBuffer::Flag
    Flag values for flags() and setFlags()

    \value UsedWithSwapChainOnly For DepthStencil renderbuffers this indicates
    that the renderbuffer is only used in combination with a QRhiSwapChain and
    never in other ways. Relevant with some backends, while others ignore it.
    With OpenGL where a separate windowing system interface API is in use (EGL,
    GLX, etc.), the flag is important since it avoids creating any actual
    resource as there is already a windowing system provided depth/stencil
    buffer as requested by QSurfaceFormat.
 */

/*!
    \internal
 */
QRhiRenderBuffer::QRhiRenderBuffer(QRhiImplementation *rhi, Type type_, const QSize &pixelSize_,
                                   int sampleCount_, Flags flags_)
    : QRhiResource(rhi),
      m_type(type_), m_pixelSize(pixelSize_), m_sampleCount(sampleCount_), m_flags(flags_)
{
}

/*!
    \fn bool QRhiRenderBuffer::build()

    Creates the corresponding native graphics resources. If there are already
    resources present due to an earlier build() with no corresponding
    release(), then release() is called implicitly first.

    \return \c true when successful, \c false when a graphics operation failed.
    Regardless of the return value, calling release() is always safe.
 */

1817 1818 1819 1820 1821 1822
/*!
    \fn QRhiTexture::Format QRhiRenderBuffer::backingFormat() const

    \internal
 */

Laszlo Agocs's avatar
Laszlo Agocs committed
1823 1824 1825
/*!
    \class QRhiTexture
    \inmodule QtRhi
1826
    \brief Texture resource.
Laszlo Agocs's avatar
Laszlo Agocs committed
1827 1828
 */

1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854
/*!
    \enum QRhiTexture::Flag

    Flag values to specify how the texture is going to be used. Not honoring
    the flags set before build() and attempting to use the texture in ways that
    was not declared upfront can lead to unspecified behavior or decreased
    performance depending on the backend and the underlying graphics API.

    \value RenderTarget The texture going to be used in combination with
    QRhiTextureRenderTarget

    \value ChangesFrequently Performance hint to indicate that the texture
    contents will change frequently and so staging buffers, if any, are to be
    kept alive to avoid performance hits

    \value CubeMap The texture is a cubemap. Such textures have 6 layers, one
    for each face in the order of +X, -X, +Y, -Y, +Z, -Z. Cubemap textures
    cannot be multisample.

     \value MipMapped The texture has mipmaps. The appropriate mip count is
     calculated automatically and can also be retrieved via
     QRhi::mipLevelsForSize(). The images for the mip levels have to be
     provided in the texture uploaded or generated via
     QRhiResourceUpdateBatch::generateMips(). Multisample textures cannot have
     mipmaps.

1855
    \value sRGB Use an sRGB format.
1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872

    \value UsedAsTransferSource The texture is used as the source of a texture
    copy or readback, meaning the texture is given as the source in
    QRhiResourceUpdateBatch::copyTexture() or
    QRhiResourceUpdateBatch::readBackTexture().

     \value UsedWithGenerateMips The texture is going to be used with
     QRhiResourceUpdateBatch::generateMips().
 */

/*!
    \enum QRhiTexture::Format

    Specifies the texture format. See also QRhi::isTextureFormatSupported() and
    note that flags() can modify the format when QRhiTexture::sRGB is set.

    \value UnknownFormat Not a valid format. This cannot be passed to setFormat().
1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884

    \value RGBA8 Four component, unsigned normalized 8 bit per component. Always supported.

    \value BGRA8 Four component, unsigned normalized 8 bit per component.

    \value R8 One component, unsigned normalized 8 bit.

    \value R16 One component, unsigned normalized 16 bit.

    \value RED_OR_ALPHA8 Either same as R8, or is a similar format with the component swizzled to alpha,
    depending on \l{QRhi::RedOrAlpha8IsRed}{RedOrAlpha8IsRed}.

1885 1886 1887 1888
    \value RGBA16F Four components, 16-bit float per component.

    \value RGBA32F Four components, 32-bit float per component.

1889 1890 1891 1892
    \value D16 16-bit depth (normalized unsigned integer)

    \value D32 32-bit depth (32-bit float)

1893 1894 1895 1896 1897 1898 1899
    \value BC1
    \value BC2
    \value BC3
    \value BC4
    \value BC5
    \value BC6H
    \value BC7
1900

1901 1902 1903
    \value ETC2_RGB8
    \value ETC2_RGB8A1
    \value ETC2_RGBA8
1904

1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920
    \value ASTC_4x4
    \value ASTC_5x4
    \value ASTC_5x5
    \value ASTC_6x5
    \value ASTC_6x6
    \value ASTC_8x5
    \value ASTC_8x6
    \value ASTC_8x8
    \value ASTC_10x5
    \value ASTC_10x6
    \value ASTC_10x8
    \value ASTC_10x10
    \value ASTC_12x10
    \value ASTC_12x12
 */

Laszlo Agocs's avatar
Laszlo Agocs committed
1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983
/*!
    \internal
 */
QRhiTexture::QRhiTexture(QRhiImplementation *rhi, Format format_, const QSize &pixelSize_,
                         int sampleCount_, Flags flags_)
    : QRhiResource(rhi),
      m_format(format_), m_pixelSize(pixelSize_), m_sampleCount(sampleCount_), m_flags(flags_)
{
}

/*!
    \fn bool QRhiTexture::build()

    Creates the corresponding native graphics resources. If there are already
    resources present due to an earlier build() with no corresponding
    release(), then release() is called implicitly first.

    \return \c true when successful, \c false when a graphics operation failed.
    Regardless of the return value, calling release() is always safe.
 */

/*!
    \return a pointer to a backend-specific QRhiNativeHandles subclass, such as
    QRhiVulkanTextureNativeHandles. The returned value is null when exposing
    the underlying native resources is not supported by the backend.

    \sa QRhiVulkanTextureNativeHandles, QRhiD3D11TextureNativeHandles,
    QRhiMetalTextureNativeHandles, QRhiGles2TextureNativeHandles
 */
const QRhiNativeHandles *QRhiTexture::nativeHandles()
{
    return nullptr;
}

/*!
    Similar to build() except that no new native textures are created. Instead,
    the texture from \a src is used.

    This allows importing an existing native texture object (which must belong
    to the same device or sharing context, depending on the graphics API) from
    an external graphics engine.

    \note format(), pixelSize(), sampleCount(), and flags() must still be set
    correctly. Passing incorrect sizes and other values to QRhi::newTexture()
    and then following it with a buildFrom() expecting that the native texture
    object alone is sufficient to deduce such values is \b wrong and will lead
    to problems.

    \note QRhiTexture does not take ownership of the texture object. release()
    does not free the object or any associated memory.

    The opposite of this operation, exposing a QRhiTexture-created native
    texture object to a foreign engine, is possible via nativeHandles().

    \sa QRhiVulkanTextureNativeHandles, QRhiD3D11TextureNativeHandles,
    QRhiMetalTextureNativeHandles, QRhiGles2TextureNativeHandles
 */
bool QRhiTexture::buildFrom(const QRhiNativeHandles *src)
{
    Q_UNUSED(src);
    return false;
}

Laszlo Agocs's avatar
Laszlo Agocs committed
1984 1985 1986
/*!
    \class QRhiSampler
    \inmodule QtRhi
1987
    \brief Sampler resource.
Laszlo Agocs's avatar
Laszlo Agocs committed
1988 1989
 */

1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009
/*!
    \enum QRhiSampler::Filter
    Specifies the minification, magnification, or mipmap filtering

    \value None Applicable only for mipmapMode(), indicates no mipmaps to be used
    \value Nearest
    \value Linear
 */

/*!
    \enum QRhiSampler::AddressMode
    Specifies the addressing mode

    \value Repeat
    \value ClampToEdge
    \value Border
    \value Mirror
    \value MirrorOnce
 */

Laszlo Agocs's avatar
Laszlo Agocs committed
2010
/*!
Laszlo Agocs's avatar
Laszlo Agocs committed
2011 2012 2013 2014 2015 2016 2017 2018 2019 2020
    \internal
 */
QRhiSampler::QRhiSampler(QRhiImplementation *rhi,
                         Filter magFilter_, Filter minFilter_, Filter mipmapMode_,
                         AddressMode u_, AddressMode v_, AddressMode w_)
    : QRhiResource(rhi),
      m_magFilter(magFilter_), m_minFilter(minFilter_), m_mipmapMode(mipmapMode_),
      m_addressU(u_), m_addressV(v_), m_addressW(w_)
{
}
2021

Laszlo Agocs's avatar
Laszlo Agocs committed
2022 2023 2024 2025
/*!
    \class QRhiRenderPassDescriptor
    \inmodule QtRhi
    \brief Render pass resource.
Laszlo Agocs's avatar
Laszlo Agocs committed
2026 2027
 */

2028
/*!
Laszlo Agocs's avatar
Laszlo Agocs committed
2029
    \internal
Laszlo Agocs's avatar
Laszlo Agocs committed
2030
 */
Laszlo Agocs's avatar
Laszlo Agocs committed
2031 2032 2033 2034
QRhiRenderPassDescriptor::QRhiRenderPassDescriptor(QRhiImplementation *rhi)
    : QRhiResource(rhi)
{
}
Laszlo Agocs's avatar
Laszlo Agocs committed
2035 2036 2037 2038

/*!
    \class QRhiRenderTarget
    \inmodule QtRhi
2039
    \brief Represents an onscreen (swapchain) or offscreen (texture) render target.
Laszlo Agocs's avatar
Laszlo Agocs committed
2040 2041
 */

2042 2043 2044 2045 2046 2047 2048 2049 2050 2051
/*!
    \enum QRhiRenderTarget::Type
    Specifies the type of the render target

    \value RtRef This is a reference to another resource's buffer(s). Used by
    targets returned from QRhiSwapChain::currentFrameRenderTarget().

    \value RtTexture This is a QRhiTextureRenderTarget.
 */

Laszlo Agocs's avatar
Laszlo Agocs committed
2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080
/*!
    \internal
 */
QRhiRenderTarget::QRhiRenderTarget(QRhiImplementation *rhi)
    : QRhiResource(rhi)
{
}

/*!
    \fn QRhiRenderTarget::Type QRhiRenderTarget::type() const

    \return the type of the render target.
 */

/*!
    \fn QSize QRhiRenderTarget::sizeInPixels() const

    \return the size in pixels.
 */

/*!
    \fn float QRhiRenderTarget::devicePixelRatio() const

    \return the device pixel ratio. For QRhiTextureRenderTarget this is always
    1. For targets retrieved from a QRhiSwapChain the value reflects the
    \l{QWindow::devicePixelRatio()}{device pixel ratio} of the targeted
    QWindow.
 */

Laszlo Agocs's avatar
Laszlo Agocs committed
2081 2082 2083
/*!
    \class QRhiTextureRenderTarget
    \inmodule QtRhi
2084
    \brief Texture render target resource.
2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103

    A texture render target allows rendering into one or more textures,
    optionally with a depth texture or depth/stencil renderbuffer.

    \note Textures used in combination with QRhiTextureRenderTarget must be
    created with the QRhiTexture::RenderTarget flag.

    The simplest example of creating a render target with a texture as its
    single color attachment:

    \badcode
        texture = rhi->newTexture(QRhiTexture::RGBA8, size, 1, QRhiTexture::RenderTarget);
        texture->build();
        rt = rhi->newTextureRenderTarget({ texture });
        rp = rt->newCompatibleRenderPassDescriptor();
        rt->setRenderPassDescriptor(rt);
        rt->build();
        // rt can now be used with beginPass()
    \endcode
Laszlo Agocs's avatar
Laszlo Agocs committed
2104 2105
 */

2106 2107
/*!
    \enum QRhiTextureRenderTarget::Flag
2108 2109 2110 2111 2112 2113

    Flag values describing the load/store behavior for the render target. The
    load/store behavior may be baked into native resources under the hood,
    depending on the backend, and therefore it needs to be known upfront and
    cannot be changed without rebuilding (and so releasing and creating new
    native resources).
2114 2115 2116 2117 2118 2119 2120 2121 2122

    \value PreserveColorContents Indicates that the contents of the color
    attachments is to be loaded when starting a render pass, instead of
    clearing. This is potentially more expensive, especially on mobile (tiled)
    GPUs, but allows preserving the existing contents between passes.

    \value PreserveDepthStencilContents Indicates that the contents of the
    depth texture is to be loaded when starting a render pass, instead
    clearing. Only applicable when a texture is used as the depth buffer
2123
    (QRhiTextureRenderTargetDescription::depthTexture() is set) because
2124 2125 2126 2127
    depth/stencil renderbuffers may not have any physical backing and data may
    not be written out in the first place.
 */