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;
                // initialisation du périphérique, de la chaîne d'échange, etc.
                QVulkanInstance*inst = vulkanInstance();
                QVulkanFunctions*f = inst->functions();
                uint32_t devCount = 0;
                f->vkEnumeratePhysicalDevices(inst->vkInstance(), &devCount, nullptr);
                // ...
               // construire la première image
                render();
            }
        }
    }

    bool event(QEvent*e) {
        if (e->type()== QEvent::UpdateRequest)
            render();
        return QWindow::event(e);
    }

   void render() {
       // ...
       requestUpdate(); // rendu 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()

Crée une nouvelle instance.

[noexcept] QVulkanInstance::~QVulkanInstance()

Destructeur.

QVersionNumber QVulkanInstance::apiVersion() const

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

Voir également setApiVersion().

[since 6.5] void QVulkanInstance::clearDebugOutputFilters()

Supprime toutes les fonctions de filtrage précédemment installées par la fonction 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 reprend une instance existante.

Renvoie « true » en cas de réussite, « false » en cas d'erreur ou lorsque Vulkan n'est pas pris en charge.

En cas de réussite, le pointeur vers cette instance de Vulkan ( QVulkanInstance ) peut être récupéré via la fonction ` vkInstance()`.

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

Par défaut, l’instance VkInstance est créée avec le drapeau VK_INSTANCE_CREATE_ENUMERATE_PORTABILITY_BIT_KHR activé. Cela signifie que les périphériques physiques de Vulkan Portability sont également énumérés. Si cela n’est pas souhaité, activez le drapeau NoPortabilityDrivers.

void QVulkanInstance::destroy()

Supprime l'instance de la plateforme sous-jacente, ce qui entraîne la suppression de l'instance VkInstance (si celle-ci est détenue). L'objet QVulkanInstance reste réutilisable en appelant à nouveau la méthode create().

QVulkanDeviceFunctions *QVulkanInstance::deviceFunctions(VkDevice device)

Renvoie l'objet ` QVulkanDeviceFunctions ` qui expose l'ensemble de commandes Vulkan de base au niveau du périphérique et dont le fonctionnement est garanti sur toutes les plateformes.

Les fonctions de l’API principale de Vulkan 1.0 seront toujours disponibles. En ce qui concerne les versions supérieures de Vulkan, telles que 1.1 et 1.2, l’objet ` QVulkanDeviceFunctions ` tentera également de résoudre les fonctions de l’API de base pour celles-ci, mais si le périphérique physique Vulkan ne prend pas en charge ces versions au moment de l’exécution, l’appel de toute fonction non prise en charge entraînera un comportement indéfini. 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()`. De plus, les applications doivent vérifier la propriété ` 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 appel create() ayant échoué ; sinon, renvoie VK_SUCCESS.

Cette valeur correspond généralement à la valeur de retour de vkCreateInstance() (lors de la création d’une nouvelle instance Vulkan plutôt que de l’adoption d’une instance existante), mais peut également être « VK_NOT_READY » si le plugin de la plateforme ne prend pas en charge Vulkan.

QByteArrayList QVulkanInstance::extensions() const

Renvoie les extensions d'instance activées, si la fonction create() a été appelée et s'est déroulée avec succès. Dans le cas contraire, elle renvoie les extensions demandées.

Voir aussi setExtensions().

QVulkanInstance::Flags QVulkanInstance::flags() const

Renvoie les indicateurs demandés.

Voir aussi setFlags().

QVulkanFunctions *QVulkanInstance::functions() const

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

Les fonctions de l’API principale de Vulkan 1.0 seront toujours disponibles. En ce qui concerne les versions supérieures de Vulkan, telles que 1.1 et 1.2, l’objet ` QVulkanFunctions ` tentera également de résoudre les fonctions de l’API de base pour celles-ci, mais si l’implémentation de l’instance Vulkan en temps d’exécution ne les prend pas en charge, l’appel d’une telle fonction non prise en charge entraînera un comportement indéfini. De plus, 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 appropriée de l’API d’instance en appelant ` setApiVersion()` avant ` create()`. Pour interroger la version au niveau de l’instance de l’implémentation de Vulkan, appelez ` supportedApiVersion()`.

Voir également deviceFunctions() et supportedApiVersion().

PFN_vkVoidFunction QVulkanInstance::getInstanceProcAddr(const char *name)

Résout la fonction Vulkan à l'aide de l'name fournie.

Pour les commandes Vulkan de base, privilégiez plutôt l'utilisation des wrappers de fonctions disponibles via functions() et deviceFunctions().

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

Installe une fonction de rappel ( filter ) qui est appelée à chaque message de débogage Vulkan. Lorsque la fonction de rappel renvoie la valeur « true », le message est bloqué (filtré) et n'apparaîtra pas dans 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 de rappel ( filter ) qui est appelée pour chaque message de débogage Vulkan. Lorsque la fonction de rappel renvoie true, le message est bloqué (filtré) et n'apparaîtra pas dans la sortie de débogage.

Voir aussi removeDebugOutputFilter().

bool QVulkanInstance::isValid() const

Renvoie « true » si la fonction ` create()` s'est déroulée correctement et si l'instance est valide.

QByteArrayList QVulkanInstance::layers() const

Renvoie les couches d'instance activées, si la fonction create() a été appelée et s'est déroulée avec succès. Dans le cas contraire, renvoie les couches demandées.

Voir également 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 de rendu pour window.

Si, sur certaines plateformes, cette fonction n'aura aucun effet, d'autres peuvent effectuer une synchronisation dépendant du système de fenêtrage. Par exemple, sous Wayland, cela ajoutera l'envoi d'une requête wl_surface.frame afin d'empêcher le pilote de se bloquer pour 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 rendu pour window.

Si, sur certaines plateformes, cette fonction n'aura aucun effet, d'autres peuvent effectuer une synchronisation dépendante du système de fenêtrage. Par exemple, sous X11, cela mettra à jour _NET_WM_SYNC_REQUEST_COUNTER.

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

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

Voir également installDebugOutputFilter().

void QVulkanInstance::resetDeviceFunctions(VkDevice device)

Invalide et détruit l'objet ` QVulkanDeviceFunctions ` associé à l'device` spécifié.

Cette fonction doit être appelée lorsqu’un VkDevice, pour lequel la fonction deviceFunctions() a été appelée, est détruit alors que l’application prévoit de continuer à s’exécuter, éventuellement en créant un nouveau périphérique Vulkan logique ultérieurement.

Il n’est pas nécessaire d’appeler cette fonction avant de détruire l’ QVulkanInstance, car le nettoyage est alors effectué automatiquement.

Voir également deviceFunctions().

void QVulkanInstance::setApiVersion(const QVersionNumber &vulkanVersion)

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

Par défaut, ` vulkanVersion ` est égal à 0, ce qui correspond à Vulkan 1.0.

Il est conseillé aux développeurs d’applications de se familiariser avec les remarques relatives à l’ apiVersion s figurant dans la spécification Vulkan.

Voir également apiVersion() et supportedApiVersion().

void QVulkanInstance::setExtensions(const QByteArrayList &extensions)

Spécifie la liste des extensions d'instance supplémentaires extensions à activer. Vous pouvez sans risque spécifier des extensions non prises en charge, car celles-ci seront ignorées si elles ne sont pas prises en charge lors de l'exécution.

Voir également ` extensions()`.

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

Configure le comportement de la fonction ` create()` en fonction de l’ flags fournie.

Voir également flags().

void QVulkanInstance::setLayers(const QByteArrayList &layers)

Spécifie la liste des couches d'layers s d'instance à activer. Vous pouvez sans risque spécifier des couches non prises en charge, car celles-ci seront ignorées si elles ne sont pas prises en charge lors de l'exécution.

Voir également ` layers()`.

void QVulkanInstance::setVkInstance(VkInstance existingVkInstance)

Permet à la fonction ` QVulkanInstance ` d'utiliser un descripteur `VkInstance` existant au lieu d'en créer un nouveau.

Qt ne dispose d'aucun moyen d'activer des couches et des extensions sur une instance VkInstance déjà créée. Par conséquent, il incombe à l’appelant de s’assurer que existingVkInstance est adapté à une utilisation avec Qt. Si un rendu basé sur QRhi est impliqué, appelez QRhiVulkanInitParams::preferredInstanceExtensions() pour obtenir une liste supplémentaire d’extensions d’instance qui doivent être activées par le créateur de existingVkInstance, en plus des extensions mentionnées ci-dessus, à condition qu’elles soient disponibles et prises en charge par le système au moment de l’exécution.

Voir aussi vkInstance().

QVersionNumber QVulkanInstance::supportedApiVersion() const

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

En pratique, il s'agit soit de la valeur renvoyée par vkEnumerateInstanceVersion, si cette fonction est disponible (à partir de Vulkan 1.1), soit de 1.0.

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

Voir également setApiVersion().

QVulkanInfoVector<QVulkanExtension> QVulkanInstance::supportedExtensions() const

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

QVulkanInfoVector<QVulkanLayer> QVulkanInstance::supportedLayers() const

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

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

Renvoie « true » si la famille de files d'attente dont l'queueFamilyIndex, au sein de l'physicalDevice, prend en charge l'affichage via window.

Appelez cette fonction lorsque vous examinez les files d’attente d’un périphérique Vulkan donné, afin de déterminer 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 le descripteur « VkSurfaceKHR » existant pour l’ window donné.

Renvoie le descripteur de surface Vulkan ou 0 en cas d'échec.

VkInstance QVulkanInstance::vkInstance() const

Renvoie le descripteur VkInstance encapsulé par cette fonction QVulkanInstance, ou nullptr si la fonction create() n'a pas encore été appelée avec succès et qu'aucune instance existante n'a été fournie via la fonction setVkInstance().

Voir également setVkInstance().