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; // Gerät, Swapchain, etc. initialisieren             QVulkanInstance *inst = vulkanInstance();                QVulkanFunctions *f =  inst->functions(); uint32_t devCount = 0;  f->vkEnumeratePhysicalDevices(inst->vkInstance(), &devCount, nullptr); // ... // den ersten Frame erzeugenrender(); } } } bool event(QEvent *e) { if (e->type() == QEvent::UpdateRequest) render(); return QWindow::event(e); } void render() { // ...requestUpdate(); // kontinuierlich rendern}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)>;

Dokumentation der Mitgliedsfunktionen

QVulkanInstance::QVulkanInstance()

Konstruiert eine neue Instanz.

[noexcept] QVulkanInstance::~QVulkanInstance()

Zerstörer.

QVersionNumber QVulkanInstance::apiVersion() const

Gibt die angeforderte Vulkan-API-Version zurück, mit der die Anwendung laufen soll, oder eine Null-Versionsnummer, wenn setApiVersion() nicht vor create() aufgerufen wurde.

Siehe auch setApiVersion().

[since 6.5] void QVulkanInstance::clearDebugOutputFilters()

Entfernt alle Filterfunktionen, die zuvor durch installDebugOutputFilter() installiert wurden.

Diese Funktion wurde in Qt 6.5 eingeführt.

Siehe auch installDebugOutputFilter().

bool QVulkanInstance::create()

Initialisiert die Vulkan-Bibliothek und erstellt eine neue oder übernimmt eine vorhandene Vulkan-Instanz.

Gibt bei Erfolg true zurück, false bei einem Fehler oder wenn Vulkan nicht unterstützt wird.

Bei Erfolg ist der Zeiger auf diese QVulkanInstance über vkInstance() abrufbar.

Die Vulkan-Instanz und -Bibliothek sind verfügbar, solange diese QVulkanInstance existiert oder bis destroy() aufgerufen wird.

Standardmäßig wird die VkInstance mit dem gesetzten Flag VK_INSTANCE_CREATE_ENUMERATE_PORTABILITY_BIT_KHR erstellt. Das bedeutet, dass die physischen Vulkan-Portabilitätsgeräte ebenfalls aufgezählt werden. Wenn dies nicht erwünscht ist, setzen Sie das Flag NoPortabilityDrivers.

void QVulkanInstance::destroy()

Zerstört die zugrundeliegende Plattforminstanz und damit auch die VkInstance (wenn sie ihr gehört). Das Objekt QVulkanInstance kann durch erneuten Aufruf von create() weiterverwendet werden.

QVulkanDeviceFunctions *QVulkanInstance::deviceFunctions(VkDevice device)

Gibt das Objekt QVulkanDeviceFunctions zurück, das den Kern-Vulkan-Befehlssatz auf Geräteebene zur Verfügung stellt und garantiert plattformübergreifend funktionsfähig ist.

Die Funktionen der Kern-API von Vulkan 1.0 werden immer verfügbar sein. Bei höheren Vulkan-Versionen, wie 1.1 und 1.2, versucht das QVulkanDeviceFunctions -Objekt, die Kern-API-Funktionen auch für diese aufzulösen, aber wenn das physische Vulkan-Gerät zur Laufzeit keine Unterstützung für diese bietet, führt der Aufruf einer solchen nicht unterstützten Funktion zu einem nicht spezifizierten Verhalten. Um die Unterstützung für Vulkan-Versionen höher als 1.0 ordnungsgemäß zu aktivieren, muss möglicherweise eine geeignete Instanz-API-Version durch den Aufruf von setApiVersion() vor create() festgelegt werden. Darüber hinaus wird von Anwendungen erwartet, dass sie die apiVersion des physischen Geräts in VkPhysicalDeviceProperties überprüfen.

Siehe auch functions() und resetDeviceFunctions().

VkResult QVulkanInstance::errorCode() const

Gibt den Vulkan-Fehlercode nach einem fehlgeschlagenen create() zurück, ansonsten VK_SUCCESS.

Der Wert ist normalerweise der Rückgabewert von vkCreateInstance() (wenn eine neue Vulkan-Instanz erstellt wird, anstatt eine bestehende zu übernehmen), kann aber auch VK_NOT_READY sein, wenn das Plattform-Plugin Vulkan nicht unterstützt.

QByteArrayList QVulkanInstance::extensions() const

Gibt die aktivierten Instanzerweiterungen zurück, wenn create() aufgerufen wurde und erfolgreich war. Andernfalls die angeforderten Erweiterungen.

Siehe auch setExtensions().

QVulkanInstance::Flags QVulkanInstance::flags() const

Gibt die angeforderten Flags zurück.

Siehe auch setFlags().

QVulkanFunctions *QVulkanInstance::functions() const

Gibt das entsprechende QVulkanFunctions Objekt zurück, das den zentralen Vulkan-Befehlssatz mit Ausnahme der Funktionen auf Geräteebene bereitstellt und garantiert plattformübergreifend funktioniert.

Die Funktionen der Kern-API von Vulkan 1.0 sind immer verfügbar. Bei höheren Vulkan-Versionen, wie z. B. 1.1 und 1.2, versucht das Objekt QVulkanFunctions, die Kern-API-Funktionen auch für diese aufzulösen, aber wenn die Vulkan-Instanzimplementierung zur Laufzeit keine Unterstützung für diese bietet, führt der Aufruf einer solchen nicht unterstützten Funktion zu einem nicht spezifizierten Verhalten. Um die Unterstützung für Vulkan-Versionen höher als 1.0 zu aktivieren, muss außerdem eine geeignete Instanz-API-Version durch den Aufruf von setApiVersion() vor create() gesetzt werden. Um die Version der Vulkan-Implementierung auf Instanzebene abzufragen, rufen Sie supportedApiVersion() auf.

Siehe auch deviceFunctions() und supportedApiVersion().

PFN_vkVoidFunction QVulkanInstance::getInstanceProcAddr(const char *name)

Löst die Vulkan-Funktion mit der angegebenen name auf.

Für die wichtigsten Vulkan-Befehle sollten Sie stattdessen die Funktions-Wrapper verwenden, die über functions() und deviceFunctions() abgerufen werden können.

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

Installiert eine Funktion filter, die für jede Vulkan-Debug-Meldung aufgerufen wird. Wenn der Callback true zurückgibt, wird die Nachricht gestoppt (herausgefiltert) und erscheint nicht in der Debug-Ausgabe.

Diese Funktion wurde in Qt 6.5 eingeführt.

Siehe auch clearDebugOutputFilters().

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

Dies ist eine überladene Funktion.

Installiert eine filter Funktion, die für jede Vulkan-Debug-Meldung aufgerufen wird. Wenn der Callback true zurückgibt, wird die Nachricht gestoppt (herausgefiltert) und erscheint nicht in der Debug-Ausgabe.

Siehe auch removeDebugOutputFilter().

bool QVulkanInstance::isValid() const

Gibt true zurück, wenn create() erfolgreich war und die Instanz gültig ist.

QByteArrayList QVulkanInstance::layers() const

Gibt die aktivierten Instanzebenen zurück, wenn create() aufgerufen wurde und erfolgreich war. Andernfalls die angeforderten Ebenen.

Siehe auch setLayers().

void QVulkanInstance::presentAboutToBeQueued(QWindow *window)

Diese Funktion sollte vom Renderer der Anwendung aufgerufen werden, bevor eine aktuelle Operation in die Warteschlange für window gestellt wird.

Während dies auf einigen Plattformen kein Problem darstellt, können andere eine vom Windowing-System abhängige Synchronisation durchführen. Zum Beispiel wird auf Wayland zusätzlich eine wl_surface.frame-Anfrage gesendet, um zu verhindern, dass der Treiber für minimierte Fenster blockiert.

void QVulkanInstance::presentQueued(QWindow *window)

Diese Funktion sollte vom Renderer der Anwendung aufgerufen werden, nachdem eine aktuelle Operation in die Warteschlange für window gestellt wurde.

Während dies auf einigen Plattformen kein Problem darstellt, kann auf anderen eine vom Fenstersystem abhängige Synchronisation durchgeführt werden. Unter X11 zum Beispiel wird _NET_WM_SYNC_REQUEST_COUNTER aktualisiert.

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

Dies ist eine überladene Funktion.

Entfernt eine filter Funktion, die zuvor durch installDebugOutputFilter() installiert wurde.

Siehe auch installDebugOutputFilter().

void QVulkanInstance::resetDeviceFunctions(VkDevice device)

Invalidiert und zerstört das Objekt QVulkanDeviceFunctions für das angegebene device.

Diese Funktion muss aufgerufen werden, wenn ein VkDevice, für das deviceFunctions() aufgerufen wurde, zerstört wird, während die Anwendung weiterlaufen soll, um möglicherweise später ein neues logisches Vulkan-Gerät zu erstellen.

Es besteht keine Notwendigkeit, diese Funktion vor der Zerstörung von QVulkanInstance aufzurufen, da die Aufräumarbeiten dann automatisch durchgeführt werden.

Siehe auch deviceFunctions().

void QVulkanInstance::setApiVersion(const QVersionNumber &vulkanVersion)

Gibt die höchste Vulkan-API-Version an, die die Anwendung verwenden soll.

Standardmäßig ist vulkanVersion gleich 0, was Vulkan 1.0 entspricht.

Anwendungsentwicklern wird empfohlen, sich mit den apiVersion Hinweisen in der Vulkan-Spezifikation vertraut zu machen.

Siehe auch apiVersion() und supportedApiVersion().

void QVulkanInstance::setExtensions(const QByteArrayList &extensions)

Gibt die Liste der zu aktivierenden zusätzlichen Instanzen extensions an. Es ist sicher, auch nicht unterstützte Erweiterungen anzugeben, da diese ignoriert werden, wenn sie zur Laufzeit nicht unterstützt werden.

Siehe auch extensions().

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

Konfiguriert das Verhalten von create() auf der Grundlage der angegebenen flags.

Siehe auch flags().

void QVulkanInstance::setLayers(const QByteArrayList &layers)

Gibt die Liste der zu aktivierenden Instanzen layers an. Es ist sicher, auch nicht unterstützte Ebenen anzugeben, da diese ignoriert werden, wenn sie zur Laufzeit nicht unterstützt werden.

Siehe auch layers().

void QVulkanInstance::setVkInstance(VkInstance existingVkInstance)

Bringt QVulkanInstance dazu, ein bestehendes VkInstance-Handle zu übernehmen, anstatt ein neues zu erstellen.

Siehe auch vkInstance().

QVersionNumber QVulkanInstance::supportedApiVersion() const

Gibt die Version der von der Vulkan-Implementierung unterstützten Funktionalität auf Instanzebene zurück.

In der Praxis ist dies entweder der Wert, der von vkEnumerateInstanceVersion zurückgegeben wird, wenn diese Funktion verfügbar ist (mit Vulkan 1.1 und neuer), oder 1.0.

Anwendungen, die ihre Vulkan-Funktionen und API-Nutzung davon abhängig machen wollen, welche Vulkan-Version zur Laufzeit verfügbar ist, können diese Funktion verwenden, um zu bestimmen, welche Version an setApiVersion() übergeben werden soll, bevor create() aufgerufen wird.

Siehe auch setApiVersion().

QVulkanInfoVector<QVulkanExtension> QVulkanInstance::supportedExtensions() const

Gibt die Liste der unterstützten Erweiterungen auf Instanzebene zurück.

QVulkanInfoVector<QVulkanLayer> QVulkanInstance::supportedLayers() const

Gibt die Liste der unterstützten Instanz-Ebenen zurück.

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

Gibt true zurück, wenn die Warteschlangenfamilie mit queueFamilyIndex innerhalb der physicalDevice die Präsentation auf window unterstützt.

Rufen Sie diese Funktion auf, wenn Sie die Warteschlangen eines bestimmten Vulkan-Geräts untersuchen, um zu entscheiden, welche Warteschlange für die Präsentation verwendet werden kann.

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

Erzeugt oder holt das bereits vorhandene VkSurfaceKHR -Handle für die angegebene window.

Gibt das Vulkan-Oberflächen-Handle zurück oder 0, wenn der Vorgang fehlgeschlagen ist.

VkInstance QVulkanInstance::vkInstance() const

Gibt das VkInstance-Handle zurück, das QVulkanInstance umhüllt, oder nullptr, wenn create() noch nicht erfolgreich aufgerufen wurde und keine vorhandene Instanz über setVkInstance() bereitgestellt wurde.

Siehe auch setVkInstance().