QRhiResourceUpdateBatch Class

Documentation des fonctions membres

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

Met en file d'attente une opération de copie de texture à texture de src à dst comme décrit par desc.

void QRhiResourceUpdateBatch::generateMips(QRhiTexture *tex)

Met en file d'attente une opération de génération de mipmap pour la texture spécifiée tex.

Les textures 2D et cubiques sont prises en charge.

bool QRhiResourceUpdateBatch::hasOptimalCapacity() const

Retourne vrai jusqu'à ce que le nombre d'opérations de tampon et de texture mises en file d'attente dans ce lot soit inférieur à une limite raisonnable.

La valeur de retour est fausse lorsque le nombre d'opérations de tampon et/ou de texture ajoutées à ce lot a atteint, ou est sur le point d'atteindre, une certaine limite. Le lot est également pleinement fonctionnel par la suite, mais peut avoir besoin d'allouer de la mémoire supplémentaire. Par conséquent, un moteur de rendu qui collecte de nombreuses mises à jour de tampons et de textures en un seul lot lors de la préparation d'une image peut envisager d'utiliser submitting the batch et starting a new one lorsque cette fonction renvoie une valeur fausse.

void QRhiResourceUpdateBatch::merge(QRhiResourceUpdateBatch *other)

Copie toutes les opérations en file d'attente du lot other dans celui-ci.

Cela permet un schéma pratique où les mises à jour des ressources qui sont déjà connues pendant l'étape d'initialisation sont rassemblées dans un lot qui est ensuite fusionné dans un autre lors du démarrage de la première passe de rendu plus tard :

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)

Enqueues reading back a region of the QRhiBuffer buf . La taille de la région est spécifiée par size en octets, offset est le décalage en octets à partir duquel commencer la lecture.

Une relecture est asynchrone. result contient un rappel qui est invoqué lorsque l'opération est terminée. Les données sont fournies dans QRhiReadbackResult::data. Si l'opération est réussie, la taille de QByteArray sera égale à celle de size. En cas d'échec, QByteArray sera vide.

Voir également readBackTexture(), QRhi::isFeatureSupported() et QRhi::resourceLimit().

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

Demande une opération de copie texture-hôte telle que décrite par rb.

Normalement, rb spécifie une QRhiTexture comme source. Cependant, lorsque la chaîne d'échange dans le cadre actuel a été créée avec QRhiSwapChain::UsedAsTransferSource, elle peut également être la source de la lecture. Pour cela, laissez la texture à null dans rb.

Contrairement à d'autres opérations, les résultats doivent être traités par l'application. Par conséquent, result fournit non seulement les données, mais aussi un rappel, car les opérations sur le lot sont asynchrones par nature :

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

Une seule opération de relecture permet de copier un niveau mip d'une couche (face cubemap ou tranche 3D ou élément de tableau de texture) à la fois. Le niveau et la couche sont spécifiés par les champs respectifs de rb.

Voir également readBackBuffer() et QRhi::resourceLimit().

void QRhiResourceUpdateBatch::release()

Retourne le lot au pool. Cette fonction ne doit être utilisée que si le lot n'est pas transmis à l'une des fonctions suivantes : QRhiCommandBuffer::beginPass(), QRhiCommandBuffer::endPass() ou QRhiCommandBuffer::resourceUpdate(), car celles-ci appellent implicitement la fonction destroy().

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

Enqueues updating a region of a QRhiBuffer buf created with the type QRhiBuffer::Dynamic.

La région est spécifiée par offset et size. Les octets à écrire sont spécifiés par data qui doit avoir au moins size octets disponibles.

data La région est copiée et peut être détruite ou modifiée en toute sécurité après le retour de cette fonction.

[since 6.10] void QRhiResourceUpdateBatch::updateDynamicBuffer(QRhiBuffer *buf, quint32 offset, QByteArray data)

Enqueues updating a region of a QRhiBuffer buf created with the type QRhiBuffer::Dynamic.

data est déplacée dans le lot au lieu d'être copiée avec cette surcharge.

Cette fonction a été introduite dans Qt 6.10.

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

Enqueues updating a region of a QRhiBuffer buf created with the type QRhiBuffer::Immutable or QRhiBuffer::Static.

La région est spécifiée par offset et size. Les octets à écrire sont spécifiés par data qui doit avoir au moins size octets disponibles.

data La région est copiée et peut être détruite ou modifiée en toute sécurité après le retour de cette fonction.

[since 6.10] void QRhiResourceUpdateBatch::uploadStaticBuffer(QRhiBuffer *buf, QByteArray data)

Enqueues updating the entire QRhiBuffer buf created with the type QRhiBuffer::Immutable or QRhiBuffer::Static.

data Avec cette surcharge, le contenu est déplacé dans le lot au lieu d'être copié.

data La taille doit être égale à la taille de buf.

Cette fonction a été introduite dans Qt 6.10.

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

Enqueues updating the entire QRhiBuffer buf created with the type QRhiBuffer::Immutable or QRhiBuffer::Static.

[since 6.10] void QRhiResourceUpdateBatch::uploadStaticBuffer(QRhiBuffer *buf, quint32 offset, QByteArray data)

Enqueues updating a region of a QRhiBuffer buf created with the type QRhiBuffer::Immutable or QRhiBuffer::Static.

data est déplacée dans le lot au lieu d'être copiée avec cette surcharge.

Cette fonction a été introduite dans Qt 6.10.

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

Enqueues uploading the image data for mip level 0 of layer 0 of the texture tex.

tex Le format de l'image doit être non compressé. Son format doit également être compatible avec celui de QImage::format() de image. Les données sources sont indiquées dans image.

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

Enqueues uploading the image data for one or more mip levels in one or more layers of the texture tex.

Les détails de la copie (données de texture source QImage ou compressées, régions, couches et niveaux cibles) sont décrits dans desc.