diff options
author | Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io> | 2020-11-09 08:31:40 +0100 |
---|---|---|
committer | Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io> | 2020-11-13 10:08:49 +0100 |
commit | d8efe51303a08e93240766c620d2a7be3df0dd04 (patch) | |
tree | 3269d08ad5cf9a8c223644f01cb9d21bde89875c /src/opengl/doc/src/qtopengl-index.qdoc | |
parent | c87692a48b053b830ca192a2580f7d27723f16df (diff) |
Update Qt OpenGL docs and add porting docsv6.0.0-beta5
This fleshes out the Qt OpenGL documentation, since this
is now a first class citizen and no longer a compatibility
module. It also adds Qt OpenGL-related info on porting
to Qt 6.
Fixes: QTBUG-88150
Change-Id: I85fcaa2eb5ae574416dcebcc0104bf97428ff42d
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@qt.io>
Diffstat (limited to 'src/opengl/doc/src/qtopengl-index.qdoc')
-rw-r--r-- | src/opengl/doc/src/qtopengl-index.qdoc | 53 |
1 files changed, 42 insertions, 11 deletions
diff --git a/src/opengl/doc/src/qtopengl-index.qdoc b/src/opengl/doc/src/qtopengl-index.qdoc index d09d508fb3..f6d7ef81a6 100644 --- a/src/opengl/doc/src/qtopengl-index.qdoc +++ b/src/opengl/doc/src/qtopengl-index.qdoc @@ -31,19 +31,50 @@ \brief The Qt OpenGL module offers classes that make it easy to use OpenGL in Qt applications. + OpenGL is a low-level, cross-platform API for graphics. In Qt, + it can optionally be used as the foundation for rendering. + \section1 Introduction - The Qt OpenGL module makes it easy to use OpenGL in Qt applications. - It provides an OpenGL widget class that can be used just like any - other Qt widget, except that it opens an OpenGL display buffer where - you can use the OpenGL API to render the contents. - - The Qt OpenGL module is implemented as a platform-independent Qt/C++ - wrapper around the platform-dependent GLX (version 1.3 or later), - WGL, or AGL C APIs. Although the basic functionality provided is very - similar to Mark Kilgard's GLUT library, applications can use the - other \l{All Modules}{Qt modules} to implement the rest of the user - interface. + Qt has two main approaches to UI development: \l[QtQuick]{Qt Quick} and + \l{Qt Widgets}. They exist to support different types of user + interfaces, and build on separate graphics engines which have been + optimized for each of these types. + + It is possible to combine code written in the OpenGL graphics API + with both these user interface types in Qt. This can be useful + when the application has its own OpenGL-dependent code, or when it + is integrating with a third-party OpenGL-based renderer. + + The Qt OpenGL module contains convenience classes to make this type of + integration easier and faster. + + \section1 Qt OpenGL and Qt Widgets + + \l{Qt Widgets} is typically rendered by a highly optimized and accurate + software rasterizer, and the final content reproduced on screen using a + method appropriate for the platform where the application is running. + + But it is also possible to combine \l{Qt Widgets} with OpenGL. The main entry + point for this is the \l{QOpenGLWidget} class. This class can be used to + enable OpenGL rendering for a certain part of the widget tree, and the + classes in the Qt OpenGL module can be used to facilitate any application-side + OpenGL code. + + \section1 Qt OpenGL and Qt Quick + + \l[QtQuick]{Qt Quick} is optimized for hardware-accelerated rendering. By default, + it will be built on the low-level graphics API most appropriate for the + target platform. + + For instance, it will default to \c Direct3D on Windows, whereas on macOS, + it will default to \c Metal. But the it is also possible to manually + select OpenGL as the active graphics API on platforms where this is supported. + + For more details on enabling OpenGL with \l[QtQuick]{Qt Quick}, see + \l{Rendering via the Qt Rendering Hardware Interface}{scenegraph renderer documentation}. + + \section1 Overview The \l{Qt OpenGL C++ Classes} page gives an overview over the available classes in this module. |