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 usw. initialisieren.
                QVulkanInstance*inst = vulkanInstance();
                QVulkanFunctions*f = inst->functions();
                uint32_t devCount = 0;
                f->vkEnumeratePhysicalDevices(inst->vkInstance(), &devCount, nullptr);
                // ...
               // Erstellen des ersten Frames
                render();
            }
        }
    }

    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()

Erstellt eine neue Instanz.

[noexcept] QVulkanInstance::~QVulkanInstance()

Destruktor.

QVersionNumber QVulkanInstance::apiVersion() const

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

Siehe auch „ setApiVersion()“.

[since 6.5] void QVulkanInstance::clearDebugOutputFilters()

Entfernt alle zuvor mit installDebugOutputFilter() installierten Filterfunktionen.

Diese Funktion wurde in Qt 6.5 eingeführt.

Siehe auch ` installDebugOutputFilter()`.

bool QVulkanInstance::create()

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

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

Bei Erfolg kann der Zeiger auf diese „ QVulkanInstance “ über „ vkInstance()“ abgerufen werden.

Die Vulkan-Instanz und die Bibliothek stehen zur Verfügung, solange diese ` QVulkanInstance ` existiert oder bis ` destroy()` aufgerufen wird.

Standardmäßig wird die `VkInstance` mit gesetztem Flag ` VK_INSTANCE_CREATE_ENUMERATE_PORTABILITY_BIT_KHR ` erstellt. Das bedeutet, dass auch physische Geräte der Vulkan-Portabilität aufgelistet werden. Wenn dies nicht gewünscht ist, setzen Sie das Flag ` NoPortabilityDrivers `.

void QVulkanInstance::destroy()

Löscht die zugrunde liegende Plattforminstanz und damit auch die `VkInstance` (sofern diese im Besitz des Aufrufers ist). Das ` QVulkanInstance `-Objekt kann durch erneuten Aufruf von ` create()` weiterhin wiederverwendet werden.

QVulkanDeviceFunctions *QVulkanInstance::deviceFunctions(VkDevice device)

Gibt das Objekt ` QVulkanDeviceFunctions ` zurück, das den Kernbefehlssatz von Vulkan auf Geräteebene bereitstellt und dessen plattformübergreifende Funktionsfähigkeit gewährleistet ist.

Die Funktionen aus der Kern-API von Vulkan 1.0 sind stets verfügbar. Bei höheren Vulkan-Versionen, wie beispielsweise 1.1 und 1.2, versucht das ` QVulkanDeviceFunctions `-Objekt, auch die Kern-API-Funktionen für diese Versionen aufzulösen. Wenn das physische Vulkan-Gerät zur Laufzeit diese jedoch nicht unterstützt, führt der Aufruf einer solchen nicht unterstützten Funktion zu nicht spezifiziertem Verhalten. Um die Unterstützung für Vulkan-Versionen höher als 1.0 ordnungsgemäß zu aktivieren, muss möglicherweise vor dem Aufruf von ` create()` durch den Aufruf von ` setApiVersion()` eine entsprechende Instanz-API-Version festgelegt werden. Darüber hinaus wird erwartet, dass Anwendungen die Eigenschaft ` 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 Aufruf von ` create()` zurück, andernfalls ` VK_SUCCESS `.

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

QByteArrayList QVulkanInstance::extensions() const

Gibt die aktivierten Instanzerweiterungen zurück, sofern 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 Kern des Vulkan-Befehlssatzes bereitstellt – mit Ausnahme von Funktionen auf Geräteebene – und dessen plattformübergreifende Funktionsfähigkeit garantiert ist.

Die Funktionen der Kern-API von Vulkan 1.0 sind stets verfügbar. Bei höheren Vulkan-Versionen, wie beispielsweise 1.1 und 1.2, versucht das „ QVulkanFunctions “-Objekt, auch die Kern-API-Funktionen für diese Versionen aufzulösen. Wenn die Vulkan-Instanzimplementierung zur Laufzeit diese jedoch nicht unterstützt, 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 vor dem Aufruf von ` create()` die entsprechende Instanz-API-Version durch den Aufruf von ` setApiVersion()` festgelegt 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 dem angegebenen „ name “ auf.

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

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

Installiert eine ` filter `-Funktion, die bei jeder Vulkan-Debug-Meldung aufgerufen wird. Wenn der Callback ` true` zurückgibt, wird die Meldung unterdrückt (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)

Installiert eine ` filter `-Funktion, die bei jeder Vulkan-Debug-Meldung aufgerufen wird. Wenn der Callback ` true` zurückgibt, wird die Meldung unterdrückt (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, sofern die Funktion „ create()“ aufgerufen wurde und erfolgreich war. Andernfalls werden die angeforderten Ebenen zurückgegeben.

Siehe auch ` setLayers()`.

void QVulkanInstance::presentAboutToBeQueued(QWindow *window)

Diese Funktion sollte vom Renderer der Anwendung aufgerufen werden, bevor ein Darstellungsvorgang für „ window “ in die Warteschlange gestellt wird.

Während dies auf einigen Plattformen keine Auswirkung hat, führen andere möglicherweise eine vom Fenstersystem abhängige Synchronisation durch. Auf Wayland wird beispielsweise eine `wl_surface.frame`-Anforderung gesendet, um zu verhindern, dass der Treiber bei minimierten Fenstern blockiert wird.

void QVulkanInstance::presentQueued(QWindow *window)

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

Während dies auf einigen Plattformen keine Auswirkung hat, führen andere möglicherweise eine vom Fenstersystem abhängige Synchronisation durch. Unter X11 wird dadurch beispielsweise „ _NET_WM_SYNC_REQUEST_COUNTER “ aktualisiert.

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

Entfernt eine zuvor mit installDebugOutputFilter() installierte filter -Funktion.

Siehe auch installDebugOutputFilter().

void QVulkanInstance::resetDeviceFunctions(VkDevice device)

Macht das „ QVulkanDeviceFunctions “-Objekt für das angegebene „ device “ ungültig und löscht es.

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

Es ist nicht erforderlich, diese Funktion vor dem Löschen des ` QVulkanInstance ` aufzurufen, da die Bereinigung dann automatisch erfolgt.

Siehe auch ` deviceFunctions()`.

void QVulkanInstance::setApiVersion(const QVersionNumber &vulkanVersion)

Gibt die höchste Vulkan-API-Version an, für deren Verwendung die Anwendung ausgelegt ist.

Standardmäßig ist ` vulkanVersion ` auf 0 gesetzt, was Vulkan 1.0 entspricht.

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

Siehe auch apiVersion() und supportedApiVersion().

void QVulkanInstance::setExtensions(const QByteArrayList &extensions)

Gibt die Liste der zusätzlichen Instanz- extensions en an, die aktiviert werden sollen. Es ist unbedenklich, auch nicht unterstützte Erweiterungen anzugeben, da diese bei Nichtunterstützung zur Laufzeit ignoriert werden.

Siehe auch ` extensions()`.

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

Konfiguriert das Verhalten von ` create()` basierend auf dem angegebenen ` flags`.

Siehe auch ` flags()`.

void QVulkanInstance::setLayers(const QByteArrayList &layers)

Gibt die Liste der zu aktivierenden Instanz- layers en an. Es ist unbedenklich, auch nicht unterstützte Ebenen anzugeben, da diese bei Nichtunterstützung zur Laufzeit ignoriert werden.

Siehe auch ` layers()`.

void QVulkanInstance::setVkInstance(VkInstance existingVkInstance)

Bewirkt, dass „ QVulkanInstance “ ein vorhandenes VkInstance-Handle übernimmt, anstatt ein neues zu erstellen.

Qt verfügt über keine Möglichkeit, Layer und Erweiterungen bei einer bereits erstellten `VkInstance` zu aktivieren. Daher liegt es in der Verantwortung des Aufrufers, sicherzustellen, dass „ existingVkInstance “ für die Verwendung mit Qt geeignet ist. Wenn ein auf „ QRhi “ basierendes Rendering zum Einsatz kommt, rufen Sie „ QRhiVulkanInitParams::preferredInstanceExtensions()“ auf, um eine zusätzliche Liste von Instanzerweiterungen abzufragen, die vom Ersteller von „ existingVkInstance “ zusätzlich zu den oben genannten Erweiterungen aktiviert werden sollten, sofern diese zur Laufzeit verfügbar sind und vom System unterstützt werden.

Siehe auch vkInstance().

QVersionNumber QVulkanInstance::supportedApiVersion() const

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

In der Praxis ist dies entweder der von `vkEnumerateInstanceVersion` zurückgegebene Wert, sofern diese Funktion verfügbar ist (ab Vulkan 1.1), oder 1.0.

Anwendungen, die ihre Nutzung von Vulkan-Funktionen und -APIs je nach der zur Laufzeit verfügbaren Vulkan-Version anpassen möchten, können diese Funktion verwenden, um zu ermitteln, 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 Ebenen auf Instanzebene zurück.

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

Gibt „true“ zurück, wenn die Warteschlangenfamilie mit dem Parameter „ queueFamilyIndex “ innerhalb des „ physicalDevice “ die Darstellung an „ 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 Darstellung verwendet werden kann.

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

Erstellt oder ruft das bereits vorhandene „ VkSurfaceKHR “-Handle für die angegebene „ window “ ab.

Gibt das Vulkan-Surface-Handle zurück oder 0, falls der Vorgang fehlgeschlagen ist.

VkInstance QVulkanInstance::vkInstance() const

Gibt das VkInstance-Handle zurück, das diese ` QVulkanInstance ` umschließt, oder ` nullptr `, falls ` create()` noch nicht erfolgreich aufgerufen wurde und keine vorhandene Instanz über ` setVkInstance()` bereitgestellt wurde.

Siehe auch setVkInstance().