From 1f6bfc220774e9407fe88916843b76ed103cff72 Mon Sep 17 00:00:00 2001
From: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Date: Mon, 3 Sep 2018 14:02:13 +0200
Subject: Doc: Move literal code block to a separate file
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

We need to override this snippet for the documentation
we generate for Qt for Python, and it is easier to have
it on a separate file.

Task-number: PYSIDE-801
Task-number: PYSIDE-691
Change-Id: Ideb5b6af25024279f167137d3b65660bb9c96a7e
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
---
 .../snippets/code/src_gui_vulkan_qvulkanwindow.cpp | 121 +++++++++++++++++++++
 1 file changed, 121 insertions(+)
 create mode 100644 src/gui/doc/snippets/code/src_gui_vulkan_qvulkanwindow.cpp

(limited to 'src/gui/doc/snippets/code/src_gui_vulkan_qvulkanwindow.cpp')

diff --git a/src/gui/doc/snippets/code/src_gui_vulkan_qvulkanwindow.cpp b/src/gui/doc/snippets/code/src_gui_vulkan_qvulkanwindow.cpp
new file mode 100644
index 0000000000..65eca4a77f
--- /dev/null
+++ b/src/gui/doc/snippets/code/src_gui_vulkan_qvulkanwindow.cpp
@@ -0,0 +1,121 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtGui module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+//! [0]
+  class VulkanRenderer : public QVulkanWindowRenderer
+  {
+  public:
+      VulkanRenderer(QVulkanWindow *w) : m_window(w) { }
+
+      void initResources() override
+      {
+          m_devFuncs = m_window->vulkanInstance()->deviceFunctions(m_window->device());
+          ...
+      }
+      void initSwapChainResources() override { ... }
+      void releaseSwapChainResources() override { ... }
+      void releaseResources() override { ... }
+
+      void startNextFrame() override
+      {
+          VkCommandBuffer cmdBuf = m_window->currentCommandBuffer();
+          ...
+          m_devFuncs->vkCmdBeginRenderPass(...);
+          ...
+          m_window->frameReady();
+      }
+
+  private:
+      QVulkanWindow *m_window;
+      QVulkanDeviceFunctions *m_devFuncs;
+  };
+
+  class VulkanWindow : public QVulkanWindow
+  {
+  public:
+      QVulkanWindowRenderer *createRenderer() override {
+          return new VulkanRenderer(this);
+      }
+  };
+
+  int main(int argc, char *argv[])
+  {
+      QGuiApplication app(argc, argv);
+
+      QVulkanInstance inst;
+      // enable the standard validation layers, when available
+      inst.setLayers(QByteArrayList() << "VK_LAYER_LUNARG_standard_validation");
+      if (!inst.create())
+          qFatal("Failed to create Vulkan instance: %d", inst.errorCode());
+
+      VulkanWindow w;
+      w.setVulkanInstance(&inst);
+      w.showMaximized();
+
+      return app.exec();
+  }
+//! [0]
+
+//! [1]
+    class Renderer {
+        ...
+        VkDescriptorBufferInfo m_uniformBufInfo[QVulkanWindow::MAX_CONCURRENT_FRAME_COUNT];
+    };
+
+    void Renderer::startNextFrame()
+    {
+        VkDescriptorBufferInfo &uniformBufInfo(m_uniformBufInfo[m_window->currentFrame()]);
+        ...
+    }
+//! [1]
+
+//! [2]
+    class Renderer {
+        ...
+        VkDescriptorBufferInfo m_uniformBufInfo[QVulkanWindow::MAX_CONCURRENT_FRAME_COUNT];
+    };
+
+    void Renderer::startNextFrame()
+    {
+        const int count = m_window->concurrentFrameCount();
+        for (int i = 0; i < count; ++i)
+            m_uniformBufInfo[i] = ...
+        ...
+    }
+//! [2]
-- 
cgit v1.2.3