EchoEngine开发笔记-GraphicWidget

706 words

4 minutes

EchoEngine开发笔记-GraphicWidget

2025-01-01

EchoEngine

Render Engine

对于渲染引擎来说，UI中的图形显示组件最为重要，因为它是显示渲染结果和与用户进行交互的窗口，所以编写一篇笔记来记录图形显示组件的实现过程是很有必要的。

GraphicWidget#

设计思路#

在EchoEngine中，我设计了一个名为GraphicWidget类，此类是用于在EchoEditor中显示图形渲染结果的组件。在一开始时，我是以QOpenGLWidget为基类来设计的，但考虑到未来该项目将支持多个图形API，如OpenGL、DirectX、Vulkan等，所以最终我决定使用QWidget作为基类。
基于目前开发计划是围绕OpenGL来设计的，因此我打算使用GLFW来进行图形上下文管理。

实现过程#

重写两个重要函数：paintEvent和resizeEvent，在paintEvent中绘制图形，在resizeEvent中更新窗口大小。
重写paintEngine函数，返回nullptr，表示禁用QPainter绘制组件，完全使用渲染引擎来绘制。
在构造函数中设置setAttribute(Qt::WA_PaintOnScreen);，用于控制Qt在控件上直接进行绘制操作，而不通过缓冲区（例如双缓冲）进行中间绘制。
在paintEvent中，获取当前OpenGL上下文，并使用OpenGL来绘制图形，最后交换缓冲区将渲染结果显示到屏幕上。

1
#pragma once
2

3
struct GLFWwindow;
4

5
namespace EchoEditor {
6

7
    /// @brief 图形显示组件
8
    class GraphicWidget : public QWidget
9
    {
10
        Q_OBJECT
11
    public:
12
        GraphicWidget(uint32_t nWidth, uint32_t nHeight, QWidget* parent = nullptr);
13
        virtual ~GraphicWidget();
14

15
    public:
16
        virtual void paintEvent(QPaintEvent* event) override;
17
        virtual void resizeEvent(QResizeEvent* event) override;
18

19
        /// @brief 获取绘制引擎
20
        /// @return 返回nullptr：表示禁用QPainter绘制组件，完全使用渲染引擎来绘制
21
        virtual QPaintEngine* paintEngine() const override { return nullptr; }
22

23
    private:
24
        /// @brief 初始化
25
        void Initialize();
26

27
    private:
28
        GLFWwindow* m_pWindow = nullptr;
29
    };
30

31
}
32

33
// GraphicWidget.cpp
34
#include "pch.h"
35
#include "GraphicWidget.h"
36

37
#include <GLFW/glfw3.h>
38
#include <glad/glad.h>
39

40
namespace EchoEditor {
41

42
    static bool s_bGLFWInitialiazed = false;
43

44
    GraphicWidget::GraphicWidget(uint32_t nWidth, uint32_t nHeight, QWidget* parent)
45
        : QWidget(parent)
46
    {
47
        // 设置直接绘制在屏幕上
48
        setAttribute(Qt::WA_PaintOnScreen);
49
        // 设置大小
50
        resize((int)nWidth, (int)nHeight);
51
        // 初始化
52
        Initialize();
53
    }
54

55
    GraphicWidget::~GraphicWidget()
56
    {
57
        glfwDestroyWindow(m_pWindow);
58
    }
59

60
    void GraphicWidget::paintEvent(QPaintEvent* event)
61
    {
62
        //设置当前上下文
63
        glfwMakeContextCurrent(m_pWindow);
64

65
        // OpenGL rendering here
66
        glClearColor(0.1f, 0.1f, 0.1f, 1.0f);
67
        glClear(GL_COLOR_BUFFER_BIT);
68

69
        // 交换缓冲区
70
        glfwSwapBuffers(m_pWindow);
71
    }
72

73
    void GraphicWidget::resizeEvent(QResizeEvent* event)
74
    {
75
    }
76

77
    void GraphicWidget::Initialize()
78
    {
79
        if (!s_bGLFWInitialiazed)
80
        {
81
            // glfwTerminate on system shutdown
82
            int success = glfwInit();
83
            ECHO_CORE_ASSERT(success, "Could not intialiaz GLFW!");
84
            s_bGLFWInitialiazed = true;
85
        }
86
        glfwWindowHint(GLFW_VISIBLE, GLFW_FALSE);
87
        m_pWindow = glfwCreateWindow(width(), height(), "EchoEngine", nullptr, nullptr);
88
        glfwMakeContextCurrent(m_pWindow);
89

90
        //初始化GLAD
91
        int iStatus = gladLoadGLLoader((GLADloadproc)glfwGetProcAddress);
92
        ECHO_CORE_ASSERT(iStatus, "Failed to initiazlize Glad!");
93
        //设置垂直同步
94
        glfwSwapInterval(1);
95

96
        #if defined(_WIN32)// Windows: Use glfwGetWin32Window
97
            QWindow* pGLFWWindow = QWindow::fromWinId((WId)glfwGetWin32Window(m_pWindow));
98
        #else
99
            ECHO_CORE_ASSERT(false, "Unsupported platform for embedding GLFW window.");
100
        #endif
101
        //将GLFW嵌入到GraphicWidget中
102
        QVBoxLayout* layout = new QVBoxLayout();
103
        QWidget* container = QWidget::createWindowContainer(pGLFWWindow, this);
104
        layout->addWidget(container);
105
        setLayout(layout);
106
    }
107

108
}