QRhiResourceUpdateBatch Class

Dokumentation der Mitgliedsfunktionen

void QRhiResourceUpdateBatch::copyTexture(QRhiTexture *dst, QRhiTexture *src, const QRhiTextureCopyDescription &desc = QRhiTextureCopyDescription())

Stellt einen Textur-zu-Textur-Kopiervorgang von src in dst ein, wie in desc beschrieben.

void QRhiResourceUpdateBatch::generateMips(QRhiTexture *tex)

Stellt eine Mipmap-Erzeugungsoperation für die angegebene Textur tex in die Warteschlange.

Es werden sowohl 2D- als auch Würfeltexturen unterstützt.

bool QRhiResourceUpdateBatch::hasOptimalCapacity() const

Gibt true zurück, bis die Anzahl der Puffer- und Texturoperationen, die in diesen Stapel eingereiht wurden, unter einer angemessenen Grenze liegt.

Der Rückgabewert ist false, wenn die Anzahl der zu diesem Stapel hinzugefügten Puffer- und/oder Texturoperationen eine bestimmte Grenze erreicht hat oder kurz davor ist, sie zu erreichen. Der Stapel ist auch danach voll funktionsfähig, muss aber möglicherweise zusätzlichen Speicher zuweisen. Daher sollte ein Renderer, der bei der Vorbereitung eines Frames viele Puffer- und Texturaktualisierungen in einem einzigen Stapel sammelt, submitting the batch und starting a new one in Betracht ziehen, wenn diese Funktion den Wert false zurückgibt.

void QRhiResourceUpdateBatch::merge(QRhiResourceUpdateBatch *other)

Kopiert alle in der Warteschlange stehenden Vorgänge aus dem Stapel other in diesen.

Dies ermöglicht ein bequemes Muster, bei dem Ressourcenaktualisierungen, die bereits während des Initialisierungsschritts bekannt sind, in einem Stapel gesammelt werden, der dann später beim Start des ersten Rendering-Durchgangs in einen anderen zusammengeführt wird:

void init()
{
    initialUpdates = rhi->nextResourceUpdateBatch();
    initialUpdates->uploadStaticBuffer(vbuf, vertexData);
    initialUpdates->uploadStaticBuffer(ibuf, indexData);
    // ...
}

void render()
{
    QRhiResourceUpdateBatch *resUpdates = rhi->nextResourceUpdateBatch();
    if (initialUpdates) {
        resUpdates->merge(initialUpdates);
        initialUpdates->release();
        initialUpdates = nullptr;
    }
    // resUpdates->updateDynamicBuffer(...);
    cb->beginPass(rt, clearCol, clearDs, resUpdates);
}

void QRhiResourceUpdateBatch::readBackBuffer(QRhiBuffer *buf, quint32 offset, quint32 size, QRhiReadbackResult *result)

Stellt das Zurücklesen eines Bereichs der Datei QRhiBuffer buf in die Warteschlange. Die Größe des Bereichs wird durch size in Bytes angegeben, offset ist der Offset in Bytes, ab dem gelesen werden soll.

Ein Readback ist asynchron. result enthält einen Callback, der aufgerufen wird, wenn der Vorgang abgeschlossen ist. Die Daten werden in QRhiReadbackResult::data bereitgestellt. Bei erfolgreichem Abschluss hat QByteArray die gleiche Größe wie size. Bei einem Fehlschlag wird QByteArray leer sein.

Siehe auch readBackTexture(), QRhi::isFeatureSupported(), und QRhi::resourceLimit().

void QRhiResourceUpdateBatch::readBackTexture(const QRhiReadbackDescription &rb, QRhiReadbackResult *result)

Stellt eine Textur-zu-Host-Kopieroperation in die Warteschlange, wie von rb beschrieben.

Normalerweise wird rb eine QRhiTexture als Quelle angeben. Wenn jedoch die Swapchain im aktuellen Frame mit QRhiSwapChain::UsedAsTransferSource erstellt wurde, kann sie auch die Quelle für das Zurücklesen sein. Lassen Sie dazu die Textur in rb auf Null gesetzt.

Im Gegensatz zu anderen Operationen müssen die Ergebnisse hier von der Anwendung verarbeitet werden. Daher stellt result nicht nur die Daten, sondern auch einen Callback zur Verfügung, da Operationen mit dem Stapel von Natur aus asynchron sind:

rhi->beginFrame(swapchain);
cb->beginPass(swapchain->currentFrameRenderTarget(), colorClear, dsClear);
// ...
QRhiReadbackResult *rbResult = new QRhiReadbackResult;
rbResult->completed = [rbResult] {
    {
        const QImage::Format fmt = QImage::Format_RGBA8888_Premultiplied; // fits QRhiTexture::RGBA8
        const uchar *p = reinterpret_cast<const uchar *>(rbResult->data.constData());
        QImage image(p, rbResult->pixelSize.width(), rbResult->pixelSize.height(), fmt);
        image.save("result.png");
    }
    delete rbResult;
};
QRhiResourceUpdateBatch *u = nextResourceUpdateBatch();
QRhiReadbackDescription rb; // no texture -> uses the current backbuffer of sc
u->readBackTexture(rb, rbResult);
cb->endPass(u);
rhi->endFrame(swapchain);

Ein einzelner Rücklesevorgang kopiert jeweils eine Mip-Ebene einer Ebene (Cubemap-Fläche oder 3D-Slice oder Textur-Array-Element). Die Ebene und der Layer werden durch die entsprechenden Felder in rb angegeben.

Siehe auch readBackBuffer() und QRhi::resourceLimit().

void QRhiResourceUpdateBatch::release()

Gibt den Stapel an den Pool zurück. Dies sollte nur verwendet werden, wenn der Stapel nicht an eine der Funktionen QRhiCommandBuffer::beginPass(), QRhiCommandBuffer::endPass() oder QRhiCommandBuffer::resourceUpdate() übergeben wird, da diese implizit destroy() aufrufen.

void QRhiResourceUpdateBatch::updateDynamicBuffer(QRhiBuffer *buf, quint32 offset, quint32 size, const void *data)

Enqueues Aktualisierung einer Region eines QRhiBuffer buf erstellt mit dem Typ QRhiBuffer::Dynamic.

Der Bereich wird durch offset und size angegeben. Die tatsächlich zu schreibenden Bytes werden durch data angegeben, das mindestens size Bytes zur Verfügung haben muss. data kann sicher zerstört oder geändert werden, sobald diese Funktion zurückkehrt.

void QRhiResourceUpdateBatch::uploadStaticBuffer(QRhiBuffer *buf, quint32 offset, quint32 size, const void *data)

Ermöglicht die Aktualisierung einer Region von QRhiBuffer buf , die mit dem Typ QRhiBuffer::Immutable oder QRhiBuffer::Static erstellt wurde.

Der Bereich wird durch offset und size angegeben. Die tatsächlich zu schreibenden Bytes werden durch data angegeben, das mindestens size Bytes zur Verfügung haben muss. data kann sicher zerstört oder geändert werden, sobald diese Funktion zurückkehrt.

void QRhiResourceUpdateBatch::uploadStaticBuffer(QRhiBuffer *buf, const void *data)

Dies ist eine überladene Funktion.

Stellt die Aktualisierung der gesamten QRhiBuffer buf , die mit dem Typ QRhiBuffer::Immutable oder QRhiBuffer::Static erstellt wurde, in die Warteschlange.

void QRhiResourceUpdateBatch::uploadTexture(QRhiTexture *tex, const QImage &image)

Ermöglicht das Hochladen der Bilddaten für die Mip-Ebene 0 der Ebene 0 der Textur tex.

tex muss ein unkomprimiertes Format haben. Sein Format muss auch mit dem QImage::format() von image kompatibel sein. Die Quelldaten sind in image angegeben.

void QRhiResourceUpdateBatch::uploadTexture(QRhiTexture *tex, const QRhiTextureUploadDescription &desc)

Enqueues Hochladen der Bilddaten für eine oder mehrere mip-Ebenen in einer oder mehreren Ebenen der Textur tex.

Die Einzelheiten der Kopie (Quelldaten QImage oder komprimierte Texturdaten, Regionen, Zielebenen und -ebenen) sind in desc beschrieben.