QVulkanInstance Class

    int main(int argc, char **argv)
    {
        QGuiApplication app(argc, argv);

        QVulkanInstance inst;
        if (!inst.create())
            return 1;

        // ...
        window->setVulkanInstance(&inst);
        window->show();

        return app.exec();
    }

    QVulkanInstance inst;

    // Enable validation layer, if supported. Messages go to qDebug by default.
    inst.setLayers({ "VK_LAYER_KHRONOS_validation" });

    bool ok = inst.create();
    if (!ok) {
        // ... Vulkan not available
    }

    if (!inst.layers().contains("VK_LAYER_KHRONOS_validation")) {
        // ... validation layer not available
    }

    QVulkanInstance inst;

    if (inst.supportedLayers().contains("VK_LAYER_KHRONOS_validation")) {
        // ...
    }
    bool ok = inst.create();
    // ...

class VulkanWindow : public QWindow
{public: VulkanWindow() { setSurfaceType(VulkanSurface) ; } void exposeEvent(QExposeEvent *) { if (isExposed()) { if (!m_initialized) { m_initialized = true; // initialize device, swapchain, etc.    QVulkanInstance *inst = vulkanInstance() ; QVulkanFunctions *f =  inst->functions() ; uint32_t devCount = 0;  f->vkEnumeratePhysicalDevices(inst->vkInstance(), &devCount, nullptr) ; // ... // construire la première imagerender() ; } } bool event()QEvent *e) { if (e->type() == QEvent::UpdateRequest) render() ; return QWindow::event(e) ; } void render() { // ...requestUpdate() ; // render en continu}private: bool m_initialized = false; } ;int main(int argc, char**argv) { QGuiApplication app(argc, argv) ; QVulkanInstance inst ; if (!inst.create())) {        qWarning("Vulkan not available");
       return 1; } VulkanWindow window ; window.showMaximized() ; return app.exec() ; }

bool myDebugFilter(VkDebugReportFlagsEXT flags, VkDebugReportObjectTypeEXT objectType, uint64_t object,
                   size_t location, int32_t messageCode, const char *pLayerPrefix, const char *pMessage)

std::function<bool(DebugMessageSeverityFlags severity, DebugMessageTypeFlags type, const void *message)>;

Documentation des fonctions membres

QVulkanInstance::QVulkanInstance()

Construit une nouvelle instance.

[noexcept] QVulkanInstance::~QVulkanInstance()

Destructeur.

QVersionNumber QVulkanInstance::apiVersion() const

Renvoie la version de l'API Vulkan demandée contre laquelle l'application s'attend à fonctionner, ou un numéro de version nul si setApiVersion() n'a pas été appelé avant create().

Voir aussi setApiVersion().

[since 6.5] void QVulkanInstance::clearDebugOutputFilters()

Supprime toutes les fonctions de filtrage installées précédemment par installDebugOutputFilter().

Cette fonction a été introduite dans Qt 6.5.

Voir aussi installDebugOutputFilter().

bool QVulkanInstance::create()

Initialise la bibliothèque Vulkan et crée une nouvelle instance Vulkan ou adopte une instance Vulkan existante.

Retourne true en cas de succès, false en cas d'erreur ou si Vulkan n'est pas pris en charge.

En cas de succès, le pointeur sur ce QVulkanInstance est récupérable via vkInstance().

L'instance et la bibliothèque Vulkan sont disponibles tant que cette QVulkanInstance existe, ou jusqu'à ce que destroy() soit appelé.

Par défaut, la VkInstance est créée avec le drapeau VK_INSTANCE_CREATE_ENUMERATE_PORTABILITY_BIT_KHR. Cela signifie que les périphériques physiques de la portabilité Vulkan sont également énumérés. Si vous ne le souhaitez pas, définissez l'indicateur NoPortabilityDrivers.

void QVulkanInstance::destroy()

Détruit l'instance de la plate-forme sous-jacente, détruisant ainsi la VkInstance (lorsqu'elle en est propriétaire). L'objet QVulkanInstance est toujours réutilisable en appelant à nouveau create().

QVulkanDeviceFunctions *QVulkanInstance::deviceFunctions(VkDevice device)

Renvoie l'objet QVulkanDeviceFunctions qui expose le jeu de commandes Vulkan de base au niveau du périphérique et dont le fonctionnement multiplateforme est garanti.

Les fonctions de l'API Vulkan 1.0 seront toujours disponibles. Lorsqu'il s'agit de versions supérieures de Vulkan, telles que 1.1 et 1.2, l'objet QVulkanDeviceFunctions tente de résoudre les fonctions de l'API de base pour celles-ci également, mais si le périphérique physique Vulkan n'est pas pris en charge au moment de l'exécution, l'appel d'une fonction non prise en charge entraînera un comportement non spécifié. Pour activer correctement la prise en charge des versions de Vulkan supérieures à 1.0, il peut être nécessaire de définir une version d'API d'instance appropriée en appelant setApiVersion() avant create(). En outre, les applications sont censées vérifier l'adresse apiVersion du périphérique physique dans VkPhysicalDeviceProperties.

Voir également functions() et resetDeviceFunctions().

VkResult QVulkanInstance::errorCode() const

Renvoie le code d'erreur Vulkan après un échec de create(), VK_SUCCESS sinon.

La valeur est typiquement la valeur de retour de vkCreateInstance() (lors de la création d'une nouvelle instance Vulkan au lieu de l'adoption d'une instance existante), mais peut également être VK_NOT_READY si le plugin de la plateforme ne supporte pas Vulkan.

QByteArrayList QVulkanInstance::extensions() const

Renvoie les extensions d'instance activées, si create() a été appelé et a réussi. Les extensions demandées dans le cas contraire.

Voir aussi setExtensions().

QVulkanInstance::Flags QVulkanInstance::flags() const

Renvoie les drapeaux demandés.

Voir aussi setFlags().

QVulkanFunctions *QVulkanInstance::functions() const

Renvoie l'objet QVulkanFunctions correspondant qui expose le jeu de commandes Vulkan de base, à l'exclusion des fonctions au niveau du périphérique, et dont le fonctionnement est garanti pour toutes les plates-formes.

Les fonctions de l'API Vulkan 1.0 seront toujours disponibles. Lorsqu'il s'agit de versions supérieures de Vulkan, telles que 1.1 et 1.2, l'objet QVulkanFunctions tentera de résoudre les fonctions de l'API de base pour celles-ci également, mais si l'implémentation de l'instance Vulkan au moment de l'exécution n'a pas de support pour celles-ci, l'appel d'une telle fonction non supportée conduira à un comportement non spécifié. En outre, pour activer correctement la prise en charge des versions de Vulkan supérieures à 1.0, il peut être nécessaire de définir une version d'API d'instance appropriée en appelant setApiVersion() avant create(). Pour demander la version au niveau de l'instance de l'implémentation Vulkan, appelez supportedApiVersion().

Voir également deviceFunctions() et supportedApiVersion().

PFN_vkVoidFunction QVulkanInstance::getInstanceProcAddr(const char *name)

Résout la fonction Vulkan avec l'adresse name.

Pour les commandes Vulkan de base, il est préférable d'utiliser les enveloppes de fonctions récupérables à partir de functions() et deviceFunctions().

[since 6.5] void QVulkanInstance::installDebugOutputFilter(QVulkanInstance::DebugUtilsFilter filter)

Installe une fonction filter qui est appelée pour chaque message de débogage Vulkan. Lorsque le callback renvoie true, le message est arrêté (filtré) et n'apparaîtra pas sur la sortie de débogage.

Cette fonction a été introduite dans Qt 6.5.

Voir aussi clearDebugOutputFilters().

void QVulkanInstance::installDebugOutputFilter(QVulkanInstance::DebugFilter filter)

Installe une fonction filter qui est appelée pour chaque message de débogage Vulkan. Lorsque le callback renvoie true, le message est arrêté (filtré) et n'apparaîtra pas sur la sortie de débogage.

Voir aussi removeDebugOutputFilter().

bool QVulkanInstance::isValid() const

Retourne vrai si create() a réussi et si l'instance est valide.

QByteArrayList QVulkanInstance::layers() const

Renvoie les couches d'instance activées, si create() a été appelé et a réussi. Les couches demandées dans le cas contraire.

Voir aussi setLayers().

void QVulkanInstance::presentAboutToBeQueued(QWindow *window)

Cette fonction doit être appelée par le moteur de rendu de l'application avant de mettre en file d'attente une opération présente pour window.

Alors que sur certaines plates-formes, il s'agit d'une opération sans effet, d'autres peuvent effectuer une synchronisation dépendant du système de fenêtrage. Par exemple, sur Wayland, cette fonction ajoutera l'envoi d'une requête wl_surface.frame afin d'empêcher le pilote de bloquer les fenêtres minimisées.

void QVulkanInstance::presentQueued(QWindow *window)

Cette fonction doit être appelée par le moteur de rendu de l'application après avoir mis en file d'attente une opération de présentation pour window.

Alors que sur certaines plates-formes, il n'y a pas d'opération, d'autres peuvent effectuer une synchronisation dépendant du système de fenêtrage. Par exemple, sur X11, cette fonction mettra à jour _NET_WM_SYNC_REQUEST_COUNTER.

void QVulkanInstance::removeDebugOutputFilter(QVulkanInstance::DebugFilter filter)

Supprime une fonction filter précédemment installée par installDebugOutputFilter().

Voir aussi installDebugOutputFilter().

void QVulkanInstance::resetDeviceFunctions(VkDevice device)

Invalide et détruit l'objet QVulkanDeviceFunctions pour l'objet device donné.

Cette fonction doit être appelée lorsqu'un VkDevice, pour lequel deviceFunctions() a été appelé, est détruit alors que l'application a l'intention de continuer à fonctionner, en créant éventuellement un nouveau périphérique Vulkan logique par la suite.

Il n'est pas nécessaire d'appeler cette fonction avant de détruire le QVulkanInstance puisque le nettoyage est alors effectué automatiquement.

Voir aussi deviceFunctions().

void QVulkanInstance::setApiVersion(const QVersionNumber &vulkanVersion)

Spécifie la version la plus élevée de l'API Vulkan que l'application est conçue pour utiliser.

Par défaut, vulkanVersion vaut 0, ce qui correspond à Vulkan 1.0.

Il est conseillé aux développeurs d'applications de se familiariser avec les notes apiVersion de la spécification Vulkan.

Voir également apiVersion() et supportedApiVersion().

void QVulkanInstance::setExtensions(const QByteArrayList &extensions)

Spécifie la liste des instances supplémentaires extensions à activer. Il est prudent de spécifier également les extensions non prises en charge, car elles sont ignorées lorsqu'elles ne sont pas prises en charge au moment de l'exécution.

Voir aussi extensions().

void QVulkanInstance::setFlags(QVulkanInstance::Flags flags)

Configure le comportement de create() en fonction de flags.

Voir aussi flags().

void QVulkanInstance::setLayers(const QByteArrayList &layers)

Spécifie la liste des instances layers à activer. Il est prudent de spécifier également les couches non prises en charge, car elles sont ignorées lorsqu'elles ne sont pas prises en charge au moment de l'exécution.

Voir aussi layers().

void QVulkanInstance::setVkInstance(VkInstance existingVkInstance)

Fait en sorte que QVulkanInstance adopte un handle VkInstance existant au lieu d'en créer un nouveau.

Voir également vkInstance().

QVersionNumber QVulkanInstance::supportedApiVersion() const

Renvoie la version de la fonctionnalité au niveau de l'instance prise en charge par l'implémentation Vulkan.

En pratique, il s'agit soit de la valeur renvoyée par vkEnumerateInstanceVersion, si cette fonction est disponible (avec Vulkan 1.1 et les versions plus récentes), soit de la valeur 1.0.

Les applications qui souhaitent utiliser les fonctionnalités et API Vulkan en fonction de la version Vulkan disponible au moment de l'exécution peuvent utiliser cette fonction pour déterminer la version à transmettre à setApiVersion() avant d'appeler create().

Voir également setApiVersion().

QVulkanInfoVector<QVulkanExtension> QVulkanInstance::supportedExtensions() const

Renvoie la liste des extensions de niveau instance prises en charge.

QVulkanInfoVector<QVulkanLayer> QVulkanInstance::supportedLayers() const

Renvoie la liste des couches de niveau instance prises en charge.

bool QVulkanInstance::supportsPresent(VkPhysicalDevice physicalDevice, uint32_t queueFamilyIndex, QWindow *window)

Retourne true si la famille de files d'attente avec queueFamilyIndex au sein de physicalDevice prend en charge la présentation à window.

Appeler cette fonction lors de l'examen des files d'attente d'un périphérique Vulkan donné, afin de décider quelle file d'attente peut être utilisée pour effectuer la présentation.

[static] VkSurfaceKHR QVulkanInstance::surfaceForWindow(QWindow *window)

Crée ou récupère la poignée VkSurfaceKHR déjà existante pour le site window donné.

Retourne le handle de la surface Vulkan ou 0 en cas d'échec.

VkInstance QVulkanInstance::vkInstance() const

Renvoie le handle VkInstance que ce QVulkanInstance enveloppe, ou nullptr si create() n'a pas encore été appelé avec succès et qu'aucune instance existante n'a été fournie via setVkInstance().

Voir aussi setVkInstance().