QVulkanWindow Class

Documentation des fonctions membres

[explicit] QVulkanWindow::QVulkanWindow(QWindow *parent = nullptr)

Construit une nouvelle QVulkanWindow avec la valeur donnée parent.

Le type de surface est fixé à QSurface::VulkanSurface.

[virtual noexcept] QVulkanWindow::~QVulkanWindow()

Destructeur.

QList<VkPhysicalDeviceProperties> QVulkanWindow::availablePhysicalDevices()

Renvoie la liste des propriétés des dispositifs physiques pris en charge dans le système.

QMatrix4x4 QVulkanWindow::clipCorrectionMatrix()

Renvoie un QMatrix4x4 qui peut être utilisé pour corriger les différences de système de coordonnées entre OpenGL et Vulkan.

En prémultipliant la matrice de projection avec cette matrice, les applications peuvent continuer à supposer que Y pointe vers le haut, et peuvent définir minDepth et maxDepth dans le viewport à 0 et 1, respectivement, sans avoir à effectuer d'autres corrections sur les positions Z des sommets. La géométrie des applications OpenGL peut alors être utilisée telle quelle, en supposant que l'état de la rastérisation corresponde aux paramètres d'abattage et de face avant d'OpenGL.

VkFormat QVulkanWindow::colorFormat() const

Renvoie le format du tampon de couleur utilisé par la chaîne d'échange.

Voir aussi setPreferredColorFormats().

int QVulkanWindow::concurrentFrameCount() const

Renvoie le nombre de trames qui peuvent être potentiellement actives en même temps.

    class Renderer {
        void startNextFrame();
        // ...

        VkDescriptorBufferInfo m_uniformBufInfo[QVulkanWindow::MAX_CONCURRENT_FRAME_COUNT];
        QVulkanWindow *m_window = nullptr;
    };

    void Renderer::startNextFrame()
    {
        const int count = m_window->concurrentFrameCount();
        // for (int i = 0; i < count; ++i)
            // m_uniformBufInfo[i] = ...
        // ...
    }

Voir également currentFrame().

[virtual] QVulkanWindowRenderer *QVulkanWindow::createRenderer()

Renvoie une nouvelle instance de QVulkanWindowRenderer.

Cette fonction virtuelle est appelée une fois pendant la durée de vie de la fenêtre, à un moment donné après l'avoir rendue visible pour la première fois.

L'implémentation par défaut renvoie null et aucun rendu n'est donc effectué, à l'exception de l'effacement des tampons.

La fenêtre devient propriétaire de l'objet de rendu renvoyé.

VkCommandBuffer QVulkanWindow::currentCommandBuffer() const

Renvoie le tampon de commande actif pour le cadre de la chaîne d'échange en cours. Les implémentations de QVulkanWindowRenderer::startNextFrame() sont censées ajouter des commandes à ce tampon de commandes.

int QVulkanWindow::currentFrame() const

Renvoie l'indice de la trame courante dans l'intervalle [0, concurrentFrameCount() - 1].

Les implémentations du moteur de rendu devront s'assurer que les données uniformes et les autres ressources dynamiques existent en plusieurs copies, afin d'éviter que la trame N ne modifie les données utilisées par les trames N - 1, N - 2, ... encore actives. N - concurrentFrameCount() + 1.

Pour éviter de dépendre de la taille dynamique des tableaux, les applications peuvent utiliser MAX_CONCURRENT_FRAME_COUNT lors de la déclaration des tableaux. Il est garanti que cette valeur sera toujours égale ou supérieure à la valeur renvoyée par concurrentFrameCount(). Ces tableaux peuvent alors être indexés par la valeur renvoyée par cette fonction.

    class Renderer {
        void startNextFrame();
        // ...

        VkDescriptorBufferInfo m_uniformBufInfo[QVulkanWindow::MAX_CONCURRENT_FRAME_COUNT];
        QVulkanWindow *m_window = nullptr;
    };

    void Renderer::startNextFrame()
    {
        VkDescriptorBufferInfo &uniformBufInfo(m_uniformBufInfo[m_window->currentFrame()]);
        // ...
    }

Voir également concurrentFrameCount().

VkFramebuffer QVulkanWindow::currentFramebuffer() const

Renvoie un VkFramebuffer pour l'image swapchain courante en utilisant la passe de rendu par défaut.

Le framebuffer a deux attachements (couleur, profondeur-crayon) lorsque le multi-échantillonnage n'est pas utilisé, et trois (couleur résolue, profondeur-crayon, couleur multi-échantillon) lorsque sampleCountFlagBits() est supérieur à VK_SAMPLE_COUNT_1_BIT. Les moteurs de rendu doivent en tenir compte, par exemple lorsqu'ils fournissent des valeurs claires.

Voir aussi defaultRenderPass().

int QVulkanWindow::currentSwapChainImageIndex() const

Renvoie l'indice de l'image de la chaîne d'échange actuelle dans l'intervalle [0, swapChainImageCount() - 1].

VkRenderPass QVulkanWindow::defaultRenderPass() const

Renvoie une passe de rendu typique avec une passe secondaire.

Voir également currentFramebuffer().

VkFormat QVulkanWindow::depthStencilFormat() const

Renvoie le format utilisé par le(s) tampon(s) de profondeur.

VkImage QVulkanWindow::depthStencilImage() const

Renvoie l'image du crayon de profondeur.

VkImageView QVulkanWindow::depthStencilImageView() const

Renvoie la vue de l'image du crayon de profondeur.

VkDevice QVulkanWindow::device() const

Renvoie l'appareil logique actif.

uint32_t QVulkanWindow::deviceLocalMemoryIndex() const

Renvoie un index de type de mémoire locale de périphérique adapté à une utilisation générale.

QVulkanWindow::Flags QVulkanWindow::flags() const

Renvoie les drapeaux demandés.

Voir aussi setFlags().

[signal] void QVulkanWindow::frameGrabbed(const QImage &image)

Ce signal est émis lorsque le site image est prêt.

void QVulkanWindow::frameReady()

Cette fonction doit être appelée exactement une fois en réponse à chaque invocation de l'implémentation QVulkanWindowRenderer::startNextFrame(). Au moment de cet appel, le tampon de commande principal, exposé via currentCommandBuffer(), doit contenir toutes les commandes de rendu nécessaires, car cette fonction déclenchera la soumission des commandes et la mise en file d'attente de la commande actuelle.

Voir également QVulkanWindowRenderer::startNextFrame().

QImage QVulkanWindow::grab()

Construit et rend l'image suivante sans la présenter, puis effectue une lecture bloquante du contenu de l'image.

Renvoie l'image si l'implémentation de startNextFrame() du moteur de rendu rappelle directement frameReady(). Sinon, elle renvoie une image incomplète, qui a la bonne taille mais pas encore le contenu. Dans ce dernier cas, le contenu sera transmis via le signal frameGrabbed().

L'image QImage renvoyée a toujours le format QImage::Format_RGBA8888. Si colorFormat() est VK_FORMAT_B8G8R8A8_UNORM, les canaux rouge et bleu sont automatiquement échangés, car ce format est couramment utilisé comme choix par défaut pour les tampons de couleur de la chaîne d'échange. Avec tout autre format de tampon de couleur, aucune conversion n'est effectuée par cette fonction.

VkCommandPool QVulkanWindow::graphicsCommandPool() const

Renvoie le pool de commandes graphiques actif.

VkQueue QVulkanWindow::graphicsQueue() const

Renvoie la file d'attente graphique active.

uint32_t QVulkanWindow::graphicsQueueFamilyIndex() const

Renvoie l'indice de famille de la file d'attente graphique active.

uint32_t QVulkanWindow::hostVisibleMemoryIndex() const

Renvoie un index de type de mémoire visible par l'hôte, adapté à une utilisation générale.

Le type de mémoire renvoyé sera à la fois visible par l'hôte et cohérent. En outre, il sera également mis en cache, si possible.

bool QVulkanWindow::isValid() const

Retourne true si cette fenêtre a initialisé avec succès toutes les ressources Vulkan, y compris la swapchain.

VkImage QVulkanWindow::msaaColorImage(int idx) const

Renvoie l'image couleur multi-échantillonnée spécifiée, ou VK_NULL_HANDLE si le multi-échantillonnage n'est pas utilisé.

idx doit être comprise entre [0, swapChainImageCount() - 1].

VkImageView QVulkanWindow::msaaColorImageView(int idx) const

Renvoie la vue de l'image couleur multi-échantillonnée spécifiée, ou VK_NULL_HANDLE si le multi-échantillonnage n'est pas utilisé.

idx doit être compris entre [0, swapChainImageCount() - 1].

VkPhysicalDevice QVulkanWindow::physicalDevice() const

Renvoie l'appareil physique actif.

const VkPhysicalDeviceProperties *QVulkanWindow::physicalDeviceProperties() const

Renvoie un pointeur sur les propriétés du dispositif physique actif.

VkSampleCountFlagBits QVulkanWindow::sampleCountFlagBits() const

Renvoie le nombre actuel d'échantillons sous la forme d'une valeur VkSampleCountFlagBits.

Lors du ciblage de la cible de rendu par défaut, le champ rasterizationSamples de VkPipelineMultisampleStateCreateInfo doit être défini à cette valeur.

Voir aussi setSampleCount() et supportedSampleCounts().

void QVulkanWindow::setDeviceExtensions(const QByteArrayList &extensions)

Définit la liste des appareils extensions à activer.

Les extensions non prises en charge sont ignorées.

L'extension swapchain sera toujours ajoutée automatiquement, il n'est pas nécessaire de l'inclure dans cette liste.

[since 6.7] void QVulkanWindow::setEnabledFeaturesModifier(const QVulkanWindow::EnabledFeaturesModifier &modifier)

Définit la fonction de modification des fonctionnalités activées du périphérique modifier.

Cette fonction a été introduite dans Qt 6.7.

Voir aussi EnabledFeaturesModifier.

[since 6.7] void QVulkanWindow::setEnabledFeaturesModifier(QVulkanWindow::EnabledFeatures2Modifier modifier)

Définit la fonction de modification des caractéristiques de l'appareil activée modifier.

Cette fonction a été introduite dans Qt 6.7.

Voir aussi EnabledFeatures2Modifier.

void QVulkanWindow::setFlags(QVulkanWindow::Flags flags)

Configure le comportement en fonction de l'adresse flags.

Voir également flags().

void QVulkanWindow::setPhysicalDeviceIndex(int idx)

Demande l'utilisation de l'appareil physique avec l'index idx. L'index correspond à la liste renvoyée par availablePhysicalDevices().

Par défaut, le premier dispositif physique est utilisé.

void QVulkanWindow::setPreferredColorFormats(const QList<VkFormat> &formats)

Définit le format préféré formats de la chaîne d'échange.

Par défaut, aucun format préféré par l'application n'est défini. Dans ce cas, le format préféré de la surface sera utilisé ou, à défaut, VK_FORMAT_B8G8R8A8_UNORM.

La liste de formats est ordonnée. Si le premier format n'est pas pris en charge, le deuxième sera pris en considération, et ainsi de suite. Si aucun format de la liste n'est pris en charge, le comportement est le même que dans le cas par défaut.

Pour demander le format actuel après l'initialisation, appelez colorFormat().

Voir aussi colorFormat().

void QVulkanWindow::setQueueCreateInfoModifier(const QVulkanWindow::QueueCreateInfoModifier &modifier)

Définit la fonction de modification des informations de création de la file d'attente modifier.

Voir aussi QueueCreateInfoModifier.

void QVulkanWindow::setSampleCount(int sampleCount)

Demande un anticrénelage multi-échantillon avec la valeur donnée sampleCount. Les valeurs valides sont 1, 2, 4, 8, ... jusqu'à la valeur maximale supportée par le périphérique physique.

Lorsque le nombre d'échantillons est supérieur à 1, QVulkanWindow crée un tampon de couleurs multi-échantillons au lieu de cibler simplement les images de la chaîne d'échange. Le rendu dans le tampon multi-échantillon sera résolu dans les tampons non multi-échantillons à la fin de chaque image.

Pour examiner la liste des nombres d'échantillons pris en charge, appelez supportedSampleCounts().

Lors de la configuration du pipeline de rendu, appelez sampleCountFlagBits() pour demander le nombre d'échantillons actif sous la forme d'une valeur VkSampleCountFlagBits.

Voir également supportedSampleCounts() et sampleCountFlagBits().

QVulkanInfoVector<QVulkanExtension> QVulkanWindow::supportedDeviceExtensions()

Renvoie la liste des extensions prises en charge par les périphériques logiques créés à partir du périphérique physique sélectionné par setPhysicalDeviceIndex().

QList<int> QVulkanWindow::supportedSampleCounts()

Renvoie l'ensemble des nombres d'échantillons pris en charge lors de l'utilisation du périphérique physique sélectionné par setPhysicalDeviceIndex(), sous la forme d'une liste triée.

Par défaut, QVulkanWindow utilise un nombre d'échantillons de 1. En appelant setSampleCount() avec une valeur différente (2, 4, 8, ...) de celle renvoyée par cette fonction, il est possible de demander un anticrénelage multi-échantillons.

Voir aussi setSampleCount().

bool QVulkanWindow::supportsGrab() const

Retourne vrai si la chaîne de swap supporte l'utilisation comme source de transfert, ce qui signifie que grab() est fonctionnel.

VkImage QVulkanWindow::swapChainImage(int idx) const

Renvoie l'image de la chaîne d'échange spécifiée.

idx doit être comprise entre [0, swapChainImageCount() - 1].

int QVulkanWindow::swapChainImageCount() const

Renvoie le nombre d'images dans la chaîne d'échange.

QSize QVulkanWindow::swapChainImageSize() const

Renvoie la taille de l'image de la chaîne d'échange.

Celle-ci correspond généralement à la taille de la fenêtre, mais peut également être différente si vkGetPhysicalDeviceSurfaceCapabilitiesKHR indique une taille fixe.

sizeDe plus, il a été observé sur certaines plateformes que la taille de la surface rapportée par Vulkan est différente avec une mise à l'échelle DPI élevée active, ce qui signifie que la valeur rapportée par QWindow() multipliée par devicePixelRatio() était inférieure ou supérieure de 1 pixel par rapport à la valeur retournée ici, probablement en raison de différences d'arrondi. Le code de rendu doit en être conscient et toute logique de rendu doit être basée sur la valeur renvoyée ici, jamais sur la taille rapportée par QWindow. Quelle que soit la taille de pixel correcte en théorie, le rendu Vulkan ne doit jamais se baser sur la taille de surface rapportée par l'API Vulkan. Dans le cas contraire, des erreurs de validation peuvent se produire, par exemple lors de la définition de la fenêtre de visualisation, car les valeurs fournies par l'application peuvent devenir hors limites du point de vue de Vulkan.

VkImageView QVulkanWindow::swapChainImageView(int idx) const

Renvoie la vue de l'image de la chaîne d'échange spécifiée.

idx doit être compris entre [0, swapChainImageCount() - 1].