diff options
| author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2019-11-07 09:54:13 +0100 |
|---|---|---|
| committer | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2019-11-18 11:12:35 +0100 |
| commit | 688176a3c35f49c7c087ca2f0e8c841e72133176 (patch) | |
| tree | 04d5939c747ccd748cd14889c192f0485cfe3320 /sources/pyside2/doc/extras/QtOpenGL.rst | |
| parent | 91f62b1db2bdfe9b4eaeb291f31c97c1767fa3fd (diff) | |
Doc: Drop PySide prefix from the RST filenames
Shiboken appends the content in these RSTs to the module index
pages that it generates.
In addition,
- updated the snippets, extras, and additional docs
passed to the Shiboken call.
- moved the copy_directory command right before the
shiboken call.
Change-Id: I45222ba7d0798105a764d7692d466f7a2a105d77
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/pyside2/doc/extras/QtOpenGL.rst')
| -rw-r--r-- | sources/pyside2/doc/extras/QtOpenGL.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/sources/pyside2/doc/extras/QtOpenGL.rst b/sources/pyside2/doc/extras/QtOpenGL.rst new file mode 100644 index 000000000..38783d9fd --- /dev/null +++ b/sources/pyside2/doc/extras/QtOpenGL.rst @@ -0,0 +1,14 @@ +OpenGL is a standard API for rendering 3D graphics. OpenGL only deals with 3D rendering and provides little or no support for GUI programming issues. The user interface for an OpenGL application must be created with another toolkit, such as Motif on the X platform, Microsoft Foundation Classes (MFC) under Windows, or Qt on both platforms. + +.. note:: OpenGL is a trademark of Silicon Graphics, Inc. in the United States and other countries. + +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. +To include the definitions of the module's classes, use the following directive: + +:: + + import PySide2.QtOpenGL + +The Qt OpenGL module is implemented as a platform-independent 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 using the Qt OpenGL module can take advantage of the whole Qt API for non-OpenGL-specific GUI functionality. + +The QtOpenGL module is available on Windows, X11 and Mac OS X. Qt for Embedded Linux and OpenGL supports OpenGL ES (OpenGL for Embedded Systems).
\ No newline at end of file |