diff options
Diffstat (limited to 'src/opengl/doc/snippets')
5 files changed, 349 insertions, 2 deletions
diff --git a/src/opengl/doc/snippets/CMakeLists.txt b/src/opengl/doc/snippets/CMakeLists.txt index 03b161ee97..419e0923e0 100644 --- a/src/opengl/doc/snippets/CMakeLists.txt +++ b/src/opengl/doc/snippets/CMakeLists.txt @@ -1,4 +1,7 @@ +# Copyright (C) 2022 The Qt Company Ltd. +# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause + #! [cmake_use] -find_package(Qt6 COMPONENTS OpenGL REQUIRED) -target_link_libraries(mytarget Qt::OpenGL) +find_package(Qt6 REQUIRED COMPONENTS OpenGL) +target_link_libraries(mytarget PRIVATE Qt6::OpenGL) #! [cmake_use] diff --git a/src/opengl/doc/snippets/code/doc_gui_widgets_qopenglwidget.cpp b/src/opengl/doc/snippets/code/doc_gui_widgets_qopenglwidget.cpp new file mode 100644 index 0000000000..f2c26e0bb8 --- /dev/null +++ b/src/opengl/doc/snippets/code/doc_gui_widgets_qopenglwidget.cpp @@ -0,0 +1,168 @@ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause + +//! [0] +class MyGLWidget : public QOpenGLWidget +{ +public: + MyGLWidget(QWidget *parent) : QOpenGLWidget(parent) { } + +protected: + void initializeGL() override + { + // Set up the rendering context, load shaders and other resources, etc.: + QOpenGLFunctions *f = QOpenGLContext::currentContext()->functions(); + f->glClearColor(1.0f, 1.0f, 1.0f, 1.0f); + ... + } + + void resizeGL(int w, int h) override + { + // Update projection matrix and other size related settings: + m_projection.setToIdentity(); + m_projection.perspective(45.0f, w / float(h), 0.01f, 100.0f); + ... + } + + void paintGL() override + { + // Draw the scene: + QOpenGLFunctions *f = QOpenGLContext::currentContext()->functions(); + f->glClear(GL_COLOR_BUFFER_BIT); + ... + } + +}; +//! [0] + +//! [1] +class MyGLWidget : public QOpenGLWidget, protected QOpenGLFunctions +{ + ... + void initializeGL() override + { + initializeOpenGLFunctions(); + glClearColor(...); + ... + } + ... +}; +//! [1] + +//! [2] +QOpenGLWidget *widget = new QOpenGLWidget(parent); +QSurfaceFormat format; +format.setDepthBufferSize(24); +format.setStencilBufferSize(8); +format.setVersion(3, 2); +format.setProfile(QSurfaceFormat::CoreProfile); +widget->setFormat(format); // must be called before the widget or its parent window gets shown +//! [2] + +//! [3] + ... + void paintGL() override + { + QOpenGLFunctions_3_2_Core *f = QOpenGLContext::currentContext()->versionFunctions<QOpenGLFunctions_3_2_Core>(); + ... + f->glDrawArraysInstanced(...); + ... + } + ... +//! [3] + +//! [4] +class MyGLWidget : public QOpenGLWidget +{ + ... + +private: + QOpenGLVertexArrayObject m_vao; + QOpenGLBuffer m_vbo; + QOpenGLShaderProgram *m_program; + QOpenGLShader *m_shader; + QOpenGLTexture *m_texture; +}; + +MyGLWidget::MyGLWidget() + : m_program(0), m_shader(0), m_texture(0) +{ + // No OpenGL resource initialization is done here. +} + +MyGLWidget::~MyGLWidget() +{ + // Make sure the context is current and then explicitly + // destroy all underlying OpenGL resources. + makeCurrent(); + + delete m_texture; + delete m_shader; + delete m_program; + + m_vbo.destroy(); + m_vao.destroy(); + + doneCurrent(); +} + +void MyGLWidget::initializeGL() +{ + m_vao.create(); + if (m_vao.isCreated()) + m_vao.bind(); + + m_vbo.create(); + m_vbo.bind(); + m_vbo.allocate(...); + + m_texture = new QOpenGLTexture(QImage(...)); + + m_shader = new QOpenGLShader(...); + m_program = new QOpenGLShaderProgram(...); + + ... +} +//! [4] + +//! [5] +MyGLWidget::~MyGLWidget() +{ + cleanup(); +} + +void MyGLWidget::initializeGL() +{ + ... + connect(context(), &QOpenGLContext::aboutToBeDestroyed, this, &MyGLWidget::cleanup); +} + +void MyGLWidget::cleanup() +{ + makeCurrent(); + delete m_texture; + m_texture = 0; + ... + doneCurrent(); + disconnect(context(), &QOpenGLContext::aboutToBeDestroyed, this, &MyGLWidget::cleanup); +} +//! [5] + +//! [6] +int main(int argc, char **argv) +{ + QApplication app(argc, argv); + + QSurfaceFormat format; + format.setDepthBufferSize(24); + format.setStencilBufferSize(8); + format.setVersion(3, 2); + format.setProfile(QSurfaceFormat::CoreProfile); + QSurfaceFormat::setDefaultFormat(format); + + MyWidget widget; + widget.show(); + + return app.exec(); +} +//! [6] diff --git a/src/opengl/doc/snippets/code/src_gui_opengl_qopenglbuffer.cpp b/src/opengl/doc/snippets/code/src_gui_opengl_qopenglbuffer.cpp new file mode 100644 index 0000000000..f20eb3493a --- /dev/null +++ b/src/opengl/doc/snippets/code/src_gui_opengl_qopenglbuffer.cpp @@ -0,0 +1,21 @@ +// Copyright (C) 2018 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause +#include <QtOpenGL/QOpenGLBuffer> + +namespace src_gui_opengl_qopenglbuffer { +void wrapper() { + +//! [0] +QOpenGLBuffer buffer1(QOpenGLBuffer::IndexBuffer); +buffer1.create(); + +QOpenGLBuffer buffer2 = buffer1; +//! [0] + + +//! [1] +QOpenGLBuffer::release(QOpenGLBuffer::VertexBuffer); +//! [1] + +} // wrapper +} // src_gui_opengl_qopenglbuffer diff --git a/src/opengl/doc/snippets/code/src_gui_opengl_qopengldebug.cpp b/src/opengl/doc/snippets/code/src_gui_opengl_qopengldebug.cpp new file mode 100644 index 0000000000..bb5c212205 --- /dev/null +++ b/src/opengl/doc/snippets/code/src_gui_opengl_qopengldebug.cpp @@ -0,0 +1,86 @@ +// Copyright (C) 2018 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause +#include <QOpenGLContext> +#include <QSurfaceFormat> +#include <QWidget> +#include <QtOpenGL/QOpenGLDebugLogger> + +namespace src_gui_opengl_qopengldebug { +struct LogHandler : public QObject +{ + Q_OBJECT +public slots: + static bool handleLoggedMessage() { return true; }; +}; +struct SnippetWrapper : public QObject +{ + Q_OBJECT + void wrapper1(LogHandler *receiver); + const QWidget *receiver; +}; + +void wrapper0() { + +//! [0] +GLenum error = GL_NO_ERROR; +do { + error = glGetError(); + if (error != GL_NO_ERROR) { + // handle the error + } +} while (error != GL_NO_ERROR); +//! [0] + + +//! [1] +QSurfaceFormat format; +// asks for a OpenGL 3.2 debug context using the Core profile +format.setMajorVersion(3); +format.setMinorVersion(2); +format.setProfile(QSurfaceFormat::CoreProfile); +format.setOption(QSurfaceFormat::DebugContext); + +QOpenGLContext *context = new QOpenGLContext; +context->setFormat(format); +context->create(); +//! [1] + +} // wrapper0 + + +void SnippetWrapper::wrapper1(LogHandler *receiver) { +//! [2] +QOpenGLContext *ctx = QOpenGLContext::currentContext(); +QOpenGLDebugLogger *logger = new QOpenGLDebugLogger(this); + +logger->initialize(); // initializes in the current context, i.e. ctx +//! [2] + + +//! [3] +ctx->hasExtension(QByteArrayLiteral("GL_KHR_debug")); +//! [3] + + +//! [4] +const QList<QOpenGLDebugMessage> messages = logger->loggedMessages(); +for (const QOpenGLDebugMessage &message : messages) + qDebug() << message; +//! [4] + + +//! [5] +connect(logger, &QOpenGLDebugLogger::messageLogged, receiver, &LogHandler::handleLoggedMessage); +logger->startLogging(); +//! [5] + + +//! [6] +QOpenGLDebugMessage message = + QOpenGLDebugMessage::createApplicationMessage(QStringLiteral("Custom message")); + +logger->logMessage(message); +//! [6] + +} // SnippetWrapper::wrapper1 +} // src_gui_opengl_qopengldebug diff --git a/src/opengl/doc/snippets/code/src_gui_qopenglshaderprogram.cpp b/src/opengl/doc/snippets/code/src_gui_qopenglshaderprogram.cpp new file mode 100644 index 0000000000..de62069fda --- /dev/null +++ b/src/opengl/doc/snippets/code/src_gui_qopenglshaderprogram.cpp @@ -0,0 +1,69 @@ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause +#include <QColor> +#include <QString> +#include <QtOpenGL/QOpenGLShader> + +namespace src_gui_qopenglshaderprogram { +QString code; +QObject *context = nullptr; +QRectF rect() { return QRectF(); } + +void wrapper() { +//! [0] +QOpenGLShader shader(QOpenGLShader::Vertex); +shader.compileSourceCode(code); + +QOpenGLShaderProgram program(context); +program.addShader(&shader); +program.link(); + +program.bind(); +//! [0] + +//! [1] +program.addShaderFromSourceCode(QOpenGLShader::Vertex, + "attribute highp vec4 vertex;\n" + "uniform highp mat4 matrix;\n" + "void main(void)\n" + "{\n" + " gl_Position = matrix * vertex;\n" + "}"); +program.addShaderFromSourceCode(QOpenGLShader::Fragment, + "uniform mediump vec4 color;\n" + "void main(void)\n" + "{\n" + " gl_FragColor = color;\n" + "}"); +program.link(); +program.bind(); + +int vertexLocation = program.attributeLocation("vertex"); +int matrixLocation = program.uniformLocation("matrix"); +int colorLocation = program.uniformLocation("color"); +//! [1] + +//! [2] +static GLfloat const triangleVertices[] = { + 60.0f, 10.0f, 0.0f, + 110.0f, 110.0f, 0.0f, + 10.0f, 110.0f, 0.0f +}; + +QColor color(0, 255, 0, 255); + +QMatrix4x4 pmvMatrix; +pmvMatrix.ortho(rect()); + +program.enableAttributeArray(vertexLocation); +program.setAttributeArray(vertexLocation, triangleVertices, 3); +program.setUniformValue(matrixLocation, pmvMatrix); +program.setUniformValue(colorLocation, color); + +glDrawArrays(GL_TRIANGLES, 0, 3); + +program.disableAttributeArray(vertexLocation); +//! [2] + +} // wrapper +} // src_gui_qopenglshaderprogram |