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 vers texture depuis src vers dst, comme décrit à l'adresse desc.

void QRhiResourceUpdateBatch::generateMips(QRhiTexture *tex)

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

Les textures 2D et cubiques sont prises en charge. Les textures 1D et 3D sont prises en charge lorsque la fonctionnalité QRhi::OneDimensionalTextureMipmaps ou QRhi::ThreeDimensionalTextureMipmaps est signalée comme prise en charge, respectivement.

bool QRhiResourceUpdateBatch::hasOptimalCapacity() const

Renvoie « true » tant que le nombre d'opérations sur les tampons et les textures mises en file d'attente dans ce lot reste inférieur à une limite raisonnable.

La valeur de retour est « false » lorsque le nombre d’opérations sur les tampons et/ou les textures ajoutées à ce lot a atteint, ou est sur le point d’atteindre, une certaine limite. Le lot reste pleinement fonctionnel par la suite, mais peut nécessiter l’allocation de mémoire supplémentaire. Par conséquent, un moteur de rendu qui regroupe un grand nombre de mises à jour de tampons et de textures dans un seul lot lors de la préparation d’une image peut envisager d’appeler ` submitting the batch ` et ` starting a new one ` lorsque cette fonction renvoie `false`.

void QRhiResourceUpdateBatch::merge(QRhiResourceUpdateBatch *other)

Copie toutes les opérations en file d’attente du lot « other » vers celui-ci.

Cela permet de mettre en place un schéma pratique où les mises à jour de ressources déjà connues lors de l’étape d’initialisation sont regroupées dans un lot qui est ensuite fusionné avec un autre lors du lancement du premier passage de rendu ultérieurement :

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)

Met en file d'attente la relecture d'une région de l'QRhiBuffer buf . La taille de la région est spécifiée par size en octets, offset correspond au décalage en octets à partir duquel la lecture doit commencer.

La relecture est asynchrone. result contient un callback qui est appelé lorsque l’opération est terminée. Les données sont fournies dans QRhiReadbackResult::data. En cas de réussite, QByteArray aura une taille égale à size. En cas d’échec, QByteArray sera vide.

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

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

Met en file d'attente une opération de copie d'une texture vers l'hôte, comme décrit à l'adresse rb.

Normalement, la fonction ` rb ` spécifie une ` QRhiTexture ` comme source. Cependant, lorsque la chaîne d’échange (swapchain) de l’image actuelle a été créée avec ` QRhiSwapChain::UsedAsTransferSource`, elle peut également servir de source pour la relecture. Pour cela, laissez la texture définie sur `null` dans ` rb`.

Contrairement à d’autres opérations, les résultats doivent ici être traités par l’application. Par conséquent, ` result ` fournit non seulement les données, mais également un callback, car les opérations sur le lot sont de nature asynchrone :

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 opération de relecture unique copie un niveau de mip d’une couche (face de cubemap, tranche 3D ou élément de tableau de textures) à la fois. Le niveau et la couche sont spécifiés par les champs respectifs dans rb.

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

void QRhiResourceUpdateBatch::release()

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

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

Met en file d'attente la mise à jour d'une région d'un QRhiBuffer buf créé avec le 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 disposer d’au moins size octets disponibles.

data est copiée et peut être détruite ou modifiée en toute sécurité une fois que cette fonction renvoie une valeur.

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

Cette surcharge met en file d’attente la mise à jour d’une région d’un objet ` QRhiBuffer ` buf créé avec le type ` QRhiBuffer::Dynamic`.

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

Cette fonction a été introduite dans Qt 6.10.

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

Met en file d'attente la mise à jour d'une région d'un QRhiBuffer buf créé avec le type QRhiBuffer::Immutable ou QRhiBuffer::Static.

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

data est copiée et peut être détruite ou modifiée en toute sécurité une fois que cette fonction renvoie une valeur.

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

Cette surcharge met en file d'attente la mise à jour de l'ensemble de l'QRhiBuffer buf créée avec le type QRhiBuffer::Immutable ou QRhiBuffer::Static.

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

data size doit être égal à la taille de buf.

Cette fonction a été introduite dans Qt 6.10.

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

Met en file d'attente la mise à jour de l'ensemble de l'QRhiBuffer buf créé avec le type QRhiBuffer::Immutable ou QRhiBuffer::Static.

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

Cette surcharge met en file d'attente la mise à jour d'une région d'un objet de type ` QRhiBuffer ` ( buf ) créé avec le type ` QRhiBuffer::Immutable ` ou ` 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)

Met en file d'attente le téléchargement des données d'image pour le niveau mip 0 de la couche 0 de la texture tex.

tex Le format doit être non compressé. Il doit également être compatible avec la fonction QImage::format() de image. Les données source sont fournies dans image.

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

Met en file d’attente le téléchargement des données d’image pour un ou plusieurs niveaux de mip dans un ou plusieurs calques de la texture tex.

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