Documented QtOpenGL classes that have better replacements as obsolete.

These have new replacements in QtGui since Qt 5.0.

Change-Id: I20e8fdd4e9c14d8c626eda3072217af1858bf492
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

diff --git a/src/opengl/qglbuffer.cpp b/src/opengl/qglbuffer.cpp
index bdfc152..6798f1e 100644 (file)
--- a/src/opengl/qglbuffer.cpp
+++ b/src/opengl/qglbuffer.cpp
@@ -51,6 +51,7 @@ QT_BEGIN_NAMESPACE
     \class QGLBuffer
     \brief The QGLBuffer class provides functions for creating and managing GL buffer objects.
     \since 4.7
+    \obsolete
     \ingroup painting-3D
 
     Buffer objects are created in the GL server so that the
@@ -70,6 +71,8 @@ QT_BEGIN_NAMESPACE
     QGLBuffer performs a shallow copy when objects are copied in this
     manner, but does not implement copy-on-write semantics.  The original
     object will be affected whenever the copy is modified.
+
+    \note This class has been deprecated in favor of QOpenGLBuffer.
 */
 
 /*!

diff --git a/src/opengl/qglcolormap.cpp b/src/opengl/qglcolormap.cpp
index 8dabe68..6a9fdce 100644 (file)
--- a/src/opengl/qglcolormap.cpp
+++ b/src/opengl/qglcolormap.cpp
@@ -44,6 +44,7 @@
     \brief The QGLColormap class is used for installing custom colormaps into
     a QGLWidget.
 
+    \obsolete
     \inmodule OpenGL
     \ingroup painting-3D
     \ingroup shared

diff --git a/src/opengl/qglframebufferobject.cpp b/src/opengl/qglframebufferobject.cpp
index 0359de8..cc950e7 100644 (file)
--- a/src/opengl/qglframebufferobject.cpp
+++ b/src/opengl/qglframebufferobject.cpp
@@ -108,6 +108,7 @@ extern QImage qt_gl_read_framebuffer(const QSize&, bool, bool);
     framebuffer object.
 
     \since 4.6
+    \obsolete
 
     \ingroup painting-3D
 
@@ -124,6 +125,8 @@ extern QImage qt_gl_read_framebuffer(const QSize&, bool, bool);
     after creating a QGLFramebufferObject to find the exact format that was
     used to create the frame buffer object.
 
+    \note This class has been deprecated in favor of QOpenGLFramebufferObject.
+
     \sa QGLFramebufferObject
 */
 

diff --git a/src/opengl/qglfunctions.cpp b/src/opengl/qglfunctions.cpp
index 5649092..5bdd24c 100644 (file)
--- a/src/opengl/qglfunctions.cpp
+++ b/src/opengl/qglfunctions.cpp
@@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE
     \class QGLFunctions
     \brief The QGLFunctions class provides cross-platform access to the OpenGL/ES 2.0 API.
     \since 4.8
+    \obsolete
     \ingroup painting-3D
 
     OpenGL/ES 2.0 defines a subset of the OpenGL specification that is
@@ -117,6 +118,8 @@ QT_BEGIN_NAMESPACE
     QGLFunctions funcs(QGLContext::currentContext());
     bool npot = funcs.hasOpenGLFeature(QGLFunctions::NPOTTextures);
     \endcode
+
+    \note This class has been deprecated in favor of QOpenGLFunctions.
 */
 
 /*!

diff --git a/src/opengl/qglpixelbuffer.cpp b/src/opengl/qglpixelbuffer.cpp
index ca7568d..f9c841a 100644 (file)
--- a/src/opengl/qglpixelbuffer.cpp
+++ b/src/opengl/qglpixelbuffer.cpp
@@ -43,6 +43,7 @@
     \class QGLPixelBuffer
     \brief The QGLPixelBuffer class encapsulates an OpenGL pbuffer.
     \since 4.1
+    \obsolete
 
     \ingroup painting-3D
 
@@ -76,6 +77,8 @@
 
     \endlist
 
+    \note This class has been deprecated, use QOpenGLFramebufferObject
+    for offscreen rendering.
 
     \section1 Threading
 

diff --git a/src/opengl/qglshaderprogram.cpp b/src/opengl/qglshaderprogram.cpp
index 1062669..8d86f8d 100644 (file)
--- a/src/opengl/qglshaderprogram.cpp
+++ b/src/opengl/qglshaderprogram.cpp
@@ -54,6 +54,7 @@ QT_BEGIN_NAMESPACE
     \class QGLShaderProgram
     \brief The QGLShaderProgram class allows OpenGL shader programs to be linked and used.
     \since 4.6
+    \obsolete
     \ingroup painting-3D
 
     \section1 Introduction
@@ -117,6 +118,8 @@ QT_BEGIN_NAMESPACE
     specified and linked, allowing other operations to be performed
     on the shader program.
 
+    \note This class has been deprecated in favor of QOpenGLShaderProgram.
+
     \sa QGLShader
 */
 
@@ -124,6 +127,7 @@ QT_BEGIN_NAMESPACE
     \class QGLShader
     \brief The QGLShader class allows OpenGL shaders to be compiled.
     \since 4.6
+    \obsolete
     \ingroup painting-3D
 
     This class supports shaders written in the OpenGL Shading Language (GLSL)
@@ -132,6 +136,8 @@ QT_BEGIN_NAMESPACE
     QGLShader and QGLShaderProgram shelter the programmer from the details of
     compiling and linking vertex and fragment shaders.
 
+    \note This class has been deprecated in favor of QOpenGLShader.
+
     \sa QGLShaderProgram
 */